CitraClient.SatelliteGroups (citra_client v0.3.0)

View Source

Generated operations for OpenAPI tag satellite_groups.

Summary

Functions

Add Satellites To Group

Create Satellite Groups

Delete Satellite Group

Favorite Satellite Group

Get Satellite Group

Get Satellites For Group

List Favorite Satellite Groups

List Satellite Groups

List Satellite Groups For Satellite

List User Satellite Groups

Remove Satellites From Group

Unfavorite Satellite Group

Upsert Satellite Groups

Functions

add_satellites_to_group(group_id, body)

Add Satellites To Group

Add satellites to a satellite group

POST /satellite-groups/{group_id}/satellites

Path parameters

  • group_id (path)

Body

Request body (map or generated struct).

create_satellite_groups(body)

Create Satellite Groups

Create new satellite groups for the current user (bulk create)

POST /satellite-groups

Body

Request body (map or generated struct).

delete_satellite_group(group_id)

Delete Satellite Group

Delete a satellite group

DELETE /satellite-groups/{group_id}

Path parameters

  • group_id (path)

favorite_satellite_group(group_id)

Favorite Satellite Group

Add a satellite group to user's favorites

POST /satellite-groups/{group_id}/favorite

Path parameters

  • group_id (path)

get_satellite_group(group_id)

Get Satellite Group

Get a single satellite group by ID

GET /satellite-groups/{group_id}

Path parameters

  • group_id (path)

get_satellites_for_group(group_id)

Get Satellites For Group

Get all satellites that belong to a specific satellite group

GET /satellite-groups/{group_id}/satellites

Path parameters

  • group_id (path)

list_favorite_satellite_groups()

List Favorite Satellite Groups

List current user's favorited satellite groups

GET /my/satellite-groups/favorites

list_satellite_groups(opts \\ [])

List Satellite Groups

List all satellite groups, optionally filtered by IDs

GET /satellite-groups

Options (passed via keyword list)

  • :ids — Filter satellite groups by specific IDs

list_satellite_groups_for_satellite(satellite_id)

List Satellite Groups For Satellite

List all satellite groups that contain a specific satellite

GET /satellites/{satellite_id}/groups

Path parameters

  • satellite_id (path)

list_user_satellite_groups(opts \\ [])

List User Satellite Groups

List current user's satellite groups, optionally filtered by IDs

GET /my/satellite-groups

Options (passed via keyword list)

  • :ids — Filter satellite groups by specific IDs

remove_satellites_from_group(group_id, body)

Remove Satellites From Group

Remove satellites from a satellite group

DELETE /satellite-groups/{group_id}/satellites

Path parameters

  • group_id (path)

Body

Request body (map or generated struct).

unfavorite_satellite_group(group_id)

Unfavorite Satellite Group

Remove a satellite group from user's favorites

DELETE /satellite-groups/{group_id}/favorite

Path parameters

  • group_id (path)

upsert_satellite_groups(body)

Upsert Satellite Groups

Create and/or update satellite groups for the current user (bulk upsert)

PUT /satellite-groups

Body

Request body (map or generated struct).