openblox/dist/apis/cloud/standardDataStores_V1/standardDataStores_V1.d.ts

Roblox API Wrapper For Both Classic And OpenCloud APIs.

import type { Identifier, Prettify } from "typeforge";
/**
 * Returns a list of data stores belonging to an experience.
 * @endpoint GET /v1/universes/{universeId}/standard-datastores
 * @tags [ "Cloud Key" ]
 * @deprecated Please use `StandardDataStoresApi_V2` for new work.
 *
 * @param universeId The identifier of the experience with data stores that you want to access.
 * @param prefix Provide to return only data stores with this prefix.
 * @param limit The maximum number of items to return. Each call only reads one partition so it can return fewer than the given value when running out of objectives on one partition.
 * @param cursor Provide to request the next set of data.
 *
 * @example const { data:datastores } = await StandardDataStoresApi_V1.listStandardDatastores({ universeId: 5097539509 })
 * @exampleData [ { name: "InventoryStore", createdTime: 2023-09-16T11:03:03.868Z } ]
 * @exampleRawBody { datastores: [ { name: "InventoryStore", createdTime: "2023-09-16T11:03:03.868331Z" } ], nextPageCursor: "" }
 */
export declare const listStandardDatastores: <Prefix extends string>(this: any, args: {
    universeId: Identifier;
    prefix?: Prefix | undefined;
    limit?: number | undefined;
    cursor?: string | undefined;
}) => Promise<{
    data: {
        name: Prefix extends string ? `${Prefix}${string}` : string;
        createdTime: Date;
    }[];
    response: {
        fullResponse: unknown;
        url: `https://${string}`;
        method: import("../../../utils/utils.types").RestMethod;
        success: boolean;
        statusCode: number;
        headers: Headers;
        body: {
            datastores: {
                name: Prefix extends string ? `${Prefix}${string}` : string;
                createdTime: `${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}`;
            }[];
            nextPageCursor: string;
        };
    };
    cursors: {
        previous: import("../../apiGroup/apiGroup.types").Cursor;
        next: import("../../apiGroup/apiGroup.types").Cursor;
    };
    [Symbol.asyncIterator]: () => AsyncGenerator<{
        data: {
            name: Prefix extends string ? `${Prefix}${string}` : string;
            createdTime: Date;
        }[];
        response: {
            fullResponse: unknown;
            url: `https://${string}`;
            method: import("../../../utils/utils.types").RestMethod;
            success: boolean;
            statusCode: number;
            headers: Headers;
            body: {
                datastores: {
                    name: Prefix extends string ? `${Prefix}${string}` : string;
                    createdTime: `${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}`;
                }[];
                nextPageCursor: string;
            };
        };
        cursors: {
            previous: import("../../apiGroup/apiGroup.types").Cursor;
            next: import("../../apiGroup/apiGroup.types").Cursor;
        };
        [Symbol.asyncIterator]: null;
    } & {
        again: () => Promise<{
            data: {
                name: Prefix extends string ? `${Prefix}${string}` : string;
                createdTime: Date;
            }[];
            response: {
                fullResponse: unknown;
                url: `https://${string}`;
                method: import("../../../utils/utils.types").RestMethod;
                success: boolean;
                statusCode: number;
                headers: Headers;
                body: {
                    datastores: {
                        name: Prefix extends string ? `${Prefix}${string}` : string;
                        createdTime: `${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}`;
                    }[];
                    nextPageCursor: string;
                };
            };
        }>;
    }, any, unknown>;
} & {
    again: () => Promise<{
        data: {
            name: Prefix extends string ? `${Prefix}${string}` : string;
            createdTime: Date;
        }[];
        response: {
            fullResponse: unknown;
            url: `https://${string}`;
            method: import("../../../utils/utils.types").RestMethod;
            success: boolean;
            statusCode: number;
            headers: Headers;
            body: {
                datastores: {
                    name: Prefix extends string ? `${Prefix}${string}` : string;
                    createdTime: `${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}`;
                }[];
                nextPageCursor: string;
            };
        };
    }>;
}>;
/**
 * Returns a list of entry keys within a data store.
 * @endpoint GET /v1/universes/{universeId}/standard-datastores/datastore/entries
 * @tags [ "Cloud Key" ]
 * @deprecated Please use `StandardDataStoresApi_V2` for new work.
 *
 * @param universeId The identifier of the experience with data stores that you want to access.
 * @param datastoreName The name of the data store.
 * @param scope The value is global by default.
 * @param allScopes Set to true to return keys from all scopes.
 * @param prefix Provide to return only keys with this prefix.
 * @param limit The maximum number of items to return. Each call only reads one partition so it can return fewer than the given value when running out of objectives on one partition.
 * @param cursor Provide to request the next set of data.
 *
 * @example
 * const { data:keys } = await StandardDataStoresApi_V1.standardDatastoreKeys({
     universeId: 5097539509, datastoreName: "InventoryStore"
   })
 * @exampleData [ "user/45348281" ]
 * @exampleRawBody { keys: [ { key: "user/45348281" } ], nextPageCursor: "eyJ2ZXJzaW9uIjoxLCJjdXJzb3IiOiIxMyMifQ==" }
 */
export declare const standardDatastoreKeys: <Prefix extends string>(this: any, args: {
    universeId: Identifier;
    datastoreName: string;
    scope?: string | undefined;
    allScopes?: boolean | undefined;
    limit?: number | undefined;
    prefix?: Prefix | undefined;
    cursor?: string | undefined;
}) => Promise<{
    data: (Prefix extends string ? `${Prefix}${string}` : string)[];
    response: {
        fullResponse: unknown;
        url: `https://${string}`;
        method: import("../../../utils/utils.types").RestMethod;
        success: boolean;
        statusCode: number;
        headers: Headers;
        body: {
            keys: {
                key: Prefix extends string ? `${Prefix}${string}` : string;
            }[];
            nextPageCursor: string;
        };
    };
    cursors: {
        previous: import("../../apiGroup/apiGroup.types").Cursor;
        next: import("../../apiGroup/apiGroup.types").Cursor;
    };
    [Symbol.asyncIterator]: () => AsyncGenerator<{
        data: (Prefix extends string ? `${Prefix}${string}` : string)[];
        response: {
            fullResponse: unknown;
            url: `https://${string}`;
            method: import("../../../utils/utils.types").RestMethod;
            success: boolean;
            statusCode: number;
            headers: Headers;
            body: {
                keys: {
                    key: Prefix extends string ? `${Prefix}${string}` : string;
                }[];
                nextPageCursor: string;
            };
        };
        cursors: {
            previous: import("../../apiGroup/apiGroup.types").Cursor;
            next: import("../../apiGroup/apiGroup.types").Cursor;
        };
        [Symbol.asyncIterator]: null;
    } & {
        again: () => Promise<{
            data: (Prefix extends string ? `${Prefix}${string}` : string)[];
            response: {
                fullResponse: unknown;
                url: `https://${string}`;
                method: import("../../../utils/utils.types").RestMethod;
                success: boolean;
                statusCode: number;
                headers: Headers;
                body: {
                    keys: {
                        key: Prefix extends string ? `${Prefix}${string}` : string;
                    }[];
                    nextPageCursor: string;
                };
            };
        }>;
    }, any, unknown>;
} & {
    again: () => Promise<{
        data: (Prefix extends string ? `${Prefix}${string}` : string)[];
        response: {
            fullResponse: unknown;
            url: `https://${string}`;
            method: import("../../../utils/utils.types").RestMethod;
            success: boolean;
            statusCode: number;
            headers: Headers;
            body: {
                keys: {
                    key: Prefix extends string ? `${Prefix}${string}` : string;
                }[];
                nextPageCursor: string;
            };
        };
    }>;
}>;
/**
 * Returns the value and metadata associated with an entry. Depending on the runtime, `Bun.CryptoHasher` or `node:crypto` is used to calculate the md5 checksum.
 * @endpoint GET /v1/universes/{universeId}/standard-datastores/datastore/entries/entry
 * @tags [ "Cloud Key" ]
 * @deprecated Please use `StandardDataStoresApi_V2` for new work.
 *
 * @param universeId The identifier of the experience with data stores that you want to access.
 * @param datastoreName The name of the data store.
 * @param entryKey The key identifying the entry.
 * @param scope The value is global by default.
 *
 * @example
 * type InventorySchema = { Iron?: number, Gold?: number, Copper?: number, Stone?: number, Wood?: number }
   const { data:entryInfo } = await StandardDataStoresApi_V1.standardDatastoreEntry<InventorySchema>({
     universeId: 5097539509, datastoreName: "InventoryStore", entryKey: "user/45348281"
   })
   if (!entryInfo.checksumsMatch) console.log("checksums do not match, data may be invalid!")
   else console.log("checksums match! ->", entryInfo.entry)
 * @exampleData { entry: { Gold: 6, Iron: 57 }, checksumsMatch: true, metadata: { contentMD5: "hGwoaGwduF4bOhexREYGkA==", entryVersion: "08DBB6A47FDE6132.0000000016.08DBB782CEE11766.01", entryCreatedTime: 2023-09-16T11:03:03.922Z, entryVersionCreatedTime: 2023-09-17T13:34:24.754Z, entryAttributes: null, entryUserIds: [ 45348281 ] } }
 * @exampleRawBody { entry: { Gold: 6, Iron: 57 }, checksumsMatch: true, metadata: { contentMD5: "hGwoaGwduF4bOhexREYGkA==", entryVersion: "08DBB6A47FDE6132.0000000016.08DBB782CEE11766.01", entryCreatedTime: 2023-09-16T11:03:03.922Z, entryVersionCreatedTime: 2023-09-17T13:34:24.754Z, entryAttributes: null, entryUserIds: [ 45348281 ] } }
 */
export declare const standardDatastoreEntry: <Schema extends string | number | Record<any, any> = string | number>(this: any, args: {
    universeId: Identifier;
    datastoreName: string;
    entryKey: string;
    scope?: string | undefined;
}) => Promise<{
    data: {
        entry: Prettify<Schema, Schema extends Date ? true : false>;
        checksumsMatch: boolean;
        metadata: {
            contentMD5: string;
            entryVersion: string;
            entryCreatedTime: Date;
            entryVersionCreatedTime: Date;
            entryAttributes: Record<string, string> | null;
            entryUserIds: number[];
        };
    };
    response: {
        fullResponse: unknown;
        url: `https://${string}`;
        method: import("../../../utils/utils.types").RestMethod;
        success: boolean;
        statusCode: number;
        headers: Headers;
        body: Prettify<Exclude<Prettify<Schema, Schema extends Date ? true : false>, undefined>, Exclude<Prettify<Schema, Schema extends Date ? true : false>, undefined> extends infer T ? T extends Exclude<Prettify<Schema, Schema extends Date ? true : false>, undefined> ? T extends Date ? true : false : never : never>;
    };
} & {
    again: () => Promise<{
        data: {
            entry: Prettify<Schema, Schema extends Date ? true : false>;
            checksumsMatch: boolean;
            metadata: {
                contentMD5: string;
                entryVersion: string;
                entryCreatedTime: Date;
                entryVersionCreatedTime: Date;
                entryAttributes: Record<string, string> | null;
                entryUserIds: number[];
            };
        };
        response: {
            fullResponse: unknown;
            url: `https://${string}`;
            method: import("../../../utils/utils.types").RestMethod;
            success: boolean;
            statusCode: number;
            headers: Headers;
            body: Prettify<Exclude<Prettify<Schema, Schema extends Date ? true : false>, undefined>, Exclude<Prettify<Schema, Schema extends Date ? true : false>, undefined> extends infer T_1 ? T_1 extends Exclude<Prettify<Schema, Schema extends Date ? true : false>, undefined> ? T_1 extends Date ? true : false : never : never>;
        };
    }>;
}>;
/**
 * Sets the value, metadata and user IDs associated with an entry.
 * @endpoint POST /v1/universes/{universeId}/standard-datastores/datastore/entries/entry
 * @tags [ "Cloud Key" ]
 * @deprecated Please use `StandardDataStoresApi_V2` for new work.
 *
 * @param universeId The identifier of the experience with data stores that you want to access.
 * @param datastoreName The name of the data store.
 * @param entryKey The key identifying the entry.
 * @param scope The value is global by default.
 * @param matchVersion Provide to update only if the current version matches this.
 * @param exclusiveCreate Create the entry only if it does not exist.
 * @param entryAttributes Attributes to be associated with new version of the entry. If not provided, existing attributes are cleared.
 * @param entryUserIds An array of Roblox user IDs tagged with the entry. If not provided, existing user IDs are cleared.
 *
 * @example
 * type InventorySchema = { Iron?: number, Gold?: number, Copper?: number, Stone?: number, Wood?: number }
   const { data:response } = await StandardDataStoresApi_V1.setStandardDatastoreEntry<InventorySchema>({
     universeId: 5097539509, datastoreName: "InventoryStore", entryKey: "user/45348281",
     entryValue: { Gold: 6 },  entryUserIds: [ 45348281 ]
   })
 * @exampleData { version: "08DBB6A47FDE6132.000000000E.08DBB780C616DF0C.01", deleted: false, contentLength: 20, createdTime: 2023-09-17T13:19:51.014Z, objectCreatedTime: 2023-09-16T11:03:03.922Z }
 * @exampleRawBody { version: "08DBB6A47FDE6132.000000000E.08DBB780C616DF0C.01", deleted: false, contentLength: 20, createdTime: "2023-09-17T13:19:51.014Z", objectCreatedTime: "2023-09-16T11:03:03.922Z" }
 */
export declare const setStandardDatastoreEntry: <Schema extends string | number | Record<any, any> = string | number>(this: any, args: {
    universeId: Identifier;
    datastoreName: string;
    entryKey: string;
    entryValue: Schema;
    scope?: string | undefined;
    matchVersion?: string | undefined;
    exclusiveCreate?: boolean | undefined;
    entryAttributes?: Record<string, Identifier> | undefined;
    entryUserIds?: Identifier[] | undefined;
}) => Promise<{
    data: {
        version: string;
        deleted: boolean;
        contentLength: number;
        createdTime: Date;
        objectCreatedTime: Date;
    };
    response: {
        fullResponse: unknown;
        url: `https://${string}`;
        method: import("../../../utils/utils.types").RestMethod;
        success: boolean;
        statusCode: number;
        headers: Headers;
        body: {
            version: string;
            deleted: boolean;
            contentLength: number;
            createdTime: `${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}`;
            objectCreatedTime: `${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: {
            version: string;
            deleted: boolean;
            contentLength: number;
            createdTime: Date;
            objectCreatedTime: Date;
        };
        response: {
            fullResponse: unknown;
            url: `https://${string}`;
            method: import("../../../utils/utils.types").RestMethod;
            success: boolean;
            statusCode: number;
            headers: Headers;
            body: {
                version: string;
                deleted: boolean;
                contentLength: number;
                createdTime: `${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}`;
                objectCreatedTime: `${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}`;
            };
        };
    }>;
}>;
/**
 * Returns the value and metadata associated with an entry.
 * @endpoint GET /v1/universes/{universeId}/standard-datastores/datastore/entries/entry
 * @tags [ "Cloud Key" ]
 * @deprecated Please use `StandardDataStoresApi_V2` for new work.
 *
 * @param universeId The identifier of the experience with data stores that you want to access.
 * @param datastoreName The name of the data store.
 * @param entryKey The key identifying the entry.
 * @param scope The value is global by default.
 *
 * @example const { data:success } = await StandardDataStoresApi_V1.deleteStandardDatastoreEntry({
     universeId: 5097539509, datastoreName: "InventoryStore",  entryKey: "user/45348281"
   })
 * @exampleData true
 * @exampleRawBody ""
 */
export declare const deleteStandardDatastoreEntry: import("../../apiGroup/apiGroup.types").CallApiMethod<{
    universeId: Identifier;
    datastoreName: string;
    entryKey: string;
    scope?: 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: "") => 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>;
/**
 * Increments the value for an entry by a given amount, or create a new entry with that amount.
 * @endpoint POST /v1/universes/{universeId}/standard-datastores/datastore/entries/entry/increment
 * @tags [ "Cloud Key" ]
 * @deprecated Please use `StandardDataStoresApi_V2` for new work.
 *
 * @param universeId The identifier of the experience with data stores that you want to access.
 * @param datastoreName The name of the data store.
 * @param entryKey The key identifying the entry.
 * @param incrementBy The amount by which the entry should be incremented, or the starting value if it doesn't exist.
 * @param scope The value is global by default.
 * @param entryAttributes Attributes to be associated with new version of the entry. If not provided, existing attributes are cleared.
 * @param entryUserIds A comma-separated list of Roblox user IDs that the entry is tagged with. If not provided, existing user IDs are cleared.
 *
 * @example
 * const { data:incrementedEntry } = await StandardDataStoresApi_V1.incrementStandardDatastoreEntry({
     universeId: 5097539509, datastoreName: "LoremIpsum", entryKey: "user/45348281", incrementBy: 1,
     entryUserIds: [ 45348281 ]
   })
 * @exampleData 2
 * @exampleRawBody 2
 */
export declare const incrementStandardDatastoreEntry: import("../../apiGroup/apiGroup.types").CallApiMethod<{
    universeId: Identifier;
    datastoreName: string;
    entryKey: string;
    scope?: string | undefined;
    incrementBy: number;
    entryAttributes?: Record<string, Identifier> | undefined;
    entryUserIds?: Identifier[] | 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: 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>;
/**
 * Returns the value and metadata of a specific version of an entry.
 * @endpoint POST /v1/universes/{universeId}/standard-datastores/datastore/entries/entry/versions/version
 * @tags [ "Cloud Key" ]
 * @deprecated Please use `StandardDataStoresApi_V2` for new work.
 *
 * @param universeId The identifier of the experience with data stores that you want to access.
 * @param datastoreName The name of the data store.
 * @param entryKey The key identifying the entry.
 * @param versionId The version to inspect.
 * @param scope The value is global by default.
 *
 * @example
 * type InventorySchema = { Iron?: number, Gold?: number, Copper?: number, Stone?: number, Wood?: number }
   const { data:entry } = await StandardDataStoresApi_V1.standardDatastoreEntryOfVersion({
     universeId: 5097539509, datastoreName: "LoremIpsum",  entryKey: "user/45348281",
     versionId: "08DC7742E4BD78AF.0000000001.08DC7742E4BD78AF.01"
   })
 * @exampleData { entry: { Gold: 6, Iron: 57 }, checksumsMatch: true, metadata: { contentMD5: "hGwoaGwduF4bOhexREYGkA==", entryVersion: "08DBB6A47FDE6132.0000000016.08DBB782CEE11766.01", entryCreatedTime: 2023-09-16T11:03:03.922Z, entryVersionCreatedTime: 2023-09-17T13:34:24.754Z, entryAttributes: null, entryUserIds: [ 45348281 ] } }
 * @exampleRawBody { entry: { Gold: 6, Iron: 57 }, checksumsMatch: true, metadata: { contentMD5: "hGwoaGwduF4bOhexREYGkA==", entryVersion: "08DBB6A47FDE6132.0000000016.08DBB782CEE11766.01", entryCreatedTime: 2023-09-16T11:03:03.922Z, entryVersionCreatedTime: 2023-09-17T13:34:24.754Z, entryAttributes: null, entryUserIds: [ 45348281 ] } }
 */
export declare const standardDatastoreEntryOfVersion: <Schema extends string | number | Record<any, any> = string | number>(this: any, args: {
    universeId: Identifier;
    datastoreName: string;
    entryKey: string;
    scope?: string | undefined;
    versionId: string;
}) => Promise<{
    data: {
        entry: Prettify<Schema, Schema extends Date ? true : false>;
        checksumsMatch: boolean;
        metadata: {
            contentMD5: string;
            entryVersion: string;
            entryCreatedTime: Date;
            entryVersionCreatedTime: Date;
            entryAttributes: Record<string, string> | null;
            entryUserIds: number[];
        };
    };
    response: {
        fullResponse: unknown;
        url: `https://${string}`;
        method: import("../../../utils/utils.types").RestMethod;
        success: boolean;
        statusCode: number;
        headers: Headers;
        body: Prettify<Exclude<Prettify<Prettify<Schema, Schema extends Date ? true : false>, Prettify<Schema, Schema extends Date ? true : false> extends infer T ? T extends Prettify<Schema, Schema extends Date ? true : false> ? T extends Date ? true : false : never : never>, undefined>, Exclude<Prettify<Prettify<Schema, Schema extends Date ? true : false>, Prettify<Schema, Schema extends Date ? true : false> extends infer T_1 ? T_1 extends Prettify<Schema, Schema extends Date ? true : false> ? T_1 extends Date ? true : false : never : never>, undefined> extends infer T_2 ? T_2 extends Exclude<Prettify<Prettify<Schema, Schema extends Date ? true : false>, Prettify<Schema, Schema extends Date ? true : false> extends infer T_3 ? T_3 extends Prettify<Schema, Schema extends Date ? true : false> ? T_3 extends Date ? true : false : never : never>, undefined> ? T_2 extends Date ? true : false : never : never>;
    };
} & {
    again: () => Promise<{
        data: {
            entry: Prettify<Schema, Schema extends Date ? true : false>;
            checksumsMatch: boolean;
            metadata: {
                contentMD5: string;
                entryVersion: string;
                entryCreatedTime: Date;
                entryVersionCreatedTime: Date;
                entryAttributes: Record<string, string> | null;
                entryUserIds: number[];
            };
        };
        response: {
            fullResponse: unknown;
            url: `https://${string}`;
            method: import("../../../utils/utils.types").RestMethod;
            success: boolean;
            statusCode: number;
            headers: Headers;
            body: Prettify<Exclude<Prettify<Prettify<Schema, Schema extends Date ? true : false>, Prettify<Schema, Schema extends Date ? true : false> extends infer T_4 ? T_4 extends Prettify<Schema, Schema extends Date ? true : false> ? T_4 extends Date ? true : false : never : never>, undefined>, Exclude<Prettify<Prettify<Schema, Schema extends Date ? true : false>, Prettify<Schema, Schema extends Date ? true : false> extends infer T_5 ? T_5 extends Prettify<Schema, Schema extends Date ? true : false> ? T_5 extends Date ? true : false : never : never>, undefined> extends infer T_6 ? T_6 extends Exclude<Prettify<Prettify<Schema, Schema extends Date ? true : false>, Prettify<Schema, Schema extends Date ? true : false> extends infer T_7 ? T_7 extends Prettify<Schema, Schema extends Date ? true : false> ? T_7 extends Date ? true : false : never : never>, undefined> ? T_6 extends Date ? true : false : never : never>;
        };
    }>;
}>;
/**
 * Returns a list of data stores belonging to an experience.
 * @endpoint GET /v1/universes/{universeId}/standard-datastores/datastore/entries/entry/versions
 * @tags [ "Cloud Key" ]
 * @deprecated Please use `StandardDataStoresApi_V2` for new work.
 *
 * @param universeId The identifier of the experience with data stores that you want to access.
 * @param datastoreName The name of the data store.
 * @param entryKey The key identifying the entry.
 * @param scope The value is global by default.
 * @param startTime Provide to not include versions earlier than this timestamp.
 * @param endTime Provide to not include versions later than this timestamp.
 * @param sortOrder Either "Ascending" (earlier versions first) or "Descending" (later versions first).
 * @param limit The maximum number of items to return. Each call only reads one partition so it can return fewer than the given value when running out of objectives on one partition.
 * @param cursor Provide to request the next set of data.
 *
 * @example
 * const { data:versions } = await StandardDataStoresApi_V1.listStandardDatastoreEntryVersions({
     universeId: 5097539509, datastoreName: "InventoryStore", entryKey: "user/45348281",
     sortOrder: "Ascending", limit: 1
   })
 * @exampleData [ { version: "08DBB6A47FDE6132.0000000010.08DBB781B9579F00.01", deleted: false, contentLength: 20, createdTime: 2023-09-17T13:26:39.124Z, objectCreatedTime: 2023-09-16T11:03:03.922Z } ]
 * @exampleRawBody { versions: [ { version: "08DBB6A47FDE6132.0000000010.08DBB781B9579F00.01", deleted: false, contentLength: 20, createdTime: "2023-09-17T13:26:39.124Z", objectCreatedTime: "2023-09-16T11:03:03.922Z" } ] }
 */
export declare const listStandardDatastoreEntryVersions: <Schema extends string | number | Record<any, any> = string | number>(this: any, args: {
    universeId: Identifier;
    datastoreName: string;
    entryKey: string;
    scope?: string | undefined;
    startTime?: 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;
    endTime?: 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;
    sortOrder?: "Ascending" | "Descending" | undefined;
    limit?: number | undefined;
    cursor?: string | undefined;
}) => Promise<{
    data: {
        version: string;
        deleted: boolean;
        contentLength: number;
        createdTime: Date;
        objectCreatedTime: Date;
    }[];
    response: {
        fullResponse: unknown;
        url: `https://${string}`;
        method: import("../../../utils/utils.types").RestMethod;
        success: boolean;
        statusCode: number;
        headers: Headers;
        body: {
            versions: {
                version: string;
                deleted: boolean;
                contentLength: number;
                createdTime: `${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}`;
                objectCreatedTime: `${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}`;
            }[];
            nextPageCursor: string;
        };
    };
    cursors: {
        previous: import("../../apiGroup/apiGroup.types").Cursor;
        next: import("../../apiGroup/apiGroup.types").Cursor;
    };
    [Symbol.asyncIterator]: () => AsyncGenerator<{
        data: {
            version: string;
            deleted: boolean;
            contentLength: number;
            createdTime: Date;
            objectCreatedTime: Date;
        }[];
        response: {
            fullResponse: unknown;
            url: `https://${string}`;
            method: import("../../../utils/utils.types").RestMethod;
            success: boolean;
            statusCode: number;
            headers: Headers;
            body: {
                versions: {
                    version: string;
                    deleted: boolean;
                    contentLength: number;
                    createdTime: `${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}`;
                    objectCreatedTime: `${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}`;
                }[];
                nextPageCursor: string;
            };
        };
        cursors: {
            previous: import("../../apiGroup/apiGroup.types").Cursor;
            next: import("../../apiGroup/apiGroup.types").Cursor;
        };
        [Symbol.asyncIterator]: null;
    } & {
        again: () => Promise<{
            data: {
                version: string;
                deleted: boolean;
                contentLength: number;
                createdTime: Date;
                objectCreatedTime: Date;
            }[];
            response: {
                fullResponse: unknown;
                url: `https://${string}`;
                method: import("../../../utils/utils.types").RestMethod;
                success: boolean;
                statusCode: number;
                headers: Headers;
                body: {
                    versions: {
                        version: string;
                        deleted: boolean;
                        contentLength: number;
                        createdTime: `${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}${n