rbxcloud 0.17.0

CLI and SDK for the Roblox Open Cloud APIs
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

# Group API

## Get Group Info
Get information about a group.
```
Usage: rbxcloud group get [OPTIONS] --group-id <GROUP_ID> --api-key <API_KEY>

Options:
  -a, --api-key <API_KEY>    Roblox Open Cloud API Key [env: RBXCLOUD_API_KEY=]
  -g, --group-id <GROUP_ID>  Group ID
  -p, --pretty               Pretty-print the JSON response
  -h, --help                 Print help
```

### Example
```
$ rbxcloud group get -p -g 12345 -a MY_KEY
```

## Get Group Shout
Get a group's current shout and its metadata.
```
Usage: rbxcloud group shout [OPTIONS] --group-id <GROUP_ID> --api-key <API_KEY>

Options:
  -a, --api-key <API_KEY>    Roblox Open Cloud API Key [env: RBXCLOUD_API_KEY=]
  -g, --group-id <GROUP_ID>  Group ID
  -p, --pretty               Pretty-print the JSON response
  -o, --only-message         Only return the shout message string
  -h, --help                 Print help
```

### Example
Get a group's shout and its metadata:
```
$ rbxcloud group shout -p -g 12345 -a MY_KEY
```

Get a group's shout message only:
```
$ rbxcloud group shout -p -g 12345 -a MY_KEY --only-message
```

## List Group Roles
List the roles of a given group.
```
Usage: rbxcloud group roles [OPTIONS] --group-id <GROUP_ID> --api-key <API_KEY>

Options:
  -a, --api-key <API_KEY>                  Roblox Open Cloud API Key [env: RBXCLOUD_API_KEY=]
  -g, --group-id <GROUP_ID>                Group ID
  -p, --pretty                             Pretty-print the JSON response
  -m, --max-page-size <MAX_PAGE_SIZE>      Max items returned per page
  -n, --next-page-token <NEXT_PAGE_TOKEN>  Next page token
  -h, --help                               Print help
```

### Example
```
$ rbxcloud group roles -p -g 12345 -a MY_KEY
```

## List Group Memberships
List members of the group. For more info on the `--filter` option, see [Roblox's documentation](https://create.roblox.com/docs/cloud/reference/patterns#list-group-memberships).
```
Usage: rbxcloud group memberships [OPTIONS] --group-id <GROUP_ID> --api-key <API_KEY>

Options:
  -a, --api-key <API_KEY>                  Roblox Open Cloud API Key [env: RBXCLOUD_API_KEY=]
  -g, --group-id <GROUP_ID>                Group ID
  -p, --pretty                             Pretty-print the JSON response
  -m, --max-page-size <MAX_PAGE_SIZE>      Max items returned per page
  -f, --filter <FILTER>                    Filter
  -n, --next-page-token <NEXT_PAGE_TOKEN>  Next page token
  -h, --help                               Print help
```

### Example
```
$ rbxcloud group memberships -p -g 12345 -a MY_KEY
```