rbx-ds-cloud 0.1.0

CLI and Library for Roblox's Datastore Open Cloud API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270

//! Structs used as Arguments for the Roblox API

use clap::{Args, ValueEnum};

#[derive(Args, Debug)]
/// List all Datastores in the specified "universe" or game
pub struct ListDataStores {
    /// The value of DataModel.GameId, which is visible in the URL on the universe's Configure page.
    #[clap(short, long, value_parser)]
    pub universe_id: u64,

    /// API key of Roblox Open Cloud
    #[clap(short, long, value_parser)]
    pub api_key: String,

    /// (INTEGER) Maximum number of items to return
    #[clap(short, long, value_parser)]
    pub limit: u64,

    /// (Optional) Return only data stores with this prefix
    #[clap(short, long, value_parser)]
    pub prefix: Option<String>,

    /// (Optional) Cursor for the next set of data
    #[clap(short, long, value_parser)]
    pub cursor: Option<String>,
}

#[derive(Args, Debug)]
/// Returns a list of entry keys within a data store.
pub struct ListEntries {
    /// The value of DataModel.GameId, which is visible in the URL on the universe's Configure page.
    #[clap(short, long, value_parser)]
    pub universe_id: u64,

    /// API key of Roblox Open Cloud
    #[clap(short, long, value_parser)]
    pub api_key: String,

    /// Name of the data store
    #[clap(short, long, value_parser)]
    pub datastore_name: String,

    /// If true, return keys from all scopes
    #[clap(short = 'o', long, value_parser)]
    pub all_scopes: Option<bool>,

    /// (Optional) If "None", defaults to global, similar to Lua API
    #[clap(short, long, value_parser)]
    pub scope: Option<String>,

    /// (Optional) Return only keys with this prefix
    #[clap(short, long, value_parser)]
    pub prefix: Option<String>,

    /// (INTEGER) Maximum number of items to return
    #[clap(short, long, value_parser)]
    pub limit: u64,

    /// (Optional) Provide to request the next set of data
    #[clap(short, long, value_parser)]
    pub cursor: Option<String>,
}

#[derive(Args, Debug)]
/// Returns the value associated with an entry.
pub struct GetEntry {
    /// The value of DataModel.GameId, which is visible in the URL on the universe's Configure page.
    #[clap(short, long, value_parser)]
    pub universe_id: u64,

    /// API key of Roblox Open Cloud
    #[clap(short, long, value_parser)]
    pub api_key: String,

    /// Name of the data store
    #[clap(short, long, value_parser)]
    pub datastore_name: String,

    /// (Optional) If "None", defaults to global, similar to Lua API
    #[clap(short, long, value_parser)]
    pub scope: Option<String>,

    /// The key which identifies the entry
    #[clap(short, long, value_parser)]
    pub key: String,
}

#[derive(Args, Debug)]
/// Returns the versions and metadata of an Entry of a datastore
pub struct ListEntryVersions {
    /// The value of DataModel.GameId, which is visible in the URL on the universe's Configure page.
    #[clap(short, long, value_parser)]
    pub universe_id: u64,

    /// API key of Roblox Open Cloud
    #[clap(short, long, value_parser)]
    pub api_key: String,

    /// Name of the data store
    #[clap(short, long, value_parser)]
    pub datastore_name: String,

    /// (Optional) If "None", defaults to global, similar to Lua API
    #[clap(short, long, value_parser)]
    pub scope: Option<String>,

    /// The key which identifies the entry
    #[clap(short, long, value_parser)]
    pub key: String,

    /// (Optional) Start time constraint (ISO UTC Datetime)
    #[clap(short = 't', long, value_parser)]
    pub start_time: Option<String>,

    /// (Optional) End time constraint (ISO UTC Datetime)
    #[clap(short = 'e', long, value_parser)]
    pub end_time: Option<String>,

    /// Sort order
    #[clap(short = 'o', long, value_enum)]
    pub sort_order: SortOrder,

    /// (INTEGER) Maximum number of items to return
    #[clap(short, long, value_parser)]
    pub limit: u64,

    /// (Optional) Cursor for the next set of data
    #[clap(short, long, value_parser)]
    pub cursor: Option<String>,
}

#[derive(Args, Debug)]
/// Returns the metadata of a specific version of an entry.
pub struct GetEntryVersion {
    /// The value of DataModel.GameId, which is visible in the URL on the universe's Configure page.
    #[clap(short, long, value_parser)]
    pub universe_id: u64,

    /// API key of Roblox Open Cloud
    #[clap(short, long, value_parser)]
    pub api_key: String,

    /// Name of the data store
    #[clap(short, long, value_parser)]
    pub datastore_name: String,

    /// (Optional) If "None", defaults to global, similar to Lua API
    #[clap(short, long, value_parser)]
    pub scope: Option<String>,

    /// The key which identifies the entry
    #[clap(short, long, value_parser)]
    pub key: String,

    /// The version of the key
    #[clap(short, long, value_parser)]
    pub version_id: String,
}

#[derive(Args, Debug)]
/// Sets the value, metadata and user IDs associated with an entry.
pub struct SetEntry {
    /// The value of DataModel.GameId, which is visible in the URL on the universe's Configure page.
    #[clap(short, long, value_parser)]
    pub universe_id: u64,

    /// API key of Roblox Open Cloud
    #[clap(short, long, value_parser)]
    pub api_key: String,

    /// Name of the data store
    #[clap(short, long, value_parser)]
    pub datastore_name: String,

    /// (Optional) If "None", defaults to global, similar to Lua API
    #[clap(short, long, value_parser)]
    pub scope: Option<String>,

    /// The key which identifies the entry
    #[clap(short, long, value_parser)]
    pub key: String,

    /// (Optional) Only update if current version matches this
    #[clap(short = 'i', long, value_parser)]
    pub match_version: Option<String>,

    /// (Optional) Only create the entry if it does not exist
    #[clap(short, long, value_parser)]
    pub exclusive_create: Option<bool>,

    /// JSON-stringified or stringify-able data (Limit: 4MB)
    #[clap(short = 'D', long, value_parser)]
    pub data: String,

    /// (Optional) Associated UserID (can be multiple)
    #[clap(short = 'U', long, value_parser)]
    pub user_ids: Option<Vec<u64>>,

    /// (Optional) JSON-stringified attributes data
    #[clap(short = 't', long, value_parser)]
    pub attributes: Option<String>,
}

#[derive(Args, Debug)]
/// Increments the value for an entry by a given amount, or create a new entry with that amount.
pub struct IncrementEntry {
    /// The value of DataModel.GameId, which is visible in the URL on the universe's Configure page.
    #[clap(short, long, value_parser)]
    pub universe_id: u64,

    /// API key of Roblox Open Cloud
    #[clap(short, long, value_parser)]
    pub api_key: String,

    /// Name of the data store
    #[clap(short, long, value_parser)]
    pub datastore_name: String,

    /// (Optional) If "None", defaults to global, similar to Lua API
    #[clap(short, long, value_parser)]
    pub scope: Option<String>,

    /// The key which identifies the entry
    #[clap(short, long, value_parser)]
    pub key: String,

    /// The amount by which the entry should be incremented
    #[clap(short, long, value_parser)]
    pub increment_by: f64,

    /// (Optional) Comma-separated list of Roblox user IDs
    #[clap(short = 'U', long, value_parser)]
    pub user_ids: Option<Vec<u64>>,

    /// (Optional) JSON-stringified attributes data
    #[clap(short = 't', long, value_parser)]
    pub attributes: Option<String>,
}

#[derive(Args, Debug)]
/// Marks the entry as deleted by creating a tombstone version. Entries are deleted permanently after 30 days.
pub struct DeleteEntry {
    /// The value of DataModel.GameId, which is visible in the URL on the universe's Configure page.
    #[clap(short, long, value_parser)]
    pub universe_id: u64,

    /// API key of Roblox Open Cloud
    #[clap(short, long, value_parser)]
    pub api_key: String,

    /// Name of the data store
    #[clap(short, long, value_parser)]
    pub datastore_name: String,

    /// (Optional) If "None", defaults to global, similar to Lua API
    #[clap(short, long, value_parser)]
    pub scope: Option<String>,

    /// The key which identifies the entry
    #[clap(short, long, value_parser)]
    pub key: String,
}

#[derive(Debug, Clone, ValueEnum)]
/// An Enum for the ListEntryVersions API
pub enum SortOrder {
    Ascending,
    Descending,
}