openblox
Version:
Roblox API Wrapper For Both Classic And OpenCloud APIs.
635 lines • 103 kB
TypeScript
import type { ArrayNonEmptyIfConst, Identifier } from "typeforge";
import type { SortOrder } from "../../../utils/utils.types";
import type { PrettifiedBadgeAwardedDateForUserData, PrettifiedBadgesAwardedDatesForUserData, PrettifiedPaginatedBadgesData, RawBadgesAwardedDatesForUserData, RawPaginatedBadgesData } from "./badges.types";
/**
* Gets information for a badge.
* @endpoint GET /v1/badges/{badgeId}
*
* @param badgeId The ID of the badge to get information for.
*
* @example const { data:badgeInfo } = await ClassicBadgesApi.badgeInfo({ badgeId: 2124533401 })
* @exampleData {"id":2124533401,"name":"Tutorial Done","description":"Tutorial Lol","displayName":"Tutorial Done","displayDescription":"Tutorial Lol","enabled":true,"iconImageId":5316501478,"displayIconImageId":5316501478,"created":"2020-05-05T08:20:10.653Z","updated":"2023-08-26T12:43:15.280Z","statistics":{"pastDayAwardedCount":0,"awardedCount":394,"winRatePercentage":0},"awardingUniverse":{"id":1685831367,"name":"RoCamping","rootPlaceId":4922741943}}
* @exampleRawBody {"id":2124533401,"name":"Tutorial Done","description":"Tutorial Lol","displayName":"Tutorial Done","displayDescription":"Tutorial Lol","enabled":true,"iconImageId":5316501478,"displayIconImageId":5316501478,"created":"2020-05-05T08:20:10.653Z","updated":"2023-08-26T12:43:15.280Z","statistics":{"pastDayAwardedCount":0,"awardedCount":394,"winRatePercentage":0},"awardingUniverse":{"id":1685831367,"name":"RoCamping","rootPlaceId":4922741943}}
*/
export declare const badgeInfo: <BadgeId extends Identifier>(this: any, args: {
badgeId: BadgeId;
}) => Promise<{
data: {
id: BadgeId;
name: string;
description: string;
displayName: string;
displayDescription: string;
enabled: boolean;
iconImageId: Identifier;
displayIconImageId: Identifier;
created: Date;
updated: Date;
statistics: {
pastDayAwardedCount: number;
awardedCount: number;
winRatePercentage: number;
};
awardingUniverse: {
id: Identifier;
name: string;
rootPlaceId: Identifier;
};
};
response: {
fullResponse: unknown;
url: `https://${string}`;
method: import("../../../utils/utils.types").RestMethod;
success: boolean;
statusCode: number;
headers: Headers;
body: {
id: BadgeId;
name: string;
description: string;
displayName: string;
displayDescription: string;
enabled: boolean;
iconImageId: Identifier;
displayIconImageId: Identifier;
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}`;
statistics: {
pastDayAwardedCount: number;
awardedCount: number;
winRatePercentage: number;
};
awardingUniverse: {
id: Identifier;
name: string;
rootPlaceId: Identifier;
};
};
};
} & {
again: () => Promise<{
data: {
id: BadgeId;
name: string;
description: string;
displayName: string;
displayDescription: string;
enabled: boolean;
iconImageId: Identifier;
displayIconImageId: Identifier;
created: Date;
updated: Date;
statistics: {
pastDayAwardedCount: number;
awardedCount: number;
winRatePercentage: number;
};
awardingUniverse: {
id: Identifier;
name: string;
rootPlaceId: Identifier;
};
};
response: {
fullResponse: unknown;
url: `https://${string}`;
method: import("../../../utils/utils.types").RestMethod;
success: boolean;
statusCode: number;
headers: Headers;
body: {
id: BadgeId;
name: string;
description: string;
displayName: string;
displayDescription: string;
enabled: boolean;
iconImageId: Identifier;
displayIconImageId: Identifier;
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}`;
statistics: {
pastDayAwardedCount: number;
awardedCount: number;
winRatePercentage: number;
};
awardingUniverse: {
id: Identifier;
name: string;
rootPlaceId: Identifier;
};
};
};
}>;
}>;
/**
* Updates a badge.
* @endpoint PATCH /v1/badges/{badgeId}
*
* @param badgeId The ID of the badge to update.
* @param name The new name for the badge.
* @param description The new description for the badge.
* @param enabled If the badge is to enabled.
*
* @example const { data:success } = await ClassicBadgesApi.updateBadge({ badgeId: 2124533401, description: "hello" })
* @exampleData true
* @exampleRawBody {}
*/
export declare const updateBadge: import("../../apiGroup/apiGroup.types").CallApiMethod<{
badgeId: Identifier;
name?: string | undefined;
description?: string | undefined;
enabled?: boolean | undefined;
}, {
method: import("../../../utils/utils.types").RestMethod;
path: `/${string}`;
name: string;
searchParams?: string | Record<string, any> | undefined;
headers?: Record<string, any> | undefined;
body?: string | number | Record<string, any> | undefined;
formData?: FormData | undefined;
applyFieldMask?: boolean | undefined;
pathToPoll?: ((rawData: {}) => 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 metadata about the badges system.
* @endpoint GET /v1/badges/metadata
*
* @example const { data:metadata } = await ClassicBadgesApi.badgesMetadata()
* @exampleData {"badgeCreationPrice":100,"maxBadgeNameLength":50,"maxBadgeDescriptionLength":1000}
* @exampleRawBody {"badgeCreationPrice":100,"maxBadgeNameLength":50,"maxBadgeDescriptionLength":1000}
*/
export declare const badgesMetadata: 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: {
badgeCreationPrice: number;
maxBadgeNameLength: number;
maxBadgeDescriptionLength: number;
}) => string) | undefined;
getCursorsFn?: ((rawData: {
badgeCreationPrice: number;
maxBadgeNameLength: number;
maxBadgeDescriptionLength: number;
}) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined;
"\uD83D\uDD12__PRIVATE_RAW_DATA"?: {
badgeCreationPrice: number;
maxBadgeNameLength: number;
maxBadgeDescriptionLength: number;
} | undefined;
"\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: {
badgeCreationPrice: number;
maxBadgeNameLength: number;
maxBadgeDescriptionLength: number;
} | undefined;
}, false>;
/**
* Gets badges for a specific universe.
* @endpoint GET /v1/universes/{universeId}/badges
*
* @param universeId The ID of the universe to get badges from.
* @param limit The number of results per request.
* @param sortOrder The order the results are sorted in.
* @param cursor The paging cursor for the previous or next page.
*
* @example const { data:badges } = await ClassicBadgesApi.badgesForUniverse({ universeId: 1685831367 })
* @exampleData [{"id":2124533401,"name":"Tutorial Done","description":"true","displayName":"Tutorial Done","displayDescription":"true","enabled":true,"iconImageId":5316501478,"displayIconImageId":5316501478,"created":"2020-05-05T08:20:10.653Z","updated":"2024-07-16T22:34:44.021Z","statistics":{"pastDayAwardedCount":0,"awardedCount":394,"winRatePercentage":0},"awardingUniverse":{"id":1685831367,"name":"RoCamping","rootPlaceId":4922741943}}]
* @exampleRawBody {"previousPageCursor":null,"nextPageCursor":"eyJrZXkiOiJpZF8yendBQUFYSGo2OEVkem42aHpwayIsInNvcnRPcmRlciI6IkFzYyIsInBhZ2luZ0RpcmVjdGlvbiI6IkZvcndhcmQiLCJwYWdlTnVtYmVyIjoyLCJkaXNjcmltaW5hdG9yIjoidW5pdmVyc2VJZDoxNjg1ODMxMzY3IiwiY291bnQiOjEwfQplMzk4ODQzNTg5NGYxNzU4MTk1YmVlNWFhMDE5NTI1MmJiMjdhZDRiYzU5YzE3NjNjNjg3M2UxYmExNDdkMWZh","data":[{"id":2124533401,"name":"Tutorial Done","description":"true","displayName":"Tutorial Done","displayDescription":"true","enabled":true,"iconImageId":5316501478,"displayIconImageId":5316501478,"created":"2020-05-05T08:20:10.653+00:00","updated":"2024-07-16T22:34:44.021+00:00","statistics":{"pastDayAwardedCount":0,"awardedCount":394,"winRatePercentage":0},"awardingUniverse":{"id":1685831367,"name":"RoCamping","rootPlaceId":4922741943}}]}
*/
export declare const badgesForUniverse: <UniverseId extends Identifier>(this: any, args: {
universeId: UniverseId;
limit?: 10 | 25 | 50 | 100 | undefined;
sortOrder?: SortOrder | undefined;
cursor?: string | undefined;
}) => Promise<{
data: {
id: Identifier;
name: string;
description: string;
displayName: string;
displayDescription: string;
enabled: boolean;
iconImageId: Identifier;
displayIconImageId: Identifier;
created: Date;
updated: Date;
statistics: {
pastDayAwardedCount: number;
awardedCount: number;
winRatePercentage: number;
};
awardingUniverse: {
id: UniverseId;
name: string;
rootPlaceId: Identifier;
};
}[];
response: {
fullResponse: unknown;
url: `https://${string}`;
method: import("../../../utils/utils.types").RestMethod;
success: boolean;
statusCode: number;
headers: Headers;
body: {
previousPageCursor: string | null;
nextPageCursor: string | null;
data: {
id: Identifier;
name: string;
description: string;
displayName: string;
displayDescription: string;
enabled: boolean;
iconImageId: Identifier;
displayIconImageId: Identifier;
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}`;
statistics: {
pastDayAwardedCount: number;
awardedCount: number;
winRatePercentage: number;
};
awardingUniverse: {
id: UniverseId;
name: string;
rootPlaceId: Identifier;
};
}[];
};
};
cursors: {
previous: import("../../apiGroup/apiGroup.types").Cursor;
next: import("../../apiGroup/apiGroup.types").Cursor;
};
[Symbol.asyncIterator]: () => AsyncGenerator<{
data: {
id: Identifier;
name: string;
description: string;
displayName: string;
displayDescription: string;
enabled: boolean;
iconImageId: Identifier;
displayIconImageId: Identifier;
created: Date;
updated: Date;
statistics: {
pastDayAwardedCount: number;
awardedCount: number;
winRatePercentage: number;
};
awardingUniverse: {
id: UniverseId;
name: string;
rootPlaceId: Identifier;
};
}[];
response: {
fullResponse: unknown;
url: `https://${string}`;
method: import("../../../utils/utils.types").RestMethod;
success: boolean;
statusCode: number;
headers: Headers;
body: {
previousPageCursor: string | null;
nextPageCursor: string | null;
data: {
id: Identifier;
name: string;
description: string;
displayName: string;
displayDescription: string;
enabled: boolean;
iconImageId: Identifier;
displayIconImageId: Identifier;
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}`;
statistics: {
pastDayAwardedCount: number;
awardedCount: number;
winRatePercentage: number;
};
awardingUniverse: {
id: UniverseId;
name: string;
rootPlaceId: Identifier;
};
}[];
};
};
cursors: {
previous: import("../../apiGroup/apiGroup.types").Cursor;
next: import("../../apiGroup/apiGroup.types").Cursor;
};
[Symbol.asyncIterator]: null;
} & {
again: () => Promise<{
data: {
id: Identifier;
name: string;
description: string;
displayName: string;
displayDescription: string;
enabled: boolean;
iconImageId: Identifier;
displayIconImageId: Identifier;
created: Date;
updated: Date;
statistics: {
pastDayAwardedCount: number;
awardedCount: number;
winRatePercentage: number;
};
awardingUniverse: {
id: UniverseId;
name: string;
rootPlaceId: Identifier;
};
}[];
response: {
fullResponse: unknown;
url: `https://${string}`;
method: import("../../../utils/utils.types").RestMethod;
success: boolean;
statusCode: number;
headers: Headers;
body: {
previousPageCursor: string | null;
nextPageCursor: string | null;
data: {
id: Identifier;
name: string;
description: string;
displayName: string;
displayDescription: string;
enabled: boolean;
iconImageId: Identifier;
displayIconImageId: Identifier;
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}`;
statistics: {
pastDayAwardedCount: number;
awardedCount: number;
winRatePercentage: number;
};
awardingUniverse: {
id: UniverseId;
name: string;
rootPlaceId: Identifier;
};
}[];
};
};
}>;
}, any, unknown>;
} & {
again: () => Promise<{
data: {
id: Identifier;
name: string;
description: string;
displayName: string;
displayDescription: string;
enabled: boolean;
iconImageId: Identifier;
displayIconImageId: Identifier;
created: Date;
updated: Date;
statistics: {
pastDayAwardedCount: number;
awardedCount: number;
winRatePercentage: number;
};
awardingUniverse: {
id: UniverseId;
name: string;
rootPlaceId: Identifier;
};
}[];
response: {
fullResponse: unknown;
url: `https://${string}`;
method: import("../../../utils/utils.types").RestMethod;
success: boolean;
statusCode: number;
headers: Headers;
body: {
previousPageCursor: string | null;
nextPageCursor: string | null;
data: {
id: Identifier;
name: string;
description: string;
displayName: string;
displayDescription: string;
enabled: boolean;
iconImageId: Identifier;
displayIconImageId: Identifier;
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}`;
statistics: {
pastDayAwardedCount: number;
awardedCount: number;
winRatePercentage: number;
};
awardingUniverse: {
id: UniverseId;
name: string;
rootPlaceId: Identifier;
};
}[];
};
};
}>;
}>;
/**
* Gets the number of free badges left for the current UTC day by their awarding game.
* @endpoint GET /v1/universes/{universeId}/free-badges-quota
*
* @param universeId The ID of the universe to get free badges for.
*
* @example const { data:freeBadgesLeft } = await ClassicBadgesApi.freeBadgesLeftForUniverse({ universeId: 1685831367 })
* @exampleData 5
* @exampleRawBody 5
*/
export declare const freeBadgesLeftForUniverse: import("../../apiGroup/apiGroup.types").CallApiMethod<{
universeId: Identifier;
}, {
method: import("../../../utils/utils.types").RestMethod;
path: `/${string}`;
name: string;
searchParams?: string | Record<string, any> | undefined;
headers?: Record<string, any> | undefined;
body?: string | number | Record<string, any> | undefined;
formData?: FormData | undefined;
applyFieldMask?: boolean | undefined;
pathToPoll?: ((rawData: number) => string) | undefined;
getCursorsFn?: ((rawData: number) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined;
"\uD83D\uDD12__PRIVATE_RAW_DATA"?: number | undefined;
"\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: number | undefined;
}, false>;
/**
* Gets a list of badges a user has been awarded
* @endpoint GET /v1/users/{userId}/badges
*
* @param userId The ID of the user to get badges for.
* @param limit The number of results per request.
* @param sortOrder The order the results are sorted in.
* @param cursor The paging cursor for the previous or next page.
*
* @example const { data:badges } = await ClassicBadgesApi.userBadges({ userId: 45348281 })
* @exampleData [{"id":2124533401,"name":"Tutorial Done","description":"true","displayName":"Tutorial Done","displayDescription":"true","enabled":true,"iconImageId":5316501478,"displayIconImageId":5316501478,"created":"2020-05-05T08:20:10.653Z","updated":"2024-07-16T22:34:44.021Z","statistics":{"pastDayAwardedCount":0,"awardedCount":394,"winRatePercentage":0},"awardingUniverse":{"id":1685831367,"name":"RoCamping","rootPlaceId":4922741943}}]
* @exampleRawBody {"previousPageCursor":null,"nextPageCursor":"eyJrZXkiOiJpZF8yendBQUFYSGo2OEVkem42aHpwayIsInNvcnRPcmRlciI6IkFzYyIsInBhZ2luZ0RpcmVjdGlvbiI6IkZvcndhcmQiLCJwYWdlTnVtYmVyIjoyLCJkaXNjcmltaW5hdG9yIjoidW5pdmVyc2VJZDoxNjg1ODMxMzY3IiwiY291bnQiOjEwfQplMzk4ODQzNTg5NGYxNzU4MTk1YmVlNWFhMDE5NTI1MmJiMjdhZDRiYzU5YzE3NjNjNjg3M2UxYmExNDdkMWZh","data":[{"id":2124533401,"name":"Tutorial Done","description":"true","displayName":"Tutorial Done","displayDescription":"true","enabled":true,"iconImageId":5316501478,"displayIconImageId":5316501478,"created":"2020-05-05T08:20:10.653+00:00","updated":"2024-07-16T22:34:44.021+00:00","statistics":{"pastDayAwardedCount":0,"awardedCount":394,"winRatePercentage":0},"awardingUniverse":{"id":1685831367,"name":"RoCamping","rootPlaceId":4922741943}}]}
*/
export declare const userBadges: import("../../apiGroup/apiGroup.types").CallApiMethod<{
userId: 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<string, any> | undefined;
headers?: Record<string, any> | undefined;
body?: string | number | Record<string, any> | undefined;
formData?: FormData | undefined;
applyFieldMask?: boolean | undefined;
pathToPoll?: ((rawData: RawPaginatedBadgesData) => string) | undefined;
getCursorsFn?: ((rawData: {
previousPageCursor: string | null;
nextPageCursor: string | null;
data: {
id: Identifier;
name: string;
description: string;
displayName: string;
displayDescription: string;
enabled: boolean;
iconImageId: Identifier;
displayIconImageId: Identifier;
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}`;
statistics: {
pastDayAwardedCount: number;
awardedCount: number;
winRatePercentage: number;
};
awardingUniverse: {
id: Identifier;
name: string;
rootPlaceId: Identifier;
};
}[];
}) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined;
"\uD83D\uDD12__PRIVATE_RAW_DATA"?: {
previousPageCursor: string | null;
nextPageCursor: string | null;
data: {
id: Identifier;
name: string;
description: string;
displayName: string;
displayDescription: string;
enabled: boolean;
iconImageId: Identifier;
displayIconImageId: Identifier;
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}`;
statistics: {
pastDayAwardedCount: number;
awardedCount: number;
winRatePercentage: number;
};
awardingUniverse: {
id: Identifier;
name: string;
rootPlaceId: Identifier;
};
}[];
} | undefined;
"\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: {
id: Identifier;
name: string;
description: string;
displayName: string;
displayDescription: string;
enabled: boolean;
iconImageId: Identifier;
displayIconImageId: Identifier;
created: Date;
updated: Date;
statistics: {
pastDayAwardedCount: number;
awardedCount: number;
winRatePercentage: number;
};
awardingUniverse: {
id: Identifier;
name: string;
rootPlaceId: Identifier;
};
}[] | undefined;
} & import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<RawPaginatedBadgesData, PrettifiedPaginatedBadgesData>, true>;
/**
* Gets timestamp for when a single badge was awarded to a user.
* @endpoint GET /v1/users/{userId}/badges/{badgeId}/awarded-date
*
* @param badgeId The ID of the badge to get award date from.
* @param userId The ID of thw user to get award date for.
*
* @example const { data:awardDate } = await ClassicBadgesApi.badgeAwardedDateForUser({ badgeId: 2124533401, userId: 45348281 })
* @exampleData 2020-11-15T18:51:30.604Z
* @exampleRawBody {"badgeId":2124533401,"awardedDate":"2020-11-15T18:51:30.604064Z"}
*/
export declare const badgeAwardedDateForUser: <BadgeId extends Identifier>(this: any, args: {
badgeId: BadgeId;
userId: Identifier;
}) => Promise<{
data: PrettifiedBadgeAwardedDateForUserData;
response: {
fullResponse: unknown;
url: `https://${string}`;
method: import("../../../utils/utils.types").RestMethod;
success: boolean;
statusCode: number;
headers: Headers;
body: "" | {
badgeId: BadgeId;
awardedDate: `${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}`;
};
};
} & {
again: () => Promise<{
data: PrettifiedBadgeAwardedDateForUserData;
response: {
fullResponse: unknown;
url: `https://${string}`;
method: import("../../../utils/utils.types").RestMethod;
success: boolean;
statusCode: number;
headers: Headers;
body: "" | {
badgeId: BadgeId;
awardedDate: `${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}`;
};
};
}>;
}>;
/**
* Gets timestamp for when multiple badges were awarded to a user.
* @endpoint GET /v1/users/{userId}/badges/awarded-dates
*
* @param badgeIds The IDs of the badges to get award dates from.
* @param userId T