UNPKG

openblox

Version:

Roblox API Wrapper For Both Classic And OpenCloud APIs.

674 lines 217 kB
import type { ArrayNonEmptyIfConst, ISODateTime, Identifier } from "typeforge"; import type { AssetResaleData, AssetResellerData, AuthedUserDevExCashOutInfoData, AuthedUserEconomyMetadataData, GroupRevenueSummaryData, PrettifiedGroupTransactionHistoryData, PrettifiedUserGroupPayoutEligibilityData, RawAssetResellersData, RawGroupTransactionHistoryData, RawUserGroupPayoutEligibilityData } from "./economy.types"; /** * Gets resale data for a particular asset. * @endpoint GET /v1/assets/{assetId}/resale-data * * @param assetId The ID of the asset to get resale data for. * * @example const { data:resaleData } = await ClassicEconomyApi.assetResaleData({ assetId: 1365767 }) * @exampleData {"assetStock":null,"sales":11412,"numberRemaining":null,"recentAveragePrice":261565,"originalPrice":null,"priceDataPoints":[{"value":271997,"date":"2024-07-30T00:00:00Z"}],"volumeDataPoints":[{"value":2,"date":"2024-07-30T00:00:00Z"}]} * @exampleRawBody {"assetStock":null,"sales":11412,"numberRemaining":null,"recentAveragePrice":261565,"originalPrice":null,"priceDataPoints":[{"value":271997,"date":"2024-07-30T00:00:00Z"}],"volumeDataPoints":[{"value":2,"date":"2024-07-30T00:00:00Z"}]} */ export declare const assetResaleData: import("../../apiGroup/apiGroup.types").CallApiMethod<{ assetId: 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: AssetResaleData) => string) | undefined; getCursorsFn?: ((rawData: { assetStock: number | null; sales: number; numberRemaining: number | null; recentAveragePrice: number; originalPrice: number | null; priceDataPoints: { value: number; date: `${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}`; }[]; volumeDataPoints: { value: number; date: `${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"?: { assetStock: number | null; sales: number; numberRemaining: number | null; recentAveragePrice: number; originalPrice: number | null; priceDataPoints: { value: number; date: `${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}`; }[]; volumeDataPoints: { value: number; date: `${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"?: { assetStock: number | null; sales: number; numberRemaining: number | null; recentAveragePrice: number; originalPrice: number | null; priceDataPoints: { value: number; date: `${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}`; }[]; volumeDataPoints: { value: number; date: `${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; }, false>; /** * Gets resellers for a particular asset. * @endpoint GET /v1/assets/{assetId}/resellers * * @param assetId The ID of the asset to get resellers for. * @param limit The number of results per request. * @param cursor The paging cursor for the previous or next page. * * @example const { data:resellers } = await ClassicEconomyApi.assetResellers({ assetId: 1365767 }) * @exampleData [{"userAssetId":482809968,"seller":{"hasVerifiedBadge":false,"id":4159620298,"type":"User","name":"AnimatedObjects"},"price":280000,"serialNumber":null}] * @exampleRawBody {"previousPageCursor":null,"nextPageCursor":"eyJzdGFydEluZGV4IjoxMCwiZGlzY3JpbWluYXRvciI6ImFzc2V0SWQ6MTM2NTc2NyIsImNvdW50IjoxMH0KYTlmMDVlNGMxZGYwMDMwMjAwOWQ5ODFjMzk5MTY2OWJmNDU1MTljNDQ2OWEzZTZmMGI2NzE0NTgwOWE4NWQzZQ==","data":[{"userAssetId":482809968,"seller":{"hasVerifiedBadge":false,"id":4159620298,"type":"User","name":"AnimatedObjects"},"price":280000,"serialNumber":null}]} */ export declare const assetResellers: import("../../apiGroup/apiGroup.types").CallApiMethod<{ assetId: Identifier; limit?: 10 | 25 | 50 | 100 | 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: RawAssetResellersData) => string) | undefined; getCursorsFn?: ((rawData: { previousPageCursor: string | null; nextPageCursor: string | null; data: { userAssetId: Identifier; seller: { id: Identifier; type: "User" | "Group"; name: string; }; price: number; serialNumber: number; }[]; }) => [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: { userAssetId: Identifier; seller: { id: Identifier; type: "User" | "Group"; name: string; }; price: number; serialNumber: number; }[]; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: { userAssetId: Identifier; seller: { id: Identifier; type: "User" | "Group"; name: string; }; price: number; serialNumber: number; }[] | undefined; } & import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<RawAssetResellersData, { userAssetId: Identifier; seller: { id: Identifier; type: "User" | "Group"; name: string; }; price: number; serialNumber: number; }[]>, true>; /** * Gets resellable copies of an asset that the authenticated user owns. * @endpoint GET /v1/assets/{assetId}/users/{userId}/resellable-copies * * @param userId The ID of the authenticated user. * @param assetId The ID of the asset to get resellable copies for. * * @example const { data:resellableCopies } = await ClassicEconomyApi.authedUserAssetResellableCopies({ userId: 45348281, assetId: 3798248888 }) * @exampleData [{"userAssetId":45867931761,"seller":{"hasVerifiedBadge":false,"id":45348281,"type":"User","name":"MightyPart"},"price":null,"serialNumber":null,"isOnHold":false}] * @exampleRawBody {"data":[{"userAssetId":45867931761,"seller":{"hasVerifiedBadge":false,"id":45348281,"type":"User","name":"MightyPart"},"price":null,"serialNumber":null,"isOnHold":false}]} */ export declare const authedUserAssetResellableCopies: import("../../apiGroup/apiGroup.types").CallApiMethod<{ userId: Identifier; assetId: 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: { data: AssetResellerData[]; }) => string) | undefined; getCursorsFn?: ((rawData: { data: AssetResellerData[]; }) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: { data: AssetResellerData[]; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: { userAssetId: Identifier; seller: { id: Identifier; type: "User" | "Group"; name: string; }; price: number; serialNumber: number; }[] | undefined; } & import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<{ data: AssetResellerData[]; }, { userAssetId: Identifier; seller: { id: Identifier; type: "User" | "Group"; name: string; }; price: number; serialNumber: number; }[]>, false>; /** * Gets asset resale related metadata * @endpoint GET /v1/resale-tax-rate * * @example const { data:taxRate } = await ClassicEconomyApi.assetResaleTaxRate() * @exampleData {"taxRate":0.3,"minimumFee":1} * @exampleRawBody {"taxRate":0.3,"minimumFee":1} */ export declare const assetResaleTaxRate: 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: { taxRate: number; minimumFee: number; }) => string) | undefined; getCursorsFn?: ((rawData: { taxRate: number; minimumFee: number; }) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: { taxRate: number; minimumFee: number; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: { taxRate: number; minimumFee: number; } | undefined; }, false>; /** * Gets info data about whether the authenticated user can make a developer exchange cashout request. * @endpoint GET /v1/developer-exchange/info * * @example const { data:cashOutInfo } = await ClassicEconomyApi.authedUserDevExCashOutInfo() * @exampleData {"hasCurrencyOperationError":false,"currencyOperationErrorMessage":"","showOnlyExchangeRates":true,"emailIsVerified":true,"isImbursementBlacklistUser":false,"canProceedToCashout":false,"showProgressBar":false,"percentRobux":1,"minRobuxToCashOut":30000,"maxRobuxCanCashOut":20000000000,"lastImbursementStatus":null,"lastImbursementSubmissionDate":null,"conversionPercent":0.0035} * @exampleRawBody {"hasCurrencyOperationError":false,"currencyOperationErrorMessage":"","showOnlyExchangeRates":true,"emailIsVerified":true,"isImbursementBlacklistUser":false,"canProceedToCashout":false,"showProgressBar":false,"percentRobux":1,"minRobuxToCashOut":30000,"maxRobuxCanCashOut":20000000000,"lastImbursementStatus":null,"lastImbursementSubmissionDate":null,"conversionPercent":0.0035} */ export declare const authedUserDevExCashOutInfo: 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: AuthedUserDevExCashOutInfoData) => string) | undefined; getCursorsFn?: ((rawData: { hasCurrencyOperationError: boolean; currencyOperationErrorMessage: string; showOnlyExchangeRates: boolean; meetsMembershipRequirements: boolean; emailIsVerified: boolean; isImbursementBlacklistUser: boolean; canProceedToCashout: boolean; showProgressBar: boolean; percentRobux: number; minRobuxToCashOut: number; maxRobuxCanCashOut: number; lastImbursementStatus: string; lastImbursementSubmissionDate: `${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; conversionPercent: number; }) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: { hasCurrencyOperationError: boolean; currencyOperationErrorMessage: string; showOnlyExchangeRates: boolean; meetsMembershipRequirements: boolean; emailIsVerified: boolean; isImbursementBlacklistUser: boolean; canProceedToCashout: boolean; showProgressBar: boolean; percentRobux: number; minRobuxToCashOut: number; maxRobuxCanCashOut: number; lastImbursementStatus: string; lastImbursementSubmissionDate: `${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; conversionPercent: number; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: { hasCurrencyOperationError: boolean; currencyOperationErrorMessage: string; showOnlyExchangeRates: boolean; meetsMembershipRequirements: boolean; emailIsVerified: boolean; isImbursementBlacklistUser: boolean; canProceedToCashout: boolean; showProgressBar: boolean; percentRobux: number; minRobuxToCashOut: number; maxRobuxCanCashOut: number; lastImbursementStatus: string; lastImbursementSubmissionDate: `${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; conversionPercent: number; } | undefined; }, false>; /** * Checks if a group can have funds added to it. * @endpoint GET /v1/groups/${groupId}/addfunds/allowed * * @param groupId The ID of the group to check if funds can be added to. * * @example const { data:canAddFunds } = await ClassicEconomyApi.groupCanAddFunds({ groupId: 5850082 }) * @exampleData false * @exampleRawBody false */ export declare const groupCanAddFunds: import("../../apiGroup/apiGroup.types").CallApiMethod<{ groupId: 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: 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"?: boolean | undefined; }, false>; /** * Checks if a group can have funds added to it. * @endpoint GET /v1/groups/${groupId}/addfunds/allowed * * @param groupId The ID of the group to check if funds can be added to. * * @example const { data:fundsData } = await ClassicEconomyApi.groupLatestAddedFundsData({ groupId: 5850082 }) * @exampleData {"transactionDate":null,"rateLimitInDays":30} * @exampleRawBody {"transactionDate":null,"rateLimitInDays":30} */ export declare const groupLatestAddedFundsData: import("../../apiGroup/apiGroup.types").CallApiMethod<{ groupId: 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: { transactionDate: ISODateTime | null; rateLimitInDays: number; }) => string) | undefined; getCursorsFn?: ((rawData: { transactionDate: ISODateTime | null; rateLimitInDays: number; }) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: { transactionDate: ISODateTime | null; rateLimitInDays: number; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: { transactionDate: ISODateTime | null; rateLimitInDays: number; } | undefined; }, false>; /** * Gets currency for a particular group. * @endpoint GET /v1/groups/{groupId}/currency * * @param groupId The ID of the group to get currency for. * * @example const { data:currency } = await ClassicEconomyApi.groupCurrency({ groupId: 5850082 }) * @exampleData {"robux":0} * @exampleRawBody {"robux":0} */ export declare const groupCurrency: import("../../apiGroup/apiGroup.types").CallApiMethod<{ groupId: 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: { robux: number; }) => string) | undefined; getCursorsFn?: ((rawData: { robux: number; }) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: { robux: number; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: { robux: number; } | undefined; }, false>; /** * Gets currency for the authenticated user. * @endpoint GET /v1/user/currency * * @example const { data:currency } = await ClassicEconomyApi.authedUserCurrency() * @exampleData {"robux":0} * @exampleRawBody {"robux":0} */ export declare const authedUserCurrency: 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: { robux: number; }) => string) | undefined; getCursorsFn?: ((rawData: { robux: number; }) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: { robux: number; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: { robux: number; } | undefined; }, false>; /** * Gets the revenue summary for a particular group. * @endpoint GET /v1/groups/{groupId}/revenue/summary/{timeFrame} * * @param groupId The ID of the group to get the revenue summary for. * @param timeFrame The timeframe of the summary to get. * * @example const { data:summary } = await ClassicEconomyApi.groupRevenueSummary({ groupId: 5850082, timeFrame: "Day" }) * @exampleData {"recurringRobuxStipend":0,"itemSaleRobux":0,"purchasedRobux":0,"tradeSystemRobux":0,"pendingRobux":0,"groupPayoutRobux":0,"individualToGroupRobux":0,"premiumPayouts":0,"groupPremiumPayouts":0,"adjustmentRobux":0,"immersiveAdPayouts":0,"subscriptionPayouts":0,"subscriptionClawbacks":0,"isShowImmersiveAdPayoutSummaryOnZeroEnabled":false,"commissionRobux":0,"publishingAdvanceRebates":0} * @exampleRawBody {"recurringRobuxStipend":0,"itemSaleRobux":0,"purchasedRobux":0,"tradeSystemRobux":0,"pendingRobux":0,"groupPayoutRobux":0,"individualToGroupRobux":0,"premiumPayouts":0,"groupPremiumPayouts":0,"adjustmentRobux":0,"immersiveAdPayouts":0,"subscriptionPayouts":0,"subscriptionClawbacks":0,"isShowImmersiveAdPayoutSummaryOnZeroEnabled":false,"commissionRobux":0,"publishingAdvanceRebates":0} */ export declare const groupRevenueSummary: import("../../apiGroup/apiGroup.types").CallApiMethod<{ groupId: Identifier; timeFrame: "Day" | "Week" | "Month" | "Year"; }, { 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: GroupRevenueSummaryData) => string) | undefined; getCursorsFn?: ((rawData: { recurringRobuxStipend: number; itemSaleRobux: number; purchasedRobux: number; tradeSystemRobux: number; pendingRobux: number; groupPayoutRobux: number; individualToGroupRobux: number; premiumPayouts: number; groupPremiumPayouts: number; adjustmentRobux: number; immersiveAdPayouts: number; subscriptionPayouts: number; subscriptionClawbacks: number; isShowImmersiveAdPayoutSummaryOnZeroEnabled: false; commissionRobux: number; publishingAdvanceRebates: number; }) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: { recurringRobuxStipend: number; itemSaleRobux: number; purchasedRobux: number; tradeSystemRobux: number; pendingRobux: number; groupPayoutRobux: number; individualToGroupRobux: number; premiumPayouts: number; groupPremiumPayouts: number; adjustmentRobux: number; immersiveAdPayouts: number; subscriptionPayouts: number; subscriptionClawbacks: number; isShowImmersiveAdPayoutSummaryOnZeroEnabled: false; commissionRobux: number; publishingAdvanceRebates: number; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: { recurringRobuxStipend: number; itemSaleRobux: number; purchasedRobux: number; tradeSystemRobux: number; pendingRobux: number; groupPayoutRobux: number; individualToGroupRobux: number; premiumPayouts: number; groupPremiumPayouts: number; adjustmentRobux: number; immersiveAdPayouts: number; subscriptionPayouts: number; subscriptionClawbacks: number; isShowImmersiveAdPayoutSummaryOnZeroEnabled: false; commissionRobux: number; publishingAdvanceRebates: number; } | undefined; }, false>; /** * Gets the group payout eligibility for a group of users. * @endpoint GET /v1/groups/{groupId}/users-payout-eligibility * * @param groupId The ID of the group. * @param userIds The userIds to check for payout eligibility. * * @example const { data:eligibility } = await ClassicEconomyApi.groupPayoutsUserEligibility({ groupId: 14941564, userIds: [1412728377] }) * @exampleData {"1412728377":"Eligible"} * @exampleRawBody {"usersGroupPayoutEligibility":{"1412728377":"Eligible"}} */ export declare const groupPayoutsUserEligibility: <UserId extends Identifier>(this: any, args: { groupId: Identifier; userIds: ArrayNonEmptyIfConst<UserId>; }) => 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: RawUserGroupPayoutEligibilityData<UserId>) => string) | undefined; getCursorsFn?: ((rawData: { usersGroupPayoutEligibility: { [Key in UserId]: "Undefined" | "Eligible" | "NotInGroup" | "PayoutRestricted" | undefined; }; }) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: { usersGroupPayoutEligibility: { [Key in UserId]: "Undefined" | "Eligible" | "NotInGroup" | "PayoutRestricted" | undefined; }; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: (PrettifiedUserGroupPayoutEligibilityData<UserId> extends infer T ? T extends PrettifiedUserGroupPayoutEligibilityData<UserId> ? T extends undefined ? { usersGroupPayoutEligibility: { [Key in UserId]: "Undefined" | "Eligible" | "NotInGroup" | "PayoutRestricted" | undefined; }; } : import("typeforge").Prettify<T, T extends Date ? true : false> : never : never) | undefined; } & (PrettifiedUserGroupPayoutEligibilityData<UserId> extends infer T_1 ? T_1 extends PrettifiedUserGroupPayoutEligibilityData<UserId> ? T_1 extends undefined ? {} : import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<RawUserGroupPayoutEligibilityData<UserId>, PrettifiedUserGroupPayoutEligibilityData<UserId> extends infer T_2 ? T_2 extends PrettifiedUserGroupPayoutEligibilityData<UserId> ? T_2 extends undefined ? RawUserGroupPayoutEligibilityData<UserId> : 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: RawUserGroupPayoutEligibilityData<UserId>) => string) | undefined; getCursorsFn?: ((rawData: { usersGroupPayoutEligibility: { [Key in UserId]: "Undefined" | "Eligible" | "NotInGroup" | "PayoutRestricted" | undefined; }; }) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: { usersGroupPayoutEligibility: { [Key in UserId]: "Undefined" | "Eligible" | "NotInGroup" | "PayoutRestricted" | undefined; }; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: (PrettifiedUserGroupPayoutEligibilityData<UserId> extends infer T_3 ? T_3 extends PrettifiedUserGroupPayoutEligibilityData<UserId> ? T_3 extends undefined ? { usersGroupPayoutEligibility: { [Key in UserId]: "Undefined" | "Eligible" | "NotInGroup" | "PayoutRestricted" | undefined; }; } : import("typeforge").Prettify<T_3, T_3 extends Date ? true : false> : never : never) | undefined; } & (PrettifiedUserGroupPayoutEligibilityData<UserId> extends infer T_4 ? T_4 extends PrettifiedUserGroupPayoutEligibilityData<UserId> ? T_4 extends undefined ? {} : import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<RawUserGroupPayoutEligibilityData<UserId>, PrettifiedUserGroupPayoutEligibilityData<UserId> extends infer T_5 ? T_5 extends PrettifiedUserGroupPayoutEligibilityData<UserId> ? T_5 extends undefined ? RawUserGroupPayoutEligibilityData<UserId> : 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: RawUserGroupPayoutEligibilityData<UserId>) => string) | undefined; getCursorsFn?: ((rawData: { usersGroupPayoutEligibility: { [Key in UserId]: "Undefined" | "Eligible" | "NotInGroup" | "PayoutRestricted" | undefined; }; }) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: { usersGroupPayoutEligibility: { [Key in UserId]: "Undefined" | "Eligible" | "NotInGroup" | "PayoutRestricted" | undefined; }; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: (PrettifiedUserGroupPayoutEligibilityData<UserId> extends infer T_6 ? T_6 extends PrettifiedUserGroupPayoutEligibilityData<UserId> ? T_6 extends undefined ? { usersGroupPayoutEligibility: { [Key in UserId]: "Undefined" | "Eligible" | "NotInGroup" | "PayoutRestricted" | undefined; }; } : import("typeforge").Prettify<T_6, T_6 extends Date ? true : false> : never : never) | undefined; } & (PrettifiedUserGroupPayoutEligibilityData<UserId> extends infer T_7 ? T_7 extends PrettifiedUserGroupPayoutEligibilityData<UserId> ? T_7 extends undefined ? {} : import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<RawUserGroupPayoutEligibilityData<UserId>, PrettifiedUserGroupPayoutEligibilityData<UserId> extends infer T_8 ? T_8 extends PrettifiedUserGroupPayoutEligibilityData<UserId> ? T_8 extends undefined ? RawUserGroupPayoutEligibilityData<UserId> : T_8 : never : never> : never : never))["🔒__PRIVATE_RAW_DATA"], undefined> extends infer T_9 ? T_9 extends Exclude<({ method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record<string, any> | undefined; headers?: Record<string, any> | undefined; body?: string | number | Record<string, any> | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: RawUserGroupPayoutEligibilityData<UserId>) => string) | undefined; getCursorsFn?: ((rawData: { usersGroupPayoutEligibility: { [Key in UserId]: "Undefined" | "Eligible" | "NotInGroup" | "PayoutRestricted" | undefined; }; }) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: { usersGroupPayoutEligibility: { [Key in UserId]: "Undefined" | "Eligible" | "NotInGroup" | "PayoutRestricted" | undefined; }; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: (PrettifiedUserGroupPayoutEligibilityData<UserId> extends infer T_10 ? T_10 extends PrettifiedUserGroupPayoutEligibilityData<UserId> ? T_10 extends undefined ? { usersGroupPayoutEligibility: { [Key in UserId]: "Undefined" | "Eligible" | "NotInGroup" | "PayoutRestricted" | undefined; }; } : import("typeforge").Prettify<T_10, T_10 extends Date ? true : false> : never : never) | undefined; } & (PrettifiedUserGroupPayoutEligibilityData<UserId> extends infer T_11 ? T_11 extends PrettifiedUserGroupPayoutEligibilityData<UserId> ? T_11 extends undefined ? {} : import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<RawUserGroupPayoutEligibilityData<UserId>, PrettifiedUserGroupPayoutEligibilityData<UserId> extends infer T_12 ? T_12 extends PrettifiedUserGroupPayoutEligibilityData<UserId> ? T_12 extends undefined ? RawUserGroupPayoutEligibilityData<UserId> : T_12 : never : never> : never : never))["🔒__PRIVATE_RAW_DATA"], undefined> ? T_9 extends Date ? true : false : never : never>; }; } & { again: () => Promise<{ data: Exclude<({ method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record<string, any> | undefined; headers?: Record<string, any> | undefined; body?: string | number | Record<string, any> | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: RawUserGroupPayoutEligibilityData<UserId>) => string) | undefined; getCursorsFn?: ((rawData: { usersGroupPayoutEligibility: { [Key in UserId]: "Undefined" | "Eligible" | "NotInGroup" | "PayoutRestricted" | undefined; }; }) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: { usersGroupPayoutEligibility: { [Key in UserId]: "Undefined" | "Eligible" | "NotInGroup" | "PayoutRestricted" | undefined; }; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: (PrettifiedUserGroupPayoutEligibilityData<UserId> extends infer T_13 ? T_13 extends PrettifiedUserGroupPayoutEligibilityData<UserId> ? T_13 extends undefined ? { usersGroupPayoutEligibility: { [Key in UserId]: "Undefined" | "Eligible" | "NotInGroup" | "PayoutRestricted" | undefined; }; } : import("typeforge").Prettify<T_13, T_13 extends Date ? true : false> : never : never) | undefined; } & (PrettifiedUserGroupPayoutEligibilityData<UserId> extends infer T_14 ? T_14 extends PrettifiedUserGroupPayoutEligibilityData<UserId> ? T_14 extends undefined ? {} : import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<RawUserGroupPayoutEligibilityData<UserId>, PrettifiedUserGroupPayoutEligibilityData<UserId> extends infer T_15 ? T_15 extends PrettifiedUserGroupPayoutEligibilityData<UserId> ? T_15 extends undefined ? RawUserGroupPayoutEligibilityData<UserId> : T_15 : never : never> : never : never))["🔒__PRIVATE_FORMATTED_DATA"], undefined>; response: { fullResponse: unknown; url: `https://${string}`; method: import("../../../utils/utils.types").RestMethod; success: boolean; statusCode: number; headers: Headers; body: import("typeforge").Prettify<Exclude<({ method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record<string, any> | undefined; headers?: Record<string, any> | undefined; body?: string | number | Record<string, any> | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: RawUserGroupPayoutEligibilityData<UserId>) => string) | undefined; getCursorsFn?: ((rawData: { usersGroupPayoutEligibility: { [Key in UserId]: "Undefined" | "Eligible" | "NotInGroup" | "PayoutRestricted" | undefined; }; }) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: { usersGroupPayoutEligibility: { [Key in UserId]: "Undefined" | "Eligible" | "NotInGroup" | "PayoutRestricted" | undefined; }; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: (PrettifiedUserGroupPayoutEligibilityData<UserId> extends infer T_16 ? T_16 extends PrettifiedUserGroupPayoutEligibilityData<UserId> ? T_16 extends undefined ? { usersGroupPayoutEligibility: { [Key in UserId]: "Undefined" | "Eligible" | "NotInGroup" | "PayoutRestricted" | undefined; }; } : import("typeforge").Prettify<T_16, T_16 extends Date ? true : false> : never : never) | undefined; } & (PrettifiedUserGroupPayoutEligibilityData<UserId> extends infer T_17 ? T_17 extends PrettifiedUserGroupPayoutEligibilityData<UserId> ? T_17 extends undefined ? {} : import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<RawUserGroupPayoutEligibilityData<UserId>, PrettifiedUserGroupPayoutEligibilityData<UserId> extends infer T_18 ? T_18 extends PrettifiedUserGroupPayoutEligibilityData<UserId> ? T_18 extends undefined ? RawUserGroupPayoutEligibilityData<UserId> : T_18 : never : never> : never : never))["🔒__PRIVATE_RAW_DATA"], undefined>, Exclude<({ method: import("../../../utils/utils.types").RestMethod; path: `/${string}`; name: string; searchParams?: string | Record<string, any> | undefined; headers?: Record<string, any> | undefined; body?: string | number | Record<string, any> | undefined; formData?: FormData | undefined; applyFieldMask?: boolean | undefined; pathToPoll?: ((rawData: RawUserGroupPayoutEligibilityData<UserId>) => string) | undefined; getCursorsFn?: ((rawData: { usersGroupPayoutEligibility: { [Key in UserId]: "Undefined" | "Eligible" | "NotInGroup" | "PayoutRestricted" | undefined; }; }) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined; "\uD83D\uDD12__PRIVATE_RAW_DATA"?: { usersGroupPayoutEligibility: { [Key in UserId]: "Undefined" | "Eligible" | "NotInGroup" | "PayoutRestricted" | undefined; }; } | undefined; "\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: (PrettifiedUserGroupPayoutEligibilityData<UserId> extends infer T_19 ? T_19 extends PrettifiedUserGroupPayoutEligibilityData<UserId> ? T_19 extends undefined ? { usersGroupPayoutEligibility: { [Key in UserId]: "Undefined" | "Eligible" | "NotInGroup" | "PayoutRestricted" | undefined; }; } :