openblox
Version:
Roblox API Wrapper For Both Classic And OpenCloud APIs.
620 lines • 81.9 kB
TypeScript
import type { Identifier } from "typeforge";
import type { PrettifiedCreateStandardDataStoreSnapshotData, PrettifiedFullDatastoreData, PrettifiedListStandardDatastoreEntriesData, PrettifiedListStandardDatastoresData, RawCreateStandardDataStoreSnapshotData, RawFullDatastoreData } from "./standardDataStores_V2.types";
/**
* Returns a list of data stores belonging to an experience.
* @endpoint GET /v2/universes/{universeId}/data-stores
*
* @param universeId The ID of the universe to list datastores for.
* @param prefix Provide to return only data stores with this prefix.
* @param limit The maximum number of data stores to return. The service might return fewer than this value. If unspecified, at most 10 data stores are returned. The maximum value is 100 and higher values are set to 100.
* @param cursor The paging cursor for the previous or next page.
*
* @example const { data:datastores } = await StandardDataStoresApi_V2.listStandardDataStores({ universeId: 5097539509, prefix: "Ba" })
* @exampleData [{"path":"universes/5097539509/data-stores/Bans","id":"Bans"}]
* @exampleRawBody {"dataStores":[{"path":"universes/5097539509/data-stores/Bans","id":"Bans"}]}
*/
export declare const listStandardDataStores: <UniverseId extends Identifier, Prefix extends string>(this: any, args: {
universeId: UniverseId;
prefix?: Prefix | undefined;
limit?: number | undefined;
cursor?: string | undefined;
}) => Promise<{
data: {
path: `universes/${UniverseId}/data-stores/${string}`;
id: `${Prefix}${string}`;
}[];
response: {
fullResponse: unknown;
url: `https://${string}`;
method: import("../../../utils/utils.types").RestMethod;
success: boolean;
statusCode: number;
headers: Headers;
body: {
dataStores: PrettifiedListStandardDatastoresData<UniverseId, Prefix>;
nextPageToken: string;
};
};
cursors: {
previous: import("../../apiGroup/apiGroup.types").Cursor;
next: import("../../apiGroup/apiGroup.types").Cursor;
};
[Symbol.asyncIterator]: () => AsyncGenerator<{
data: {
path: `universes/${UniverseId}/data-stores/${string}`;
id: `${Prefix}${string}`;
}[];
response: {
fullResponse: unknown;
url: `https://${string}`;
method: import("../../../utils/utils.types").RestMethod;
success: boolean;
statusCode: number;
headers: Headers;
body: {
dataStores: PrettifiedListStandardDatastoresData<UniverseId, Prefix>;
nextPageToken: string;
};
};
cursors: {
previous: import("../../apiGroup/apiGroup.types").Cursor;
next: import("../../apiGroup/apiGroup.types").Cursor;
};
[Symbol.asyncIterator]: null;
} & {
again: () => Promise<{
data: {
path: `universes/${UniverseId}/data-stores/${string}`;
id: `${Prefix}${string}`;
}[];
response: {
fullResponse: unknown;
url: `https://${string}`;
method: import("../../../utils/utils.types").RestMethod;
success: boolean;
statusCode: number;
headers: Headers;
body: {
dataStores: PrettifiedListStandardDatastoresData<UniverseId, Prefix>;
nextPageToken: string;
};
};
}>;
}, any, unknown>;
} & {
again: () => Promise<{
data: {
path: `universes/${UniverseId}/data-stores/${string}`;
id: `${Prefix}${string}`;
}[];
response: {
fullResponse: unknown;
url: `https://${string}`;
method: import("../../../utils/utils.types").RestMethod;
success: boolean;
statusCode: number;
headers: Headers;
body: {
dataStores: PrettifiedListStandardDatastoresData<UniverseId, Prefix>;
nextPageToken: string;
};
};
}>;
}>;
/**
* Creates a snapshot of standard datastores for a universe.
* @endpoint POST /cloud/v2/universes/{universeId}/data-stores:snapshot
*
* @param universeId The ID of the universe to create a snapshot for.
*
* @example const { data:snapshot } = await StandardDataStoresApi_V2.createStandardDataStoreSnapshot({ universeId: 5097539509 })
* @exampleData {"newSnapshotTaken":false,"latestSnapshotTime":"2024-07-29T22:08:49.588Z"}
* @exampleRawBody {"newSnapshotTaken":false,"latestSnapshotTime":"2024-07-29T22:08:49.588Z"}
*/
export declare const createStandardDataStoreSnapshot: import("../../apiGroup/apiGroup.types").CallApiMethod<{
universeId: Identifier;
}, {
method: import("../../../utils/utils.types").RestMethod;
path: `/${string}`;
name: string;
searchParams?: string | Record<string, any> | undefined;
headers?: Record<string, any> | undefined;
body?: string | number | Record<string, any> | undefined;
formData?: FormData | undefined;
applyFieldMask?: boolean | undefined;
pathToPoll?: ((rawData: RawCreateStandardDataStoreSnapshotData) => string) | undefined;
getCursorsFn?: ((rawData: {
newSnapshotTaken: true;
latestSnapshotTime: `${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}`;
} | {
newSnapshotTaken: false;
latestSnapshotTime?: false | 0 | null | undefined;
}) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined;
"\uD83D\uDD12__PRIVATE_RAW_DATA"?: {
newSnapshotTaken: true;
latestSnapshotTime: `${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}`;
} | {
newSnapshotTaken: false;
latestSnapshotTime?: false | 0 | null | undefined;
} | undefined;
"\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: {
newSnapshotTaken: true;
latestSnapshotTime: Date;
} | {
newSnapshotTaken: false;
latestSnapshotTime?: false | 0 | null | undefined;
} | undefined;
} & import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<RawCreateStandardDataStoreSnapshotData, PrettifiedCreateStandardDataStoreSnapshotData>, false>;
/**
* Lists entries for a standard datastore.
* @endpoint
* GET /v2/universes/{universe}/data-stores/{data-store}/entries
* GET /v2/universes/{universe}/data-stores/{data-store}/scopes/{scope}/entries
*
* @param universeId The ID of the universe to get data store entries for.
* @param prefix Provide to return only data store entries with this prefix.
* @param limit The maximum number of data store entries to return. The service might return fewer than this value. If unspecified, at most 10 data store entries are returned. The maximum value is 256 and higher values are set to 256.
* @param cursor The paging cursor for the previous or next page.
*
* @example
* await StandardDataStoresApi_V2.listStandardDataStoreEntries({
universeId: 5097539509, dataStore: "InventoryStore"
})
* @exampleData [{"path":"universes/5097539509/data-stores/InventoryStore/entries/user/45348281","id":"user/45348281"}]
* @exampleRawBody {"dataStoreEntries":[{"path":"universes/5097539509/data-stores/InventoryStore/entries/user/45348281","id":"user/45348281"}]}
*/
export declare const listStandardDataStoreEntries: <UniverseId extends Identifier, Prefix extends string, DataStore extends string, Scope extends string>(this: any, args: {
universeId: UniverseId;
dataStore: DataStore;
scope?: Scope | undefined;
prefix?: Prefix | undefined;
limit?: number | undefined;
cursor?: string | undefined;
}) => Promise<{
data: {
path: `universes/${UniverseId}/data-stores/${DataStore}/entries/${import("typeforge").StringIsLiteral<Scope> extends true ? `${Scope}/` : ""}${Prefix}${string}`;
id: `${Prefix}${string}`;
}[];
response: {
fullResponse: unknown;
url: `https://${string}`;
method: import("../../../utils/utils.types").RestMethod;
success: boolean;
statusCode: number;
headers: Headers;
body: {
dataStoreEntries: PrettifiedListStandardDatastoreEntriesData<UniverseId, Prefix, DataStore, Scope>;
nextPageToken: string;
};
};
cursors: {
previous: import("../../apiGroup/apiGroup.types").Cursor;
next: import("../../apiGroup/apiGroup.types").Cursor;
};
[Symbol.asyncIterator]: () => AsyncGenerator<{
data: {
path: `universes/${UniverseId}/data-stores/${DataStore}/entries/${import("typeforge").StringIsLiteral<Scope> extends true ? `${Scope}/` : ""}${Prefix}${string}`;
id: `${Prefix}${string}`;
}[];
response: {
fullResponse: unknown;
url: `https://${string}`;
method: import("../../../utils/utils.types").RestMethod;
success: boolean;
statusCode: number;
headers: Headers;
body: {
dataStoreEntries: PrettifiedListStandardDatastoreEntriesData<UniverseId, Prefix, DataStore, Scope>;
nextPageToken: string;
};
};
cursors: {
previous: import("../../apiGroup/apiGroup.types").Cursor;
next: import("../../apiGroup/apiGroup.types").Cursor;
};
[Symbol.asyncIterator]: null;
} & {
again: () => Promise<{
data: {
path: `universes/${UniverseId}/data-stores/${DataStore}/entries/${import("typeforge").StringIsLiteral<Scope> extends true ? `${Scope}/` : ""}${Prefix}${string}`;
id: `${Prefix}${string}`;
}[];
response: {
fullResponse: unknown;
url: `https://${string}`;
method: import("../../../utils/utils.types").RestMethod;
success: boolean;
statusCode: number;
headers: Headers;
body: {
dataStoreEntries: PrettifiedListStandardDatastoreEntriesData<UniverseId, Prefix, DataStore, Scope>;
nextPageToken: string;
};
};
}>;
}, any, unknown>;
} & {
again: () => Promise<{
data: {
path: `universes/${UniverseId}/data-stores/${DataStore}/entries/${import("typeforge").StringIsLiteral<Scope> extends true ? `${Scope}/` : ""}${Prefix}${string}`;
id: `${Prefix}${string}`;
}[];
response: {
fullResponse: unknown;
url: `https://${string}`;
method: import("../../../utils/utils.types").RestMethod;
success: boolean;
statusCode: number;
headers: Headers;
body: {
dataStoreEntries: PrettifiedListStandardDatastoreEntriesData<UniverseId, Prefix, DataStore, Scope>;
nextPageToken: string;
};
};
}>;
}>;
/**
* Creates an entry in a standard datastore.
* @endpoint
* POST /v2/universes/{universe}/data-stores/{data-store}/entries
* POST /v2/universes/{universe}/data-stores/{data-store}/scopes/{scope}/entries
*
* @param universeId The ID of the universe to create the entry in.
* @param dataStore the name of the datastore to create the entry in.
* @param scope The optional scope for the dataStore.
* @param entryId The ID (key / name) for the entry.
* @param value The value (content) for the entry.
* @param users Array metadata containing the IDs of the users this entry is affiliated with.
* @param attributes Key-Value Pairs metadata containing arbitrary data.
*
* @example
* type InventorySchema = { Iron?: number, Gold?: number, Copper?: number, Stone?: number, Wood?: number }
* const { data:entry } = await StandardDataStoresApi_V2.createStandardDataStoreEntry<InventorySchema>({
universeId: 5097539509, dataStore: "InventoryStore", entryId: "users/45348281", value: { Iron: 50 }, users: [ 45348281 ]
})
* @exampleData {"path":"universes/5097539509/data-stores/InventoryStore/entries/users:45348281","createTime":"2024-07-22T19:06:55.829Z","revisionId":"08DCAA81744A406E.0000000001.08DCAA81744A406E.01","revisionCreateTime":"2024-07-22T19:06:55.829Z","state":"ACTIVE","etag":"08DCAA81744A406E.0000000001.08DCAA81744A406E.01","value":{"Iron":50},"id":"users:45348281","users":["users/45348281"],"attributes":{}}
* @exampleRawBody {"path":"universes/5097539509/data-stores/InventoryStore/entries/users:45348281","createTime":"2024-07-22T19:06:55.829412600Z","revisionId":"08DCAA81744A406E.0000000001.08DCAA81744A406E.01","revisionCreateTime":"2024-07-22T19:06:55.829412600Z","state":"ACTIVE","etag":"08DCAA81744A406E.0000000001.08DCAA81744A406E.01","value":{"Iron":50},"id":"users:45348281","users":["users/45348281"],"attributes":{}}
*/
export declare const createStandardDataStoreEntry: <Schema extends string | number | boolean | any[] | Record<any, any> | null>(this: any, args: {
universeId: Identifier;
dataStore: string;
scope?: string | undefined;
entryId: string;
value: Schema;
users?: Identifier[] | undefined;
attributes?: Record<any, any> | undefined;
}) => Promise<{
data: {
path: `universes/${number}/data-stores/${string}/entries/${string}` | `universes/${number}/data-stores/${string}/entries/${string}@${string}` | `universes/${number}/data-stores/${string}/scope/${string}/entries/${string}` | `universes/${number}/data-stores/${string}/scope/${string}/entries/${string}@${string}`;
createTime: Date;
revisionId: string;
revisionCreateTime: Date;
state: "STATE_UNSPECIFIED" | "ACTIVE" | "DELETED";
etag: string;
value: import("typeforge").PrettifyDeep<Schema, Schema extends Date ? true : false>;
id: string;
users: `users/${number}`[];
attributes: Record<any, any>;
};
response: {
fullResponse: unknown;
url: `https://${string}`;
method: import("../../../utils/utils.types").RestMethod;
success: boolean;
statusCode: number;
headers: Headers;
body: {
path: `universes/${number}/data-stores/${string}/entries/${string}` | `universes/${number}/data-stores/${string}/entries/${string}@${string}` | `universes/${number}/data-stores/${string}/scope/${string}/entries/${string}` | `universes/${number}/data-stores/${string}/scope/${string}/entries/${string}@${string}`;
createTime: `${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}`;
revisionId: string;
revisionCreateTime: `${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}`;
state: "STATE_UNSPECIFIED" | "ACTIVE" | "DELETED";
etag: string;
value: import("typeforge").PrettifyDeep<Schema, Schema extends Date ? true : false>;
id: string;
users: `users/${number}`[];
attributes: Record<any, any>;
};
};
} & {
again: () => Promise<{
data: {
path: `universes/${number}/data-stores/${string}/entries/${string}` | `universes/${number}/data-stores/${string}/entries/${string}@${string}` | `universes/${number}/data-stores/${string}/scope/${string}/entries/${string}` | `universes/${number}/data-stores/${string}/scope/${string}/entries/${string}@${string}`;
createTime: Date;
revisionId: string;
revisionCreateTime: Date;
state: "STATE_UNSPECIFIED" | "ACTIVE" | "DELETED";
etag: string;
value: import("typeforge").PrettifyDeep<Schema, Schema extends Date ? true : false>;
id: string;
users: `users/${number}`[];
attributes: Record<any, any>;
};
response: {
fullResponse: unknown;
url: `https://${string}`;
method: import("../../../utils/utils.types").RestMethod;
success: boolean;
statusCode: number;
headers: Headers;
body: {
path: `universes/${number}/data-stores/${string}/entries/${string}` | `universes/${number}/data-stores/${string}/entries/${string}@${string}` | `universes/${number}/data-stores/${string}/scope/${string}/entries/${string}` | `universes/${number}/data-stores/${string}/scope/${string}/entries/${string}@${string}`;
createTime: `${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}`;
revisionId: string;
revisionCreateTime: `${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}`;
state: "STATE_UNSPECIFIED" | "ACTIVE" | "DELETED";
etag: string;
value: import("typeforge").PrettifyDeep<Schema, Schema extends Date ? true : false>;
id: string;
users: `users/${number}`[];
attributes: Record<any, any>;
};
};
}>;
}>;
/**
* Gets an entry from a standard datastore.
* @endpoint
* GET /v2/universes/{universe}/data-stores/{data-store}/entries/{entryId}
* GET /v2/universes/{universe}/data-stores/{data-store}/scopes/{scope}/entries/{entryId}
*
* @param universeId The ID of the universe to get the entry in.
* @param dataStore the name of the datastore to get the entry in.
* @param scope The optional scope of the dataStore.
* @param entryId The ID (key / name) of the entry.
*
* @example
* type InventorySchema = { Iron?: number, Gold?: number, Copper?: number, Stone?: number, Wood?: number }
const { data, response:{body} } = await StandardDataStoresApi_V2.standardDataStoreEntry<InventorySchema>({
universeId: 5097539509, dataStore: "InventoryStore", entryId: "users/45348281"
})
* @exampleData
* @exampleRawBody
*/
export declare const standardDataStoreEntry: <Schema extends Record<any, any>>(this: any, args: {
universeId: Identifier;
dataStore: string;
scope?: string | undefined;
entryId: string;
revisionId?: string | undefined;
}) => Promise<{
data: {
path: `universes/${number}/data-stores/${string}/entries/${string}` | `universes/${number}/data-stores/${string}/entries/${string}@${string}` | `universes/${number}/data-stores/${string}/scope/${string}/entries/${string}` | `universes/${number}/data-stores/${string}/scope/${string}/entries/${string}@${string}`;
createTime: Date;
revisionId: string;
revisionCreateTime: Date;
state: "STATE_UNSPECIFIED" | "ACTIVE" | "DELETED";
etag: string;
value: import("typeforge").PrettifyDeep<Schema, Schema extends Date ? true : false>;
id: string;
users: `users/${number}`[];
attributes: Record<any, any>;
};
response: {
fullResponse: unknown;
url: `https://${string}`;
method: import("../../../utils/utils.types").RestMethod;
success: boolean;
statusCode: number;
headers: Headers;
body: {
path: `universes/${number}/data-stores/${string}/entries/${string}` | `universes/${number}/data-stores/${string}/entries/${string}@${string}` | `universes/${number}/data-stores/${string}/scope/${string}/entries/${string}` | `universes/${number}/data-stores/${string}/scope/${string}/entries/${string}@${string}`;
createTime: `${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}`;
revisionId: string;
revisionCreateTime: `${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}`;
state: "STATE_UNSPECIFIED" | "ACTIVE" | "DELETED";
etag: string;
value: import("typeforge").PrettifyDeep<Schema, Schema extends Date ? true : false>;
id: string;
users: `users/${number}`[];
attributes: Record<any, any>;
};
};
} & {
again: () => Promise<{
data: {
path: `universes/${number}/data-stores/${string}/entries/${string}` | `universes/${number}/data-stores/${string}/entries/${string}@${string}` | `universes/${number}/data-stores/${string}/scope/${string}/entries/${string}` | `universes/${number}/data-stores/${string}/scope/${string}/entries/${string}@${string}`;
createTime: Date;
revisionId: string;
revisionCreateTime: Date;
state: "STATE_UNSPECIFIED" | "ACTIVE" | "DELETED";
etag: string;
value: import("typeforge").PrettifyDeep<Schema, Schema extends Date ? true : false>;
id: string;
users: `users/${number}`[];
attributes: Record<any, any>;
};
response: {
fullResponse: unknown;
url: `https://${string}`;
method: import("../../../utils/utils.types").RestMethod;
success: boolean;
statusCode: number;
headers: Headers;
body: {
path: `universes/${number}/data-stores/${string}/entries/${string}` | `universes/${number}/data-stores/${string}/entries/${string}@${string}` | `universes/${number}/data-stores/${string}/scope/${string}/entries/${string}` | `universes/${number}/data-stores/${string}/scope/${string}/entries/${string}@${string}`;
createTime: `${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}`;
revisionId: string;
revisionCreateTime: `${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}`;
state: "STATE_UNSPECIFIED" | "ACTIVE" | "DELETED";
etag: string;
value: import("typeforge").PrettifyDeep<Schema, Schema extends Date ? true : false>;
id: string;
users: `users/${number}`[];
attributes: Record<any, any>;
};
};
}>;
}>;
/**
* Deletes an entry from a standard datastore.
* @endpoint
* DELETE /v2/universes/{universe}/data-stores/{data-store}/entries/{entryId}
* DELETE /v2/universes/{universe}/data-stores/{data-store}/scopes/{scope}/entries/{entryId}
*
* @param universeId The ID of the universe to delete the entry in.
* @param dataStore the name of the datastore to delete the entry in.
* @param scope The optional scope of the dataStore.
* @param entryId The ID (key / name) of the entry.
*
* @example
* const { data:success } = await StandardDataStoresApi_V2.deleteStandardDataStoreEntry({
universeId: 5097539509, dataStore: "InventoryStore", entryId: "users/45348281"
})
* @exampleData true
* @exampleRawBody {}
*/
export declare const deleteStandardDataStoreEntry: import("../../apiGroup/apiGroup.types").CallApiMethod<{
universeId: Identifier;
dataStore: string;
scope?: string | undefined;
entryId: string;
}, {
method: import("../../../utils/utils.types").RestMethod;
path: `/${string}`;
name: string;
searchParams?: string | Record<string, any> | undefined;
headers?: Record<string, any> | undefined;
body?: string | number | Record<string, any> | undefined;
formData?: FormData | undefined;
applyFieldMask?: boolean | undefined;
pathToPoll?: ((rawData: {}) => string) | undefined;
getCursorsFn?: ((rawData: {}) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined;
"\uD83D\uDD12__PRIVATE_RAW_DATA"?: {} | undefined;
"\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: boolean | undefined;
} & import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<{}, boolean>, false>;
/**
* Updates an entry in a standard datastore.
* @endpoint
* PATCH /v2/universes/{universe}/data-stores/{data-store}/entries/{entryId}
* PATCH /v2/universes/{universe}/data-stores/{data-store}/scopes/{scope}/entries/{entryId}
*
* @param universeId The ID of the universe to update an entry in.
* @param dataStore the name of the datastore to update an entry in.
* @param scope The optional scope of the dataStore.
* @param entryId The ID (key / name) of the entry.
* @param allowMissing If set to true, and the data store entry is not found, a data store entry is created.
* @param value The value (content) of the entry.
* @param users Array metadata containing the IDs of the users this entry is affiliated with.
* @param attributes Key-Value Pairs metadata containing arbitrary data.
*
* @example
* type InventorySchema = { Iron?: number, Gold?: number, Copper?: number, Stone?: number, Wood?: number }
const { data, response:{body} } = await StandardDataStoresApi_V2.updateStandardDataStoreEntry<InventorySchema>({
universeId: 5097539509, dataStore: "InventoryStore", entryId: "users/453482811", value: { Iron: 50, Gold: 26 }, users: [ 45348281 ]
})
* @exampleData {"path":"universes/5097539509/data-stores/InventoryStore/entries/users:453482811","createTime":"2024-07-22T19:02:27.811Z","revisionId":"08DCAA80D489FD52.0000000003.08DCAA8627CF76E1.01","revisionCreateTime":"2024-07-22T19:02:27.811Z","state":"ACTIVE","etag":"08DCAA80D489FD52.0000000003.08DCAA8627CF76E1.01","value":{"Iron":50,"Gold":26},"id":"users:453482811","users":["users/45348281"],"attributes":{}}
* @exampleRawBody {"path":"universes/5097539509/data-stores/InventoryStore/entries/users:453482811","createTime":"2024-07-22T19:02:27.811669Z","revisionId":"08DCAA80D489FD52.0000000003.08DCAA8627CF76E1.01","revisionCreateTime":"2024-07-22T19:40:35.001520100Z","state":"ACTIVE","etag":"08DCAA80D489FD52.0000000003.08DCAA8627CF76E1.01","value":{"Iron":50,"Gold":26},"id":"users:453482811","users":["users/45348281"],"attributes":{}}
*/
export declare const updateStandardDataStoreEntry: <Schema extends Record<any, any>>(this: any, args: {
universeId: Identifier;
dataStore: string;
scope?: string | undefined;
entryId: string;
value: Schema;
allowMissing: boolean;
users?: Identifier[] | undefined;
attributes?: Record<any, any> | undefined;
}) => Promise<{
data: {
path: `universes/${number}/data-stores/${string}/entries/${string}` | `universes/${number}/data-stores/${string}/entries/${string}@${string}` | `universes/${number}/data-stores/${string}/scope/${string}/entries/${string}` | `universes/${number}/data-stores/${string}/scope/${string}/entries/${string}@${string}`;
createTime: Date;
revisionId: string;
revisionCreateTime: Date;
state: "STATE_UNSPECIFIED" | "ACTIVE" | "DELETED";
etag: string;
value: import("typeforge").PrettifyDeep<Schema, Schema extends Date ? true : false>;
id: string;
users: `users/${number}`[];
attributes: Record<any, any>;
};
response: {
fullResponse: unknown;
url: `https://${string}`;
method: import("../../../utils/utils.types").RestMethod;
success: boolean;
statusCode: number;
headers: Headers;
body: {
path: `universes/${number}/data-stores/${string}/entries/${string}` | `universes/${number}/data-stores/${string}/entries/${string}@${string}` | `universes/${number}/data-stores/${string}/scope/${string}/entries/${string}` | `universes/${number}/data-stores/${string}/scope/${string}/entries/${string}@${string}`;
createTime: `${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}`;
revisionId: string;
revisionCreateTime: `${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}`;
state: "STATE_UNSPECIFIED" | "ACTIVE" | "DELETED";
etag: string;
value: import("typeforge").PrettifyDeep<Schema, Schema extends Date ? true : false>;
id: string;
users: `users/${number}`[];
attributes: Record<any, any>;
};
};
} & {
again: () => Promise<{
data: {
path: `universes/${number}/data-stores/${string}/entries/${string}` | `universes/${number}/data-stores/${string}/entries/${string}@${string}` | `universes/${number}/data-stores/${string}/scope/${string}/entries/${string}` | `universes/${number}/data-stores/${string}/scope/${string}/entries/${string}@${string}`;
createTime: Date;
revisionId: string;
revisionCreateTime: Date;
state: "STATE_UNSPECIFIED" | "ACTIVE" | "DELETED";
etag: string;
value: import("typeforge").PrettifyDeep<Schema, Schema extends Date ? true : false>;
id: string;
users: `users/${number}`[];
attributes: Record<any, any>;
};
response: {
fullResponse: unknown;
url: `https://${string}`;
method: import("../../../utils/utils.types").RestMethod;
success: boolean;
statusCode: number;
headers: Headers;
body: {
path: `universes/${number}/data-stores/${string}/entries/${string}` | `universes/${number}/data-stores/${string}/entries/${string}@${string}` | `universes/${number}/data-stores/${string}/scope/${string}/entries/${string}` | `universes/${number}/data-stores/${string}/scope/${string}/entries/${string}@${string}`;
createTime: `${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}`;
revisionId: string;
revisionCreateTime: `${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}`;
state: "STATE_UNSPECIFIED" | "ACTIVE" | "DELETED";
etag: string;
value: import("typeforge").PrettifyDeep<Schema, Schema extends Date ? true : false>;
id: string;
users: `users/${number}`[];
attributes: Record<any, any>;
};
};
}>;
}>;
/**
* Increments an entry in a standard datastore.
* @endpoint
* POST /v2/universes/{universe}/data-stores/{data-store}/entries/{entryId}:increment
* POST /v2/universes/{universe}/data-stores/{data-store}/scopes/{scope}/entries/{entryId}:increment
*
* @param universeId The ID of the universe to increment an entry in.
* @param dataStore the name of the datastore to increment an entry in.
* @param scope The optional scope of the dataStore.
* @param entryId The ID (key / name) of the entry.
* @param value The value (content) of the entry.
* @param users Array metadata containing the IDs of the users this entry is affiliated with.
* @param attributes Key-Value Pairs metadata containing arbitrary data.
*
* @example
* const { data:entry } = await StandardDataStoresApi_V2.incrementStandardDatastoreEntry({
universeId: 5097539509, dataStore: "Deaths", entryId: "users/45348281", amount: 3, users: [ 45348281 ]
})
* @exampleData {"path":"universes/5097539509/data-stores/Deaths/entries/users:45348281","createTime":"2024-07-22T19:46:42.453Z","revisionId":"08DCAA8702D435AC.0000000003.08DCAA877D776995.01","revisionCreateTime":"2024-07-22T19:46:42.453Z","state":"ACTIVE","etag":"08DCAA8702D435AC.0000000003.08DCAA877D776995.01","value":9,"id":"users:45348281","users":["users/45348281"],"attributes":{}}
* @exampleRawBody {"path":"universes/5097539509/data-stores/Deaths/entries/users:45348281","createTime":"2024-07-22T19:46:42.453649200Z","revisionId":"08DCAA8702D435AC.0000000003.08DCAA877D776995.01","revisionCreateTime":"2024-07-22T19:50:08.205250100Z","state":"ACTIVE","etag":"08DCAA8702D435AC.0000000003.08DCAA877D776995.01","value":9,"id":"users:45348281","users":["users/45348281"],"attributes":{}}
*/
export declare const incrementStandardDatastoreEntry: import("../../apiGroup/apiGroup.types").CallApiMethod<{
universeId: Identifier;
dataStore: string;
scope?: string | undefined;
entryId: string;
amount: number;
users?: Identifier[] | undefined;
attributes?: Record<any, any> | undefined;
}, {
method: import("../../../utils/utils.types").RestMethod;
path: `/${string}`;
name: string;
searchParams?: