openblox
Version:
Roblox API Wrapper For Both Classic And OpenCloud APIs.
567 lines (566 loc) • 37.7 kB
TypeScript
import type { Identifier } from "typeforge";
import type { CreateSortedMapItem_ConstructItemConfig, EnqueueItem_ConstructItemConfig, RawListSortedMapItemsData, UpdateSortedMapItem_ConstructItemConfig } from "./memoryStores.types";
/**
* Gets a sorted map item.
* @endpoint GET /v2/universes/{universeId}/memory-store/sorted-maps/{sortedMap}/items/{itemId}
*
* @param universeId The id of the universe to get the sorted map item from.
* @param sortedMap The sorted map to get the item from.
* @param itemId The id of the item to get.
*
* @example
* type Item = { isReal: boolean }
const { data } = await MemoryStoresApi.sortedMapItem<Item>({ universeId: 5243626809, sortedMap: "MySortedMap", itemId: "Testing123" })
* @exampleData {"path":"cloud/v2/universes/5243626809/memory-stores/sorted-maps/MySortedMap/items/Testing123","value":{"isReal":true},"etag":"12","expireTime":"2024-04-18T01:44:49.000Z","id":"Testing123","numericSortKey":1}
* @exampleRawBody {"path":"cloud/v2/universes/5243626809/memory-stores/sorted-maps/MySortedMap/items/Testing123","value":{"isReal":true},"etag":"12","expireTime":"2024-04-18T01:44:49Z","id":"Testing123","numericSortKey":1}
*/
export declare const sortedMapItem: <ItemValue>(this: any, args: {
universeId: Identifier;
sortedMap: string;
itemId: string;
}) => Promise<{
data: {
path: `cloud/v2/universes/${number}/memory-store/sorted-maps/MySortedMap/items`;
value: import("typeforge").Prettify<ItemValue, ItemValue extends Date ? true : false>;
etag: `${number}`;
expireTime: Date;
id: string;
numericSortKey?: number | undefined;
stringSortKey?: string | undefined;
};
response: {
fullResponse: unknown;
url: `https://${string}`;
method: import("../../../utils/utils.types").RestMethod;
success: boolean;
statusCode: number;
headers: Headers;
body: {
path: `cloud/v2/universes/${number}/memory-store/sorted-maps/MySortedMap/items`;
value: import("typeforge").Prettify<ItemValue, ItemValue extends Date ? true : false>;
etag: `${number}`;
expireTime: `${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}`;
id: string;
numericSortKey?: number | undefined;
stringSortKey?: string | undefined;
};
};
} & {
again: () => Promise<{
data: {
path: `cloud/v2/universes/${number}/memory-store/sorted-maps/MySortedMap/items`;
value: import("typeforge").Prettify<ItemValue, ItemValue extends Date ? true : false>;
etag: `${number}`;
expireTime: Date;
id: string;
numericSortKey?: number | undefined;
stringSortKey?: string | undefined;
};
response: {
fullResponse: unknown;
url: `https://${string}`;
method: import("../../../utils/utils.types").RestMethod;
success: boolean;
statusCode: number;
headers: Headers;
body: {
path: `cloud/v2/universes/${number}/memory-store/sorted-maps/MySortedMap/items`;
value: import("typeforge").Prettify<ItemValue, ItemValue extends Date ? true : false>;
etag: `${number}`;
expireTime: `${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}`;
id: string;
numericSortKey?: number | undefined;
stringSortKey?: string | undefined;
};
};
}>;
}>;
/**
* Lists items of a sorted map.
* @endpoint GET /v2/universes/{universeId}/memory-store/sorted-maps/{sortedMap}/items
*
* @param universeId The id of the universe to get the sorted map item from.
* @param sortedMap The sorted map to get the item from.
* @param maxPageSize The id of the item to get.
* @param orderBy The order of the returned sorted map items.
* @param filter filter returned sorted map items.
*
* @example const { data:items } = await MemoryStoresApi.listSortedMapItems<Item>({ universeId: 5243626809, sortedMap: "MySortedMap", maxPageSize: 1 })
* @exampleData [{"path":"cloud/v2/universes/5243626809/memory-store/sorted-maps/MySortedMap/items/Testing123","value":{"isReal":true},"etag":"24","expireTime":"2024-04-18T04:31:14.000Z","id":"Testing123","numericSortKey":1}]
* @exampleRawBody {"items":[{"path":"cloud/v2/universes/5243626809/memory-store/sorted-maps/MySortedMap/items/Testing123","value":{"isReal":true},"etag":"24","expireTime":"2024-04-18T04:31:14Z","id":"Testing123","numericSortKey":1}],"nextPageToken":"S_USLzRFVMU73i67jNK349FgCtYxw4Wl18ziPHeFRZoACgBUZXN0aW5nMTIzCQAAv_AAAAAAAAA"}
*/
export declare const listSortedMapItems: import("../../apiGroup/apiGroup.types").CallApiMethod<{
universeId: Identifier;
sortedMap: string;
maxPageSize?: number | undefined;
orderBy?: "desc" | "asc" | undefined;
filter?: string | undefined;
cursor?: string | undefined;
}, {
method: import("../../../utils/utils.types").RestMethod;
path: `/${string}`;
name: string;
searchParams?: string | Record<string, any> | undefined;
headers?: Record<string, any> | undefined;
body?: string | number | Record<string, any> | undefined;
formData?: FormData | undefined;
applyFieldMask?: boolean | undefined;
pathToPoll?: ((rawData: RawListSortedMapItemsData) => string) | undefined;
getCursorsFn?: ((rawData: {
items: {
path: `cloud/v2/universes/${number}/memory-store/sorted-maps/MySortedMap/items`;
value: any;
etag: `${number}`;
expireTime: `${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}`;
id: string;
numericSortKey?: number | undefined;
stringSortKey?: string | undefined;
}[];
nextPageToken?: string | undefined;
}) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined;
"\uD83D\uDD12__PRIVATE_RAW_DATA"?: {
items: {
path: `cloud/v2/universes/${number}/memory-store/sorted-maps/MySortedMap/items`;
value: any;
etag: `${number}`;
expireTime: `${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}`;
id: string;
numericSortKey?: number | undefined;
stringSortKey?: string | undefined;
}[];
nextPageToken?: string | undefined;
} | undefined;
"\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: {
path: `cloud/v2/universes/${number}/memory-store/sorted-maps/MySortedMap/items`;
value: any;
etag: `${number}`;
expireTime: Date;
id: string;
numericSortKey?: number | undefined;
stringSortKey?: string | undefined;
}[] | undefined;
} & import("../../apiGroup/apiGroup.types").ApiMethodDataFormatRawData<RawListSortedMapItemsData, {
path: `cloud/v2/universes/${number}/memory-store/sorted-maps/MySortedMap/items`;
value: any;
etag: `${number}`;
expireTime: Date;
id: string;
numericSortKey?: number | undefined;
stringSortKey?: string | undefined;
}[]>, true>;
/**
* Creates a sorted map item.
* @endpoint POST /v2/universes/{universeId}/memory-store/sorted-maps/{sortedMap}/items
*
* @param universeId The id of the universe to create the sorted map item in.
* @param sortedMap The sorted map to create the item in.
* @param item The sorted map item data.
*
* @example
* type Item = { isReal: boolean }
const { data } = await MemoryStoresApi.createSortedMapItem<Item>({
universeId: 5243626809, sortedMap: "MySortedMap",
item: { id: "Testing123", value: { isReal: true }, ttl: "300s", numericSortKey: 1 }
})
* @exampleData {"path":"cloud/v2/universes/5243626809/memory-store/sorted-maps/MySortedMap/items","value":{"isReal":true},"etag":"10","expireTime":"2024-04-18T00:30:14.000Z","id":"Testing123","numericSortKey":1}
* @exampleRawBody {"path":"cloud/v2/universes/5243626809/memory-store/sorted-maps/MySortedMap/items","value":{"isReal":true},"etag":"10","expireTime":"2024-04-18T00:30:14Z","id":"Testing123","numericSortKey":1}
*/
export declare const createSortedMapItem: <ItemValue>(this: any, args: {
universeId: Identifier;
sortedMap: string;
item: CreateSortedMapItem_ConstructItemConfig<ItemValue>;
}) => Promise<{
data: {
path: `cloud/v2/universes/${number}/memory-store/sorted-maps/MySortedMap/items`;
value: import("typeforge").Prettify<ItemValue, ItemValue extends Date ? true : false>;
etag: `${number}`;
expireTime: Date;
id: string;
numericSortKey?: number | undefined;
stringSortKey?: string | undefined;
};
response: {
fullResponse: unknown;
url: `https://${string}`;
method: import("../../../utils/utils.types").RestMethod;
success: boolean;
statusCode: number;
headers: Headers;
body: {
path: `cloud/v2/universes/${number}/memory-store/sorted-maps/MySortedMap/items`;
value: import("typeforge").Prettify<ItemValue, ItemValue extends Date ? true : false>;
etag: `${number}`;
expireTime: `${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}`;
id: string;
numericSortKey?: number | undefined;
stringSortKey?: string | undefined;
};
};
} & {
again: () => Promise<{
data: {
path: `cloud/v2/universes/${number}/memory-store/sorted-maps/MySortedMap/items`;
value: import("typeforge").Prettify<ItemValue, ItemValue extends Date ? true : false>;
etag: `${number}`;
expireTime: Date;
id: string;
numericSortKey?: number | undefined;
stringSortKey?: string | undefined;
};
response: {
fullResponse: unknown;
url: `https://${string}`;
method: import("../../../utils/utils.types").RestMethod;
success: boolean;
statusCode: number;
headers: Headers;
body: {
path: `cloud/v2/universes/${number}/memory-store/sorted-maps/MySortedMap/items`;
value: import("typeforge").Prettify<ItemValue, ItemValue extends Date ? true : false>;
etag: `${number}`;
expireTime: `${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}`;
id: string;
numericSortKey?: number | undefined;
stringSortKey?: string | undefined;
};
};
}>;
}>;
/**
* Updates a sorted map item.
* @endpoint PATCH /v2/universes/{universeId}/memory-store/sorted-maps/{sortedMap}/items/{itemId}
*
* @param universeId The id of the universe to get the sorted map item from.
* @param sortedMap The sorted map to get the item from.
* @param itemId The id of the item to update.
* @param updatedItemData The data to update the sorted map item with.
* @param allowMissing If set to true, and the item is not found, a new item will be created. Default false.
*
* @example
* type Item = { isReal: boolean }
const { data:updatedItem } = await MemoryStoresApi.updateSortedMapItem<Item>({
universeId: 5243626809, sortedMap: "MySortedMap", itemId: "Testing123",
updatedItemData: { value: { isReal: true }, ttl: "300s", numericSortKey: 1 }
});
* @exampleData {"path":"cloud/v2/universes/5243626809/memory-store/sorted-maps/MySortedMap/items/","value":{"isReal":false},"etag":"20","expireTime":"2024-04-18T03:48:53.000Z","numericSortKey":null}
* @exampleRawBody {"path":"cloud/v2/universes/5243626809/memory-store/sorted-maps/MySortedMap/items/","value":{"isReal":false},"etag":"20","expireTime":"2024-04-18T03:48:53Z","numericSortKey":null}
*/
export declare const updateSortedMapItem: <ItemValue>(this: any, args: {
universeId: Identifier;
sortedMap: string;
itemId: string;
updatedItemData: UpdateSortedMapItem_ConstructItemConfig<ItemValue>;
allowMissing?: boolean | undefined;
}) => Promise<{
data: {
value: import("typeforge").Prettify<ItemValue, ItemValue extends Date ? true : false>;
path: `cloud/v2/universes/${number}/memory-store/sorted-maps/MySortedMap/items`;
etag: `${number}`;
expireTime: Date;
numericSortKey?: number | undefined;
stringSortKey?: string | undefined;
};
response: {
fullResponse: unknown;
url: `https://${string}`;
method: import("../../../utils/utils.types").RestMethod;
success: boolean;
statusCode: number;
headers: Headers;
body: {
value: import("typeforge").Prettify<ItemValue, ItemValue extends Date ? true : false>;
path: `cloud/v2/universes/${number}/memory-store/sorted-maps/MySortedMap/items`;
etag: `${number}`;
expireTime: `${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}`;
numericSortKey?: number | undefined;
stringSortKey?: string | undefined;
};
};
} & {
again: () => Promise<{
data: {
value: import("typeforge").Prettify<ItemValue, ItemValue extends Date ? true : false>;
path: `cloud/v2/universes/${number}/memory-store/sorted-maps/MySortedMap/items`;
etag: `${number}`;
expireTime: Date;
numericSortKey?: number | undefined;
stringSortKey?: string | undefined;
};
response: {
fullResponse: unknown;
url: `https://${string}`;
method: import("../../../utils/utils.types").RestMethod;
success: boolean;
statusCode: number;
headers: Headers;
body: {
value: import("typeforge").Prettify<ItemValue, ItemValue extends Date ? true : false>;
path: `cloud/v2/universes/${number}/memory-store/sorted-maps/MySortedMap/items`;
etag: `${number}`;
expireTime: `${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}`;
numericSortKey?: number | undefined;
stringSortKey?: string | undefined;
};
};
}>;
}>;
/**
* Deletes a sorted map item.
* @endpoint DELETE /v2/universes/{universeId}/memory-store/sorted-maps/{sortedMap}/items/{itemId}
*
* @param universeId The id of the universe to get the sorted map item from.
* @param sortedMap The sorted map to get the item from.
* @param itemId The id of the item to update.
* @param etag Server generated id for conditional delete.
*
* @example await MemoryStoresApi.deleteSortedMapItem({ universeId: 5243626809, sortedMap: "MySortedMap", itemId: "Testing1234" });
* @exampleData ""
* @exampleRawBody ""
*/
export declare const deleteSortedMapItem: import("../../apiGroup/apiGroup.types").CallApiMethod<{
universeId: Identifier;
sortedMap: string;
itemId: string;
etag?: 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"?: "" | undefined;
}, false>;
/**
* Adds an item to a memory store queue.
* @endpoint POST /v2/universes/{universeId}/memory-store/queues/{queue}/items
*
* @param universeId The id of the universe to get the sorted map item from.
* @param sortedMap The sorted map to get the item from.
* @param itemId The id of the item to update.
* @param etag Server generated id for conditional delete.
*
* @example
* const { data:enqueuedItem } = await MemoryStoresApi.enqueueItem({
universeId: 5243626809, queue: "MyQueue",
item: { name: "MyItem", value: "fooBar", ttl: "300s" }
});
* @exampleData {"path":"cloud/v2/universes/5243626809/memory-store/queues/MyQueue/items/7fffffffffffffff0000000000000003","data":{"name":"MyItem","value":"fooBar"},"priority":0,"expireTime":2024-06-04T08:10:33.000Z}
* @exampleRawBody {"path":"cloud/v2/universes/5243626809/memory-store/queues/MyQueue/items/7fffffffffffffff0000000000000003","data":{"name":"MyItem","value":"fooBar"},"priority":0,"expireTime":"2024-06-04T08:10:33Z"}
*/
export declare const enqueueItem: <ItemValue>(this: any, args: {
universeId: Identifier;
queue: string;
item: EnqueueItem_ConstructItemConfig<ItemValue>;
}) => Promise<{
data: {
path: `cloud/v2/universes/${number}/memory-store/queues/${string}/items/${string}`;
data: {
name: string;
value: ItemValue;
};
priority: number;
expireTime: Date;
};
response: {
fullResponse: unknown;
url: `https://${string}`;
method: import("../../../utils/utils.types").RestMethod;
success: boolean;
statusCode: number;
headers: Headers;
body: {
path: `cloud/v2/universes/${number}/memory-store/queues/${string}/items/${string}`;
data: {
name: string;
value: ItemValue;
};
priority: number;
expireTime: `${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: {
path: `cloud/v2/universes/${number}/memory-store/queues/${string}/items/${string}`;
data: {
name: string;
value: ItemValue;
};
priority: number;
expireTime: Date;
};
response: {
fullResponse: unknown;
url: `https://${string}`;
method: import("../../../utils/utils.types").RestMethod;
success: boolean;
statusCode: number;
headers: Headers;
body: {
path: `cloud/v2/universes/${number}/memory-store/queues/${string}/items/${string}`;
data: {
name: string;
value: ItemValue;
};
priority: number;
expireTime: `${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}`;
};
};
}>;
}>;
/**
* Reads queue items.
* @endpoint GET /v2/universes/{universeId}/memory-store/queues/{queue}/items:read
*
* @param universeId The id of the universe to read queue items from.
* @param queue Name of the Queue.
* @param limit Maximum entries to read, Max 200, Default 1.
* @param allOrNothing Whether to read any items if >= count can’t be read. Default false.
* @param invisibilityTimeoutSeconds Invisibility timeout for items read, default 30s. This will make previously read items invisible for the provided duration in the next Read request.
*
* @example
* type Item = { isReal: boolean };
* const { data:queueItems } = await MemoryStoresApi.readQueueItems<Item>({ universeId: 5243626809, queue: "MyQueue", limit: 2 });
* @exampleData {"items":[{"name":"Testing123","value":{"isReal":true}},{"name":"Testing1234","value":{"isReal":true}}],"id":"48e44da3c8754a4ab7ed728d07ac9526"}
* @exampleRawBody {"data":[{"name":"Testing123","value":{"isReal":true}},{"name":"Testing1234","value":{"isReal":true}}],"id":"5cfc27af46da4cf08b41aa9a3d78a75e"}
*/
export declare const readQueueItems: <ItemValue extends unknown>(this: any, args: {
universeId: Identifier;
queue: string;
limit?: number | undefined;
allOrNothing?: boolean | undefined;
invisibilityTimeoutSeconds?: number | undefined;
}) => Promise<{
data: {
items: {
name: string;
value: import("typeforge").Prettify<ItemValue, ItemValue extends Date ? true : false>;
}[];
readId: string;
};
response: {
fullResponse: unknown;
url: `https://${string}`;
method: import("../../../utils/utils.types").RestMethod;
success: boolean;
statusCode: number;
headers: Headers;
body: {
data: {
name: string;
value: import("typeforge").Prettify<ItemValue, ItemValue extends Date ? true : false>;
}[];
id: string;
};
};
} & {
again: () => Promise<{
data: {
items: {
name: string;
value: import("typeforge").Prettify<ItemValue, ItemValue extends Date ? true : false>;
}[];
readId: string;
};
response: {
fullResponse: unknown;
url: `https://${string}`;
method: import("../../../utils/utils.types").RestMethod;
success: boolean;
statusCode: number;
headers: Headers;
body: {
data: {
name: string;
value: import("typeforge").Prettify<ItemValue, ItemValue extends Date ? true : false>;
}[];
id: string;
};
};
}>;
}>;
/**
* Dequeues queue items.
* @endpoint POST /v2/universes/{universeId}/memory-store/queues/{queue}/items:discard
*
* @param universeId The id of the universe to remove queue items from.
* @param queue Name of the Queue.
* @param readId ID returned from a previous Read Queue call. It will discard all items that were read from the previous call.
*
* @example await MemoryStoresApi.dequeueItems({ universeId: 5243626809, queue: "MyQueue", readId: "5cfc27af46da4cf08b41aa9a3d78a75e" })
* @exampleData ""
* @exampleRawBody ""
*/
export declare const dequeueItems: import("../../apiGroup/apiGroup.types").CallApiMethod<{
universeId: Identifier;
queue: string;
readId: 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"?: "" | undefined;
}, false>;
/**
* Removes all items from every queue in a given universe.
* @endpoint POST /v2/universes/${universeId}/memory-store:flush
*
* @param universeId The id of the universe to flush all queue items from.
*
* @example const { data:createdOperation } = await MemoryStoresApi.flushAllQueues({ universeId: 5243626809 });
* @exampleData {"path":"cloud/v2/universes/5243626809/operations/AAUAAAAAAADRMx55T0AKRxSgFCrSusMzqOKQNyVaQz8eMi9t-dwQwQ","done":false,"id":"AAUAAAAAAADRMx55T0AKRxSgFCrSusMzqOKQNyVaQz8eMi9t-dwQwQ"}
* @exampleRawBody {"path":"cloud/v2/universes/5243626809/operations/AAUAAAAAAADRMx55T0AKRxSgFCrSusMzqOKQNyVaQz8eMi9t-dwQwQ","done":null}
*/
export declare const flushAllQueues: <UniverseId extends Identifier>(this: any, args: {
universeId: UniverseId;
}) => Promise<{
data: {
path: `cloud/v2/universes/${UniverseId}/operations/${string}`;
done: boolean;
};
response: {
fullResponse: unknown;
url: `https://${string}`;
method: import("../../../utils/utils.types").RestMethod;
success: boolean;
statusCode: number;
headers: Headers;
body: {
path: `cloud/v2/universes/${UniverseId}/operations/${string}`;
done: true | null;
};
};
} & {
again: () => Promise<{
data: {
path: `cloud/v2/universes/${UniverseId}/operations/${string}`;
done: boolean;
};
response: {
fullResponse: unknown;
url: `https://${string}`;
method: import("../../../utils/utils.types").RestMethod;
success: boolean;
statusCode: number;
headers: Headers;
body: {
path: `cloud/v2/universes/${UniverseId}/operations/${string}`;
done: true | null;
};
};
}>;
}>;