Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions robosystems_client/api/backup/get_backup_download_url.py
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,8 @@ def sync_detailed(
"""Get temporary download URL for backup

Generate a temporary download URL for a backup. The filename carries the extension listed as
`download_extension` on the backup: `.lbug.zip` is a ZIP holding the LadybugDB database file
`{graph_id}.lbug`; `.lbug.zst` (shared repository snapshots) is a single zstd-compressed database
`download_extension` on the backup: `.lbdb.zip` is a ZIP holding the LadybugDB database file
`{graph_id}.lbdb`; `.lbdb.zst` (shared repository snapshots) is a single zstd-compressed database
file; decompress it with `zstd -d`.

Args:
Expand Down Expand Up @@ -128,8 +128,8 @@ def sync(
"""Get temporary download URL for backup

Generate a temporary download URL for a backup. The filename carries the extension listed as
`download_extension` on the backup: `.lbug.zip` is a ZIP holding the LadybugDB database file
`{graph_id}.lbug`; `.lbug.zst` (shared repository snapshots) is a single zstd-compressed database
`download_extension` on the backup: `.lbdb.zip` is a ZIP holding the LadybugDB database file
`{graph_id}.lbdb`; `.lbdb.zst` (shared repository snapshots) is a single zstd-compressed database
file; decompress it with `zstd -d`.

Args:
Expand Down Expand Up @@ -163,8 +163,8 @@ async def asyncio_detailed(
"""Get temporary download URL for backup

Generate a temporary download URL for a backup. The filename carries the extension listed as
`download_extension` on the backup: `.lbug.zip` is a ZIP holding the LadybugDB database file
`{graph_id}.lbug`; `.lbug.zst` (shared repository snapshots) is a single zstd-compressed database
`download_extension` on the backup: `.lbdb.zip` is a ZIP holding the LadybugDB database file
`{graph_id}.lbdb`; `.lbdb.zst` (shared repository snapshots) is a single zstd-compressed database
file; decompress it with `zstd -d`.

Args:
Expand Down Expand Up @@ -201,8 +201,8 @@ async def asyncio(
"""Get temporary download URL for backup

Generate a temporary download URL for a backup. The filename carries the extension listed as
`download_extension` on the backup: `.lbug.zip` is a ZIP holding the LadybugDB database file
`{graph_id}.lbug`; `.lbug.zst` (shared repository snapshots) is a single zstd-compressed database
`download_extension` on the backup: `.lbdb.zip` is a ZIP holding the LadybugDB database file
`{graph_id}.lbdb`; `.lbdb.zst` (shared repository snapshots) is a single zstd-compressed database
file; decompress it with `zstd -d`.

Args:
Expand Down
40 changes: 24 additions & 16 deletions robosystems_client/api/graph_operations/delete_graph.py
Original file line number Diff line number Diff line change
Expand Up @@ -115,10 +115,12 @@ def sync_detailed(
body flag: omit it (or pass `false`) to tear down immediately (~10 min); pass `true` to keep the
graph usable through the current billing period and tear it down at the period boundary via the
existing suspend → deprovision pipeline. An immediate delete credits the unused part of the billed
period; it is not refunded. On a card-billed plan the credit goes to the organization's account
balance and is applied to its next invoice; on an invoiced plan it is a credit line on that period's
invoice, or a separate credit invoice if that one is already paid. Requires `confirm` to equal the
URL `graph_id`. Caller must be both org owner (billing authority) and admin on the graph
period; it is not refunded. A period buys time and AI credits, so the credit is the smaller unused
share of the two: credits used ahead of the time elapsed reduce it. On a card-billed plan the credit
lands on the organization's account balance at once and is applied to its next invoice, so a graph
created right after is charged the difference; on an invoiced plan it is a credit line on that
period's invoice, or a separate credit invoice if that one is already paid. Requires `confirm` to
equal the URL `graph_id`. Caller must be both org owner (billing authority) and admin on the graph
(operational authority). Not allowed on shared repositories.

**Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours
Expand Down Expand Up @@ -180,10 +182,12 @@ def sync(
body flag: omit it (or pass `false`) to tear down immediately (~10 min); pass `true` to keep the
graph usable through the current billing period and tear it down at the period boundary via the
existing suspend → deprovision pipeline. An immediate delete credits the unused part of the billed
period; it is not refunded. On a card-billed plan the credit goes to the organization's account
balance and is applied to its next invoice; on an invoiced plan it is a credit line on that period's
invoice, or a separate credit invoice if that one is already paid. Requires `confirm` to equal the
URL `graph_id`. Caller must be both org owner (billing authority) and admin on the graph
period; it is not refunded. A period buys time and AI credits, so the credit is the smaller unused
share of the two: credits used ahead of the time elapsed reduce it. On a card-billed plan the credit
lands on the organization's account balance at once and is applied to its next invoice, so a graph
created right after is charged the difference; on an invoiced plan it is a credit line on that
period's invoice, or a separate credit invoice if that one is already paid. Requires `confirm` to
equal the URL `graph_id`. Caller must be both org owner (billing authority) and admin on the graph
(operational authority). Not allowed on shared repositories.

**Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours
Expand Down Expand Up @@ -240,10 +244,12 @@ async def asyncio_detailed(
body flag: omit it (or pass `false`) to tear down immediately (~10 min); pass `true` to keep the
graph usable through the current billing period and tear it down at the period boundary via the
existing suspend → deprovision pipeline. An immediate delete credits the unused part of the billed
period; it is not refunded. On a card-billed plan the credit goes to the organization's account
balance and is applied to its next invoice; on an invoiced plan it is a credit line on that period's
invoice, or a separate credit invoice if that one is already paid. Requires `confirm` to equal the
URL `graph_id`. Caller must be both org owner (billing authority) and admin on the graph
period; it is not refunded. A period buys time and AI credits, so the credit is the smaller unused
share of the two: credits used ahead of the time elapsed reduce it. On a card-billed plan the credit
lands on the organization's account balance at once and is applied to its next invoice, so a graph
created right after is charged the difference; on an invoiced plan it is a credit line on that
period's invoice, or a separate credit invoice if that one is already paid. Requires `confirm` to
equal the URL `graph_id`. Caller must be both org owner (billing authority) and admin on the graph
(operational authority). Not allowed on shared repositories.

**Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours
Expand Down Expand Up @@ -303,10 +309,12 @@ async def asyncio(
body flag: omit it (or pass `false`) to tear down immediately (~10 min); pass `true` to keep the
graph usable through the current billing period and tear it down at the period boundary via the
existing suspend → deprovision pipeline. An immediate delete credits the unused part of the billed
period; it is not refunded. On a card-billed plan the credit goes to the organization's account
balance and is applied to its next invoice; on an invoiced plan it is a credit line on that period's
invoice, or a separate credit invoice if that one is already paid. Requires `confirm` to equal the
URL `graph_id`. Caller must be both org owner (billing authority) and admin on the graph
period; it is not refunded. A period buys time and AI credits, so the credit is the smaller unused
share of the two: credits used ahead of the time elapsed reduce it. On a card-billed plan the credit
lands on the organization's account balance at once and is applied to its next invoice, so a graph
created right after is charged the difference; on an invoiced plan it is a credit line on that
period's invoice, or a separate credit invoice if that one is already paid. Requires `confirm` to
equal the URL `graph_id`. Caller must be both org owner (billing authority) and admin on the graph
(operational authority). Not allowed on shared repositories.

**Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours
Expand Down
2 changes: 1 addition & 1 deletion robosystems_client/models/backup_create_request.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ class BackupCreateRequest:
"""Request model for creating a backup.

Attributes:
backup_format (str | Unset): Backup format - only 'full_dump' is supported (complete .lbug database file)
backup_format (str | Unset): Backup format - only 'full_dump' is supported (complete .lbdb database file)
Default: 'full_dump'.
backup_type (str | Unset): Backup type - only 'full' is supported Default: 'full'.
retention_days (int | Unset): Retention period in days, further capped to the graph tier's maximum (7/30/90). 90
Expand Down
2 changes: 1 addition & 1 deletion robosystems_client/models/backup_response.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ class BackupResponse:
backups taken before memory was included, which make no claim either way — distinct from false, which means the
graph had none.
download_extension (None | str | Unset): Extension the download will carry, and therefore how to unpack it:
'.lbug.zip' is a ZIP holding the LadybugDB database file, '.lbug.zst' is zstd-compressed (`zstd -d`). Null only
'.lbdb.zip' is a ZIP holding the LadybugDB database file, '.lbdb.zst' is zstd-compressed (`zstd -d`). Null only
when the backup has no stored object yet.
"""

Expand Down
Loading