openblox
Version:
Roblox API Wrapper For Both Classic And OpenCloud APIs.
33 lines (32 loc) • 1.46 kB
TypeScript
/**
* 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 LegacyBadgesApi.updateBadge({ badgeId: 2124533401, description: "hello" })
* @exampleData true
* @exampleRawBody {}
*/
export declare const updateBadge: import("../../apiGroup/apiGroup.types").CallApiMethod<{
badgeId: import("typeforge").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>;