openblox
Version:
Roblox API Wrapper For Both Classic And OpenCloud APIs.
847 lines • 157 kB
TypeScript
import type { Identifier, ISODateTime, ArrayNonEmptyIfConst } from "typeforge";
import type { SortOrder } from "../../../utils/utils.types";
import type { AuthenticatedUserInfoData, PrettifiedAuthenticatedUserCountryCodeData, PrettifiedAuthenticatedUserGenderData, PrettifiedUserSearchData, PrettifiedUserIdsToUsersInfoData, PrettifiedUsernamesToUsersInfoData, RawAuthenticatedUserAgeBracketData, RawAuthenticatedUserBirthdateData, RawAuthenticatedUserCountryCodeData, RawAuthenticatedUserDescriptionData, RawAuthenticatedUserGenderData, RawAuthenticatedUserRolesData, RawUsernamesToUsersInfoData } from "./users.types";
/**
* Gets the birthdate for the currently authenticated user.
* @category Account Information
* @endpoint GET /v1/birthdate
* @tags [ "Auth Needed" ]
*
* @example const { data:birthdate } = await ClassicUsersApi.authenticatedUserBirthdate();
* @exampleData 2005-02-03T00:00:00.000Z
* @exampleRawBody { birthMonth: 2, birthDay: 3, birthYear: 2005 }
*/
export declare const authenticatedUserBirthdate: import("../../apiGroup/apiGroup.types").CallApiMethod<Record<any, any>, {
method: import("../../../utils/utils.types").RestMethod;
path: `/${string}`;
name: string;
searchParams?: string | Record<string, any> | undefined;
headers?: Record<string, any> | undefined;
body?: string | number | Record<string, any> | undefined;
formData?: FormData | undefined;
applyFieldMask?: boolean | undefined;
pathToPoll?: ((rawData: RawAuthenticatedUserBirthdateData) => string) | undefined;
getCursorsFn?: ((rawData: {
birthMonth: number;
birthDay: number;
birthYear: number;
}) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined;
"\uD83D\uDD12__PRIVATE_RAW_DATA"?: {
birthMonth: number;
birthDay: number;
birthYear: number;
} | undefined;
"\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: Date | undefined;
} & import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<RawAuthenticatedUserBirthdateData, Date>, false>;
/**
* Gets the description for the currently authenticated user.
* @category Account Information
* @endpoint GET /v1/description
* @tags [ "Auth Needed" ]
*
* @example const { data:description } = await ClassicUsersApi.authenticatedUserDescription();
* @exampleData Lorem ipsum dolor sit amet consectetur adipiscing elit.
* @exampleRawBody { description: "Lorem ipsum dolor sit amet consectetur adipiscing elit." }
*/
export declare const authenticatedUserDescription: import("../../apiGroup/apiGroup.types").CallApiMethod<Record<any, any>, {
method: import("../../../utils/utils.types").RestMethod;
path: `/${string}`;
name: string;
searchParams?: string | Record<string, any> | undefined;
headers?: Record<string, any> | undefined;
body?: string | number | Record<string, any> | undefined;
formData?: FormData | undefined;
applyFieldMask?: boolean | undefined;
pathToPoll?: ((rawData: RawAuthenticatedUserDescriptionData) => string) | undefined;
getCursorsFn?: ((rawData: {
description: string;
}) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined;
"\uD83D\uDD12__PRIVATE_RAW_DATA"?: {
description: string;
} | undefined;
"\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: string | undefined;
} & import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<RawAuthenticatedUserDescriptionData, string>, false>;
/**
* Gets the gender for the currently authenticated user.
* @category Account Information
* @endpoint GET /v1/gender
* @tags [ "Auth Needed" ]
*
* @example const { data:description } = await ClassicUsersApi.authenticatedUserGender();
* @exampleData Male
* @exampleRawBody { gender: 2 }
*/
export declare const authenticatedUserGender: import("../../apiGroup/apiGroup.types").CallApiMethod<Record<any, any>, {
method: import("../../../utils/utils.types").RestMethod;
path: `/${string}`;
name: string;
searchParams?: string | Record<string, any> | undefined;
headers?: Record<string, any> | undefined;
body?: string | number | Record<string, any> | undefined;
formData?: FormData | undefined;
applyFieldMask?: boolean | undefined;
pathToPoll?: ((rawData: RawAuthenticatedUserGenderData) => string) | undefined;
getCursorsFn?: ((rawData: {
gender: 2 | 1 | 3;
}) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined;
"\uD83D\uDD12__PRIVATE_RAW_DATA"?: {
gender: 2 | 1 | 3;
} | undefined;
"\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: PrettifiedAuthenticatedUserGenderData | undefined;
} & import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<RawAuthenticatedUserGenderData, PrettifiedAuthenticatedUserGenderData>, false>;
/**
* Validates a display name for a new user (NOTE: This does not change the display name).
* @category Display Names
* @endpoint GET /v1/display-names/validate
* @detailedEndpoint GET /v1/display-names/validate ? displayName={displayName} & birthdate={birthdate}
*
* @param displayName The display name to be validated.
* @param birthdate The birthdate of the new user.
*
* @example const { data:displayNameIsValid } = await ClassicUsersApi.validateDisplayNameForNewUser({ displayName: "Hello", birthdate: "2023-07-27T04:14:57+0000" })
* @exampleData true
* @exampleRawBody {}
*/
export declare const validateDisplayNameForNewUser: import("../../apiGroup/apiGroup.types").CallApiMethod<{
displayName: string;
birthdate: ISODateTime | Date;
}, {
method: import("../../../utils/utils.types").RestMethod;
path: `/${string}`;
name: string;
searchParams?: string | Record<string, any> | undefined;
headers?: Record<string, any> | undefined;
body?: string | number | Record<string, any> | undefined;
formData?: FormData | undefined;
applyFieldMask?: boolean | undefined;
pathToPoll?: ((rawData: {}) => 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>;
/**
* Validates a display name for an existing user (NOTE: This does not change the display name).
* @category Display Names
* @endpoint GET /v1/users/{userId}/display-names/validate
* @detailedEndpoint GET /v1/users/{userId}/display-names/validate ? displayName={displayName}
*
* @param displayName The display name to be validated.
* @param userId The id of the existing user.
*
* @example const { data:displayNameIsValid } = await ClassicUsersApi.validateDisplayNameForExistingUser({ userId: 45348281, displayName: "Hello" })
* @exampleData true
* @exampleRawBody {}
*/
export declare const validateDisplayNameForExistingUser: import("../../apiGroup/apiGroup.types").CallApiMethod<{
userId: Identifier;
displayName: string;
}, {
method: import("../../../utils/utils.types").RestMethod;
path: `/${string}`;
name: string;
searchParams?: string | Record<string, any> | undefined;
headers?: Record<string, any> | undefined;
body?: string | number | Record<string, any> | undefined;
formData?: FormData | undefined;
applyFieldMask?: boolean | undefined;
pathToPoll?: ((rawData: {}) => 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 display name for the currently authenticated user.
* @category Display Names
* @endpoint PATCH /v1/users/{userId}/display-names
* @tags [ "Auth Needed", "XCSRF" ]
*
* @param newDisplayName The new display name for the authenticated user.
* @param userId The id of the currently authenticated user (the endpoint requires this for some reason).
*
* @example const { data:displayNameUpdated } = await ClassicUsersApi.authenticatedUserSetDisplayName({ userId: 45348281, newDisplayName: "LoremIpsum" })
* @exampleData true
* @exampleRawBody {}
*/
export declare const authenticatedUserSetDisplayName: import("../../apiGroup/apiGroup.types").CallApiMethod<{
userId: Identifier;
newDisplayName: string;
}, {
method: import("../../../utils/utils.types").RestMethod;
path: `/${string}`;
name: string;
searchParams?: string | Record<string, any> | undefined;
headers?: Record<string, any> | undefined;
body?: string | number | Record<string, any> | undefined;
formData?: FormData | undefined;
applyFieldMask?: boolean | undefined;
pathToPoll?: ((rawData: {}) => 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 information about a user from their id.
* @category Users
* @endpoint GET /v1/users/{userId}
*
* @param userId The id of the user to get detailed info about.
*
* @example const { data:userInfo } = await ClassicUsersApi.userInfo({ userId: 45348281 });
* @exampleData { description: "Lorem ipsum dolor sit amet consectetur adipiscing elit.", created: 2013-07-13T07:50:00.083Z, isBanned: false, externalAppDisplayName: null, hasVerifiedBadge: false, id: 45348281, name: "MightyPart", displayName: "MightyPart" }
* @exampleRawBody { description: "Lorem ipsum dolor sit amet consectetur adipiscing elit.", created: "2013-07-13T07:50:00.083Z", isBanned: false, externalAppDisplayName: null, hasVerifiedBadge: false, id: 45348281, name: "MightyPart", displayName: "MightyPart" }
*/
export declare const userInfo: <UserId extends Identifier>(this: any, args: {
userId: UserId;
}) => Promise<{
data: {
description: string;
created: Date;
isBanned: boolean;
externalAppDisplayName: string | null;
hasVerifiedBadge: boolean;
id: UserId;
name: string;
displayName: string;
};
response: {
fullResponse: unknown;
url: `https://${string}`;
method: import("../../../utils/utils.types").RestMethod;
success: boolean;
statusCode: number;
headers: Headers;
body: {
description: 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}`;
isBanned: boolean;
externalAppDisplayName: string | null;
hasVerifiedBadge: boolean;
id: UserId;
name: string;
displayName: string;
};
};
} & {
again: () => Promise<{
data: {
description: string;
created: Date;
isBanned: boolean;
externalAppDisplayName: string | null;
hasVerifiedBadge: boolean;
id: UserId;
name: string;
displayName: string;
};
response: {
fullResponse: unknown;
url: `https://${string}`;
method: import("../../../utils/utils.types").RestMethod;
success: boolean;
statusCode: number;
headers: Headers;
body: {
description: 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}`;
isBanned: boolean;
externalAppDisplayName: string | null;
hasVerifiedBadge: boolean;
id: UserId;
name: string;
displayName: string;
};
};
}>;
}>;
/**
* Gets information about the currently authenticated user.
* @category Users
* @endpoint GET /v1/users/authenticated
* @tags [ "Auth Needed" ]
*
* @example const { data:userInfo } = await ClassicUsersApi.authenticatedUserInfo();
* @exampleData { id: 45348281, name: "MightyPart", displayName: "MightyPart" }
* @exampleRawBody { id: 45348281, name: "MightyPart", displayName: "MightyPart" }
*/
export declare const authenticatedUserInfo: import("../../apiGroup/apiGroup.types").CallApiMethod<Record<any, any>, {
method: import("../../../utils/utils.types").RestMethod;
path: `/${string}`;
name: string;
searchParams?: string | Record<string, any> | undefined;
headers?: Record<string, any> | undefined;
body?: string | number | Record<string, any> | undefined;
formData?: FormData | undefined;
applyFieldMask?: boolean | undefined;
pathToPoll?: ((rawData: AuthenticatedUserInfoData) => string) | undefined;
getCursorsFn?: ((rawData: {
id: number;
name: string;
displayName: string;
}) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined;
"\uD83D\uDD12__PRIVATE_RAW_DATA"?: {
id: number;
name: string;
displayName: string;
} | undefined;
"\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: {
id: number;
name: string;
displayName: string;
} | undefined;
}, false>;
/**
* Gets the currently authenticated user's age bracket.
* @category Users
* @endpoint GET /v1/users/authenticated/age-bracket
* @tags [ "Auth Needed" ]
*
* @example const { data:ageBracket } = await ClassicUsersApi.authenticatedUserAgeBracket();
* @exampleData 13+
* @exampleRawBody { ageBracket: 0 }
*/
export declare const authenticatedUserAgeBracket: import("../../apiGroup/apiGroup.types").CallApiMethod<Record<any, any>, {
method: import("../../../utils/utils.types").RestMethod;
path: `/${string}`;
name: string;
searchParams?: string | Record<string, any> | undefined;
headers?: Record<string, any> | undefined;
body?: string | number | Record<string, any> | undefined;
formData?: FormData | undefined;
applyFieldMask?: boolean | undefined;
pathToPoll?: ((rawData: RawAuthenticatedUserAgeBracketData) => string) | undefined;
getCursorsFn?: ((rawData: {
ageBracket: 0 | 1;
}) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined;
"\uD83D\uDD12__PRIVATE_RAW_DATA"?: {
ageBracket: 0 | 1;
} | undefined;
"\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: "13+" | "<13" | undefined;
} & import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<RawAuthenticatedUserAgeBracketData, "13+" | "<13">, false>;
/**
* Gets the currently authenticated user's country code.
* @category Users
* @endpoint GET /v1/users/authenticated/country-code
* @tags [ "Auth Needed" ]
*
* @example const { data:countryCode } = await ClassicUsersApi.authenticatedUserCountryCode();
* @exampleData DE
* @exampleRawBody { countryCode: "DE" }
*/
export declare const authenticatedUserCountryCode: import("../../apiGroup/apiGroup.types").CallApiMethod<Record<any, any>, {
method: import("../../../utils/utils.types").RestMethod;
path: `/${string}`;
name: string;
searchParams?: string | Record<string, any> | undefined;
headers?: Record<string, any> | undefined;
body?: string | number | Record<string, any> | undefined;
formData?: FormData | undefined;
applyFieldMask?: boolean | undefined;
pathToPoll?: ((rawData: RawAuthenticatedUserCountryCodeData) => string) | undefined;
getCursorsFn?: ((rawData: {
countryCode: PrettifiedAuthenticatedUserCountryCodeData;
}) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined;
"\uD83D\uDD12__PRIVATE_RAW_DATA"?: {
countryCode: PrettifiedAuthenticatedUserCountryCodeData;
} | undefined;
"\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: PrettifiedAuthenticatedUserCountryCodeData | undefined;
} & import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<RawAuthenticatedUserCountryCodeData, PrettifiedAuthenticatedUserCountryCodeData>, false>;
/**
* Gets the currently authenticated user's roles.
* @category Users
* @endpoint GET /v1/users/authenticated/roles
* @tags [ "Auth Needed" ]
*
* @example const { data:roles } = await ClassicUsersApi.authenticatedUserRoles();
* @exampleData [ "BetaTester" ]
* @exampleRawBody { roles: [ "BetaTester" ] }
*/
export declare const authenticatedUserRoles: import("../../apiGroup/apiGroup.types").CallApiMethod<Record<any, any>, {
method: import("../../../utils/utils.types").RestMethod;
path: `/${string}`;
name: string;
searchParams?: string | Record<string, any> | undefined;
headers?: Record<string, any> | undefined;
body?: string | number | Record<string, any> | undefined;
formData?: FormData | undefined;
applyFieldMask?: boolean | undefined;
pathToPoll?: ((rawData: RawAuthenticatedUserRolesData) => string) | undefined;
getCursorsFn?: ((rawData: {
roles: string[];
}) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined;
"\uD83D\uDD12__PRIVATE_RAW_DATA"?: {
roles: string[];
} | undefined;
"\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: string[] | undefined;
} & import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<RawAuthenticatedUserRolesData, string[]>, false>;
/**
* Gets information about multiple users from their usernames.
* @category Users
* @endpoint POST /v1/usernames/users
*
* @param usernames The usernames of the users to get info about.
* @param excludeBannedUsers Dictates if info about banned users should be excluded from the returned data. (defaults to false).
*
* @example const { data:usersInfo } = await ClassicUsersApi.usersInfoFromNames({ usernames: [ "MightyPart" ] });
* @exampleData { MightyPart: { hasVerifiedBadge: false, id: 45348281, name: "MightyPart", displayName: "MightyPart" } }
* @exampleRawBody { data: [ { requestedUsername: "MightyPart", hasVerifiedBadge: false, id: 45348281, name: "MightyPart", displayName: "MightyPart" } ] }
*/
export declare const usersInfoFromNames: <Username extends string>(this: any, args: {
usernames: ArrayNonEmptyIfConst<Username>;
excludeBannedUsers?: boolean | undefined;
}) => Promise<{
data: Exclude<({
method: import("../../../utils/utils.types").RestMethod;
path: `/${string}`;
name: string;
searchParams?: string | Record<string, any> | undefined;
headers?: Record<string, any> | undefined;
body?: string | number | Record<string, any> | undefined;
formData?: FormData | undefined;
applyFieldMask?: boolean | undefined;
pathToPoll?: ((rawData: RawUsernamesToUsersInfoData<Username>) => string) | undefined;
getCursorsFn?: ((rawData: {
data: {
/**
* Validates a display name for a new user (NOTE: This does not change the display name).
* @category Display Names
* @endpoint GET /v1/display-names/validate
* @detailedEndpoint GET /v1/display-names/validate ? displayName={displayName} & birthdate={birthdate}
*
* @param displayName The display name to be validated.
* @param birthdate The birthdate of the new user.
*
* @example const { data:displayNameIsValid } = await ClassicUsersApi.validateDisplayNameForNewUser({ displayName: "Hello", birthdate: "2023-07-27T04:14:57+0000" })
* @exampleData true
* @exampleRawBody {}
*/
requestedUsername: Username;
/**
* Validates a display name for a new user (NOTE: This does not change the display name).
* @category Display Names
* @endpoint GET /v1/display-names/validate
* @detailedEndpoint GET /v1/display-names/validate ? displayName={displayName} & birthdate={birthdate}
*
* @param displayName The display name to be validated.
* @param birthdate The birthdate of the new user.
*
* @example const { data:displayNameIsValid } = await ClassicUsersApi.validateDisplayNameForNewUser({ displayName: "Hello", birthdate: "2023-07-27T04:14:57+0000" })
* @exampleData true
* @exampleRawBody {}
*/
hasVerifiedBadge: boolean;
/**
* Validates a display name for a new user (NOTE: This does not change the display name).
* @category Display Names
* @endpoint GET /v1/display-names/validate
* @detailedEndpoint GET /v1/display-names/validate ? displayName={displayName} & birthdate={birthdate}
*
* @param displayName The display name to be validated.
* @param birthdate The birthdate of the new user.
*
* @example const { data:displayNameIsValid } = await ClassicUsersApi.validateDisplayNameForNewUser({ displayName: "Hello", birthdate: "2023-07-27T04:14:57+0000" })
* @exampleData true
* @exampleRawBody {}
*/
id: number;
name: string;
/**
* Validates a display name for a new user (NOTE: This does not change the display name).
* @category Display Names
* @endpoint GET /v1/display-names/validate
* @detailedEndpoint GET /v1/display-names/validate ? displayName={displayName} & birthdate={birthdate}
*
* @param displayName The display name to be validated.
* @param birthdate The birthdate of the new user.
*
* @example const { data:displayNameIsValid } = await ClassicUsersApi.validateDisplayNameForNewUser({ displayName: "Hello", birthdate: "2023-07-27T04:14:57+0000" })
* @exampleData true
* @exampleRawBody {}
*/
displayName: string;
}[];
}) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined;
"\uD83D\uDD12__PRIVATE_RAW_DATA"?: {
data: {
/**
* Validates a display name for a new user (NOTE: This does not change the display name).
* @category Display Names
* @endpoint GET /v1/display-names/validate
* @detailedEndpoint GET /v1/display-names/validate ? displayName={displayName} & birthdate={birthdate}
*
* @param displayName The display name to be validated.
* @param birthdate The birthdate of the new user.
*
* @example const { data:displayNameIsValid } = await ClassicUsersApi.validateDisplayNameForNewUser({ displayName: "Hello", birthdate: "2023-07-27T04:14:57+0000" })
* @exampleData true
* @exampleRawBody {}
*/
requestedUsername: Username;
/**
* Validates a display name for a new user (NOTE: This does not change the display name).
* @category Display Names
* @endpoint GET /v1/display-names/validate
* @detailedEndpoint GET /v1/display-names/validate ? displayName={displayName} & birthdate={birthdate}
*
* @param displayName The display name to be validated.
* @param birthdate The birthdate of the new user.
*
* @example const { data:displayNameIsValid } = await ClassicUsersApi.validateDisplayNameForNewUser({ displayName: "Hello", birthdate: "2023-07-27T04:14:57+0000" })
* @exampleData true
* @exampleRawBody {}
*/
hasVerifiedBadge: boolean;
/**
* Validates a display name for a new user (NOTE: This does not change the display name).
* @category Display Names
* @endpoint GET /v1/display-names/validate
* @detailedEndpoint GET /v1/display-names/validate ? displayName={displayName} & birthdate={birthdate}
*
* @param displayName The display name to be validated.
* @param birthdate The birthdate of the new user.
*
* @example const { data:displayNameIsValid } = await ClassicUsersApi.validateDisplayNameForNewUser({ displayName: "Hello", birthdate: "2023-07-27T04:14:57+0000" })
* @exampleData true
* @exampleRawBody {}
*/
id: number;
name: string;
/**
* Validates a display name for a new user (NOTE: This does not change the display name).
* @category Display Names
* @endpoint GET /v1/display-names/validate
* @detailedEndpoint GET /v1/display-names/validate ? displayName={displayName} & birthdate={birthdate}
*
* @param displayName The display name to be validated.
* @param birthdate The birthdate of the new user.
*
* @example const { data:displayNameIsValid } = await ClassicUsersApi.validateDisplayNameForNewUser({ displayName: "Hello", birthdate: "2023-07-27T04:14:57+0000" })
* @exampleData true
* @exampleRawBody {}
*/
displayName: string;
}[];
} | undefined;
"\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: (PrettifiedUsernamesToUsersInfoData<Username> extends infer T ? T extends PrettifiedUsernamesToUsersInfoData<Username> ? T extends undefined ? {
data: {
/**
* Validates a display name for a new user (NOTE: This does not change the display name).
* @category Display Names
* @endpoint GET /v1/display-names/validate
* @detailedEndpoint GET /v1/display-names/validate ? displayName={displayName} & birthdate={birthdate}
*
* @param displayName The display name to be validated.
* @param birthdate The birthdate of the new user.
*
* @example const { data:displayNameIsValid } = await ClassicUsersApi.validateDisplayNameForNewUser({ displayName: "Hello", birthdate: "2023-07-27T04:14:57+0000" })
* @exampleData true
* @exampleRawBody {}
*/
requestedUsername: Username;
/**
* Validates a display name for a new user (NOTE: This does not change the display name).
* @category Display Names
* @endpoint GET /v1/display-names/validate
* @detailedEndpoint GET /v1/display-names/validate ? displayName={displayName} & birthdate={birthdate}
*
* @param displayName The display name to be validated.
* @param birthdate The birthdate of the new user.
*
* @example const { data:displayNameIsValid } = await ClassicUsersApi.validateDisplayNameForNewUser({ displayName: "Hello", birthdate: "2023-07-27T04:14:57+0000" })
* @exampleData true
* @exampleRawBody {}
*/
hasVerifiedBadge: boolean;
/**
* Validates a display name for a new user (NOTE: This does not change the display name).
* @category Display Names
* @endpoint GET /v1/display-names/validate
* @detailedEndpoint GET /v1/display-names/validate ? displayName={displayName} & birthdate={birthdate}
*
* @param displayName The display name to be validated.
* @param birthdate The birthdate of the new user.
*
* @example const { data:displayNameIsValid } = await ClassicUsersApi.validateDisplayNameForNewUser({ displayName: "Hello", birthdate: "2023-07-27T04:14:57+0000" })
* @exampleData true
* @exampleRawBody {}
*/
id: number;
name: string;
/**
* Validates a display name for a new user (NOTE: This does not change the display name).
* @category Display Names
* @endpoint GET /v1/display-names/validate
* @detailedEndpoint GET /v1/display-names/validate ? displayName={displayName} & birthdate={birthdate}
*
* @param displayName The display name to be validated.
* @param birthdate The birthdate of the new user.
*
* @example const { data:displayNameIsValid } = await ClassicUsersApi.validateDisplayNameForNewUser({ displayName: "Hello", birthdate: "2023-07-27T04:14:57+0000" })
* @exampleData true
* @exampleRawBody {}
*/
displayName: string;
}[];
} : import("typeforge").Prettify<T, T extends Date ? true : false> : never : never) | undefined;
} & (PrettifiedUsernamesToUsersInfoData<Username> extends infer T_1 ? T_1 extends PrettifiedUsernamesToUsersInfoData<Username> ? T_1 extends undefined ? {} : import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<RawUsernamesToUsersInfoData<Username>, PrettifiedUsernamesToUsersInfoData<Username> extends infer T_2 ? T_2 extends PrettifiedUsernamesToUsersInfoData<Username> ? T_2 extends undefined ? RawUsernamesToUsersInfoData<Username> : T_2 : never : never> : never : never))["🔒__PRIVATE_FORMATTED_DATA"], undefined>;
response: {
fullResponse: unknown;
url: `https://${string}`;
method: import("../../../utils/utils.types").RestMethod;
success: boolean;
statusCode: number;
headers: Headers;
body: import("typeforge").Prettify<Exclude<({
method: import("../../../utils/utils.types").RestMethod;
path: `/${string}`;
name: string;
searchParams?: string | Record<string, any> | undefined;
headers?: Record<string, any> | undefined;
body?: string | number | Record<string, any> | undefined;
formData?: FormData | undefined;
applyFieldMask?: boolean | undefined;
pathToPoll?: ((rawData: RawUsernamesToUsersInfoData<Username>) => string) | undefined;
getCursorsFn?: ((rawData: {
data: {
/**
* Validates a display name for a new user (NOTE: This does not change the display name).
* @category Display Names
* @endpoint GET /v1/display-names/validate
* @detailedEndpoint GET /v1/display-names/validate ? displayName={displayName} & birthdate={birthdate}
*
* @param displayName The display name to be validated.
* @param birthdate The birthdate of the new user.
*
* @example const { data:displayNameIsValid } = await ClassicUsersApi.validateDisplayNameForNewUser({ displayName: "Hello", birthdate: "2023-07-27T04:14:57+0000" })
* @exampleData true
* @exampleRawBody {}
*/
requestedUsername: Username;
/**
* Validates a display name for a new user (NOTE: This does not change the display name).
* @category Display Names
* @endpoint GET /v1/display-names/validate
* @detailedEndpoint GET /v1/display-names/validate ? displayName={displayName} & birthdate={birthdate}
*
* @param displayName The display name to be validated.
* @param birthdate The birthdate of the new user.
*
* @example const { data:displayNameIsValid } = await ClassicUsersApi.validateDisplayNameForNewUser({ displayName: "Hello", birthdate: "2023-07-27T04:14:57+0000" })
* @exampleData true
* @exampleRawBody {}
*/
hasVerifiedBadge: boolean;
/**
* Validates a display name for a new user (NOTE: This does not change the display name).
* @category Display Names
* @endpoint GET /v1/display-names/validate
* @detailedEndpoint GET /v1/display-names/validate ? displayName={displayName} & birthdate={birthdate}
*
* @param displayName The display name to be validated.
* @param birthdate The birthdate of the new user.
*
* @example const { data:displayNameIsValid } = await ClassicUsersApi.validateDisplayNameForNewUser({ displayName: "Hello", birthdate: "2023-07-27T04:14:57+0000" })
* @exampleData true
* @exampleRawBody {}
*/
id: number;
name: string;
/**
* Validates a display name for a new user (NOTE: This does not change the display name).
* @category Display Names
* @endpoint GET /v1/display-names/validate
* @detailedEndpoint GET /v1/display-names/validate ? displayName={displayName} & birthdate={birthdate}
*
* @param displayName The display name to be validated.
* @param birthdate The birthdate of the new user.
*
* @example const { data:displayNameIsValid } = await ClassicUsersApi.validateDisplayNameForNewUser({ displayName: "Hello", birthdate: "2023-07-27T04:14:57+0000" })
* @exampleData true
* @exampleRawBody {}
*/
displayName: string;
}[];
}) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined;
"\uD83D\uDD12__PRIVATE_RAW_DATA"?: {
data: {
/**
* Validates a display name for a new user (NOTE: This does not change the display name).
* @category Display Names
* @endpoint GET /v1/display-names/validate
* @detailedEndpoint GET /v1/display-names/validate ? displayName={displayName} & birthdate={birthdate}
*
* @param displayName The display name to be validated.
* @param birthdate The birthdate of the new user.
*
* @example const { data:displayNameIsValid } = await ClassicUsersApi.validateDisplayNameForNewUser({ displayName: "Hello", birthdate: "2023-07-27T04:14:57+0000" })
* @exampleData true
* @exampleRawBody {}
*/
requestedUsername: Username;
/**
* Validates a display name for a new user (NOTE: This does not change the display name).
* @category Display Names
* @endpoint GET /v1/display-names/validate
* @detailedEndpoint GET /v1/display-names/validate ? displayName={displayName} & birthdate={birthdate}
*
* @param displayName The display name to be validated.
* @param birthdate The birthdate of the new user.
*
* @example const { data:displayNameIsValid } = await ClassicUsersApi.validateDisplayNameForNewUser({ displayName: "Hello", birthdate: "2023-07-27T04:14:57+0000" })
* @exampleData true
* @exampleRawBody {}
*/
hasVerifiedBadge: boolean;
/**
* Validates a display name for a new user (NOTE: This does not change the display name).
* @category Display Names
* @endpoint GET /v1/display-names/validate
* @detailedEndpoint GET /v1/display-names/validate ? displayName={displayName} & birthdate={birthdate}
*
* @param displayName The display name to be validated.
* @param birthdate The birthdate of the new user.
*
* @example const { data:displayNameIsValid } = await ClassicUsersApi.validateDisplayNameForNewUser({ displayName: "Hello", birthdate: "2023-07-27T04:14:57+0000" })
* @exampleData true
* @exampleRawBody {}
*/
id: number;
name: string;
/**
* Validates a display name for a new user (NOTE: This does not change the display name).
* @category Display Names
* @endpoint GET /v1/display-names/validate
* @detailedEndpoint GET /v1/display-names/validate ? displayName={displayName} & birthdate={birthdate}
*
* @param displayName The display name to be validated.
* @param birthdate The birthdate of the new user.
*
* @example const { data:displayNameIsValid } = await ClassicUsersApi.validateDisplayNameForNewUser({ displayName: "Hello", birthdate: "2023-07-27T04:14:57+0000" })
* @exampleData true
* @exampleRawBody {}
*/
displayName: string;
}[];
} | undefined;
"\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: (PrettifiedUsernamesToUsersInfoData<Username> extends infer T_3 ? T_3 extends PrettifiedUsernamesToUsersInfoData<Username> ? T_3 extends undefined ? {
data: {
/**
* Validates a display name for a new user (NOTE: This does not change the display name).
* @category Display Names
* @endpoint GET /v1/display-names/validate
* @detailedEndpoint GET /v1/display-names/validate ? displayName={displayName} & birthdate={birthdate}
*
* @param displayName The display name to be validated.
* @param birthdate The birthdate of the new user.
*
* @example const { data:displayNameIsValid } = await ClassicUsersApi.validateDisplayNameForNewUser({ displayName: "Hello", birthdate: "2023-07-27T04:14:57+0000" })
* @exampleData true
* @exampleRawBody {}
*/
requestedUsername: Username;
/**
* Validates a display name for a new user (NOTE: This does not change the display name).
* @category Display Names
* @endpoint GET /v1/display-names/validate
* @detailedEndpoint GET /v1/display-names/validate ? displayName={displayName} & birthdate={birthdate}
*
* @param displayName The display name to be validated.
* @param birthdate The birthdate of the new user.
*
* @example const { data:displayNameIsValid } = await ClassicUsersApi.validateDisplayNameForNewUser({ displayName: "Hello", birthdate: "2023-07-27T04:14:57+0000" })
* @exampleData true
* @exampleRawBody {}
*/
hasVerifiedBadge: boolean;
/**
* Validates a display name for a new user (NOTE: This does not change the display name).
* @category Display Names
* @endpoint GET /v1/display-names/validate
* @detailedEndpoint GET /v1/display-names/validate ? displayName={displayName} & birthdate={birthdate}
*
* @param displayName The display name to be validated.
* @param birthdate The birthdate of the new user.
*
* @example const { data:displayNameIsValid } = await ClassicUsersApi.validateDisplayNameForNewUser({ displayName: "Hello", birthdate: "2023-07-27T04:14:57+0000" })
* @exampleData true
* @exampleRawBody {}
*/
id: number;
name: string;
/**
* Validates a display name for a new user (NOTE: This does not change the display name).
* @category Display Names
* @endpoint GET /v1/display-names/validate
* @detailedEndpoint GET /v1/display-names/validate ? displayName={displayName} & birthdate={birthdate}
*
* @param displayName The display name to be validated.
* @param birthdate The birthdate of the new user.
*
* @example const { data:displayNameIsValid } = await ClassicUsersApi.validateDisplayNameForNewUser({ displayName: "Hello", birthdate: "2023-07-27T04:14:57+0000" })
* @exampleData true
* @exampleRawBody {}
*/
displayName: string;
}[];
} : import("typeforge").Prettify<T_3, T_3 extends Date ? true : false> : never : never) | undefined;
} & (PrettifiedUsernamesToUsersInfoData<Username> extends infer T_4 ? T_4 extends PrettifiedUsernamesToUsersInfoData<Username> ? T_4 extends undefined ? {} : import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<RawUsernamesToUsersInfoData<Username>, PrettifiedUsernamesToUsersInfoData<Username> extends infer T_5 ? T_5 extends PrettifiedUsernamesToUsersInfoData<Username> ? T_5 extends undefined ? RawUsernamesToUsersInfoData<Username> : T_5 : never : never> : never : never))["🔒__PRIVATE_RAW_DATA"], undefined>, Exclude<({
method: import("../../../utils/utils.types").RestMethod;
path: `/${string}`;
name: string;
searchParams?: string | Record<string, any> | undefined;
headers?: Record<string, any> | undefined;
body?: string | number | Record<string, any> | undefined;
formData?: FormData | undefined;
applyFieldMask?: boolean | undefined;
pathToPoll?: ((rawData: RawUsernamesToUsersInfoData<Username>) => string) | undefined;
getCursorsFn?: ((rawData: {
data: {
/**
* Validates a display name for a new user (NOTE: This does not change the display name).
* @category Display Names
* @endpoint GET /v1/display-names/validate
* @detailedEndpoint GET /v1/display-names/validate ? displayName={displayName} & birthdate={birthdate}
*
* @param displayName The display name to be validated.
* @param birthdate The birthdate of the new user.
*
* @example const { data:displayNameIsValid } = await ClassicUsersApi.validateDisplayNameForNewUser({ displayName: "Hello", birthdate: "2023-07-27T04:14:57+0000" })
* @exampleData true
* @exampleRawBody {}
*/
requestedUsername: Username;
/**
* Validates a display name for a new user (NOTE: This does not change the display name).
* @category Display Names
* @endpoint GET /v1/display-names/validate
* @detailedEndpoint GET /v1/display-names/validate ? displayName={displayName} & birthdate={birthdate}
*
* @param displayName The display name to be validated.
* @param birthdate The birthdate of the new user.
*
* @example const { data:displayNameIsValid } = await ClassicUsersApi.validateDisplayNameForNewUser({ displayName: "Hello", birthdate: "2023-07-27T04:14:57+0000" })
* @exampleData true
* @exampleRawBody {}
*/
hasVerifiedBadge: boolean;
/**
* Validates a display name for a new user (NOTE: This does not change the display name).
* @category Display Names
* @endpoint GET /v1/display-names/validate
* @detailedEndpoint GET /v1/display-names/validate ? displayName={displayName} & birthdate={birthdate}
*
* @param displayName The display name to be validated.
* @param birthdate The birthdate of the new user.
*
* @example const { data:displayNameIsValid } = await ClassicUsersApi.validateDisplayNameForNewUser({ displayName: "Hello", birthdate: "2023-07-27T04:14:57+0000" })
* @exampleData true
* @exampleRawBody {}
*/
id: number;
name: string;
/**
* Validates a display name for a new user (NOTE: This does not change the display name).
* @category Display Names
* @endpoint GET /v1/display-names/validate
* @detailedEndpoint GET /v1/display-names/validate ? displayName={displayName} & birthdate={birthdate}
*
* @param displayN