import type { Identifier, ArrayNonEmptyIfConst } from "typeforge"; import type { BanGroupMemberData, FormattedAllGroupRolesForUserData_V1, GroupAuditLogActionType, GroupRelationshipType, GroupRolePermissions, GroupSettingsData, PrettifiedAuthenticatedUserPendingGroupsData, PrettifiedGroupAuditLogsData, PrettifiedGroupBansData, PrettifiedGroupIdsToGroupsInfoData, PrettifiedGroupJoinRequests, PrettifiedGroupMembersData, PrettifiedGroupMembersWithRoleData, PrettifiedGroupNameHistoryData, PrettifiedGroupPayoutsInfoData, PrettifiedGroupPolicyInfoData, PrettifiedGroupRolesFromIdsData, RawAuthenticatedUserPendingGroupsData, RawGroupBansData, RawGroupIdsToGroupsInfoData, RawGroupNameHistoryData, RawGroupPolicyInfoData, RawGroupRolesFromIdsData, UpdateRoleSetRequest } from "./groups.types"; import type { SortOrder } from "../../../utils/utils.types"; /** * Gets the featured event for a group. * @endpoint GET /v1/featured-content/event * * @param groupId The ID of the group to get the event for. * * @example const { data:eventId } = await ClassicGroupsApi.featuredEvent({ groupId: 15842838 }) * @exampleData "6533473338141704368" * @exampleRawBody {"groupId":15842838,"contentType":"event","contentId":"6533473338141704368"} */ export declare const featuredEvent: (this: any, args: { groupId: GroupId; }) => Promise<{ data: Identifier | null; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: { groupId: GroupId; contentType: "event"; contentId: Identifier; } | null; }; 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: Identifier | null; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: { groupId: GroupId; contentType: "event"; contentId: Identifier; } | null; }; 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 a featured event for a group. * @endpoint POST /v1/featured-content/event * * @param groupId The ID of the group to set the event for. * @param eventId The ID of the event to set. * * @example const { data:eventId } = await ClassicGroupsApi.setFeaturedEvent({ groupId: 15842838, eventId: "5904751593700196492" }) * @exampleData 5904751593700196492 * @exampleRawBody {"groupId":15842838,"contentType":"event","contentId":"6533473338141704368"} */ export declare const setFeaturedEvent: (this: any, args: { groupId: Identifier; eventId: EventId; }) => Promise<{ data: Exclude<({ method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: { groupId: GroupId; contentType: "event"; contentId: EventId; }) => string) | undefined; getCursorsFn?: ((rawData: { groupId: GroupId; contentType: "event"; contentId: EventId; }) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: { groupId: GroupId; contentType: "event"; contentId: EventId; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: (EventId extends undefined ? { groupId: GroupId; contentType: "event"; contentId: EventId; } : import("typeforge").Prettify) | undefined; } & (EventId extends undefined ? {} : import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<{ groupId: GroupId; contentType: "event"; contentId: EventId; }, EventId extends undefined ? { groupId: GroupId; contentType: "event"; contentId: EventId; } : EventId>))["🔒__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 | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: { groupId: GroupId; contentType: "event"; contentId: EventId; }) => string) | undefined; getCursorsFn?: ((rawData: { groupId: GroupId; contentType: "event"; contentId: EventId; }) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: { groupId: GroupId; contentType: "event"; contentId: EventId; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: (EventId extends undefined ? { groupId: GroupId; contentType: "event"; contentId: EventId; } : import("typeforge").Prettify) | undefined; } & (EventId extends undefined ? {} : import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<{ groupId: GroupId; contentType: "event"; contentId: EventId; }, EventId extends undefined ? { groupId: GroupId; contentType: "event"; contentId: EventId; } : EventId>))["🔒__PRIVATE_RAW_DATA"], undefined>, Exclude<({ method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: { groupId: GroupId; contentType: "event"; contentId: EventId; }) => string) | undefined; getCursorsFn?: ((rawData: { groupId: GroupId; contentType: "event"; contentId: EventId; }) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: { groupId: GroupId; contentType: "event"; contentId: EventId; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: (EventId extends undefined ? { groupId: GroupId; contentType: "event"; contentId: EventId; } : import("typeforge").Prettify) | undefined; } & (EventId extends undefined ? {} : import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<{ groupId: GroupId; contentType: "event"; contentId: EventId; }, EventId extends undefined ? { groupId: GroupId; contentType: "event"; contentId: EventId; } : EventId>))["🔒__PRIVATE_RAW_DATA"], undefined> extends infer T ? T extends Exclude<({ method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: { groupId: GroupId; contentType: "event"; contentId: EventId; }) => string) | undefined; getCursorsFn?: ((rawData: { groupId: GroupId; contentType: "event"; contentId: EventId; }) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: { groupId: GroupId; contentType: "event"; contentId: EventId; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: (EventId extends undefined ? { groupId: GroupId; contentType: "event"; contentId: EventId; } : import("typeforge").Prettify) | undefined; } & (EventId extends undefined ? {} : import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<{ groupId: GroupId; contentType: "event"; contentId: EventId; }, EventId extends undefined ? { groupId: GroupId; contentType: "event"; contentId: EventId; } : EventId>))["🔒__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 | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: { groupId: GroupId; contentType: "event"; contentId: EventId; }) => string) | undefined; getCursorsFn?: ((rawData: { groupId: GroupId; contentType: "event"; contentId: EventId; }) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: { groupId: GroupId; contentType: "event"; contentId: EventId; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: (EventId extends undefined ? { groupId: GroupId; contentType: "event"; contentId: EventId; } : import("typeforge").Prettify) | undefined; } & (EventId extends undefined ? {} : import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<{ groupId: GroupId; contentType: "event"; contentId: EventId; }, EventId extends undefined ? { groupId: GroupId; contentType: "event"; contentId: EventId; } : EventId>))["🔒__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 | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: { groupId: GroupId; contentType: "event"; contentId: EventId; }) => string) | undefined; getCursorsFn?: ((rawData: { groupId: GroupId; contentType: "event"; contentId: EventId; }) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: { groupId: GroupId; contentType: "event"; contentId: EventId; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: (EventId extends undefined ? { groupId: GroupId; contentType: "event"; contentId: EventId; } : import("typeforge").Prettify) | undefined; } & (EventId extends undefined ? {} : import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<{ groupId: GroupId; contentType: "event"; contentId: EventId; }, EventId extends undefined ? { groupId: GroupId; contentType: "event"; contentId: EventId; } : EventId>))["🔒__PRIVATE_RAW_DATA"], undefined>, Exclude<({ method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: { groupId: GroupId; contentType: "event"; contentId: EventId; }) => string) | undefined; getCursorsFn?: ((rawData: { groupId: GroupId; contentType: "event"; contentId: EventId; }) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: { groupId: GroupId; contentType: "event"; contentId: EventId; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: (EventId extends undefined ? { groupId: GroupId; contentType: "event"; contentId: EventId; } : import("typeforge").Prettify) | undefined; } & (EventId extends undefined ? {} : import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<{ groupId: GroupId; contentType: "event"; contentId: EventId; }, EventId extends undefined ? { groupId: GroupId; contentType: "event"; contentId: EventId; } : EventId>))["🔒__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 | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: { groupId: GroupId; contentType: "event"; contentId: EventId; }) => string) | undefined; getCursorsFn?: ((rawData: { groupId: GroupId; contentType: "event"; contentId: EventId; }) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: { groupId: GroupId; contentType: "event"; contentId: EventId; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: (EventId extends undefined ? { groupId: GroupId; contentType: "event"; contentId: EventId; } : import("typeforge").Prettify) | undefined; } & (EventId extends undefined ? {} : import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<{ groupId: GroupId; contentType: "event"; contentId: EventId; }, EventId extends undefined ? { groupId: GroupId; contentType: "event"; contentId: EventId; } : EventId>))["🔒__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; }; }>; }>; /** * Removes a featured event for a group. * @endpoint POST /v1/featured-content/event * * @param groupId The ID of the group to remove the event from. * @param eventId The ID of the event to remove. * * @example const { data:success } = await ClassicGroupsApi.removeFeaturedEvent({ groupId: 15842838, eventId: "5904751593700196492" }) * @exampleData true * @exampleRawBody "" */ export declare const removeFeaturedEvent: (this: any, args: { groupId: Identifier; eventId: EventId; }) => Promise<{ data: boolean; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: ""; }; 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: boolean; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: ""; }; 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 information about a group. * @category Groups * @endpoint GET /v1/groups/{groupId} * @tags [ "?Cookie" ] * * @param groupId The id of the group. * * @example const { data:groupInfo } = await ClassicGroupsApi.groupInfo({ groupId: 5850082}) * @exampleData { id: 5850082, name: "MightyPart Games", description: "Lorem ipsum dolor sit amet consectetur adipiscing elit.", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, memberCount: 102, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false } * @exampleRawBody { id: 5850082, name: "MightyPart Games", description: "Lorem ipsum dolor sit amet consectetur adipiscing elit.", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, memberCount: 102, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false } */ export declare const groupInfo: (this: any, args: { groupId: GroupId; }) => Promise<{ data: { id: GroupId; name: string; description: string; hasVerifiedBadge: boolean; owner: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; memberCount: number; isBuildersClubOnly: boolean; publicEntryAllowed: boolean; shout?: { body: string; poster: { hasVerifiedBadge: boolean; userId: string; username: string; displayName: string; }; created: Date; updated: Date; } | undefined; }; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: { id: GroupId; name: string; description: string; owner: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; shout?: { body: string; poster: { hasVerifiedBadge: boolean; userId: string; username: string; displayName: string; }; created: string; updated: string; } | undefined; memberCount: number; isBuildersClubOnly: boolean; publicEntryAllowed: boolean; hasVerifiedBadge: boolean; }; }; 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: { id: GroupId; name: string; description: string; hasVerifiedBadge: boolean; owner: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; memberCount: number; isBuildersClubOnly: boolean; publicEntryAllowed: boolean; shout?: { body: string; poster: { hasVerifiedBadge: boolean; userId: string; username: string; displayName: string; }; created: Date; updated: Date; } | undefined; }; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: { id: GroupId; name: string; description: string; owner: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; shout?: { body: string; poster: { hasVerifiedBadge: boolean; userId: string; username: string; displayName: string; }; created: string; updated: string; } | undefined; memberCount: number; isBuildersClubOnly: boolean; publicEntryAllowed: boolean; hasVerifiedBadge: boolean; }; }; 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 audit log entries for a group. * @category Groups * @endpoint GET /v1/groups/{groupId}/audit-log * @tags [ "Cookie" ] * * @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 ClassicGroupsApi.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: Identifier; actionType?: GroupAuditLogActionType | undefined; userId?: Identifier | undefined; limit?: 10 | 25 | 50 | 100 | undefined; sortOrder?: SortOrder | undefined; cursor?: string | undefined; }, { method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record | undefined; headers?: Record | undefined; body?: string | number | Record | 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: { /** * Gets the featured event for a group. * @endpoint GET /v1/featured-content/event * * @param groupId The ID of the group to get the event for. * * @example const { data:eventId } = await ClassicGroupsApi.featuredEvent({ groupId: 15842838 }) * @exampleData "6533473338141704368" * @exampleRawBody {"groupId":15842838,"contentType":"event","contentId":"6533473338141704368"} */ PostDec: string; /** * Gets the featured event for a group. * @endpoint GET /v1/featured-content/event * * @param groupId The ID of the group to get the event for. * * @example const { data:eventId } = await ClassicGroupsApi.featuredEvent({ groupId: 15842838 }) * @exampleData "6533473338141704368" * @exampleRawBody {"groupId":15842838,"contentType":"event","contentId":"6533473338141704368"} */ TargetId: number; /** * Gets the featured event for a group. * @endpoint GET /v1/featured-content/event * * @param groupId The ID of the group to get the event for. * * @example const { data:eventId } = await ClassicGroupsApi.featuredEvent({ groupId: 15842838 }) * @exampleData "6533473338141704368" * @exampleRawBody {"groupId":15842838,"contentType":"event","contentId":"6533473338141704368"} */ 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: { /** * Sets a featured event for a group. * @endpoint POST /v1/featured-content/event * * @param groupId The ID of the group to set the event for. * @param eventId The ID of the event to set. * * @example const { data:eventId } = await ClassicGroupsApi.setFeaturedEvent({ groupId: 15842838, eventId: "5904751593700196492" }) * @exampleData 5904751593700196492 * @exampleRawBody {"groupId":15842838,"contentType":"event","contentId":"6533473338141704368"} */ 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: { /** * Gets information about a group. * @category Groups * @endpoint GET /v1/groups/{groupId} * @tags [ "?Cookie" ] * * @param groupId The id of the group. * * @example const { data:groupInfo } = await ClassicGroupsApi.groupInfo({ groupId: 5850082}) * @exampleData { id: 5850082, name: "MightyPart Games", description: "Lorem ipsum dolor sit amet consectetur adipiscing elit.", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, memberCount: 102, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false } * @exampleRawBody { id: 5850082, name: "MightyPart Games", description: "Lorem ipsum dolor sit amet consectetur adipiscing elit.", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, memberCount: 102, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false } */ AssetId: number; /** * Gets information about a group. * @category Groups * @endpoint GET /v1/groups/{groupId} * @tags [ "?Cookie" ] * * @param groupId The id of the group. * * @example const { data:groupInfo } = await ClassicGroupsApi.groupInfo({ groupId: 5850082}) * @exampleData { id: 5850082, name: "MightyPart Games", description: "Lorem ipsum dolor sit amet consectetur adipiscing elit.", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, memberCount: 102, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false } * @exampleRawBody { id: 5850082, name: "MightyPart Games", description: "Lorem ipsum dolor sit amet consectetur adipiscing elit.", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, memberCount: 102, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false } */ AssetName: string; VersionNumber: number; /** * Gets information about a group. * @category Groups * @endpoint GET /v1/groups/{groupId} * @tags [ "?Cookie" ] * * @param groupId The id of the group. * * @example const { data:groupInfo } = await ClassicGroupsApi.groupInfo({ groupId: 5850082}) * @exampleData { id: 5850082, name: "MightyPart Games", description: "Lorem ipsum dolor sit amet consectetur adipiscing elit.", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, memberCount: 102, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false } * @exampleRawBody { id: 5850082, name: "MightyPart Games", description: "Lorem ipsum dolor sit amet consectetur adipiscing elit.", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, memberCount: 102, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false } */ 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: { /** * Gets the featured event for a group. * @endpoint GET /v1/featured-content/event * * @param groupId The ID of the group to get the event for. * * @example const { data:eventId } = await ClassicGroupsApi.featuredEvent({ groupId: 15842838 }) * @exampleData "6533473338141704368" * @exampleRawBody {"groupId":15842838,"contentType":"event","contentId":"6533473338141704368"} */ PostDec: string; /** * Gets the featured event for a group. * @endpoint GET /v1/featured-content/event * * @param groupId The ID of the group to get the event for. * * @example const { data:eventId } = await ClassicGroupsApi.featuredEvent({ groupId: 15842838 }) * @exampleData "6533473338141704368" * @exampleRawBody {"groupId":15842838,"contentType":"event","contentId":"6533473338141704368"} */ TargetId: number; /** * Gets the featured event for a group. * @endpoint GET /v1/featured-content/event * * @param groupId The ID of the group to get the event for. * * @example const { data:eventId } = await ClassicGroupsApi.featuredEvent({ groupId: 15842838 }) * @exampleData "6533473338141704368" * @exampleRawBody {"groupId":15842838,"contentType":"event","contentId":"6533473338141704368"} */ 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: { /** * Sets a featured event for a group. * @endpoint POST /v1/featured-content/event * * @param groupId The ID of the group to set the event for. * @param eventId The ID of the event to set. * * @example const { data:eventId } = await ClassicGroupsApi.setFeaturedEvent({ groupId: 15842838, eventId: "5904751593700196492" }) * @exampleData 5904751593700196492 * @exampleRawBody {"groupId":15842838,"contentType":"event","contentId":"6533473338141704368"} */ 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: { /** * Gets information about a group. * @category Groups * @endpoint GET /v1/groups/{groupId} * @tags [ "?Cookie" ] * * @param groupId The id of the group. * * @example const { data:groupInfo } = await ClassicGroupsApi.groupInfo({ groupId: 5850082}) * @exampleData { id: 5850082, name: "MightyPart Games", description: "Lorem ipsum dolor sit amet consectetur adipiscing elit.", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, memberCount: 102, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false } * @exampleRawBody { id: 5850082, name: "MightyPart Games", description: "Lorem ipsum dolor sit amet consectetur adipiscing elit.", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, memberCount: 102, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false } */ AssetId: number; /** * Gets information about a group. * @category Groups * @endpoint GET /v1/groups/{groupId} * @tags [ "?Cookie" ] * * @param groupId The id of the group. * * @example const { data:groupInfo } = await ClassicGroupsApi.groupInfo({ groupId: 5850082}) * @exampleData { id: 5850082, name: "MightyPart Games", description: "Lorem ipsum dolor sit amet consectetur adipiscing elit.", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, memberCount: 102, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false } * @exampleRawBody { id: 5850082, name: "MightyPart Games", description: "Lorem ipsum dolor sit amet consectetur adipiscing elit.", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, memberCount: 102, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false } */ AssetName: string; VersionNumber: number; /** * Gets information about a group. * @category Groups * @endpoint GET /v1/groups/{groupId} * @tags [ "?Cookie" ] * * @param groupId The id of the group. * * @example const { data:groupInfo } = await ClassicGroupsApi.groupInfo({ groupId: 5850082}) * @exampleData { id: 5850082, name: "MightyPart Games", description: "Lorem ipsum dolor sit amet consectetur adipiscing elit.", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, memberCount: 102, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false } * @exampleRawBody { id: 5850082, name: "MightyPart Games", description: "Lorem ipsum dolor sit amet consectetur adipiscing elit.", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, memberCount: 102, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false } */ 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: { /** * Gets the featured event for a group. * @endpoint GET /v1/featured-content/event * * @param groupId The ID of the group to get the event for. * * @example const { data:eventId } = await ClassicGroupsApi.featuredEvent({ groupId: 15842838 }) * @exampleData "6533473338141704368" * @exampleRawBody {"groupId":15842838,"contentType":"event","contentId":"6533473338141704368"} */ PostDec: string; /** * Gets the featured event for a group. * @endpoint GET /v1/featured-content/event * * @param groupId The ID of the group to get the event for. * * @example const { data:eventId } = await ClassicGroupsApi.featuredEvent({ groupId: 15842838 }) * @exampleData "6533473338141704368" * @exampleRawBody {"groupId":15842838,"contentType":"event","contentId":"6533473338141704368"} */ TargetId: number; /** * Gets the featured event for a group. * @endpoint GET /v1/featured-content/event * * @param groupId The ID of the group to get the event for. * * @example const { data:eventId } = await ClassicGroupsApi.featuredEvent({ groupId: 15842838 }) * @exampleData "6533473338141704368" * @exampleRawBody {"groupId":15842838,"contentType":"event","contentId":"6533473338141704368"} */ 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: { /** * Sets a featured event for a group. * @endpoint POST /v1/featured-content/event * * @param groupId The ID of the group to set the event for. * @param eventId The ID of the event to set. * * @example const { data:eventId } = await ClassicGroupsApi.setFeaturedEvent({ groupId: 15842838, eventId: "5904751593700196492" }) * @exampleData 5904751593700196492 * @exampleRawBody {"groupId":15842838,"contentType":"event","contentId":"6533473338141704368"} */ 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: { /** * Gets information about a group. * @category Groups * @endpoint GET /v1/groups/{groupId} * @tags [ "?Cookie" ] * * @param groupId The id of the group. * * @example const { data:groupInfo } = await ClassicGroupsApi.groupInfo({ groupId: 5850082}) * @exampleData { id: 5850082, name: "MightyPart Games", description: "Lorem ipsum dolor sit amet consectetur adipiscing elit.", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, memberCount: 102, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false } * @exampleRawBody { id: 5850082, name: "MightyPart Games", description: "Lorem ipsum dolor sit amet consectetur adipiscing elit.", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, memberCount: 102, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false } */ AssetId: number; /** * Gets information about a group. * @category Groups * @endpoint GET /v1/groups/{groupId} * @tags [ "?Cookie" ] * * @param groupId The id of the group. * * @example const { data:groupInfo } = await ClassicGroupsApi.groupInfo({ groupId: 5850082}) * @exampleData { id: 5850082, name: "MightyPart Games", description: "Lorem ipsum dolor sit amet consectetur adipiscing elit.", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, memberCount: 102, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false } * @exampleRawBody { id: 5850082, name: "MightyPart Games", description: "Lorem ipsum dolor sit amet consectetur adipiscing elit.", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, memberCount: 102, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false } */ AssetName: string; VersionNumber: number; /** * Gets information about a group. * @category Groups * @endpoint GET /v1/groups/{groupId} * @tags [ "?Cookie" ] * * @param groupId The id of the group. * * @example const { data:groupInfo } = await ClassicGroupsApi.groupInfo({ groupId: 5850082}) * @exampleData { id: 5850082, name: "MightyPart Games", description: "Lorem ipsum dolor sit amet consectetur adipiscing elit.", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, memberCount: 102, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false } * @exampleRawBody { id: 5850082, name: "MightyPart Games", description: "Lorem ipsum dolor sit amet consectetur adipiscing elit.", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, memberCount: 102, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false } */ 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: { /** * Gets the featured event for a group. * @endpoint GET /v1/featured-content/event * * @param groupId The ID of the group to get the event for. * * @example const { data:eventId } = await ClassicGroupsApi.featuredEvent({ groupId: 15842838 }) * @exampleData "6533473338141704368" * @exampleRawBody {"groupId":15842838,"contentType":"event","contentId":"6533473338141704368"} */ PostDec: string; /** * Gets the featured event for a group. * @endpoint GET /v1/featured-content/event * * @param groupId The ID of the group to get the event for. * * @example const { data:eventId } = await ClassicGroupsApi.featuredEvent({ groupId: 15842838 }) * @exampleData "6533473338141704368" * @exampleRawBody {"groupId":15842838,"contentType":"event","contentId":"6533473338141704368"} */ TargetId: number; /** * Gets the featured event for a group. * @endpoint GET /v1/featured-content/event * * @param groupId The ID of the group to get the event for. * * @example const { data:eventId } = await ClassicGroupsApi.featuredEvent({ groupId: 15842838 }) * @exampleData "6533473338141704368" * @exampleRawBody {"groupId":15842838,"contentType":"event","contentId":"6533473338141704368"} */ 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: { /** * Sets a featured event for a group. * @endpoint POST /v1/featured-content/event * * @param groupId The ID of the group to set the event for. * @param eventId The ID of the event to set. * * @example const { data:eventId } = await ClassicGroupsApi.setFeaturedEvent({ groupId: 15842838, eventId: "5904751593700196492" }) * @exampleData 5904751593700196492 * @exampleRawBody {"groupId":15842838,"contentType":"event","contentId":"6533473338141704368"} */ 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: { /** * Gets information about a group. * @category Groups * @endpoint GET /v1/groups/{groupId} * @tags [ "?Cookie" ] * * @param groupId The id of the group. * * @example const { data:groupInfo } = await ClassicGroupsApi.groupInfo({ groupId: 5850082}) * @exampleData { id: 5850082, name: "MightyPart Games", description: "Lorem ipsum dolor sit amet consectetur adipiscing elit.", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, memberCount: 102, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false } * @exampleRawBody { id: 5850082, name: "MightyPart Games", description: "Lorem ipsum dolor sit amet consectetur adipiscing elit.", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, memberCount: 102, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false } */ AssetId: number; /** * Gets information about a group. * @category Groups * @endpoint GET /v1/groups/{groupId} * @tags [ "?Cookie" ] * * @param groupId The id of the group. * * @example const { data:groupInfo } = await ClassicGroupsApi.groupInfo({ groupId: 5850082}) * @exampleData { id: 5850082, name: "MightyPart Games", description: "Lorem ipsum dolor sit amet consectetur adipiscing elit.", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, memberCount: 102, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false } * @exampleRawBody { id: 5850082, name: "MightyPart Games", description: "Lorem ipsum dolor sit amet consectetur adipiscing elit.", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, memberCount: 102, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false } */ AssetName: string; VersionNumber: number; /** * Gets information about a group. * @category Groups * @endpoint GET /v1/groups/{groupId} * @tags [ "?Cookie" ] * * @param groupId The id of the group. * * @example const { data:groupInfo } = await ClassicGroupsApi.groupInfo({ groupId: 5850082}) * @exampleData { id: 5850082, name: "MightyPart Games", description: "Lorem ipsum dolor sit amet consectetur adipiscing elit.", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, memberCount: 102, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false } * @exampleRawBody { id: 5850082, name: "MightyPart Games", description: "Lorem ipsum dolor sit amet consectetur adipiscing elit.", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, memberCount: 102, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false } */ 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: { /** * Gets the featured event for a group. * @endpoint GET /v1/featured-content/event * * @param groupId The ID of the group to get the event for. * * @example const { data:eventId } = await ClassicGroupsApi.featuredEvent({ groupId: 15842838 }) * @exampleData "6533473338141704368" * @exampleRawBody {"groupId":15842838,"contentType":"event","contentId":"6533473338141704368"} */ PostDec: string; /** * Gets the featured event for a group. * @endpoint GET /v1/featured-content/event * * @param groupId The ID of the group to get the event for. * * @example const { data:eventId } = await ClassicGroupsApi.featuredEvent({ groupId: 15842838 }) * @exampleData "6533473338141704368" * @exampleRawBody {"groupId":15842838,"contentType":"event","contentId":"6533473338141704368"} */ TargetId: number; /** * Gets the featured event for a group. * @endpoint GET /v1/featured-content/event * * @param groupId The ID of the group to get the event for. * * @example const { data:eventId } = await ClassicGroupsApi.featuredEvent({ groupId: 15842838 }) * @exampleData "6533473338141704368" * @exampleRawBody {"groupId":15842838,"contentType":"event","contentId":"6533473338141704368"} */ 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: { /** * Sets a featured event for a group. * @endpoint POST /v1/featured-content/event * * @param groupId The ID of the group to set the event for. * @param eventId The ID of the event to set. * * @example const { data:eventId } = await ClassicGroupsApi.setFeaturedEvent({ groupId: 15842838, eventId: "5904751593700196492" }) * @exampleData 5904751593700196492 * @exampleRawBody {"groupId":15842838,"contentType":"event","contentId":"6533473338141704368"} */ 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: { /** * Gets information about a group. * @category Groups * @endpoint GET /v1/groups/{groupId} * @tags [ "?Cookie" ] * * @param groupId The id of the group. * * @example const { data:groupInfo } = await ClassicGroupsApi.groupInfo({ groupId: 5850082}) * @exampleData { id: 5850082, name: "MightyPart Games", description: "Lorem ipsum dolor sit amet consectetur adipiscing elit.", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, memberCount: 102, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false } * @exampleRawBody { id: 5850082, name: "MightyPart Games", description: "Lorem ipsum dolor sit amet consectetur adipiscing elit.", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, memberCount: 102, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false } */ AssetId: number; /** * Gets information about a group. * @category Groups * @endpoint GET /v1/groups/{groupId} * @tags [ "?Cookie" ] * * @param groupId The id of the group. * * @example const { data:groupInfo } = await ClassicGroupsApi.groupInfo({ groupId: 5850082}) * @exampleData { id: 5850082, name: "MightyPart Games", description: "Lorem ipsum dolor sit amet consectetur adipiscing elit.", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, memberCount: 102, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false } * @exampleRawBody { id: 5850082, name: "MightyPart Games", description: "Lorem ipsum dolor sit amet consectetur adipiscing elit.", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, memberCount: 102, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false } */ AssetName: string; VersionNumber: number; /** * Gets information about a group. * @category Groups * @endpoint GET /v1/groups/{groupId} * @tags [ "?Cookie" ] * * @param groupId The id of the group. * * @example const { data:groupInfo } = await ClassicGroupsApi.groupInfo({ groupId: 5850082}) * @exampleData { id: 5850082, name: "MightyPart Games", description: "Lorem ipsum dolor sit amet consectetur adipiscing elit.", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, memberCount: 102, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false } * @exampleRawBody { id: 5850082, name: "MightyPart Games", description: "Lorem ipsum dolor sit amet consectetur adipiscing elit.", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, memberCount: 102, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false } */ 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; })[]; }, PrettifiedGroupAuditLogsData>, true>; /** * Gets name history of a group. * @category Groups * @endpoint GET /v1/groups/{groupId}/name-history * * @param groupId The id of the group. * @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:nameHistory } = await ClassicGroupsApi.groupNameHistory({ groupId: 5850082 }) * @exampleData [ { name: "Nameless Game Studio", created: 2022-01-06T00:01:47.193Z } ] * @exampleRawBody { previousPageCursor: null, nextPageCursor: null, data: [ { name: "Nameless Game Studio", created: "2022-01-06T00:01:47.193Z" } ] } */ export declare const groupNameHistory: import("../../apiGroup/apiGroup.types").CallApiMethod<{ groupId: Identifier; limit?: 10 | 25 | 50 | 100 | undefined; sortOrder?: SortOrder | undefined; cursor?: string | undefined; }, { method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: RawGroupNameHistoryData) => string) | undefined; getCursorsFn?: ((rawData: { previousPageCursor?: string | undefined; nextPageCursor?: string | undefined; data: { name: 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}`; }[]; }) => [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: { name: 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}`; }[]; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: { name: string; created: Date; }[] | undefined; } & import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData, true>; /** * 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 ClassicGroupsApi.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: Identifier; }, { method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record | undefined; headers?: Record | undefined; body?: string | number | Record | 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 ClassicGroupsApi.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: Identifier; newSettings: GroupSettingsData; }, { method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record | undefined; headers?: Record | undefined; body?: string | number | Record | 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, false>; /** * Gets groups configuration metadata. * @category Groups * @endpoint GET /v1/groups/configuration/metadata * * @example const { data:configMetadata } = await ClassicGroupsApi.groupsConfigMetadata() * @exampleData { groupConfiguration: { nameMaxLength: 50, descriptionMaxLength: 1000, iconMaxFileSizeMb: 20, cost: 100, isUsingTwoStepWebviewComponent: true }, recurringPayoutsConfiguration: { maxPayoutPartners: 20 }, roleConfiguration: { nameMaxLength: 100, descriptionMaxLength: 1000, limit: 40, cost: 25, minRank: 0, maxRank: 255 }, groupNameChangeConfiguration: { cost: 100, cooldownInDays: 90, ownershipCooldownInDays: 90 }, isPremiumPayoutsEnabled: true, isDefaultEmblemPolicyEnabled: true } * @exampleRawBody { groupConfiguration: { nameMaxLength: 50, descriptionMaxLength: 1000, iconMaxFileSizeMb: 20, cost: 100, isUsingTwoStepWebviewComponent: true }, recurringPayoutsConfiguration: { maxPayoutPartners: 20 }, roleConfiguration: { nameMaxLength: 100, descriptionMaxLength: 1000, limit: 40, cost: 25, minRank: 0, maxRank: 255 }, groupNameChangeConfiguration: { cost: 100, cooldownInDays: 90, ownershipCooldownInDays: 90 }, isPremiumPayoutsEnabled: true, isDefaultEmblemPolicyEnabled: true } */ export declare const groupsConfigMetadata: import("../../apiGroup/apiGroup.types").CallApiMethod, { method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: { groupConfiguration: { nameMaxLength: number; descriptionMaxLength: number; iconMaxFileSizeMb: number; cost: number; isUsingTwoStepWebviewComponent: boolean; }; recurringPayoutsConfiguration: { maxPayoutPartners: number; }; roleConfiguration: { nameMaxLength: number; descriptionMaxLength: number; limit: number; cost: number; minRank: number; maxRank: number; }; groupNameChangeConfiguration: { cost: number; cooldownInDays: number; ownershipCooldownInDays: number; }; isPremiumPayoutsEnabled: boolean; isDefaultEmblemPolicyEnabled: boolean; }) => string) | undefined; getCursorsFn?: ((rawData: { groupConfiguration: { nameMaxLength: number; descriptionMaxLength: number; iconMaxFileSizeMb: number; cost: number; isUsingTwoStepWebviewComponent: boolean; }; recurringPayoutsConfiguration: { maxPayoutPartners: number; }; roleConfiguration: { nameMaxLength: number; descriptionMaxLength: number; limit: number; cost: number; minRank: number; maxRank: number; }; groupNameChangeConfiguration: { cost: number; cooldownInDays: number; ownershipCooldownInDays: number; }; isPremiumPayoutsEnabled: boolean; isDefaultEmblemPolicyEnabled: boolean; }) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: { groupConfiguration: { nameMaxLength: number; descriptionMaxLength: number; iconMaxFileSizeMb: number; cost: number; isUsingTwoStepWebviewComponent: boolean; }; recurringPayoutsConfiguration: { maxPayoutPartners: number; }; roleConfiguration: { nameMaxLength: number; descriptionMaxLength: number; limit: number; cost: number; minRank: number; maxRank: number; }; groupNameChangeConfiguration: { cost: number; cooldownInDays: number; ownershipCooldownInDays: number; }; isPremiumPayoutsEnabled: boolean; isDefaultEmblemPolicyEnabled: boolean; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: { groupConfiguration: { nameMaxLength: number; descriptionMaxLength: number; iconMaxFileSizeMb: number; cost: number; isUsingTwoStepWebviewComponent: boolean; }; recurringPayoutsConfiguration: { maxPayoutPartners: number; }; roleConfiguration: { nameMaxLength: number; descriptionMaxLength: number; limit: number; cost: number; minRank: number; maxRank: number; }; groupNameChangeConfiguration: { cost: number; cooldownInDays: number; ownershipCooldownInDays: number; }; isPremiumPayoutsEnabled: boolean; isDefaultEmblemPolicyEnabled: boolean; } | undefined; }, false>; /** * Gets groups metadata. * @category Groups * @endpoint GET /v1/groups/metadata * * @example const { data:metadata } = await ClassicGroupsApi.groupsMetadata() * @exampleData { groupLimit: 100, currentGroupCount: 57, groupStatusMaxLength: 255, groupPostMaxLength: 500, isGroupWallNotificationsEnabled: false, groupWallNotificationsSubscribeIntervalInMilliseconds: 60000, areProfileGroupsHidden: false, isGroupDetailsPolicyEnabled: true, showPreviousGroupNames: true } * @exampleRawBody { groupLimit: 100, currentGroupCount: 57, groupStatusMaxLength: 255, groupPostMaxLength: 500, isGroupWallNotificationsEnabled: false, groupWallNotificationsSubscribeIntervalInMilliseconds: 60000, areProfileGroupsHidden: false, isGroupDetailsPolicyEnabled: true, showPreviousGroupNames: true } */ export declare const groupsMetadata: import("../../apiGroup/apiGroup.types").CallApiMethod, { method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: { groupLimit: number; currentGroupCount: number; groupStatusMaxLength: number; groupPostMaxLengt: number; isGroupWallNotificationsEnabled: boolean; groupWallNotificationsSubscribeIntervalInMilliseconds: number; areProfileGroupsHidden: boolean; isGroupDetailsPolicyEnabled: boolean; showPreviousGroupNames: boolean; }) => string) | undefined; getCursorsFn?: ((rawData: { groupLimit: number; currentGroupCount: number; groupStatusMaxLength: number; groupPostMaxLengt: number; isGroupWallNotificationsEnabled: boolean; groupWallNotificationsSubscribeIntervalInMilliseconds: number; areProfileGroupsHidden: boolean; isGroupDetailsPolicyEnabled: boolean; showPreviousGroupNames: boolean; }) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: { groupLimit: number; currentGroupCount: number; groupStatusMaxLength: number; groupPostMaxLengt: number; isGroupWallNotificationsEnabled: boolean; groupWallNotificationsSubscribeIntervalInMilliseconds: number; areProfileGroupsHidden: boolean; isGroupDetailsPolicyEnabled: boolean; showPreviousGroupNames: boolean; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: { groupLimit: number; currentGroupCount: number; groupStatusMaxLength: number; groupPostMaxLengt: number; isGroupWallNotificationsEnabled: boolean; groupWallNotificationsSubscribeIntervalInMilliseconds: number; areProfileGroupsHidden: boolean; isGroupDetailsPolicyEnabled: boolean; showPreviousGroupNames: boolean; } | undefined; }, false>; /** * 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 ClassicGroupsApi.groupsPolicyInfo({ groupIds: [ 5850082 ] }) * @exampleData { "5850082": { canViewGroup: true } } * @exampleRawBody { groups: [ { canViewGroup: true, groupId: 5850082 } ] } */ export declare const groupsPolicyInfo: (this: any, args: { groupIds: ArrayNonEmptyIfConst; }) => Promise<{ data: Exclude<({ method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: RawGroupPolicyInfoData) => 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"?: (PrettifiedGroupPolicyInfoData extends infer T ? T extends PrettifiedGroupPolicyInfoData ? T extends undefined ? { groups: { canViewGroup: boolean; groupId: GroupId; }[]; } : import("typeforge").Prettify : never : never) | undefined; } & (PrettifiedGroupPolicyInfoData extends infer T_1 ? T_1 extends PrettifiedGroupPolicyInfoData ? T_1 extends undefined ? {} : import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData, PrettifiedGroupPolicyInfoData extends infer T_2 ? T_2 extends PrettifiedGroupPolicyInfoData ? T_2 extends undefined ? RawGroupPolicyInfoData : 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 | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: RawGroupPolicyInfoData) => 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"?: (PrettifiedGroupPolicyInfoData extends infer T_3 ? T_3 extends PrettifiedGroupPolicyInfoData ? T_3 extends undefined ? { groups: { canViewGroup: boolean; groupId: GroupId; }[]; } : import("typeforge").Prettify : never : never) | undefined; } & (PrettifiedGroupPolicyInfoData extends infer T_4 ? T_4 extends PrettifiedGroupPolicyInfoData ? T_4 extends undefined ? {} : import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData, PrettifiedGroupPolicyInfoData extends infer T_5 ? T_5 extends PrettifiedGroupPolicyInfoData ? T_5 extends undefined ? RawGroupPolicyInfoData : T_5 : never : never> : never : never))["🔒__PRIVATE_RAW_DATA"], undefined>, Exclude<({ method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: RawGroupPolicyInfoData) => 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"?: (PrettifiedGroupPolicyInfoData extends infer T_6 ? T_6 extends PrettifiedGroupPolicyInfoData ? T_6 extends undefined ? { groups: { canViewGroup: boolean; groupId: GroupId; }[]; } : import("typeforge").Prettify : never : never) | undefined; } & (PrettifiedGroupPolicyInfoData extends infer T_7 ? T_7 extends PrettifiedGroupPolicyInfoData ? T_7 extends undefined ? {} : import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData, PrettifiedGroupPolicyInfoData extends infer T_8 ? T_8 extends PrettifiedGroupPolicyInfoData ? T_8 extends undefined ? RawGroupPolicyInfoData : 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 | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: RawGroupPolicyInfoData) => 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"?: (PrettifiedGroupPolicyInfoData extends infer T_10 ? T_10 extends PrettifiedGroupPolicyInfoData ? T_10 extends undefined ? { groups: { canViewGroup: boolean; groupId: GroupId; }[]; } : import("typeforge").Prettify : never : never) | undefined; } & (PrettifiedGroupPolicyInfoData extends infer T_11 ? T_11 extends PrettifiedGroupPolicyInfoData ? T_11 extends undefined ? {} : import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData, PrettifiedGroupPolicyInfoData extends infer T_12 ? T_12 extends PrettifiedGroupPolicyInfoData ? T_12 extends undefined ? RawGroupPolicyInfoData : 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 | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: RawGroupPolicyInfoData) => 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"?: (PrettifiedGroupPolicyInfoData extends infer T_13 ? T_13 extends PrettifiedGroupPolicyInfoData ? T_13 extends undefined ? { groups: { canViewGroup: boolean; groupId: GroupId; }[]; } : import("typeforge").Prettify : never : never) | undefined; } & (PrettifiedGroupPolicyInfoData extends infer T_14 ? T_14 extends PrettifiedGroupPolicyInfoData ? T_14 extends undefined ? {} : import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData, PrettifiedGroupPolicyInfoData extends infer T_15 ? T_15 extends PrettifiedGroupPolicyInfoData ? T_15 extends undefined ? RawGroupPolicyInfoData : 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 | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: RawGroupPolicyInfoData) => 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"?: (PrettifiedGroupPolicyInfoData extends infer T_16 ? T_16 extends PrettifiedGroupPolicyInfoData ? T_16 extends undefined ? { groups: { canViewGroup: boolean; groupId: GroupId; }[]; } : import("typeforge").Prettify : never : never) | undefined; } & (PrettifiedGroupPolicyInfoData extends infer T_17 ? T_17 extends PrettifiedGroupPolicyInfoData ? T_17 extends undefined ? {} : import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData, PrettifiedGroupPolicyInfoData extends infer T_18 ? T_18 extends PrettifiedGroupPolicyInfoData ? T_18 extends undefined ? RawGroupPolicyInfoData : T_18 : never : never> : never : never))["🔒__PRIVATE_RAW_DATA"], undefined>, Exclude<({ method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: RawGroupPolicyInfoData) => 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"?: (PrettifiedGroupPolicyInfoData extends infer T_19 ? T_19 extends PrettifiedGroupPolicyInfoData ? T_19 extends undefined ? { groups: { canViewGroup: boolean; groupId: GroupId; }[]; } : import("typeforge").Prettify : never : never) | undefined; } & (PrettifiedGroupPolicyInfoData extends infer T_20 ? T_20 extends PrettifiedGroupPolicyInfoData ? T_20 extends undefined ? {} : import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData, PrettifiedGroupPolicyInfoData extends infer T_21 ? T_21 extends PrettifiedGroupPolicyInfoData ? T_21 extends undefined ? RawGroupPolicyInfoData : 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 | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: RawGroupPolicyInfoData) => 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"?: (PrettifiedGroupPolicyInfoData extends infer T_23 ? T_23 extends PrettifiedGroupPolicyInfoData ? T_23 extends undefined ? { groups: { canViewGroup: boolean; groupId: GroupId; }[]; } : import("typeforge").Prettify : never : never) | undefined; } & (PrettifiedGroupPolicyInfoData extends infer T_24 ? T_24 extends PrettifiedGroupPolicyInfoData ? T_24 extends undefined ? {} : import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData, PrettifiedGroupPolicyInfoData extends infer T_25 ? T_25 extends PrettifiedGroupPolicyInfoData ? T_25 extends undefined ? RawGroupPolicyInfoData : 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; }; }>; }>; /** * 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 ClassicGroupsApi.setGroupDescription({ groupId: 5850082, newDescription: "Hello World!" }) * @exampleData "Hello World!" * @exampleRawBody { newDescription: "Hello World!" } */ export declare const setGroupDescription: (this: any, args: { groupId: Identifier; newDescription: NewDescription; }) => Promise<{ data: Exclude<({ method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record | undefined; headers?: Record | undefined; body?: string | number | Record | 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) | 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 | undefined; headers?: Record | undefined; body?: string | number | Record | 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) | 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 | undefined; headers?: Record | undefined; body?: string | number | Record | 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) | 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 | undefined; headers?: Record | undefined; body?: string | number | Record | 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) | 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 | undefined; headers?: Record | undefined; body?: string | number | Record | 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) | 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 | undefined; headers?: Record | undefined; body?: string | number | Record | 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) | 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 | undefined; headers?: Record | undefined; body?: string | number | Record | 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) | 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 | undefined; headers?: Record | undefined; body?: string | number | Record | 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) | 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; }; }>; }>; /** * 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 ClassicGroupsApi.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: (this: any, args: { groupId: 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 icon. * @category Groups * @endpoint PATCH /v1/groups/{groupId}/status * @tags [ "Cookie" ] * * @param groupId The id of the group to set the icon for. * @param newIcon The new icon for the group. * * @example const { data:success } = await ClassicGroupsApi.setGroupIcon({ groupId: 5850082, newIcon: "./newGroupIcon.png" }) * @exampleData true * @exampleRawBody {} */ export declare const setGroupIcon: import("../../apiGroup/apiGroup.types").CallApiMethod<{ groupId: Identifier; newIcon: string | File; }, { method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: {}) => string) | undefined; getCursorsFn?: ((rawData: {}) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: {} | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: boolean | undefined; } & import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<{}, boolean>, false>; /** * Batch declines join requests. * @category Membership * @endpoint DELETE /v1/groups/{groupId}/join-requests * @tags [ "Cookie" ] * * @param groupId The id of the group to batch decline join requests for. * @param userIds The ids of the user to decline. * * @example const { data:success } = await ClassicGroupsApi.batchDeclineGroupJoinRequests({ groupId: 5850082, userIds: [2655994471] }) * @exampleData true * @exampleRawBody {} */ export declare const batchDeclineGroupJoinRequests: import("../../apiGroup/apiGroup.types").CallApiMethod<{ groupId: Identifier; userIds: ArrayNonEmptyIfConst; }, { method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: {}) => string) | undefined; getCursorsFn?: ((rawData: {}) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: {} | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: boolean | undefined; } & import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<{}, boolean>, false>; /** * gets join requests. * @category Membership * @endpoint GET /v1/groups/{groupId}/join-requests * @tags [ "Cookie" ] * * @param groupId The id of the group to get join requests for. * @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:joinRequests } = await ClassicGroupsApi.groupJoinRequests({ groupId: 5850082 }) * @exampleData [ { requester: { hasVerifiedBadge: false, userId: 2655994471, username: "MightyPartJr", displayName: "MightyPartJr" }, created: 2023-09-12T09:35:49.287Z } ] * @exampleRawBody [ { requester: { hasVerifiedBadge: false, userId: 2655994471, username: "MightyPartJr", displayName: "MightyPartJr" }, created: "2023-09-12T09:35:49.287Z" } ] */ export declare const groupJoinRequests: import("../../apiGroup/apiGroup.types").CallApiMethod<{ groupId: Identifier; limit?: 10 | 25 | 50 | 100 | undefined; sortOrder?: SortOrder | undefined; cursor?: string | undefined; }, { method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: { previousPageCursor?: string | undefined; nextPageCursor?: string | undefined; data: { requester: { buildersClubMembershipType: number; hasVerifiedBadge: true; userId: Identifier; 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}`; }[]; }) => string) | undefined; getCursorsFn?: ((rawData: { previousPageCursor?: string | undefined; nextPageCursor?: string | undefined; data: { requester: { buildersClubMembershipType: number; hasVerifiedBadge: true; userId: Identifier; 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}`; }[]; }) => [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: { requester: { buildersClubMembershipType: number; hasVerifiedBadge: true; userId: Identifier; 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}`; }[]; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: { requester: { buildersClubMembershipType: number; hasVerifiedBadge: true; userId: Identifier; username: string; displayName: string; }; created: Date; }[] | undefined; } & import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<{ previousPageCursor?: string | undefined; nextPageCursor?: string | undefined; data: { requester: { buildersClubMembershipType: number; hasVerifiedBadge: true; userId: Identifier; 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}`; }[]; }, PrettifiedGroupJoinRequests>, true>; /** * Batch accepts join requests. * @category Membership * @endpoint POST /v1/groups/{groupId}/join-requests * @tags [ "Cookie" ] * * @param groupId The id of the group to batch accepts join requests for. * @param userIds The ids of the user to accept. * * @example const { data:success } = await ClassicGroupsApi.batchAcceptGroupJoinRequests({ groupId: 5850082, userIds: [2655994471] }) * @exampleData true * @exampleRawBody {} */ export declare const batchAcceptGroupJoinRequests: import("../../apiGroup/apiGroup.types").CallApiMethod<{ groupId: Identifier; userIds: ArrayNonEmptyIfConst; }, { method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: {}) => string) | undefined; getCursorsFn?: ((rawData: {}) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: {} | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: boolean | undefined; } & import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<{}, boolean>, false>; /** * Declines a join request. * @category Membership * @endpoint DELETE /v1/groups/{groupId}/join-requests/users/${userId} * @tags [ "Cookie" ] * * @param groupId The id of the group to decline a join request for. * @param userId The id of the user to decline. * * @example const { data:success } = await ClassicGroupsApi.declineGroupJoinRequest({ groupId: 5850082, userId: 2655994471 }) * @exampleData true * @exampleRawBody {} */ export declare const declineGroupJoinRequest: import("../../apiGroup/apiGroup.types").CallApiMethod<{ groupId: Identifier; userId: Identifier; }, { method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: {}) => string) | undefined; getCursorsFn?: ((rawData: {}) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: {} | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: boolean | undefined; } & import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<{}, boolean>, false>; /** * Gets a join request for a user. * @category Membership * @endpoint DELETE /v1/groups/{groupId}/join-requests/users/${userId} * @tags [ "Cookie" ] * * @param groupId The id of the group. * @param userId The id of the user. * * @example const { data:joinRequest } = await ClassicGroupsApi.groupJoinRequestInfo({ groupId: 5850082, userId: 2655994471 }) * @exampleData { requester: { hasVerifiedBadge: false, userId: 2655994471, username: "MightyPartJr", displayName: "MightyPartJr" }, created: 2023-09-12T11:31:18.933Z } * @exampleRawBody { requester: { hasVerifiedBadge: false, userId: 2655994471, username: "MightyPartJr", displayName: "MightyPartJr" }, created: "2023-09-12T11:31:18.933Z" } */ export declare const groupJoinRequestInfo: (this: any, args: { groupId: Identifier; userId: UserId; }) => Promise<{ data: {} | { requester: { buildersClubMembershipType: number; hasVerifiedBadge: true; userId: UserId; username: string; displayName: string; }; created: Date; }; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: {} | { requester: { buildersClubMembershipType: number; hasVerifiedBadge: true; userId: UserId; 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}`; }; }; 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: {} | { requester: { buildersClubMembershipType: number; hasVerifiedBadge: true; userId: UserId; username: string; displayName: string; }; created: Date; }; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: {} | { requester: { buildersClubMembershipType: number; hasVerifiedBadge: true; userId: UserId; 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}`; }; }; 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; }; }>; }>; /** * Accepts a join request. * @category Membership * @endpoint POST /v1/groups/{groupId}/join-requests/users/${userId} * @tags [ "Cookie" ] * * @param groupId The id of the group to accept a join request for. * @param userId The id of the user to accept. * * @example const { data:success } = await ClassicGroupsApi.acceptGroupJoinRequest({ groupId: 5850082, userId: 2655994471 }) * @exampleData true * @exampleRawBody {} */ export declare const acceptGroupJoinRequest: import("../../apiGroup/apiGroup.types").CallApiMethod<{ groupId: Identifier; userId: Identifier; }, { method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: {}) => string) | undefined; getCursorsFn?: ((rawData: {}) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: {} | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: boolean | undefined; } & import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<{}, boolean>, false>; /** * Gets group membership info for the currently authenticated user. * @category Membership * @endpoint GET /v1/groups/{groupId}/membership * @tags [ "Cookie" ] * * @param groupId The id of the group to get membership info for. * * @example const { data:membershipInfo } = await ClassicGroupsApi.authenticatedUserGroupMembershipInfo({ groupId: 5850082 }) * @exampleData { groupId: 5850082, isPrimary: false, isPendingJoin: false, userRole: { user: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, role: { id: 38353811, name: "NamelessGuy2005 - Scriptor", rank: 255 } }, permissions: { groupPostsPermissions: { viewWall: true, postToWall: true, deleteFromWall: true, viewStatus: true, postToStatus: true }, groupMembershipPermissions: { changeRank: true, inviteMembers: true, removeMembers: true }, groupManagementPermissions: { manageRelationships: true, manageClan: true, viewAuditLogs: true }, groupEconomyPermissions: { spendGroupFunds: true, advertiseGroup: true, createItems: true, manageItems: true, addGroupPlaces: true, manageGroupGames: true, viewGroupPayouts: true, viewAnalytics: true }, groupOpenCloudPermissions: { useCloudAuthentication: true, administerCloudAuthentication: true } }, areGroupGamesVisible: true, areGroupFundsVisible: false, areEnemiesAllowed: true, canConfigure: true } * @exampleRawBody { groupId: 5850082, isPrimary: false, isPendingJoin: false, userRole: { user: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, role: { id: 38353811, name: "NamelessGuy2005 - Scriptor", rank: 255 } }, permissions: { groupPostsPermissions: { viewWall: true, postToWall: true, deleteFromWall: true, viewStatus: true, postToStatus: true }, groupMembershipPermissions: { changeRank: true, inviteMembers: true, removeMembers: true }, groupManagementPermissions: { manageRelationships: true, manageClan: true, viewAuditLogs: true }, groupEconomyPermissions: { spendGroupFunds: true, advertiseGroup: true, createItems: true, manageItems: true, addGroupPlaces: true, manageGroupGames: true, viewGroupPayouts: true, viewAnalytics: true }, groupOpenCloudPermissions: { useCloudAuthentication: true, administerCloudAuthentication: true } }, areGroupGamesVisible: true, areGroupFundsVisible: false, areEnemiesAllowed: true, canConfigure: true } */ export declare const authenticatedUserGroupMembershipInfo: (this: any, args: { groupId: GroupId; }) => Promise<{ data: { groupId: GroupId; isPrimary: boolean; isPendingJoin: boolean; userRole: { user: { buildersClubMembershipType: number; hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; role: { id: number; name: string; description: string; rank: number; memberCount: number; }; }; permissions: { groupPostsPermissions: { viewWall: boolean; postToWall: boolean; deleteFromWall: boolean; viewStatus: boolean; postToStatus: boolean; }; groupMembershipPermissions: { changeRank: boolean; inviteMembers: boolean; removeMembers: boolean; }; groupManagementPermissions: { manageRelationships: boolean; manageClan: boolean; viewAuditLogs: boolean; }; groupEconomyPermissions: { spendGroupFunds: boolean; advertiseGroup: boolean; createItems: boolean; manageItems: boolean; addGroupPlaces: boolean; manageGroupGames: boolean; viewGroupPayouts: boolean; viewAnalytics: boolean; }; groupOpenCloudPermissions: { useCloudAuthentication: boolean; administerCloudAuthentication: boolean; }; }; areGroupGamesVisible: boolean; areGroupFundsVisible: boolean; areEnemiesAllowed: boolean; canConfigure: boolean; }; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: { groupId: GroupId; isPrimary: boolean; isPendingJoin: boolean; userRole: { user: { buildersClubMembershipType: number; hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; role: { id: number; name: string; description: string; rank: number; memberCount: number; }; }; permissions: { groupPostsPermissions: { viewWall: boolean; postToWall: boolean; deleteFromWall: boolean; viewStatus: boolean; postToStatus: boolean; }; groupMembershipPermissions: { changeRank: boolean; inviteMembers: boolean; removeMembers: boolean; }; groupManagementPermissions: { manageRelationships: boolean; manageClan: boolean; viewAuditLogs: boolean; }; groupEconomyPermissions: { spendGroupFunds: boolean; advertiseGroup: boolean; createItems: boolean; manageItems: boolean; addGroupPlaces: boolean; manageGroupGames: boolean; viewGroupPayouts: boolean; viewAnalytics: boolean; }; groupOpenCloudPermissions: { useCloudAuthentication: boolean; administerCloudAuthentication: boolean; }; }; areGroupGamesVisible: boolean; areGroupFundsVisible: boolean; areEnemiesAllowed: boolean; canConfigure: boolean; }; }; 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: { groupId: GroupId; isPrimary: boolean; isPendingJoin: boolean; userRole: { user: { buildersClubMembershipType: number; hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; role: { id: number; name: string; description: string; rank: number; memberCount: number; }; }; permissions: { groupPostsPermissions: { viewWall: boolean; postToWall: boolean; deleteFromWall: boolean; viewStatus: boolean; postToStatus: boolean; }; groupMembershipPermissions: { changeRank: boolean; inviteMembers: boolean; removeMembers: boolean; }; groupManagementPermissions: { manageRelationships: boolean; manageClan: boolean; viewAuditLogs: boolean; }; groupEconomyPermissions: { spendGroupFunds: boolean; advertiseGroup: boolean; createItems: boolean; manageItems: boolean; addGroupPlaces: boolean; manageGroupGames: boolean; viewGroupPayouts: boolean; viewAnalytics: boolean; }; groupOpenCloudPermissions: { useCloudAuthentication: boolean; administerCloudAuthentication: boolean; }; }; areGroupGamesVisible: boolean; areGroupFundsVisible: boolean; areEnemiesAllowed: boolean; canConfigure: boolean; }; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: { groupId: GroupId; isPrimary: boolean; isPendingJoin: boolean; userRole: { user: { buildersClubMembershipType: number; hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; role: { id: number; name: string; description: string; rank: number; memberCount: number; }; }; permissions: { groupPostsPermissions: { viewWall: boolean; postToWall: boolean; deleteFromWall: boolean; viewStatus: boolean; postToStatus: boolean; }; groupMembershipPermissions: { changeRank: boolean; inviteMembers: boolean; removeMembers: boolean; }; groupManagementPermissions: { manageRelationships: boolean; manageClan: boolean; viewAuditLogs: boolean; }; groupEconomyPermissions: { spendGroupFunds: boolean; advertiseGroup: boolean; createItems: boolean; manageItems: boolean; addGroupPlaces: boolean; manageGroupGames: boolean; viewGroupPayouts: boolean; viewAnalytics: boolean; }; groupOpenCloudPermissions: { useCloudAuthentication: boolean; administerCloudAuthentication: boolean; }; }; areGroupGamesVisible: boolean; areGroupFundsVisible: boolean; areEnemiesAllowed: boolean; canConfigure: boolean; }; }; 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 all roles in a group. * @category Membership * @endpoint GET /v1/groups/{groupId}/roles * * @param groupId The id of the group to get roles for. * * @example const { data:roles } = await ClassicGroupsApi.groupRoles({ groupId: 5850082 }) * @exampleData [ { id: 38353814, name: "Guest", description: "A non-group member.", rank: 0, memberCount: 0 }, { id: 38353811, name: "Owner", description: "", rank: 255, memberCount: 1 } ] * @exampleRawBody { groupId: 5850082, roles: [ { id: 38353814, name: "Guest", description: "A non-group member.", rank: 0, memberCount: 0 }, { id: 38353811, name: "Owner", description: "", rank: 255, memberCount: 1 } ] } */ export declare const groupRoles: (this: any, args: { groupId: GroupId; }) => Promise<{ data: { id: number; name: string; description: string; rank: number; memberCount: number; }[]; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: { groupId: GroupId; roles: { id: number; name: string; description: string; rank: number; memberCount: 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: { id: number; name: string; description: string; rank: number; memberCount: number; }[]; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: { groupId: GroupId; roles: { id: number; name: string; description: string; rank: number; memberCount: 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; }; }>; }>; /** * Gets group members that have a specified role. * @category Membership * @endpoint GET /v1/groups/{groupId}/roles/{roleSetId}/users * * @param groupId The id of the group. * @param roleSetId The id of the role. * @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:membersWithRole } = await ClassicGroupsApi.groupMembersWithRole({ groupId: 5850082, roleSetId: 38353811 }) * @exampleData [ { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" } ] * @exampleRawBody { previousPageCursor: null, nextPageCursor: null, data: [ { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" } ] } */ export declare const groupMembersWithRole: import("../../apiGroup/apiGroup.types").CallApiMethod<{ groupId: Identifier; roleSetId: Identifier; limit?: 10 | 25 | 50 | 100 | undefined; sortOrder?: SortOrder | undefined; cursor?: string | undefined; }, { method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: { previousPageCursor?: string | undefined; nextPageCursor?: string | undefined; data: PrettifiedGroupMembersWithRoleData; }) => string) | undefined; getCursorsFn?: ((rawData: { previousPageCursor?: string | undefined; nextPageCursor?: string | undefined; data: PrettifiedGroupMembersWithRoleData; }) => [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: PrettifiedGroupMembersWithRoleData; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: { hasVerifiedBadge: boolean; userId: Identifier; username: string; displayName: string; }[] | undefined; } & import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<{ previousPageCursor?: string | undefined; nextPageCursor?: string | undefined; data: PrettifiedGroupMembersWithRoleData; }, PrettifiedGroupMembersWithRoleData>, true>; /** * Gets a page of members of a group. * @category Membership * @endpoint GET /v1/groups/{groupId}/users * * @param groupId The id of the group. * @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:members } = await ClassicGroupsApi.groupMembers({ groupId: 5850082 }) * @exampleData [ { user: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, role: { id: 38353811, name: "NamelessGuy2005 - Scriptor", rank: 255 } } ] * @exampleRawBody { previousPageCursor: null, nextPageCursor: "3023291639_1_8ba111cfa4097b6dd27d851a15353a1f", data: [ { user: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, role: { id: 38353811, name: "NamelessGuy2005 - Scriptor", rank: 255 } } ] } */ export declare const groupMembers: import("../../apiGroup/apiGroup.types").CallApiMethod<{ groupId: Identifier; limit?: 10 | 25 | 50 | 100 | undefined; sortOrder?: SortOrder | undefined; cursor?: string | undefined; }, { method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: { previousPageCursor?: string | undefined; nextPageCursor?: string | undefined; data: PrettifiedGroupMembersData; }) => string) | undefined; getCursorsFn?: ((rawData: { previousPageCursor?: string | undefined; nextPageCursor?: string | undefined; data: PrettifiedGroupMembersData; }) => [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: PrettifiedGroupMembersData; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: { user: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; role: { id: number; name: string; rank: number; }; }[] | undefined; } & import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<{ previousPageCursor?: string | undefined; nextPageCursor?: string | undefined; data: PrettifiedGroupMembersData; }, PrettifiedGroupMembersData>, true>; /** * Gets groups that the authenticated user has requested to join. * @category Membership * @endpoint GET /v1/user/groups/pending * @tags [ "Cookie" ] * * @example const { data:pendingGroups } = await ClassicGroupsApi.authenticatedUserPendingGroups() * @exampleData [ { id: 5850082, name: "lorem ipsum", description: "", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, isBuildersClubOnly: false, publicEntryAllowed: false, hasVerifiedBadge: false } ] * @exampleRawBody { data: [ { id: 5850082, name: "lorem ipsum", description: "", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, isBuildersClubOnly: false, publicEntryAllowed: false, hasVerifiedBadge: false } ] } */ export declare const authenticatedUserPendingGroups: import("../../apiGroup/apiGroup.types").CallApiMethod, { method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: RawAuthenticatedUserPendingGroupsData) => string) | undefined; getCursorsFn?: ((rawData: { id: number; name: string; description: string; owner: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; shout: { body: string; poster: { 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}`; } | null; isBuildersClubOnly: boolean; publicEntryAllowed: boolean; hasVerifiedBadge: boolean; }[]) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: { id: number; name: string; description: string; owner: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; shout: { body: string; poster: { 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}`; } | null; isBuildersClubOnly: boolean; publicEntryAllowed: boolean; hasVerifiedBadge: boolean; }[] | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: { id: number; name: string; description: string; owner: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; shout: { body: string; poster: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; created: Date; updated: Date; } | null; isBuildersClubOnly: boolean; publicEntryAllowed: boolean; hasVerifiedBadge: boolean; }[] | undefined; } & import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData, false>; /** * Gets a list of all groups the specified users' friends are in. * @category Membership * @endpoint GET /v1/users/{userId}/friends/groups/roles * @tags [ "Cookie" ] * * @param userId The id of the user to get friends groups for. * * @example const { data:groupsThatUsersFriendsAreIn } = await ClassicGroupsApi.groupsThatUsersFriendsAreIn({ userId: 45348281 }) * @exampleData [ { user: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, groups: [ { group: { id: 5850082, name: "Lorem ipsum", description: "Lorem ipsum dolor sit amet.", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false }, role: { id: 45348281, name: "MightyPart", rank: 1 } } ] } ] * @exampleRawBody { data: [ { user: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, groups: [ { group: { id: 5850082, name: "Lorem ipsum", description: "Lorem ipsum dolor sit amet.", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false }, role: { id: 45348281, name: "MightyPart", rank: 1 } } ] } ] } */ export declare const groupsThatUsersFriendsAreIn: import("../../apiGroup/apiGroup.types").CallApiMethod<{ userId: Identifier; }, { method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: { data: { user: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; groups: [{ group: { id: number; name: string; description: string; owner: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; shout: { body: string; poster: { 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}`; } | null; isBuildersClubOnly: boolean; publicEntryAllowed: boolean; hasVerifiedBadge: boolean; }; role: { id: number; name: string; rank: number; }; }]; }[]; }) => string) | undefined; getCursorsFn?: ((rawData: { data: { user: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; groups: [{ group: { id: number; name: string; description: string; owner: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; shout: { body: string; poster: { 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}`; } | null; isBuildersClubOnly: boolean; publicEntryAllowed: boolean; hasVerifiedBadge: boolean; }; role: { id: number; name: string; rank: number; }; }]; }[]; }) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: { data: { user: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; groups: [{ group: { id: number; name: string; description: string; owner: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; shout: { body: string; poster: { 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}`; } | null; isBuildersClubOnly: boolean; publicEntryAllowed: boolean; hasVerifiedBadge: boolean; }; role: { id: number; name: string; rank: number; }; }]; }[]; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: { user: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; groups: [{ group: { id: number; name: string; description: string; owner: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; shout: { body: string; poster: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; created: Date; updated: Date; } | null; isBuildersClubOnly: boolean; publicEntryAllowed: boolean; hasVerifiedBadge: boolean; }; role: { id: number; name: string; rank: number; }; }]; }[] | undefined; } & import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<{ data: { user: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; groups: [{ group: { id: number; name: string; description: string; owner: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; shout: { body: string; poster: { 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}`; } | null; isBuildersClubOnly: boolean; publicEntryAllowed: boolean; hasVerifiedBadge: boolean; }; role: { id: number; name: string; rank: number; }; }]; }[]; }, { user: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; groups: [{ group: { id: number; name: string; description: string; owner: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; shout: { body: string; poster: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; created: Date; updated: Date; } | null; isBuildersClubOnly: boolean; publicEntryAllowed: boolean; hasVerifiedBadge: boolean; }; role: { id: number; name: string; rank: number; }; }]; }[]>, false>; /** * Gets a list of all roles for every group that the specified user is in. * @category Membership * @endpoint GET /v1/users/{userId}/groups/roles * @tags [ "Cookie" ] * * @param userId The id of the user to get roles for. * * @example const { data:allRoles } = await ClassicGroupsApi.allGroupRolesForUser_V1({ userId: 45348281 }) * @exampleData [ { group: { id: 5855434, name: "MightyPart Games", description: "Lorem ipsum dolor sit amet...", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: 'MightyPart' }, shout: null, memberCount: 102, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false }, role: { id: 5855434, name: "MightyPart", rank: 1 } } ] * @exampleRawBody { data: [ { group: { id: 5855434, name: "MightyPart Games", description: "Lorem ipsum dolor sit amet...", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: 'MightyPart' }, shout: null, memberCount: 102, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false }, role: { id: 5855434, name: "MightyPart", rank: 1 } } ] } */ export declare const allGroupRolesForUser_V1: import("../../apiGroup/apiGroup.types").CallApiMethod<{ userId: Identifier; }, { method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: { data: { group: { id: number; name: string; description: string; owner: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; shout: { body: string; poster: { 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}`; } | null; memberCount: number; isBuildersClubOnly: boolean; publicEntryAllowed: boolean; hasVerifiedBadge: boolean; }; role: { id: number; name: string; description: string; rank: number; memberCount: number; }; isPrimaryGroup: boolean; }[]; }) => string) | undefined; getCursorsFn?: ((rawData: { data: { group: { id: number; name: string; description: string; owner: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; shout: { body: string; poster: { 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}`; } | null; memberCount: number; isBuildersClubOnly: boolean; publicEntryAllowed: boolean; hasVerifiedBadge: boolean; }; role: { id: number; name: string; description: string; rank: number; memberCount: number; }; isPrimaryGroup: boolean; }[]; }) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: { data: { group: { id: number; name: string; description: string; owner: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; shout: { body: string; poster: { 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}`; } | null; memberCount: number; isBuildersClubOnly: boolean; publicEntryAllowed: boolean; hasVerifiedBadge: boolean; }; role: { id: number; name: string; description: string; rank: number; memberCount: number; }; isPrimaryGroup: boolean; }[]; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: { group: { id: number; name: string; description: string; owner: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; shout: { body: string; poster: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; created: Date; updated: Date; } | null; memberCount: number; isBuildersClubOnly: boolean; publicEntryAllowed: boolean; hasVerifiedBadge: boolean; }; role: { id: number; name: string; description: string; rank: number; memberCount: number; }; isPrimaryGroup: boolean; }[] | undefined; } & import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<{ data: { group: { id: number; name: string; description: string; owner: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; shout: { body: string; poster: { 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}`; } | null; memberCount: number; isBuildersClubOnly: boolean; publicEntryAllowed: boolean; hasVerifiedBadge: boolean; }; role: { id: number; name: string; description: string; rank: number; memberCount: number; }; isPrimaryGroup: boolean; }[]; }, FormattedAllGroupRolesForUserData_V1>, false>; /** * Removes a user from a group. * @category Membership * @endpoint DELETE /v1/groups/{groupId}/users/{userId} * @tags [ "Cookie" ] * * @param groupId The id of the group to remove the user from. * @param userId The id of the user to be removed. * * @example const { data:success } = await ClassicGroupsApi.removeGroupMember({ groupId: 5850082, userId: 2655994471 }) * @exampleData true * @exampleRawBody {} */ export declare const removeGroupMember: import("../../apiGroup/apiGroup.types").CallApiMethod<{ groupId: Identifier; userId: Identifier; }, { method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: {}) => string) | undefined; getCursorsFn?: ((rawData: {}) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: {} | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: boolean | undefined; } & import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<{}, boolean>, false>; /** * Changes a members' role in a group. * @category Membership * @endpoint PATCH /v1/groups/{groupId}/users/{userId} * @tags [ "Cookie" ] * * @param groupId The id of the group * @param userId The id of the user to change role for. * @param roleId The id of the role. * * @example const { data:success } = await ClassicGroupsApi.updateGroupMemberRole({ groupId: 5850082, userId: 2655994471, roleId: 38354760 }) * @exampleData true * @exampleRawBody {} */ export declare const updateGroupMemberRole: import("../../apiGroup/apiGroup.types").CallApiMethod<{ groupId: Identifier; userId: Identifier; roleId: Identifier; }, { method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: {}) => string) | undefined; getCursorsFn?: ((rawData: {}) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: {} | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: boolean | undefined; } & import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<{}, boolean>, false>; /** * Gets values indicating if the specified group can use payout features. * @category Revenue * @endpoint GET /v1/groups/{groupId}/payout-restriction * @tags [ "Cookie" ] * * @param groupId The id of the group. * * @example const { data:payoutRestrictions } = await ClassicGroupsApi.groupPayoutRestrictionsInfo({ groupId: 5850082 }) * @exampleData { canUseRecurringPayout: true, canUseOneTimePayout: true } * @exampleRawBody { canUseRecurringPayout: true, canUseOneTimePayout: true } */ export declare const groupPayoutRestrictionsInfo: import("../../apiGroup/apiGroup.types").CallApiMethod<{ groupId: Identifier; }, { method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: { canUseRecurringPayout: boolean; canUseOneTimePayout: boolean; }) => string) | undefined; getCursorsFn?: ((rawData: { canUseRecurringPayout: boolean; canUseOneTimePayout: boolean; }) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: { canUseRecurringPayout: boolean; canUseOneTimePayout: boolean; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: { canUseRecurringPayout: boolean; canUseOneTimePayout: boolean; } | undefined; }, false>; /** * Gets a list of the group payout percentages. * @category Revenue * @endpoint GET /v1/groups/{groupId}/payouts * @tags [ "Cookie" ] * * @param groupId The id of the group. * * @example const { data:payouts } = await ClassicGroupsApi.groupPayoutsInfo({ groupId: 5850082 }) * @exampleData [ { user: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, percentage: 50 } ] * @exampleRawBody { data: [ { user: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, percentage: 50 } ] } */ export declare const groupPayoutsInfo: import("../../apiGroup/apiGroup.types").CallApiMethod<{ groupId: Identifier; }, { method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: { data: PrettifiedGroupPayoutsInfoData; }) => string) | undefined; getCursorsFn?: ((rawData: { data: PrettifiedGroupPayoutsInfoData; }) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: { data: PrettifiedGroupPayoutsInfoData; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: { user: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; percentage: number; }[] | undefined; } & import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<{ data: PrettifiedGroupPayoutsInfoData; }, PrettifiedGroupPayoutsInfoData>, false>; /** * Gets a group's relationships. * @category Relationships * @endpoint GET /v1/groups/{groupId}/relationships/{groupRelationshipType} * @tags [ "Cookie" ] * * @param groupId The id of the group. * @param groupRelationshipType The group relationship type, "Enemies" or "Allies". * @param maxRows The maximum number of rows for the page request, should be at least 1. * @param startRowIndex The start index of the page request. * * @example const { data:relationships } = await ClassicGroupsApi.groupRelationships({ groupId: 5850082, groupRelationshipType: "Allies", maxRows: 1 }) * @exampleData { groupId: 5850082, relationshipType: "Allies", totalGroupCount: 2, relatedGroups: [ { id: 50, name: "Lorem Ipsum", description: "Hello World", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, memberCount: 38, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false } ] } * @exampleRawBody { groupId: 5850082, relationshipType: "Allies", totalGroupCount: 2, relatedGroups: [ { id: 50, name: "Lorem Ipsum", description: "Hello World", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, memberCount: 38, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false } ], nextRowIndex: 1 } */ export declare const groupRelationships: (this: any, args: { groupId: Identifier; groupRelationshipType: GroupRelationshipType; maxRows?: number | undefined; startRowIndex?: number | undefined; }) => Promise<{ data: { groupId: GroupId; relationshipType: GroupRelationshipType; totalGroupCount: number; relatedGroups: { id: number; name: string; description: string; owner: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; shout: { body: string; poster: { buildersClubMembershipType: number; hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; created: Date; updated: Date; } | null; memberCount: number; isBuildersClubOnly: number; publicEntryAllowed: boolean; hasVerifiedBadge: boolean; }[]; nextRowIndex: number; }; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: { groupId: GroupId; relationshipType: GroupRelationshipType; totalGroupCount: number; relatedGroups: { id: number; name: string; description: string; owner: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; shout: { body: string; 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}`; } | null; memberCount: number; isBuildersClubOnly: number; publicEntryAllowed: boolean; hasVerifiedBadge: boolean; }[]; nextRowIndex: 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; }; cursors: { /** * Gets information about a group. * @category Groups * @endpoint GET /v1/groups/{groupId} * @tags [ "?Cookie" ] * * @param groupId The id of the group. * * @example const { data:groupInfo } = await ClassicGroupsApi.groupInfo({ groupId: 5850082}) * @exampleData { id: 5850082, name: "MightyPart Games", description: "Lorem ipsum dolor sit amet consectetur adipiscing elit.", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, memberCount: 102, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false } * @exampleRawBody { id: 5850082, name: "MightyPart Games", description: "Lorem ipsum dolor sit amet consectetur adipiscing elit.", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, memberCount: 102, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false } */ previous: import("../../apiGroup/apiGroup.types").Cursor; /** * Gets information about a group. * @category Groups * @endpoint GET /v1/groups/{groupId} * @tags [ "?Cookie" ] * * @param groupId The id of the group. * * @example const { data:groupInfo } = await ClassicGroupsApi.groupInfo({ groupId: 5850082}) * @exampleData { id: 5850082, name: "MightyPart Games", description: "Lorem ipsum dolor sit amet consectetur adipiscing elit.", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, memberCount: 102, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false } * @exampleRawBody { id: 5850082, name: "MightyPart Games", description: "Lorem ipsum dolor sit amet consectetur adipiscing elit.", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, memberCount: 102, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false } */ next: import("../../apiGroup/apiGroup.types").Cursor; }; [Symbol.asyncIterator]: () => AsyncGenerator<{ data: { groupId: GroupId; relationshipType: GroupRelationshipType; totalGroupCount: number; relatedGroups: { id: number; name: string; description: string; owner: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; shout: { body: string; poster: { buildersClubMembershipType: number; hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; created: Date; updated: Date; } | null; memberCount: number; isBuildersClubOnly: number; publicEntryAllowed: boolean; hasVerifiedBadge: boolean; }[]; nextRowIndex: number; }; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: { groupId: GroupId; relationshipType: GroupRelationshipType; totalGroupCount: number; relatedGroups: { id: number; name: string; description: string; owner: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; shout: { body: string; 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}`; } | null; memberCount: number; isBuildersClubOnly: number; publicEntryAllowed: boolean; hasVerifiedBadge: boolean; }[]; nextRowIndex: 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; }; cursors: { /** * Gets information about a group. * @category Groups * @endpoint GET /v1/groups/{groupId} * @tags [ "?Cookie" ] * * @param groupId The id of the group. * * @example const { data:groupInfo } = await ClassicGroupsApi.groupInfo({ groupId: 5850082}) * @exampleData { id: 5850082, name: "MightyPart Games", description: "Lorem ipsum dolor sit amet consectetur adipiscing elit.", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, memberCount: 102, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false } * @exampleRawBody { id: 5850082, name: "MightyPart Games", description: "Lorem ipsum dolor sit amet consectetur adipiscing elit.", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, memberCount: 102, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false } */ previous: import("../../apiGroup/apiGroup.types").Cursor; /** * Gets information about a group. * @category Groups * @endpoint GET /v1/groups/{groupId} * @tags [ "?Cookie" ] * * @param groupId The id of the group. * * @example const { data:groupInfo } = await ClassicGroupsApi.groupInfo({ groupId: 5850082}) * @exampleData { id: 5850082, name: "MightyPart Games", description: "Lorem ipsum dolor sit amet consectetur adipiscing elit.", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, memberCount: 102, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false } * @exampleRawBody { id: 5850082, name: "MightyPart Games", description: "Lorem ipsum dolor sit amet consectetur adipiscing elit.", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, memberCount: 102, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false } */ next: import("../../apiGroup/apiGroup.types").Cursor; }; [Symbol.asyncIterator]: null; } & { again: () => Promise<{ data: { groupId: GroupId; relationshipType: GroupRelationshipType; totalGroupCount: number; relatedGroups: { id: number; name: string; description: string; owner: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; shout: { body: string; poster: { buildersClubMembershipType: number; hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; created: Date; updated: Date; } | null; memberCount: number; isBuildersClubOnly: number; publicEntryAllowed: boolean; hasVerifiedBadge: boolean; }[]; nextRowIndex: number; }; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: { groupId: GroupId; relationshipType: GroupRelationshipType; totalGroupCount: number; relatedGroups: { id: number; name: string; description: string; owner: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; shout: { body: string; 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}`; } | null; memberCount: number; isBuildersClubOnly: number; publicEntryAllowed: boolean; hasVerifiedBadge: boolean; }[]; nextRowIndex: 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; }; }>; }, any, unknown>; } & { again: () => Promise<{ data: { groupId: GroupId; relationshipType: GroupRelationshipType; totalGroupCount: number; relatedGroups: { id: number; name: string; description: string; owner: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; shout: { body: string; poster: { buildersClubMembershipType: number; hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; created: Date; updated: Date; } | null; memberCount: number; isBuildersClubOnly: number; publicEntryAllowed: boolean; hasVerifiedBadge: boolean; }[]; nextRowIndex: number; }; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: { groupId: GroupId; relationshipType: GroupRelationshipType; totalGroupCount: number; relatedGroups: { id: number; name: string; description: string; owner: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; shout: { body: string; 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}`; } | null; memberCount: number; isBuildersClubOnly: number; publicEntryAllowed: boolean; hasVerifiedBadge: boolean; }[]; nextRowIndex: 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; }; }>; }>; /** * Batch declines relationship requests. * @category Relationships * @endpoint DELETE /v1/groups/{groupId}/relationships/{groupRelationshipType}/requests * @tags [ "Cookie" ] * * @param groupId The id of the group to batch decline relationship requests for. * @param groupRelationshipType The type of group relationship to batch decline for. * @param groupIds The ids of the groups to decline. * * @example * const { data:success } = await ClassicGroupsApi.batchDeclineGroupRelationshipRequests({ groupId: 5850082, groupRelationshipType: "Allies", groupIds: [15842838] }) * @exampleData true * @exampleRawBody {} */ export declare const batchDeclineGroupRelationshipRequests: import("../../apiGroup/apiGroup.types").CallApiMethod<{ groupId: Identifier; groupRelationshipType: GroupRelationshipType; groupIds: Identifier[]; }, { method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: {}) => string) | undefined; getCursorsFn?: ((rawData: {}) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: {} | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: boolean | undefined; } & import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<{}, boolean>, false>; /** * Gets relationship requests. * @category Relationships * @endpoint GET /v1/groups/{groupId}/relationships/{groupRelationshipType}/requests * @tags [ "Cookie" ] * * @param groupId The id of the group. * @param groupRelationshipType The group relationship type, "Enemies" or "Allies". * @param maxRows The maximum number of rows for the page request, should be at least 1. * @param startRowIndex The start index of the page request. * * @example * const { data:relationshipRequests, cursors } = await ClassicGroupsApi.groupRelationshipRequests({ groupId: 5850082, groupRelationshipType: "Allies", maxRows: 1 }) * @exampleData { groupId: 5850082, relationshipType: "Allies", totalGroupCount: 2, relatedGroups: [ { id: 50, name: "Lorem Ipsum", description: "Hello World", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, memberCount: 38, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false } ] } * @exampleRawBody { groupId: 5850082, relationshipType: "Allies", totalGroupCount: 2, relatedGroups: [ { id: 50, name: "Lorem Ipsum", description: "Hello World", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, memberCount: 38, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false } ], nextRowIndex: 1 } */ export declare const groupRelationshipRequests: (this: any, args: { groupId: Identifier; groupRelationshipType: GroupRelationshipType; maxRows?: number | undefined; startRowIndex?: number | undefined; }) => Promise<{ data: { groupId: GroupId; relationshipType: GroupRelationshipType; totalGroupCount: number; relatedGroups: { id: number; name: string; description: string; owner: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; shout: { body: string; poster: { buildersClubMembershipType: number; hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; created: Date; updated: Date; } | null; memberCount: number; isBuildersClubOnly: number; publicEntryAllowed: boolean; hasVerifiedBadge: boolean; }[]; nextRowIndex: number; }; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: { groupId: GroupId; relationshipType: GroupRelationshipType; totalGroupCount: number; relatedGroups: { id: number; name: string; description: string; owner: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; shout: { body: string; 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}`; } | null; memberCount: number; isBuildersClubOnly: number; publicEntryAllowed: boolean; hasVerifiedBadge: boolean; }[]; nextRowIndex: 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; }; cursors: { /** * Gets information about a group. * @category Groups * @endpoint GET /v1/groups/{groupId} * @tags [ "?Cookie" ] * * @param groupId The id of the group. * * @example const { data:groupInfo } = await ClassicGroupsApi.groupInfo({ groupId: 5850082}) * @exampleData { id: 5850082, name: "MightyPart Games", description: "Lorem ipsum dolor sit amet consectetur adipiscing elit.", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, memberCount: 102, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false } * @exampleRawBody { id: 5850082, name: "MightyPart Games", description: "Lorem ipsum dolor sit amet consectetur adipiscing elit.", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, memberCount: 102, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false } */ previous: import("../../apiGroup/apiGroup.types").Cursor; /** * Gets information about a group. * @category Groups * @endpoint GET /v1/groups/{groupId} * @tags [ "?Cookie" ] * * @param groupId The id of the group. * * @example const { data:groupInfo } = await ClassicGroupsApi.groupInfo({ groupId: 5850082}) * @exampleData { id: 5850082, name: "MightyPart Games", description: "Lorem ipsum dolor sit amet consectetur adipiscing elit.", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, memberCount: 102, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false } * @exampleRawBody { id: 5850082, name: "MightyPart Games", description: "Lorem ipsum dolor sit amet consectetur adipiscing elit.", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, memberCount: 102, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false } */ next: import("../../apiGroup/apiGroup.types").Cursor; }; [Symbol.asyncIterator]: () => AsyncGenerator<{ data: { groupId: GroupId; relationshipType: GroupRelationshipType; totalGroupCount: number; relatedGroups: { id: number; name: string; description: string; owner: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; shout: { body: string; poster: { buildersClubMembershipType: number; hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; created: Date; updated: Date; } | null; memberCount: number; isBuildersClubOnly: number; publicEntryAllowed: boolean; hasVerifiedBadge: boolean; }[]; nextRowIndex: number; }; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: { groupId: GroupId; relationshipType: GroupRelationshipType; totalGroupCount: number; relatedGroups: { id: number; name: string; description: string; owner: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; shout: { body: string; 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}`; } | null; memberCount: number; isBuildersClubOnly: number; publicEntryAllowed: boolean; hasVerifiedBadge: boolean; }[]; nextRowIndex: 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; }; cursors: { /** * Gets information about a group. * @category Groups * @endpoint GET /v1/groups/{groupId} * @tags [ "?Cookie" ] * * @param groupId The id of the group. * * @example const { data:groupInfo } = await ClassicGroupsApi.groupInfo({ groupId: 5850082}) * @exampleData { id: 5850082, name: "MightyPart Games", description: "Lorem ipsum dolor sit amet consectetur adipiscing elit.", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, memberCount: 102, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false } * @exampleRawBody { id: 5850082, name: "MightyPart Games", description: "Lorem ipsum dolor sit amet consectetur adipiscing elit.", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, memberCount: 102, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false } */ previous: import("../../apiGroup/apiGroup.types").Cursor; /** * Gets information about a group. * @category Groups * @endpoint GET /v1/groups/{groupId} * @tags [ "?Cookie" ] * * @param groupId The id of the group. * * @example const { data:groupInfo } = await ClassicGroupsApi.groupInfo({ groupId: 5850082}) * @exampleData { id: 5850082, name: "MightyPart Games", description: "Lorem ipsum dolor sit amet consectetur adipiscing elit.", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, memberCount: 102, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false } * @exampleRawBody { id: 5850082, name: "MightyPart Games", description: "Lorem ipsum dolor sit amet consectetur adipiscing elit.", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, memberCount: 102, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false } */ next: import("../../apiGroup/apiGroup.types").Cursor; }; [Symbol.asyncIterator]: null; } & { again: () => Promise<{ data: { groupId: GroupId; relationshipType: GroupRelationshipType; totalGroupCount: number; relatedGroups: { id: number; name: string; description: string; owner: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; shout: { body: string; poster: { buildersClubMembershipType: number; hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; created: Date; updated: Date; } | null; memberCount: number; isBuildersClubOnly: number; publicEntryAllowed: boolean; hasVerifiedBadge: boolean; }[]; nextRowIndex: number; }; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: { groupId: GroupId; relationshipType: GroupRelationshipType; totalGroupCount: number; relatedGroups: { id: number; name: string; description: string; owner: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; shout: { body: string; 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}`; } | null; memberCount: number; isBuildersClubOnly: number; publicEntryAllowed: boolean; hasVerifiedBadge: boolean; }[]; nextRowIndex: 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; }; }>; }, any, unknown>; } & { again: () => Promise<{ data: { groupId: GroupId; relationshipType: GroupRelationshipType; totalGroupCount: number; relatedGroups: { id: number; name: string; description: string; owner: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; shout: { body: string; poster: { buildersClubMembershipType: number; hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; created: Date; updated: Date; } | null; memberCount: number; isBuildersClubOnly: number; publicEntryAllowed: boolean; hasVerifiedBadge: boolean; }[]; nextRowIndex: number; }; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: { groupId: GroupId; relationshipType: GroupRelationshipType; totalGroupCount: number; relatedGroups: { id: number; name: string; description: string; owner: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; shout: { body: string; 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}`; } | null; memberCount: number; isBuildersClubOnly: number; publicEntryAllowed: boolean; hasVerifiedBadge: boolean; }[]; nextRowIndex: 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; }; }>; }>; /** * Batch accepts relationship requests. * @category Relationships * @endpoint POST /v1/groups/{groupId}/relationships/{groupRelationshipType}/requests * @tags [ "Cookie" ] * * @param groupId The id of the group to batch accept relationship requests for. * @param groupRelationshipType The type of group relationship to batch accept for. * @param groupIds The ids of the groups to accept. * * @example * const { data:success } = await ClassicGroupsApi.batchAcceptGroupRelationshipRequests({ groupId: 5850082, groupRelationshipType: "Allies", groupIds: [15842838] }) * @exampleData true * @exampleRawBody {} */ export declare const batchAcceptGroupRelationshipRequests: import("../../apiGroup/apiGroup.types").CallApiMethod<{ groupId: Identifier; groupRelationshipType: GroupRelationshipType; groupIds: Identifier[]; }, { method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: {}) => string) | undefined; getCursorsFn?: ((rawData: {}) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: {} | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: boolean | undefined; } & import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<{}, boolean>, false>; /** * Removes an already existing group relationship * @category Relationships * @endpoint POST /v1/groups/{groupId}/relationships/{groupRelationshipType}/{relatedGroupId} * @tags [ "Cookie" ] * * @param groupId The id of the group to remove the relationship from. * @param groupRelationshipType The type of group relationship to remove. * @param relatedGroupId The id of the group to remove. * * @example const { data:success } = await ClassicGroupsApi.removeGroupRelationship({ groupId: 5850082, groupRelationshipType: "Allies", relatedGroupId: 3843784}) * @exampleData true * @exampleRawBody {} */ export declare const removeGroupRelationship: import("../../apiGroup/apiGroup.types").CallApiMethod<{ groupId: Identifier; groupRelationshipType: GroupRelationshipType; relatedGroupId: Identifier; }, { method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: {}) => string) | undefined; getCursorsFn?: ((rawData: {}) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: {} | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: boolean | undefined; } & import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<{}, boolean>, false>; /** * Sends a group relationship request to a group. * @category Relationships * @endpoint POST /v1/groups/{groupId}/relationships/{groupRelationshipType}/{relatedGroupId} * @tags [ "Cookie" ] * * @param groupId The id of the group to send a request for. * @param groupRelationshipType The type of group relationship to request. * @param relatedGroupId The id of the group to request a relationship with. * * @example const { data:success } = await ClassicGroupsApi.requestGroupRelationship({ groupId: 5850082, groupRelationshipType: "Allies", relatedGroupId: 3843784}) * @exampleData true * @exampleRawBody {} */ export declare const requestGroupRelationship: import("../../apiGroup/apiGroup.types").CallApiMethod<{ groupId: Identifier; groupRelationshipType: GroupRelationshipType; relatedGroupId: Identifier; }, { method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: {}) => string) | undefined; getCursorsFn?: ((rawData: {}) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: {} | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: boolean | undefined; } & import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<{}, boolean>, false>; /** * Declines a group relationship request. * @category Relationships * @endpoint DELETE /v1/groups/{groupId}/relationships/{groupRelationshipType}/requests/{relatedGroupId} * @tags [ "Cookie" ] * * @param groupId The id of the group to decline for. * @param groupRelationshipType The type of group relationship to decline. * @param relatedGroupId The id of the group to decline a relationship with. * * @example const { data:success } = await ClassicGroupsApi.declineGroupRelationshipRequest({ groupId: 5850082, groupRelationshipType: "Allies", relatedGroupId: 3843784}) * @exampleData true * @exampleRawBody {} */ export declare const declineGroupRelationshipRequest: import("../../apiGroup/apiGroup.types").CallApiMethod<{ groupId: Identifier; groupRelationshipType: GroupRelationshipType; relatedGroupId: Identifier; }, { method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: {}) => string) | undefined; getCursorsFn?: ((rawData: {}) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: {} | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: boolean | undefined; } & import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<{}, boolean>, false>; /** * Accepts a group relationship request. * @category Relationships * @endpoint POST /v1/groups/{groupId}/relationships/{groupRelationshipType}/requests/{relatedGroupId} * @tags [ "Cookie" ] * * @param groupId The id of the group to accept for. * @param groupRelationshipType The type of group relationship to accept. * @param relatedGroupId The id of the group to accept a relationship with. * * @example const { data:success } = await ClassicGroupsApi.acceptGroupRelationshipRequest({ groupId: 5850082, groupRelationshipType: "Allies", relatedGroupId: 3843784}) * @exampleData true * @exampleRawBody {} */ export declare const acceptGroupRelationshipRequest: import("../../apiGroup/apiGroup.types").CallApiMethod<{ groupId: Identifier; groupRelationshipType: GroupRelationshipType; relatedGroupId: Identifier; }, { method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: {}) => string) | undefined; getCursorsFn?: ((rawData: {}) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: {} | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: boolean | undefined; } & import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<{}, boolean>, false>; /** * Gets permissions for a role in a group. * @category Permissions * @endpoint GET /v1/groups/{groupId}/roles/{roleSetId}/permissions * @tags [ "Cookie" ] * * @param groupId The id of the group. * @param roleSetId The id of the role to get permissions for. * * @example const { data:rolePerms } = await ClassicGroupsApi.groupPermissionsForRole({ groupId: 5850082, roleSetId: 38353814 }) * @exampleData { groupId: 5850082, role: { id: 38353814, name: "Guest", description: "A non-group member.", rank: 0 }, permissions: { groupPostsPermissions: { viewWall: true, postToWall: false, deleteFromWall: false, viewStatus: false, postToStatus: false }, groupMembershipPermissions: { changeRank: false, inviteMembers: false, removeMembers: false }, groupManagementPermissions: { manageRelationships: false, manageClan: false, viewAuditLogs: false }, groupEconomyPermissions: { spendGroupFunds: false, advertiseGroup: false, createItems: false, manageItems: false, addGroupPlaces: false, manageGroupGames: false, viewGroupPayouts: false, viewAnalytics: false }, groupOpenCloudPermissions: { useCloudAuthentication: false, administerCloudAuthentication: false } } } * @exampleRawBody { groupId: 5850082, role: { id: 38353814, name: "Guest", description: "A non-group member.", rank: 0 }, permissions: { groupPostsPermissions: { viewWall: true, postToWall: false, deleteFromWall: false, viewStatus: false, postToStatus: false }, groupMembershipPermissions: { changeRank: false, inviteMembers: false, removeMembers: false }, groupManagementPermissions: { manageRelationships: false, manageClan: false, viewAuditLogs: false }, groupEconomyPermissions: { spendGroupFunds: false, advertiseGroup: false, createItems: false, manageItems: false, addGroupPlaces: false, manageGroupGames: false, viewGroupPayouts: false, viewAnalytics: false }, groupOpenCloudPermissions: { useCloudAuthentication: false, administerCloudAuthentication: false } } } */ export declare const groupPermissionsForRole: (this: any, args: { groupId: GroupId; roleSetId: RoleSetId; }) => Promise<{ data: { groupId: GroupId; role: { id: RoleSetId; name: string; description: string; rank: number; }; permissions: { groupPostsPermissions: { viewWall: boolean; postToWall: boolean; deleteFromWall: boolean; viewStatus: boolean; postToStatus: boolean; }; groupMembershipPermissions: { changeRank: boolean; inviteMembers: boolean; removeMembers: boolean; }; groupManagementPermissions: { manageRelationships: boolean; manageClan: boolean; viewAuditLogs: boolean; }; groupEconomyPermissions: { spendGroupFunds: boolean; advertiseGroup: boolean; createItems: boolean; manageItems: boolean; addGroupPlaces: boolean; manageGroupGames: boolean; viewGroupPayouts: boolean; viewAnalytics: boolean; }; groupOpenCloudPermissions: { useCloudAuthentication: boolean; administerCloudAuthentication: boolean; }; }; }; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: { groupId: GroupId; role: { id: RoleSetId; name: string; description: string; rank: number; }; permissions: { groupPostsPermissions: { viewWall: boolean; postToWall: boolean; deleteFromWall: boolean; viewStatus: boolean; postToStatus: boolean; }; groupMembershipPermissions: { changeRank: boolean; inviteMembers: boolean; removeMembers: boolean; }; groupManagementPermissions: { manageRelationships: boolean; manageClan: boolean; viewAuditLogs: boolean; }; groupEconomyPermissions: { spendGroupFunds: boolean; advertiseGroup: boolean; createItems: boolean; manageItems: boolean; addGroupPlaces: boolean; manageGroupGames: boolean; viewGroupPayouts: boolean; viewAnalytics: boolean; }; groupOpenCloudPermissions: { useCloudAuthentication: boolean; administerCloudAuthentication: boolean; }; }; }; }; 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: { groupId: GroupId; role: { id: RoleSetId; name: string; description: string; rank: number; }; permissions: { groupPostsPermissions: { viewWall: boolean; postToWall: boolean; deleteFromWall: boolean; viewStatus: boolean; postToStatus: boolean; }; groupMembershipPermissions: { changeRank: boolean; inviteMembers: boolean; removeMembers: boolean; }; groupManagementPermissions: { manageRelationships: boolean; manageClan: boolean; viewAuditLogs: boolean; }; groupEconomyPermissions: { spendGroupFunds: boolean; advertiseGroup: boolean; createItems: boolean; manageItems: boolean; addGroupPlaces: boolean; manageGroupGames: boolean; viewGroupPayouts: boolean; viewAnalytics: boolean; }; groupOpenCloudPermissions: { useCloudAuthentication: boolean; administerCloudAuthentication: boolean; }; }; }; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: { groupId: GroupId; role: { id: RoleSetId; name: string; description: string; rank: number; }; permissions: { groupPostsPermissions: { viewWall: boolean; postToWall: boolean; deleteFromWall: boolean; viewStatus: boolean; postToStatus: boolean; }; groupMembershipPermissions: { changeRank: boolean; inviteMembers: boolean; removeMembers: boolean; }; groupManagementPermissions: { manageRelationships: boolean; manageClan: boolean; viewAuditLogs: boolean; }; groupEconomyPermissions: { spendGroupFunds: boolean; advertiseGroup: boolean; createItems: boolean; manageItems: boolean; addGroupPlaces: boolean; manageGroupGames: boolean; viewGroupPayouts: boolean; viewAnalytics: boolean; }; groupOpenCloudPermissions: { useCloudAuthentication: boolean; administerCloudAuthentication: boolean; }; }; }; }; 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 permissions for a role in a group. * @category Permissions * @endpoint PATCH /v1/groups/{groupId}/roles/{roleSetId}/permissions * @tags [ "Cookie" ] * * @param groupId The id of the group. * @param roleSetId The id of the role to set permissions for. * @param permissions An object of permissions to set. * * @example * const { data:success } = await ClassicGroupsApi.setGroupRolePermissions({ groupId: 5850082, roleSetId: 38353813, permissions: { viewStatus: true } }) * @exampleData true * @exampleRawBody {} */ export declare const setGroupRolePermissions: (this: any, args: { groupId: GroupId; roleSetId: RoleSetId; permissions: GroupRolePermissions; }) => Promise<{ data: boolean; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: {}; }; 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: boolean; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: {}; }; 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 permissions for the guest role of a group. * @category Permissions * @endpoint GET /v1/groups/{groupId}/roles/guest/permissions * @tags [ "Cookie" ] * * @param groupId The id of the group. * * @example const { data:rolePerms } = await ClassicGroupsApi.groupGuestRolePermissions({ groupId: 5850082 }) * @exampleData { groupId: 5850082, role: { id: 38353814, name: "Guest", description: "A non-group member.", rank: 0 }, permissions: { groupPostsPermissions: { viewWall: true, postToWall: false, deleteFromWall: false, viewStatus: false, postToStatus: false }, groupMembershipPermissions: { changeRank: false, inviteMembers: false, removeMembers: false }, groupManagementPermissions: { manageRelationships: false, manageClan: false, viewAuditLogs: false }, groupEconomyPermissions: { spendGroupFunds: false, advertiseGroup: false, createItems: false, manageItems: false, addGroupPlaces: false, manageGroupGames: false, viewGroupPayouts: false, viewAnalytics: false }, groupOpenCloudPermissions: { useCloudAuthentication: false, administerCloudAuthentication: false } } } * @exampleRawBody { groupId: 5850082, role: { id: 38353814, name: "Guest", description: "A non-group member.", rank: 0 }, permissions: { groupPostsPermissions: { viewWall: true, postToWall: false, deleteFromWall: false, viewStatus: false, postToStatus: false }, groupMembershipPermissions: { changeRank: false, inviteMembers: false, removeMembers: false }, groupManagementPermissions: { manageRelationships: false, manageClan: false, viewAuditLogs: false }, groupEconomyPermissions: { spendGroupFunds: false, advertiseGroup: false, createItems: false, manageItems: false, addGroupPlaces: false, manageGroupGames: false, viewGroupPayouts: false, viewAnalytics: false }, groupOpenCloudPermissions: { useCloudAuthentication: false, administerCloudAuthentication: false } } } */ export declare const groupGuestRolePermissions: (this: any, args: { groupId: GroupId; }) => Promise<{ data: { groupId: GroupId; role: { id: Identifier; name: "Guest"; description: string; rank: 0; }; permissions: { groupPostsPermissions: { viewWall: boolean; postToWall: boolean; deleteFromWall: boolean; viewStatus: boolean; postToStatus: boolean; }; groupMembershipPermissions: { changeRank: boolean; inviteMembers: boolean; removeMembers: boolean; }; groupManagementPermissions: { manageRelationships: boolean; manageClan: boolean; viewAuditLogs: boolean; }; groupEconomyPermissions: { spendGroupFunds: boolean; advertiseGroup: boolean; createItems: boolean; manageItems: boolean; addGroupPlaces: boolean; manageGroupGames: boolean; viewGroupPayouts: boolean; viewAnalytics: boolean; }; groupOpenCloudPermissions: { useCloudAuthentication: boolean; administerCloudAuthentication: boolean; }; }; }; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: { groupId: GroupId; role: { id: Identifier; name: "Guest"; description: string; rank: 0; }; permissions: { groupPostsPermissions: { viewWall: boolean; postToWall: boolean; deleteFromWall: boolean; viewStatus: boolean; postToStatus: boolean; }; groupMembershipPermissions: { changeRank: boolean; inviteMembers: boolean; removeMembers: boolean; }; groupManagementPermissions: { manageRelationships: boolean; manageClan: boolean; viewAuditLogs: boolean; }; groupEconomyPermissions: { spendGroupFunds: boolean; advertiseGroup: boolean; createItems: boolean; manageItems: boolean; addGroupPlaces: boolean; manageGroupGames: boolean; viewGroupPayouts: boolean; viewAnalytics: boolean; }; groupOpenCloudPermissions: { useCloudAuthentication: boolean; administerCloudAuthentication: boolean; }; }; }; }; 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: { groupId: GroupId; role: { id: Identifier; name: "Guest"; description: string; rank: 0; }; permissions: { groupPostsPermissions: { viewWall: boolean; postToWall: boolean; deleteFromWall: boolean; viewStatus: boolean; postToStatus: boolean; }; groupMembershipPermissions: { changeRank: boolean; inviteMembers: boolean; removeMembers: boolean; }; groupManagementPermissions: { manageRelationships: boolean; manageClan: boolean; viewAuditLogs: boolean; }; groupEconomyPermissions: { spendGroupFunds: boolean; advertiseGroup: boolean; createItems: boolean; manageItems: boolean; addGroupPlaces: boolean; manageGroupGames: boolean; viewGroupPayouts: boolean; viewAnalytics: boolean; }; groupOpenCloudPermissions: { useCloudAuthentication: boolean; administerCloudAuthentication: boolean; }; }; }; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: { groupId: GroupId; role: { id: Identifier; name: "Guest"; description: string; rank: 0; }; permissions: { groupPostsPermissions: { viewWall: boolean; postToWall: boolean; deleteFromWall: boolean; viewStatus: boolean; postToStatus: boolean; }; groupMembershipPermissions: { changeRank: boolean; inviteMembers: boolean; removeMembers: boolean; }; groupManagementPermissions: { manageRelationships: boolean; manageClan: boolean; viewAuditLogs: boolean; }; groupEconomyPermissions: { spendGroupFunds: boolean; advertiseGroup: boolean; createItems: boolean; manageItems: boolean; addGroupPlaces: boolean; manageGroupGames: boolean; viewGroupPayouts: boolean; viewAnalytics: boolean; }; groupOpenCloudPermissions: { useCloudAuthentication: boolean; administerCloudAuthentication: boolean; }; }; }; }; 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 permissions for all roles in a group. * @category Permissions * @endpoint GET /v1/groups/{groupId}/roles/permissions * @tags [ "Cookie" ] * * @param groupId The id of the group. * * @example const { data:allPerms } = await ClassicGroupsApi.groupPermissionsForAllRoles({ groupId: 5850082 }) * @exampleData [ { groupId: 5850082, role: { id: 38353814, name: "Guest", description: "A non-group member.", rank: 0 }, permissions: { groupPostsPermissions: { viewWall: true, postToWall: false, deleteFromWall: false, viewStatus: false, postToStatus: false }, groupMembershipPermissions: { changeRank: false, inviteMembers: false, removeMembers: false }, groupManagementPermissions: { manageRelationships: false, manageClan: false, viewAuditLogs: false }, groupEconomyPermissions: { spendGroupFunds: false, advertiseGroup: false, createItems: false, manageItems: false, addGroupPlaces: false, manageGroupGames: false, viewGroupPayouts: false, viewAnalytics: false }, groupOpenCloudPermissions: { useCloudAuthentication: false, administerCloudAuthentication: false } } } ] * @exampleRawBody { data: [ { groupId: 5850082, role: { id: 38353814, name: "Guest", description: "A non-group member.", rank: 0 }, permissions: { groupPostsPermissions: { viewWall: true, postToWall: false, deleteFromWall: false, viewStatus: false, postToStatus: false }, groupMembershipPermissions: { changeRank: false, inviteMembers: false, removeMembers: false }, groupManagementPermissions: { manageRelationships: false, manageClan: false, viewAuditLogs: false }, groupEconomyPermissions: { spendGroupFunds: false, advertiseGroup: false, createItems: false, manageItems: false, addGroupPlaces: false, manageGroupGames: false, viewGroupPayouts: false, viewAnalytics: false }, groupOpenCloudPermissions: { useCloudAuthentication: false, administerCloudAuthentication: false } } } ] } */ export declare const groupPermissionsForAllRoles: (this: any, args: { groupId: GroupId; }) => Promise<{ data: { groupId: GroupId; role: { id: number; name: string; description: string; rank: number; }; permissions: { groupPostsPermissions: { viewWall: boolean; postToWall: boolean; deleteFromWall: boolean; viewStatus: boolean; postToStatus: boolean; }; groupMembershipPermissions: { changeRank: boolean; inviteMembers: boolean; removeMembers: boolean; }; groupManagementPermissions: { manageRelationships: boolean; manageClan: boolean; viewAuditLogs: boolean; }; groupEconomyPermissions: { spendGroupFunds: boolean; advertiseGroup: boolean; createItems: boolean; manageItems: boolean; addGroupPlaces: boolean; manageGroupGames: boolean; viewGroupPayouts: boolean; viewAnalytics: boolean; }; groupOpenCloudPermissions: { useCloudAuthentication: boolean; administerCloudAuthentication: boolean; }; }; }[]; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: { data: { groupId: GroupId; role: { id: number; name: string; description: string; rank: number; }; permissions: { groupPostsPermissions: { viewWall: boolean; postToWall: boolean; deleteFromWall: boolean; viewStatus: boolean; postToStatus: boolean; }; groupMembershipPermissions: { changeRank: boolean; inviteMembers: boolean; removeMembers: boolean; }; groupManagementPermissions: { manageRelationships: boolean; manageClan: boolean; viewAuditLogs: boolean; }; groupEconomyPermissions: { spendGroupFunds: boolean; advertiseGroup: boolean; createItems: boolean; manageItems: boolean; addGroupPlaces: boolean; manageGroupGames: boolean; viewGroupPayouts: boolean; viewAnalytics: boolean; }; groupOpenCloudPermissions: { useCloudAuthentication: boolean; administerCloudAuthentication: boolean; }; }; }[]; }; }; 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: { groupId: GroupId; role: { id: number; name: string; description: string; rank: number; }; permissions: { groupPostsPermissions: { viewWall: boolean; postToWall: boolean; deleteFromWall: boolean; viewStatus: boolean; postToStatus: boolean; }; groupMembershipPermissions: { changeRank: boolean; inviteMembers: boolean; removeMembers: boolean; }; groupManagementPermissions: { manageRelationships: boolean; manageClan: boolean; viewAuditLogs: boolean; }; groupEconomyPermissions: { spendGroupFunds: boolean; advertiseGroup: boolean; createItems: boolean; manageItems: boolean; addGroupPlaces: boolean; manageGroupGames: boolean; viewGroupPayouts: boolean; viewAnalytics: boolean; }; groupOpenCloudPermissions: { useCloudAuthentication: boolean; administerCloudAuthentication: boolean; }; }; }[]; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: { data: { groupId: GroupId; role: { id: number; name: string; description: string; rank: number; }; permissions: { groupPostsPermissions: { viewWall: boolean; postToWall: boolean; deleteFromWall: boolean; viewStatus: boolean; postToStatus: boolean; }; groupMembershipPermissions: { changeRank: boolean; inviteMembers: boolean; removeMembers: boolean; }; groupManagementPermissions: { manageRelationships: boolean; manageClan: boolean; viewAuditLogs: boolean; }; groupEconomyPermissions: { spendGroupFunds: boolean; advertiseGroup: boolean; createItems: boolean; manageItems: boolean; addGroupPlaces: boolean; manageGroupGames: boolean; viewGroupPayouts: boolean; viewAnalytics: boolean; }; groupOpenCloudPermissions: { useCloudAuthentication: boolean; administerCloudAuthentication: boolean; }; }; }[]; }; }; 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 socials links for a group. * @category Social Links * @endpoint GET /v1/groups/{groupId}/social-links * @tags [ "?Cookie" ] * * @param groupId The id of the group to get social links for. * * @example const { rawBody:socials } = await ClassicGroupsApi.groupSocialLinks(5850082) * @exampleData [ { id: 3412774, type: "Discord", url: "https://discord.gg/4hDH5s52a", title: "Support Server" } ] * @exampleRawBody { data: [ { id: 3412774, type: "Discord", url: "https://discord.gg/4hDH5s52a", title: "Support Server" } ] } */ export declare const groupSocialLinks: import("../../apiGroup/apiGroup.types").CallApiMethod<{ groupId: Identifier; }, { method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: { data: { id: Identifier; type: "Facebook" | "Twitter" | "YouTube" | "Twitch" | "GooglePlus" | "Discord" | "RobloxGroup" | "Amazon" | "Guilded"; url: `http://${string}` | `https://${string}`; title: string; }[]; }) => string) | undefined; getCursorsFn?: ((rawData: { data: { id: Identifier; type: "Facebook" | "Twitter" | "YouTube" | "Twitch" | "GooglePlus" | "Discord" | "RobloxGroup" | "Amazon" | "Guilded"; url: `http://${string}` | `https://${string}`; title: string; }[]; }) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: { data: { id: Identifier; type: "Facebook" | "Twitter" | "YouTube" | "Twitch" | "GooglePlus" | "Discord" | "RobloxGroup" | "Amazon" | "Guilded"; url: `http://${string}` | `https://${string}`; title: string; }[]; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: { id: Identifier; type: "Facebook" | "Twitter" | "YouTube" | "Twitch" | "GooglePlus" | "Discord" | "RobloxGroup" | "Amazon" | "Guilded"; url: `http://${string}` | `https://${string}`; title: string; }[] | undefined; } & import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<{ data: { id: Identifier; type: "Facebook" | "Twitter" | "YouTube" | "Twitch" | "GooglePlus" | "Discord" | "RobloxGroup" | "Amazon" | "Guilded"; url: `http://${string}` | `https://${string}`; title: string; }[]; }, { id: Identifier; type: "Facebook" | "Twitter" | "YouTube" | "Twitch" | "GooglePlus" | "Discord" | "RobloxGroup" | "Amazon" | "Guilded"; url: `http://${string}` | `https://${string}`; title: string; }[]>, false>; /** * Adds a new social link to a group. * @category Social Links * @endpoint POST /v1/groups/{groupId}/social-links * @tags [ "Cookie" ] * * @param groupId The id of the group to add a social link to. * @param request The social link request data. * * @example * const { data:addedSocial } = await ClassicGroupsApi.addGroupSocialLink({ groupId: 5850082, newSocial: { type: "Twitch", title: "Follow My Twitch", url: "twitch.tv/fooBar" }}) * @exampleData { id: 10791942, type: "Twitch", url: "https://twitch.tv/fooBar", title: "Follow My Twitch" } * @exampleRawBody { id: 10791942, type: "Twitch", url: "https://twitch.tv/fooBar", title: "Follow My Twitch" } */ export declare const addGroupSocialLink: (this: any, args: { groupId: Identifier; newSocial: NewSocial; }) => Promise<{ data: Exclude ? { [Key in keyof T]: ({ id: Identifier; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; })[Key]; } : never, ({ id: Identifier; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; } extends infer T extends Record ? { [Key in keyof T]: ({ id: Identifier; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; })[Key]; } : never) extends infer T_1 ? T_1 extends ({ id: Identifier; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; } extends infer T extends Record ? { [Key in keyof T]: ({ id: Identifier; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; })[Key]; } : never) ? T_1 extends Date ? true : false : never : never>, undefined>; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: import("typeforge").Prettify ? { [Key in keyof T]: ({ id: Identifier; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; })[Key]; } : never, ({ id: Identifier; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; } extends infer T extends Record ? { [Key in keyof T]: ({ id: Identifier; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; })[Key]; } : never) extends infer T_1 ? T_1 extends ({ id: Identifier; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; } extends infer T extends Record ? { [Key in keyof T]: ({ id: Identifier; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; })[Key]; } : never) ? T_1 extends Date ? true : false : never : never>, undefined>, Exclude ? { [Key in keyof T]: ({ id: Identifier; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; })[Key]; } : never, ({ id: Identifier; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; } extends infer T extends Record ? { [Key in keyof T]: ({ id: Identifier; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; })[Key]; } : never) extends infer T_1 ? T_1 extends ({ id: Identifier; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; } extends infer T extends Record ? { [Key in keyof T]: ({ id: Identifier; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; })[Key]; } : never) ? T_1 extends Date ? true : false : never : never>, undefined> extends infer T_2 ? T_2 extends Exclude ? { [Key in keyof T]: ({ id: Identifier; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; })[Key]; } : never, ({ id: Identifier; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; } extends infer T extends Record ? { [Key in keyof T]: ({ id: Identifier; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; })[Key]; } : never) extends infer T_1 ? T_1 extends ({ id: Identifier; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; } extends infer T extends Record ? { [Key in keyof T]: ({ id: Identifier; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; })[Key]; } : never) ? T_1 extends Date ? true : false : never : never>, undefined> ? T_2 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 ? { [Key in keyof T]: ({ id: Identifier; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; })[Key]; } : never, ({ id: Identifier; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; } extends infer T extends Record ? { [Key in keyof T]: ({ id: Identifier; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; })[Key]; } : never) extends infer T_1 ? T_1 extends ({ id: Identifier; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; } extends infer T extends Record ? { [Key in keyof T]: ({ id: Identifier; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; })[Key]; } : never) ? T_1 extends Date ? true : false : never : never>, undefined>; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: import("typeforge").Prettify ? { [Key in keyof T]: ({ id: Identifier; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; })[Key]; } : never, ({ id: Identifier; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; } extends infer T extends Record ? { [Key in keyof T]: ({ id: Identifier; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; })[Key]; } : never) extends infer T_1 ? T_1 extends ({ id: Identifier; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; } extends infer T extends Record ? { [Key in keyof T]: ({ id: Identifier; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; })[Key]; } : never) ? T_1 extends Date ? true : false : never : never>, undefined>, Exclude ? { [Key in keyof T]: ({ id: Identifier; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; })[Key]; } : never, ({ id: Identifier; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; } extends infer T extends Record ? { [Key in keyof T]: ({ id: Identifier; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; })[Key]; } : never) extends infer T_1 ? T_1 extends ({ id: Identifier; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; } extends infer T extends Record ? { [Key in keyof T]: ({ id: Identifier; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; })[Key]; } : never) ? T_1 extends Date ? true : false : never : never>, undefined> extends infer T_3 ? T_3 extends Exclude ? { [Key in keyof T]: ({ id: Identifier; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; })[Key]; } : never, ({ id: Identifier; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; } extends infer T extends Record ? { [Key in keyof T]: ({ id: Identifier; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; })[Key]; } : never) extends infer T_1 ? T_1 extends ({ id: Identifier; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; } extends infer T extends Record ? { [Key in keyof T]: ({ id: Identifier; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; })[Key]; } : never) ? T_1 extends Date ? true : false : never : never>, undefined> ? T_3 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; }; }>; }>; /** * Removes an existing social link from a group. * @category Social Links * @endpoint DELETE /v1/groups/{groupId}/social-links/{socialLinkId} * @tags [ "Cookie" ] * * @param groupId The id of the group to add a social link to. * @param socialLinkId The id of the social link to remove. * * @example const { data:success } = await ClassicGroupsApi.removeGroupSocialLink({ groupId: 5850082, socialLinkId: 10792025 }) * @exampleData true * @exampleRawBody {} */ export declare const removeGroupSocialLink: import("../../apiGroup/apiGroup.types").CallApiMethod<{ groupId: Identifier; socialLinkId: Identifier; }, { method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: {}) => string) | undefined; getCursorsFn?: ((rawData: {}) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: {} | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: boolean | undefined; } & import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<{}, boolean>, false>; /** * Updates an existing social link. * @category Social Links * @endpoint PATCH /v1/groups/{groupId}/social-links/{socialLinkId} * @tags [ "Cookie" ] * * @param groupId The id of the group to add a social link to. * @param newSocial The social link request data. * * @example * const { data:updatedSocial } = await ClassicGroupsApi.updateGroupSocialLink({ groupId: 5850082, socialLinkId: addedSocial.id, newSocial: { type: "Twitch", title: "Follow My Twitch lol", url: "https://twitch.tv/fooBar" }}) * @exampleData true * @exampleRawBody {} */ export declare const updateGroupSocialLink: (this: any, args: { groupId: Identifier; socialLinkId: SocialLinkId; newSocial: NewSocial; }) => Promise<{ data: Exclude ? { [Key in keyof T]: ({ id: SocialLinkId; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; })[Key]; } : never, ({ id: SocialLinkId; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; } extends infer T extends Record ? { [Key in keyof T]: ({ id: SocialLinkId; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; })[Key]; } : never) extends infer T_1 ? T_1 extends ({ id: SocialLinkId; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; } extends infer T extends Record ? { [Key in keyof T]: ({ id: SocialLinkId; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; })[Key]; } : never) ? T_1 extends Date ? true : false : never : never>, undefined>; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: import("typeforge").Prettify ? { [Key in keyof T]: ({ id: SocialLinkId; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; })[Key]; } : never, ({ id: SocialLinkId; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; } extends infer T extends Record ? { [Key in keyof T]: ({ id: SocialLinkId; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; })[Key]; } : never) extends infer T_1 ? T_1 extends ({ id: SocialLinkId; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; } extends infer T extends Record ? { [Key in keyof T]: ({ id: SocialLinkId; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; })[Key]; } : never) ? T_1 extends Date ? true : false : never : never>, undefined>, Exclude ? { [Key in keyof T]: ({ id: SocialLinkId; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; })[Key]; } : never, ({ id: SocialLinkId; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; } extends infer T extends Record ? { [Key in keyof T]: ({ id: SocialLinkId; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; })[Key]; } : never) extends infer T_1 ? T_1 extends ({ id: SocialLinkId; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; } extends infer T extends Record ? { [Key in keyof T]: ({ id: SocialLinkId; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; })[Key]; } : never) ? T_1 extends Date ? true : false : never : never>, undefined> extends infer T_2 ? T_2 extends Exclude ? { [Key in keyof T]: ({ id: SocialLinkId; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; })[Key]; } : never, ({ id: SocialLinkId; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; } extends infer T extends Record ? { [Key in keyof T]: ({ id: SocialLinkId; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; })[Key]; } : never) extends infer T_1 ? T_1 extends ({ id: SocialLinkId; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; } extends infer T extends Record ? { [Key in keyof T]: ({ id: SocialLinkId; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; })[Key]; } : never) ? T_1 extends Date ? true : false : never : never>, undefined> ? T_2 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 ? { [Key in keyof T]: ({ id: SocialLinkId; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; })[Key]; } : never, ({ id: SocialLinkId; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; } extends infer T extends Record ? { [Key in keyof T]: ({ id: SocialLinkId; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; })[Key]; } : never) extends infer T_1 ? T_1 extends ({ id: SocialLinkId; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; } extends infer T extends Record ? { [Key in keyof T]: ({ id: SocialLinkId; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; })[Key]; } : never) ? T_1 extends Date ? true : false : never : never>, undefined>; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: import("typeforge").Prettify ? { [Key in keyof T]: ({ id: SocialLinkId; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; })[Key]; } : never, ({ id: SocialLinkId; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; } extends infer T extends Record ? { [Key in keyof T]: ({ id: SocialLinkId; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; })[Key]; } : never) extends infer T_1 ? T_1 extends ({ id: SocialLinkId; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; } extends infer T extends Record ? { [Key in keyof T]: ({ id: SocialLinkId; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; })[Key]; } : never) ? T_1 extends Date ? true : false : never : never>, undefined>, Exclude ? { [Key in keyof T]: ({ id: SocialLinkId; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; })[Key]; } : never, ({ id: SocialLinkId; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; } extends infer T extends Record ? { [Key in keyof T]: ({ id: SocialLinkId; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; })[Key]; } : never) extends infer T_1 ? T_1 extends ({ id: SocialLinkId; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; } extends infer T extends Record ? { [Key in keyof T]: ({ id: SocialLinkId; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; })[Key]; } : never) ? T_1 extends Date ? true : false : never : never>, undefined> extends infer T_3 ? T_3 extends Exclude ? { [Key in keyof T]: ({ id: SocialLinkId; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; })[Key]; } : never, ({ id: SocialLinkId; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; } extends infer T extends Record ? { [Key in keyof T]: ({ id: SocialLinkId; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; })[Key]; } : never) extends infer T_1 ? T_1 extends ({ id: SocialLinkId; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; } extends infer T extends Record ? { [Key in keyof T]: ({ id: SocialLinkId; } & { -readonly [Key_1 in keyof NewSocial]: NewSocial[Key_1]; })[Key]; } : never) ? T_1 extends Date ? true : false : never : never>, undefined> ? T_3 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 a list of group wall posts. * @category Wall * @endpoint GET /v1/groups/{groupId}/wall/posts * @tags [ "?Cookie" ] * * @param groupId The id of the group to get wall posts for. * @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:wallPosts } = await ClassicGroupsApi.groupWallPosts_V1({ groupId: 5850082 }) * @exampleData [ { id: 2727146317, poster: { hasVerifiedBadge: false, userId: 45348281, username: 'MightyPart', displayName: 'MightyPart' }, body: 'Lorem Ipsum dolor sit amet...', created: 2022-11-24T15:31:28.157Z, updated: 2022-11-24T15:31:28.157Z } ] * @exampleRawBody { previousPageCursor: null, nextPageCursor: '2550358523_1_75917f56fab75bb02bd9d16be933b95a', data: [ { id: 2727146317, poster: { hasVerifiedBadge: false, userId: 45348281, username: 'MightyPart', displayName: 'MightyPart' }, body: 'Lorem Ipsum dolor sit amet...', created: "2022-11-24T15:31:28.157Z", updated: "2022-11-24T15:31:28.157Z" } ] } */ export declare const groupWallPosts_V1: (this: any, args: { groupId: Identifier; limit?: 10 | 25 | 50 | 100 | undefined; sortOrder?: SortOrder | undefined; cursor?: string | undefined; }) => Promise<{ data: { id: number; poster: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; body: string; created: Date; updated: Date; }[]; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: { previousPageCursor?: string | undefined; nextPageCursor?: string | undefined; data: { id: number; poster: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; body: 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; }; cursors: { /** * Gets information about a group. * @category Groups * @endpoint GET /v1/groups/{groupId} * @tags [ "?Cookie" ] * * @param groupId The id of the group. * * @example const { data:groupInfo } = await ClassicGroupsApi.groupInfo({ groupId: 5850082}) * @exampleData { id: 5850082, name: "MightyPart Games", description: "Lorem ipsum dolor sit amet consectetur adipiscing elit.", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, memberCount: 102, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false } * @exampleRawBody { id: 5850082, name: "MightyPart Games", description: "Lorem ipsum dolor sit amet consectetur adipiscing elit.", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, memberCount: 102, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false } */ previous: import("../../apiGroup/apiGroup.types").Cursor; /** * Gets information about a group. * @category Groups * @endpoint GET /v1/groups/{groupId} * @tags [ "?Cookie" ] * * @param groupId The id of the group. * * @example const { data:groupInfo } = await ClassicGroupsApi.groupInfo({ groupId: 5850082}) * @exampleData { id: 5850082, name: "MightyPart Games", description: "Lorem ipsum dolor sit amet consectetur adipiscing elit.", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, memberCount: 102, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false } * @exampleRawBody { id: 5850082, name: "MightyPart Games", description: "Lorem ipsum dolor sit amet consectetur adipiscing elit.", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, memberCount: 102, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false } */ next: import("../../apiGroup/apiGroup.types").Cursor; }; [Symbol.asyncIterator]: () => AsyncGenerator<{ data: { id: number; poster: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; body: string; created: Date; updated: Date; }[]; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: { previousPageCursor?: string | undefined; nextPageCursor?: string | undefined; data: { id: number; poster: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; body: 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; }; cursors: { /** * Gets information about a group. * @category Groups * @endpoint GET /v1/groups/{groupId} * @tags [ "?Cookie" ] * * @param groupId The id of the group. * * @example const { data:groupInfo } = await ClassicGroupsApi.groupInfo({ groupId: 5850082}) * @exampleData { id: 5850082, name: "MightyPart Games", description: "Lorem ipsum dolor sit amet consectetur adipiscing elit.", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, memberCount: 102, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false } * @exampleRawBody { id: 5850082, name: "MightyPart Games", description: "Lorem ipsum dolor sit amet consectetur adipiscing elit.", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, memberCount: 102, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false } */ previous: import("../../apiGroup/apiGroup.types").Cursor; /** * Gets information about a group. * @category Groups * @endpoint GET /v1/groups/{groupId} * @tags [ "?Cookie" ] * * @param groupId The id of the group. * * @example const { data:groupInfo } = await ClassicGroupsApi.groupInfo({ groupId: 5850082}) * @exampleData { id: 5850082, name: "MightyPart Games", description: "Lorem ipsum dolor sit amet consectetur adipiscing elit.", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, memberCount: 102, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false } * @exampleRawBody { id: 5850082, name: "MightyPart Games", description: "Lorem ipsum dolor sit amet consectetur adipiscing elit.", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, memberCount: 102, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false } */ next: import("../../apiGroup/apiGroup.types").Cursor; }; [Symbol.asyncIterator]: null; } & { again: () => Promise<{ data: { id: number; poster: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; body: string; created: Date; updated: Date; }[]; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: { previousPageCursor?: string | undefined; nextPageCursor?: string | undefined; data: { id: number; poster: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; body: 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; }; }>; }, any, unknown>; } & { again: () => Promise<{ data: { id: number; poster: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; body: string; created: Date; updated: Date; }[]; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: { previousPageCursor?: string | undefined; nextPageCursor?: string | undefined; data: { id: number; poster: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; body: 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; }; }>; }>; /** * (THIS ENDPOINT PROBABLY DOESN'T WORK). Subscribes the authenticated user to notifications of group wall events. * @category Wall * @endpoint GET /v1/groups/{groupId}/wall/posts/subscribe * @tags [ "Cookie" ] * * @param groupId The id of the group. * * @example const { data } = await ClassicGroupsApi.authenticatedUserSubscribeToGroupWallNotificationEvents({ groupId: 5850082 }) */ export declare const authenticatedUserSubscribeToGroupWallNotificationEvents: import("../../apiGroup/apiGroup.types").CallApiMethod<{ groupId: Identifier; }, { method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: any) => string) | undefined; getCursorsFn?: ((rawData: any) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: any; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: any; }, false>; /** * Removes a group wall post. * @category Wall * @endpoint GET /v1/groups/{groupId}/wall/posts/{wallPostId} * @tags [ "Cookie" ] * * @param groupId The id of the group. * @param wallPostId The id of the wall post to be removed. * * @example const { data:success } = await ClassicGroupsApi.removeGroupWallPost({ groupId: 5850082, wallPostId: 2727146317 }) * @exampleData true * @exampleRawBody {} */ export declare const removeGroupWallPost: import("../../apiGroup/apiGroup.types").CallApiMethod<{ groupId: Identifier; wallPostId: Identifier; }, { method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: {}) => string) | undefined; getCursorsFn?: ((rawData: {}) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: {} | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: boolean | undefined; } & import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<{}, boolean>, false>; /** * Removes all group wall posts made by a specific user. * @category Wall * @endpoint GET /v1/groups/{groupId}/wall/users/{userId}/posts * @tags [ "Cookie" ] * * @param groupId The id of the group. * @param userId The id of the user. * * @example const { data:success } = await ClassicGroupsApi.removeAllGroupWallPostsMadeByUser({ groupId: 5850082, userId: 45348281 }) * @exampleData true * @exampleRawBody {} */ export declare const removeAllGroupWallPostsMadeByUser: import("../../apiGroup/apiGroup.types").CallApiMethod<{ groupId: Identifier; userId: Identifier; }, { method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: {}) => string) | undefined; getCursorsFn?: ((rawData: {}) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: {} | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: boolean | undefined; } & import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<{}, boolean>, false>; /** * Search for groups by keyword. * @category Group Search * @endpoint GET /v1/groups/search * * @param keyword The keyword or phrase to use as the search parameter. * @param prioritizeExactMatch Whether or not to prioritize the exact match for the keyword. * @param limit The number of results to be returned. * @param cursor The paging cursor for the previous or next page. * * @example const { data:results } = await ClassicGroupsApi.groupSearch({ keyword: "MightyPart Games", prioritizeExactMatch: true }) * @exampleData [ { id: 5850082, name: 'MightyPart Games', description: 'Welcome to my amazing group', memberCount: 102, previousName: 'Nameless Game Studio', publicEntryAllowed: true, created: '2020-03-29T18:15:20.1Z', updated: '2023-09-14T06:34:36.243Z', hasVerifiedBadge: false } ] * @exampleRawBody { keyword: 'MightyPart Games', previousPageCursor: null, nextPageCursor: 'eyJzdGFydEluZGV4IjoxMCwiZGlzY3JpbWluYXRvciI6ImtleXdvcmQ6TWlnaHR5UGFydCBHYW1lcyIsImNvdW50IjoxMH0KOTIwMGU5MzQwMTBlM2IzOTBlNmU3M2E3MzJkNzhhYzRkZjU1ZGM2ZGEwNWUwMDRjMmM1ZmRmZDlhMzk3YjRhNA==', data: [ { id: 5850082, name: 'MightyPart Games', description: 'Welcome to my amazing group', memberCount: 102, previousName: 'Nameless Game Studio', publicEntryAllowed: true, created: '2020-03-29T18:15:20.1Z', updated: '2023-09-14T06:34:36.243Z', hasVerifiedBadge: false } ] } */ export declare const groupSearch: import("../../apiGroup/apiGroup.types").CallApiMethod<{ keyword: string; prioritizeExactMatch?: boolean | undefined; limit?: 10 | 25 | 50 | 100 | undefined; cursor?: string | undefined; }, { method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: { previousPageCursor?: string | undefined; nextPageCursor?: string | undefined; keyword: string; data: { id: number; name: string; description: string; memberCount: number; previousName: string; publicEntryAllowed: true; created: string; updated: string; hasVerifiedBadge: true; }[]; }) => string) | undefined; getCursorsFn?: ((rawData: { previousPageCursor?: string | undefined; nextPageCursor?: string | undefined; keyword: string; data: { id: number; name: string; description: string; memberCount: number; previousName: string; publicEntryAllowed: true; created: string; updated: string; hasVerifiedBadge: true; }[]; }) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: { previousPageCursor?: string | undefined; nextPageCursor?: string | undefined; keyword: string; data: { id: number; name: string; description: string; memberCount: number; previousName: string; publicEntryAllowed: true; created: string; updated: string; hasVerifiedBadge: true; }[]; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: { id: number; name: string; description: string; memberCount: number; previousName: string; publicEntryAllowed: true; created: Date; updated: Date; hasVerifiedBadge: true; }[] | undefined; } & import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<{ previousPageCursor?: string | undefined; nextPageCursor?: string | undefined; keyword: string; data: { id: number; name: string; description: string; memberCount: number; previousName: string; publicEntryAllowed: true; created: string; updated: string; hasVerifiedBadge: true; }[]; }, { id: number; name: string; description: string; memberCount: number; previousName: string; publicEntryAllowed: true; created: Date; updated: Date; hasVerifiedBadge: true; }[]>, true>; /** * Search for groups by keyword. * @category Group Search * @endpoint GET /v1/groups/search/lookup * * @param groupName The name of the group to lookup. * * @example const { data:results } = await ClassicGroupsApi.groupLookupSearch({ groupName: "MightyPart Games" }) * @exampleData [ { id: 5850082, name: 'MightyPart Games', memberCount: 102, hasVerifiedBadge: false } ] * @exampleRawBody { data: [ { id: 5850082, name: 'MightyPart Games', memberCount: 102, hasVerifiedBadge: false } ] } */ export declare const groupLookupSearch: import("../../apiGroup/apiGroup.types").CallApiMethod<{ groupName: string; }, { method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: { data: { id: number; name: string; memberCount: number; hasVerifiedBadge: boolean; }[]; }) => string) | undefined; getCursorsFn?: ((rawData: { data: { id: number; name: string; memberCount: number; hasVerifiedBadge: boolean; }[]; }) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: { data: { id: number; name: string; memberCount: number; hasVerifiedBadge: boolean; }[]; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: { id: number; name: string; memberCount: number; hasVerifiedBadge: boolean; }[] | undefined; } & import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<{ data: { id: number; name: string; memberCount: number; hasVerifiedBadge: boolean; }[]; }, { id: number; name: string; memberCount: number; hasVerifiedBadge: boolean; }[]>, false>; /** * Gets suggested groups and other miscellaneous information needed for the group/join page like flags. * @category Group Search * @endpoint GET /v1/groups/search/metadata * * @example const { data:searchMetadata } = await ClassicGroupsApi.groupSearchMetadata() * @exampleData { suggestedGroupKeywords: [ 'Experience Studios', 'Building', 'Roleplaying', 'Fan' ], showFriendsGroupsSort: true } * @exampleRawBody { SuggestedGroupKeywords: [ 'Experience Studios', 'Building', 'Roleplaying', 'Fan' ], ShowFriendsGroupsSort: true } */ export declare const groupSearchMetadata: import("../../apiGroup/apiGroup.types").CallApiMethod, { method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: { SuggestedGroupKeywords: string[]; ShowFriendsGroupsSort: boolean; }) => string) | undefined; getCursorsFn?: ((rawData: { SuggestedGroupKeywords: string[]; ShowFriendsGroupsSort: boolean; }) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: { SuggestedGroupKeywords: string[]; ShowFriendsGroupsSort: boolean; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: { suggestedGroupKeywords: string[]; showFriendsGroupsSort: boolean; } | undefined; } & import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<{ SuggestedGroupKeywords: string[]; ShowFriendsGroupsSort: boolean; }, { suggestedGroupKeywords: string[]; showFriendsGroupsSort: boolean; }>, false>; /** * Gets a list of roles from role ids. * @category Roles * @endpoint GET /v1/roles * * @param roleIds The ids of roles to get. * * @example const { data:roles } = await ClassicGroupsApi.groupRolesFromIds({ roleIds: [ 38353811 ] }) * @exampleData { '38353811': { groupId: 5850082, name: 'NamelessGuy2005 - Scriptor', rank: 255 } } * @exampleRawBody { data: [ { groupId: 5850082, id: 38353811, name: 'NamelessGuy2005 - Scriptor', rank: 255 } ] } */ export declare const groupRolesFromIds: (this: any, args: { roleIds: ArrayNonEmptyIfConst; }) => Promise<{ data: Exclude<({ method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: RawGroupRolesFromIdsData) => string) | undefined; getCursorsFn?: ((rawData: { data: { groupId: number; id: RoleId; name: string; rank: number; }[]; }) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: { data: { groupId: number; id: RoleId; name: string; rank: number; }[]; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: (PrettifiedGroupRolesFromIdsData extends infer T ? T extends PrettifiedGroupRolesFromIdsData ? T extends undefined ? { data: { groupId: number; id: RoleId; name: string; rank: number; }[]; } : import("typeforge").Prettify : never : never) | undefined; } & (PrettifiedGroupRolesFromIdsData extends infer T_1 ? T_1 extends PrettifiedGroupRolesFromIdsData ? T_1 extends undefined ? {} : import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData, PrettifiedGroupRolesFromIdsData extends infer T_2 ? T_2 extends PrettifiedGroupRolesFromIdsData ? T_2 extends undefined ? RawGroupRolesFromIdsData : 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 | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: RawGroupRolesFromIdsData) => string) | undefined; getCursorsFn?: ((rawData: { data: { groupId: number; id: RoleId; name: string; rank: number; }[]; }) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: { data: { groupId: number; id: RoleId; name: string; rank: number; }[]; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: (PrettifiedGroupRolesFromIdsData extends infer T_3 ? T_3 extends PrettifiedGroupRolesFromIdsData ? T_3 extends undefined ? { data: { groupId: number; id: RoleId; name: string; rank: number; }[]; } : import("typeforge").Prettify : never : never) | undefined; } & (PrettifiedGroupRolesFromIdsData extends infer T_4 ? T_4 extends PrettifiedGroupRolesFromIdsData ? T_4 extends undefined ? {} : import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData, PrettifiedGroupRolesFromIdsData extends infer T_5 ? T_5 extends PrettifiedGroupRolesFromIdsData ? T_5 extends undefined ? RawGroupRolesFromIdsData : T_5 : never : never> : never : never))["🔒__PRIVATE_RAW_DATA"], undefined>, Exclude<({ method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: RawGroupRolesFromIdsData) => string) | undefined; getCursorsFn?: ((rawData: { data: { groupId: number; id: RoleId; name: string; rank: number; }[]; }) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: { data: { groupId: number; id: RoleId; name: string; rank: number; }[]; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: (PrettifiedGroupRolesFromIdsData extends infer T_6 ? T_6 extends PrettifiedGroupRolesFromIdsData ? T_6 extends undefined ? { data: { groupId: number; id: RoleId; name: string; rank: number; }[]; } : import("typeforge").Prettify : never : never) | undefined; } & (PrettifiedGroupRolesFromIdsData extends infer T_7 ? T_7 extends PrettifiedGroupRolesFromIdsData ? T_7 extends undefined ? {} : import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData, PrettifiedGroupRolesFromIdsData extends infer T_8 ? T_8 extends PrettifiedGroupRolesFromIdsData ? T_8 extends undefined ? RawGroupRolesFromIdsData : 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 | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: RawGroupRolesFromIdsData) => string) | undefined; getCursorsFn?: ((rawData: { data: { groupId: number; id: RoleId; name: string; rank: number; }[]; }) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: { data: { groupId: number; id: RoleId; name: string; rank: number; }[]; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: (PrettifiedGroupRolesFromIdsData extends infer T_10 ? T_10 extends PrettifiedGroupRolesFromIdsData ? T_10 extends undefined ? { data: { groupId: number; id: RoleId; name: string; rank: number; }[]; } : import("typeforge").Prettify : never : never) | undefined; } & (PrettifiedGroupRolesFromIdsData extends infer T_11 ? T_11 extends PrettifiedGroupRolesFromIdsData ? T_11 extends undefined ? {} : import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData, PrettifiedGroupRolesFromIdsData extends infer T_12 ? T_12 extends PrettifiedGroupRolesFromIdsData ? T_12 extends undefined ? RawGroupRolesFromIdsData : 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 | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: RawGroupRolesFromIdsData) => string) | undefined; getCursorsFn?: ((rawData: { data: { groupId: number; id: RoleId; name: string; rank: number; }[]; }) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: { data: { groupId: number; id: RoleId; name: string; rank: number; }[]; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: (PrettifiedGroupRolesFromIdsData extends infer T_13 ? T_13 extends PrettifiedGroupRolesFromIdsData ? T_13 extends undefined ? { data: { groupId: number; id: RoleId; name: string; rank: number; }[]; } : import("typeforge").Prettify : never : never) | undefined; } & (PrettifiedGroupRolesFromIdsData extends infer T_14 ? T_14 extends PrettifiedGroupRolesFromIdsData ? T_14 extends undefined ? {} : import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData, PrettifiedGroupRolesFromIdsData extends infer T_15 ? T_15 extends PrettifiedGroupRolesFromIdsData ? T_15 extends undefined ? RawGroupRolesFromIdsData : 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 | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: RawGroupRolesFromIdsData) => string) | undefined; getCursorsFn?: ((rawData: { data: { groupId: number; id: RoleId; name: string; rank: number; }[]; }) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: { data: { groupId: number; id: RoleId; name: string; rank: number; }[]; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: (PrettifiedGroupRolesFromIdsData extends infer T_16 ? T_16 extends PrettifiedGroupRolesFromIdsData ? T_16 extends undefined ? { data: { groupId: number; id: RoleId; name: string; rank: number; }[]; } : import("typeforge").Prettify : never : never) | undefined; } & (PrettifiedGroupRolesFromIdsData extends infer T_17 ? T_17 extends PrettifiedGroupRolesFromIdsData ? T_17 extends undefined ? {} : import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData, PrettifiedGroupRolesFromIdsData extends infer T_18 ? T_18 extends PrettifiedGroupRolesFromIdsData ? T_18 extends undefined ? RawGroupRolesFromIdsData : T_18 : never : never> : never : never))["🔒__PRIVATE_RAW_DATA"], undefined>, Exclude<({ method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: RawGroupRolesFromIdsData) => string) | undefined; getCursorsFn?: ((rawData: { data: { groupId: number; id: RoleId; name: string; rank: number; }[]; }) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: { data: { groupId: number; id: RoleId; name: string; rank: number; }[]; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: (PrettifiedGroupRolesFromIdsData extends infer T_19 ? T_19 extends PrettifiedGroupRolesFromIdsData ? T_19 extends undefined ? { data: { groupId: number; id: RoleId; name: string; rank: number; }[]; } : import("typeforge").Prettify : never : never) | undefined; } & (PrettifiedGroupRolesFromIdsData extends infer T_20 ? T_20 extends PrettifiedGroupRolesFromIdsData ? T_20 extends undefined ? {} : import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData, PrettifiedGroupRolesFromIdsData extends infer T_21 ? T_21 extends PrettifiedGroupRolesFromIdsData ? T_21 extends undefined ? RawGroupRolesFromIdsData : 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 | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: RawGroupRolesFromIdsData) => string) | undefined; getCursorsFn?: ((rawData: { data: { groupId: number; id: RoleId; name: string; rank: number; }[]; }) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: { data: { groupId: number; id: RoleId; name: string; rank: number; }[]; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: (PrettifiedGroupRolesFromIdsData extends infer T_23 ? T_23 extends PrettifiedGroupRolesFromIdsData ? T_23 extends undefined ? { data: { groupId: number; id: RoleId; name: string; rank: number; }[]; } : import("typeforge").Prettify : never : never) | undefined; } & (PrettifiedGroupRolesFromIdsData extends infer T_24 ? T_24 extends PrettifiedGroupRolesFromIdsData ? T_24 extends undefined ? {} : import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData, PrettifiedGroupRolesFromIdsData extends infer T_25 ? T_25 extends PrettifiedGroupRolesFromIdsData ? T_25 extends undefined ? RawGroupRolesFromIdsData : 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 a user's primary group. * @category Primary Group * @endpoint GET /v1/users/{userId}/groups/primary/role * * @param userId The id of the user to get the primary group for. * * @example const { data:primaryGroup } = await ClassicGroupsApi.primaryGroupForUser({ userId: 45348281 }) * @exampleData { group: { id: 5850082, name: "MightyPart Games", description: "Welcome to my amazing group", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false }, role: { id: 38353811, name: "NamelessGuy2005 - Scriptor", rank: 255 } } * @exampleRawBody { group: { id: 5850082, name: "MightyPart Games", description: "Welcome to my amazing group", owner: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, shout: null, isBuildersClubOnly: false, publicEntryAllowed: true, hasVerifiedBadge: false }, role: { id: 38353811, name: "NamelessGuy2005 - Scriptor", rank: 255 } } */ export declare const primaryGroupForUser: import("../../apiGroup/apiGroup.types").CallApiMethod<{ userId: Identifier; }, { method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: { group: { id: number; name: string; description: string; owner: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; shout: { body: string; poster: { buildersClubMembershipType: number; hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; created: string; updated: string; } | null; isBuildersClubOnly: boolean; publicEntryAllowed: boolean; hasVerifiedBadge: boolean; }; role: { id: number; name: string; rank: number; }; }) => string) | undefined; getCursorsFn?: ((rawData: { group: { id: number; name: string; description: string; owner: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; shout: { body: string; poster: { buildersClubMembershipType: number; hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; created: string; updated: string; } | null; isBuildersClubOnly: boolean; publicEntryAllowed: boolean; hasVerifiedBadge: boolean; }; role: { id: number; name: string; rank: number; }; }) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: { group: { id: number; name: string; description: string; owner: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; shout: { body: string; poster: { buildersClubMembershipType: number; hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; created: string; updated: string; } | null; isBuildersClubOnly: boolean; publicEntryAllowed: boolean; hasVerifiedBadge: boolean; }; role: { id: number; name: string; rank: number; }; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: { group: { id: number; name: string; description: string; owner: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; shout: { body: string; poster: { buildersClubMembershipType: number; hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; created: Date; updated: Date; } | null; isBuildersClubOnly: boolean; publicEntryAllowed: boolean; hasVerifiedBadge: boolean; }; role: { id: number; name: string; rank: number; }; } | undefined; } & import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<{ group: { id: number; name: string; description: string; owner: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; shout: { body: string; poster: { buildersClubMembershipType: number; hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; created: string; updated: string; } | null; isBuildersClubOnly: boolean; publicEntryAllowed: boolean; hasVerifiedBadge: boolean; }; role: { id: number; name: string; rank: number; }; }, { group: { id: number; name: string; description: string; owner: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; shout: { body: string; poster: { buildersClubMembershipType: number; hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; created: Date; updated: Date; } | null; isBuildersClubOnly: boolean; publicEntryAllowed: boolean; hasVerifiedBadge: boolean; }; role: { id: number; name: string; rank: number; }; }>, false>; /** * Removes the authenticated user's primary group. * @category Primary Group * @endpoint DELETE /v1/user/groups/primary * * @example const { data:success } = await ClassicGroupsApi.authenticatedUserRemovePrimaryGroup() * @exampleData true * @exampleRawBody {} */ export declare const authenticatedUserRemovePrimaryGroup: import("../../apiGroup/apiGroup.types").CallApiMethod, { method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: {}) => string) | undefined; getCursorsFn?: ((rawData: {}) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: {} | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: boolean | undefined; } & import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<{}, boolean>, false>; /** * Sets the authenticated user's primary group. * @category Primary Group * @endpoint POST /v1/user/groups/primary * * @param groupId The id of the group to set as the primary group. * * @example const { data:success } = await ClassicGroupsApi.authenticatedUserSetPrimaryGroup({ groupId: 5850082 }) * @exampleData true * @exampleRawBody {} */ export declare const authenticatedUserSetPrimaryGroup: import("../../apiGroup/apiGroup.types").CallApiMethod<{ groupId: Identifier; }, { method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: {}) => string) | undefined; getCursorsFn?: ((rawData: {}) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: {} | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: boolean | undefined; } & import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<{}, boolean>, false>; /** * Updates an existing role set. * @category Role Sets * @endpoint PATCH /v1/groups/{groupId}/rolesets/{roleSetId} * * @param groupId The id of the group. * @param roleSetId The id of the role to update. * @param request The updated information. * * @example * const { data:updatedRole } = await ClassicGroupsApi.updateGroupRoleSet({ groupId: 5850082, roleSetId: 38353813, newData: { name: "Mighty Member", description: "A regular group member.", rank: 2 }}) * @exampleData { id: 38353813, name: "Mighty Member", description: "A regular group member.", rank: 2, memberCount: 94 } * @exampleRawBody { id: 38353813, name: "Mighty Member", description: "A regular group member.", rank: 2, memberCount: 94 } */ export declare const updateGroupRoleSet: (this: any, args: { groupId: Identifier; roleSetId: Identifier; newData: NewRoleData; }) => Promise<{ data: { id: number; name: NewRoleData["name"]; description: NewRoleData["description"]; rank: NewRoleData["rank"]; }; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: { id: number; name: NewRoleData["name"]; description: NewRoleData["description"]; rank: NewRoleData["rank"]; }; }; 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: { id: number; name: NewRoleData["name"]; description: NewRoleData["description"]; rank: NewRoleData["rank"]; }; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: { id: number; name: NewRoleData["name"]; description: NewRoleData["description"]; rank: NewRoleData["rank"]; }; }; 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 information about multiple groups. * @category Groups * @endpoint GET /v2/groups * * @param groupIds The id of the groups to get information for. * * @example const { data:groupsInfo } = await ClassicGroupsApi.groupsInfo({ groupIds: [ 5850082 ] }) * @exampleData { "5850082": { name: "MightyPart Games", description: "Welcome to my amazing group", owner: { id: 45348281, type: "User" }, created: 2020-03-29T18:15:20.100Z, hasVerifiedBadge: false } } * @exampleRawBody { data: [ { id: 5850082, name: "MightyPart Games", description: "Welcome to my amazing group", owner: { id: 45348281, type: "User" }, created: "2020-03-29T18:15:20.1Z", hasVerifiedBadge: false } ] } */ export declare const groupsInfo: (this: any, args: { groupIds: GroupId[]; }) => Promise<{ data: Exclude<({ method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: RawGroupIdsToGroupsInfoData) => string) | undefined; getCursorsFn?: ((rawData: { data: { id: GroupId; name: string; description: string; owner: { id: number; type: string; }; created: string; hasVerifiedBadge: boolean; }[]; }) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: { data: { id: GroupId; name: string; description: string; owner: { id: number; type: string; }; created: string; hasVerifiedBadge: boolean; }[]; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: (PrettifiedGroupIdsToGroupsInfoData extends infer T ? T extends PrettifiedGroupIdsToGroupsInfoData ? T extends undefined ? { data: { id: GroupId; name: string; description: string; owner: { id: number; type: string; }; created: string; hasVerifiedBadge: boolean; }[]; } : import("typeforge").Prettify : never : never) | undefined; } & (PrettifiedGroupIdsToGroupsInfoData extends infer T_1 ? T_1 extends PrettifiedGroupIdsToGroupsInfoData ? T_1 extends undefined ? {} : import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData, PrettifiedGroupIdsToGroupsInfoData extends infer T_2 ? T_2 extends PrettifiedGroupIdsToGroupsInfoData ? T_2 extends undefined ? RawGroupIdsToGroupsInfoData : 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 | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: RawGroupIdsToGroupsInfoData) => string) | undefined; getCursorsFn?: ((rawData: { data: { id: GroupId; name: string; description: string; owner: { id: number; type: string; }; created: string; hasVerifiedBadge: boolean; }[]; }) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: { data: { id: GroupId; name: string; description: string; owner: { id: number; type: string; }; created: string; hasVerifiedBadge: boolean; }[]; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: (PrettifiedGroupIdsToGroupsInfoData extends infer T_3 ? T_3 extends PrettifiedGroupIdsToGroupsInfoData ? T_3 extends undefined ? { data: { id: GroupId; name: string; description: string; owner: { id: number; type: string; }; created: string; hasVerifiedBadge: boolean; }[]; } : import("typeforge").Prettify : never : never) | undefined; } & (PrettifiedGroupIdsToGroupsInfoData extends infer T_4 ? T_4 extends PrettifiedGroupIdsToGroupsInfoData ? T_4 extends undefined ? {} : import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData, PrettifiedGroupIdsToGroupsInfoData extends infer T_5 ? T_5 extends PrettifiedGroupIdsToGroupsInfoData ? T_5 extends undefined ? RawGroupIdsToGroupsInfoData : T_5 : never : never> : never : never))["🔒__PRIVATE_RAW_DATA"], undefined>, Exclude<({ method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: RawGroupIdsToGroupsInfoData) => string) | undefined; getCursorsFn?: ((rawData: { data: { id: GroupId; name: string; description: string; owner: { id: number; type: string; }; created: string; hasVerifiedBadge: boolean; }[]; }) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: { data: { id: GroupId; name: string; description: string; owner: { id: number; type: string; }; created: string; hasVerifiedBadge: boolean; }[]; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: (PrettifiedGroupIdsToGroupsInfoData extends infer T_6 ? T_6 extends PrettifiedGroupIdsToGroupsInfoData ? T_6 extends undefined ? { data: { id: GroupId; name: string; description: string; owner: { id: number; type: string; }; created: string; hasVerifiedBadge: boolean; }[]; } : import("typeforge").Prettify : never : never) | undefined; } & (PrettifiedGroupIdsToGroupsInfoData extends infer T_7 ? T_7 extends PrettifiedGroupIdsToGroupsInfoData ? T_7 extends undefined ? {} : import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData, PrettifiedGroupIdsToGroupsInfoData extends infer T_8 ? T_8 extends PrettifiedGroupIdsToGroupsInfoData ? T_8 extends undefined ? RawGroupIdsToGroupsInfoData : 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 | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: RawGroupIdsToGroupsInfoData) => string) | undefined; getCursorsFn?: ((rawData: { data: { id: GroupId; name: string; description: string; owner: { id: number; type: string; }; created: string; hasVerifiedBadge: boolean; }[]; }) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: { data: { id: GroupId; name: string; description: string; owner: { id: number; type: string; }; created: string; hasVerifiedBadge: boolean; }[]; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: (PrettifiedGroupIdsToGroupsInfoData extends infer T_10 ? T_10 extends PrettifiedGroupIdsToGroupsInfoData ? T_10 extends undefined ? { data: { id: GroupId; name: string; description: string; owner: { id: number; type: string; }; created: string; hasVerifiedBadge: boolean; }[]; } : import("typeforge").Prettify : never : never) | undefined; } & (PrettifiedGroupIdsToGroupsInfoData extends infer T_11 ? T_11 extends PrettifiedGroupIdsToGroupsInfoData ? T_11 extends undefined ? {} : import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData, PrettifiedGroupIdsToGroupsInfoData extends infer T_12 ? T_12 extends PrettifiedGroupIdsToGroupsInfoData ? T_12 extends undefined ? RawGroupIdsToGroupsInfoData : 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 | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: RawGroupIdsToGroupsInfoData) => string) | undefined; getCursorsFn?: ((rawData: { data: { id: GroupId; name: string; description: string; owner: { id: number; type: string; }; created: string; hasVerifiedBadge: boolean; }[]; }) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: { data: { id: GroupId; name: string; description: string; owner: { id: number; type: string; }; created: string; hasVerifiedBadge: boolean; }[]; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: (PrettifiedGroupIdsToGroupsInfoData extends infer T_13 ? T_13 extends PrettifiedGroupIdsToGroupsInfoData ? T_13 extends undefined ? { data: { id: GroupId; name: string; description: string; owner: { id: number; type: string; }; created: string; hasVerifiedBadge: boolean; }[]; } : import("typeforge").Prettify : never : never) | undefined; } & (PrettifiedGroupIdsToGroupsInfoData extends infer T_14 ? T_14 extends PrettifiedGroupIdsToGroupsInfoData ? T_14 extends undefined ? {} : import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData, PrettifiedGroupIdsToGroupsInfoData extends infer T_15 ? T_15 extends PrettifiedGroupIdsToGroupsInfoData ? T_15 extends undefined ? RawGroupIdsToGroupsInfoData : 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 | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: RawGroupIdsToGroupsInfoData) => string) | undefined; getCursorsFn?: ((rawData: { data: { id: GroupId; name: string; description: string; owner: { id: number; type: string; }; created: string; hasVerifiedBadge: boolean; }[]; }) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: { data: { id: GroupId; name: string; description: string; owner: { id: number; type: string; }; created: string; hasVerifiedBadge: boolean; }[]; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: (PrettifiedGroupIdsToGroupsInfoData extends infer T_16 ? T_16 extends PrettifiedGroupIdsToGroupsInfoData ? T_16 extends undefined ? { data: { id: GroupId; name: string; description: string; owner: { id: number; type: string; }; created: string; hasVerifiedBadge: boolean; }[]; } : import("typeforge").Prettify : never : never) | undefined; } & (PrettifiedGroupIdsToGroupsInfoData extends infer T_17 ? T_17 extends PrettifiedGroupIdsToGroupsInfoData ? T_17 extends undefined ? {} : import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData, PrettifiedGroupIdsToGroupsInfoData extends infer T_18 ? T_18 extends PrettifiedGroupIdsToGroupsInfoData ? T_18 extends undefined ? RawGroupIdsToGroupsInfoData : T_18 : never : never> : never : never))["🔒__PRIVATE_RAW_DATA"], undefined>, Exclude<({ method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: RawGroupIdsToGroupsInfoData) => string) | undefined; getCursorsFn?: ((rawData: { data: { id: GroupId; name: string; description: string; owner: { id: number; type: string; }; created: string; hasVerifiedBadge: boolean; }[]; }) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: { data: { id: GroupId; name: string; description: string; owner: { id: number; type: string; }; created: string; hasVerifiedBadge: boolean; }[]; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: (PrettifiedGroupIdsToGroupsInfoData extends infer T_19 ? T_19 extends PrettifiedGroupIdsToGroupsInfoData ? T_19 extends undefined ? { data: { id: GroupId; name: string; description: string; owner: { id: number; type: string; }; created: string; hasVerifiedBadge: boolean; }[]; } : import("typeforge").Prettify : never : never) | undefined; } & (PrettifiedGroupIdsToGroupsInfoData extends infer T_20 ? T_20 extends PrettifiedGroupIdsToGroupsInfoData ? T_20 extends undefined ? {} : import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData, PrettifiedGroupIdsToGroupsInfoData extends infer T_21 ? T_21 extends PrettifiedGroupIdsToGroupsInfoData ? T_21 extends undefined ? RawGroupIdsToGroupsInfoData : 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 | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: RawGroupIdsToGroupsInfoData) => string) | undefined; getCursorsFn?: ((rawData: { data: { id: GroupId; name: string; description: string; owner: { id: number; type: string; }; created: string; hasVerifiedBadge: boolean; }[]; }) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: { data: { id: GroupId; name: string; description: string; owner: { id: number; type: string; }; created: string; hasVerifiedBadge: boolean; }[]; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: (PrettifiedGroupIdsToGroupsInfoData extends infer T_23 ? T_23 extends PrettifiedGroupIdsToGroupsInfoData ? T_23 extends undefined ? { data: { id: GroupId; name: string; description: string; owner: { id: number; type: string; }; created: string; hasVerifiedBadge: boolean; }[]; } : import("typeforge").Prettify : never : never) | undefined; } & (PrettifiedGroupIdsToGroupsInfoData extends infer T_24 ? T_24 extends PrettifiedGroupIdsToGroupsInfoData ? T_24 extends undefined ? {} : import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData, PrettifiedGroupIdsToGroupsInfoData extends infer T_25 ? T_25 extends PrettifiedGroupIdsToGroupsInfoData ? T_25 extends undefined ? RawGroupIdsToGroupsInfoData : 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 a list of all roles for every group that the specified user is in. * @category Groups V2 * @endpoint GET /v2/users/{userId}/groups/roles * @tags [ "Cookie" ] * * @param userId The id of the user to get roles for. * * @example const { data:groups } = await ClassicGroupsApi.allGroupRolesForUser_v2({ userId: 45348281 }) * @exampleData [ { group: { id: 5850082, name: "MightyPart Games", memberCount: 108, hasVerifiedBadge: false }, role: { id: 5850082, name: "Mighty Member", rank: 100 } } ] * @exampleRawBody { data: [ { group: { id: 5850082, name: "MightyPart Games", memberCount: 108, hasVerifiedBadge: false }, role: { id: 5850082, name: "Mighty Member", rank: 100 } } ] } */ export declare const allGroupRolesForUser_v2: import("../../apiGroup/apiGroup.types").CallApiMethod<{ userId: Identifier; }, { method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: { data: { group: { id: number; name: string; memberCount: number; hasVerifiedBadge: boolean; }; role: { id: number; name: string; rank: number; }; }[]; }) => string) | undefined; getCursorsFn?: ((rawData: { data: { group: { id: number; name: string; memberCount: number; hasVerifiedBadge: boolean; }; role: { id: number; name: string; rank: number; }; }[]; }) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: { data: { group: { id: number; name: string; memberCount: number; hasVerifiedBadge: boolean; }; role: { id: number; name: string; rank: number; }; }[]; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: { group: { id: number; name: string; memberCount: number; hasVerifiedBadge: boolean; }; role: { id: number; name: string; rank: number; }; }[] | undefined; } & import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<{ data: { group: { id: number; name: string; memberCount: number; hasVerifiedBadge: boolean; }; role: { id: number; name: string; rank: number; }; }[]; }, { group: { id: number; name: string; memberCount: number; hasVerifiedBadge: boolean; }; role: { id: number; name: string; rank: number; }; }[]>, false>; /** * Gets a list of group wall posts. * @category Wall * @endpoint GET /v2/groups/{groupId}/wall/posts * @tags [ "?Cookie" ] * * @param groupId The id of the group to get wall posts for. * @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:wallPosts } = await ClassicGroupsApi.groupWallPosts_V2({ groupId: 5850082 }) * @exampleData [ { id: 2724986278, poster: { user: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, role: { id: 38353813, name: "Mighty Member", rank: 1 } }, body: "Lorem ipsum dolor sit amet.", created: 2022-11-19T16:30:38.197Z, updated: 2022-11-19T16:30:38.197Z } ] * @exampleRawBody { previousPageCursor: null, nextPageCursor: "2549745135_1_00ad0f026ca1d251093fc548c366b7ea", data: [ { id: 2724986278, poster: { user: { hasVerifiedBadge: false, userId: 45348281, username: "MightyPart", displayName: "MightyPart" }, role: { id: 38353813, name: "Mighty Member", rank: 1 } }, body: "Lorem ipsum dolor sit amet.", created: 2022-11-19T16:30:38.197Z, updated: 2022-11-19T16:30:38.197Z } ] } */ export declare const groupWallPosts_V2: import("../../apiGroup/apiGroup.types").CallApiMethod<{ groupId: Identifier; limit?: 10 | 25 | 50 | 100 | undefined; sortOrder?: SortOrder | undefined; cursor?: string | undefined; }, { method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: { previousPageCursor?: string | undefined; nextPageCursor?: string | undefined; data: { id: number; poster: { user: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; role: { id: number; name: string; rank: number; }; }; body: 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}`; }[]; }) => string) | undefined; getCursorsFn?: ((rawData: { previousPageCursor?: string | undefined; nextPageCursor?: string | undefined; data: { id: number; poster: { user: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; role: { id: number; name: string; rank: number; }; }; body: 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}`; }[]; }) => [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: { id: number; poster: { user: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; role: { id: number; name: string; rank: number; }; }; body: 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}`; }[]; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: { id: number; poster: { user: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; role: { id: number; name: string; rank: number; }; }; body: string; created: Date; updated: Date; }[] | undefined; } & import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<{ previousPageCursor?: string | undefined; nextPageCursor?: string | undefined; data: { id: number; poster: { user: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; role: { id: number; name: string; rank: number; }; }; body: 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}`; }[]; }, { id: number; poster: { user: { hasVerifiedBadge: boolean; userId: number; username: string; displayName: string; }; role: { id: number; name: string; rank: number; }; }; body: string; created: Date; updated: Date; }[]>, true>; /** * Gets a list of group bans. * @category Bans * @endpoint GET /v1/groups/{groupId}/bans * * @param groupId The id of the group to get bans for. * @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:bans } = await ClassicGroupsApi.groupBans({ groupId: 5850082 }) * @exampleData [{"user":{"hasVerifiedBadge":false,"userId":1599940985,"username":"TheNamelessBot","displayName":"TheNamelessBot"},"actingUser":{"user":{"hasVerifiedBadge":false,"userId":45348281,"username":"MightyPart","displayName":"Mighty"},"role":{"id":38353811,"name":"NamelessGuy2005 - Scriptor","rank":255}},"created":"2025-05-17T17:04:15.646Z"}] * @exampleRawBody {"previousPageCursor":null,"nextPageCursor":null,"data":[{"user":{"hasVerifiedBadge":false,"userId":1599940985,"username":"TheNamelessBot","displayName":"TheNamelessBot"},"actingUser":{"user":{"hasVerifiedBadge":false,"userId":45348281,"username":"MightyPart","displayName":"Mighty"},"role":{"id":38353811,"name":"NamelessGuy2005 - Scriptor","rank":255}},"created":"2025-05-17T17:04:15.646Z"}]} */ export declare const groupBans: import("../../apiGroup/apiGroup.types").CallApiMethod<{ groupId: Identifier; limit?: number | undefined; sortOrder?: "Asc" | "Desc" | undefined; cursor?: string | undefined; }, { method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record | undefined; headers?: Record | undefined; body?: string | number | Record | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: RawGroupBansData) => string) | undefined; getCursorsFn?: ((rawData: { previousPageCursor?: string | undefined; nextPageCursor?: string | undefined; data: BanGroupMemberData[]; }) => [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: BanGroupMemberData[]; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: BanGroupMemberData[] | undefined; } & import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData, true>; /** * Bans a member from a group. * @category Bans * @endpoint POST /v1/groups/{groupId}/bans/{userId} * * @param groupId The id of the group to ban a member from. * @param userId The id of the member to ban. * * @example const { data:banInfo } = await ClassicGroupsApi.banGroupMember({ groupId: 5850082, userId: 1599940985 }) * @exampleData {"user":{"hasVerifiedBadge":false,"userId":1599940985,"username":"TheNamelessBot","displayName":"TheNamelessBot"},"actingUser":{"user":{"hasVerifiedBadge":false,"userId":45348281,"username":"MightyPart","displayName":"Mighty"},"role":{"id":38353811,"name":"NamelessGuy2005 - Scriptor","rank":255}},"created":"2025-05-17T17:04:15.646Z"} * @exampleRawBody {"user":{"hasVerifiedBadge":false,"userId":1599940985,"username":"TheNamelessBot","displayName":"TheNamelessBot"},"actingUser":{"user":{"hasVerifiedBadge":false,"userId":45348281,"username":"MightyPart","displayName":"Mighty"},"role":{"id":38353811,"name":"NamelessGuy2005 - Scriptor","rank":255}},"created":"2025-05-17T17:04:15.646Z"} */ export declare const banGroupMember: (this: any, args: { groupId: Identifier; userId: UserId; }) => Promise<{ data: { user: { hasVerifiedBadge: boolean; userId: UserId; username: string; displayName: string; }; actingUser: { user: { hasVerifiedBadge: boolean; userId: Identifier; username: string; displayName: string; }; role: { id: Identifier; name: string; rank: number; }; }; 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}`; }; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: { user: { hasVerifiedBadge: boolean; userId: UserId; username: string; displayName: string; }; actingUser: { user: { hasVerifiedBadge: boolean; userId: Identifier; username: string; displayName: string; }; role: { id: Identifier; name: string; rank: number; }; }; 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}`; }; }; 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: { user: { hasVerifiedBadge: boolean; userId: UserId; username: string; displayName: string; }; actingUser: { user: { hasVerifiedBadge: boolean; userId: Identifier; username: string; displayName: string; }; role: { id: Identifier; name: string; rank: number; }; }; 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}`; }; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: { user: { hasVerifiedBadge: boolean; userId: UserId; username: string; displayName: string; }; actingUser: { user: { hasVerifiedBadge: boolean; userId: Identifier; username: string; displayName: string; }; role: { id: Identifier; name: string; rank: number; }; }; 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}`; }; }; 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; }; }>; }>; /** * Unbans a member from a group. * @category Bans * @endpoint DELETE /v1/groups/{groupId}/bans/{userId} * * @param groupId The id of the group to unban a member from. * @param userId The id of the member to unban. * * @example const { data:success } = await ClassicGroupsApi.unbanGroupMember({ groupId: 5850082, userId: 1599940985 }) * @exampleData true * @exampleRawBody {} */ export declare const unbanGroupMember: (this: any, args: { groupId: Identifier; userId: UserId; }) => Promise<{ data: {}; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: boolean; }; 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: {}; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: boolean; }; 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; }; }>; }>;