Complete SingleStore Management API implementation

docs/src/api.rst

@@ -239,6 +239,12 @@ object that can be used to interact with the Management API.
    :toctree: generated/
 
    manage_workspaces
+   manage_teams
+   manage_users
+   manage_audit_logs
+   manage_private_connections
+   manage_storage_dr
+   manage_metrics
 
 
 WorkspaceManager
@@ -430,6 +436,261 @@ FilesObject
    FilesObject.rmdir
 
 
+TeamsManager
+............
+
+TeamsManager objects are returned by the :func:`manage_teams` function.
+They allow you to create, retrieve, and manage teams in your organization.
+
+.. currentmodule:: singlestoredb.management.teams
+
+.. autosummary::
+   :toctree: generated/
+
+   TeamsManager
+   TeamsManager.create_team
+   TeamsManager.get_team
+   TeamsManager.list_teams
+   TeamsManager.teams
+   TeamsManager.delete_team
+   TeamsManager.update_team
+   TeamsManager.get_team_identity_roles
+
+
+Team
+....
+
+Team objects are retrieved from :meth:`TeamsManager.get_team` or by
+retrieving an element from :attr:`TeamsManager.teams`.
+
+.. autosummary::
+   :toctree: generated/
+
+   Team
+   Team.update
+   Team.delete
+   Team.refresh
+   Team.identity_roles
+
+
+UsersManager
+............
+
+UsersManager objects are returned by the :func:`manage_users` function.
+They allow you to retrieve and manage users in your organization.
+
+.. currentmodule:: singlestoredb.management.users
+
+.. autosummary::
+   :toctree: generated/
+
+   UsersManager
+   UsersManager.get_user
+   UsersManager.get_user_identity_roles
+   UsersManager.create_user_invitation
+   UsersManager.get_user_invitation
+   UsersManager.list_user_invitations
+   UsersManager.delete_user_invitation
+   UsersManager.user_invitations
+
+
+User
+....
+
+User objects are retrieved from :meth:`UsersManager.get_user`.
+
+.. autosummary::
+   :toctree: generated/
+
+   User
+   User.identity_roles
+
+
+UserInvitation
+..............
+
+UserInvitation objects are returned by the various UsersManager invitation methods.
+
+.. autosummary::
+   :toctree: generated/
+
+   UserInvitation
+
+
+AuditLogsManager
+................
+
+AuditLogsManager objects are returned by the :func:`manage_audit_logs` function.
+They allow you to retrieve and analyze audit logs for your organization.
+
+.. currentmodule:: singlestoredb.management.audit_logs
+
+.. autosummary::
+   :toctree: generated/
+
+   AuditLogsManager
+   AuditLogsManager.list_audit_logs
+   AuditLogsManager.audit_logs
+   AuditLogsManager.get_audit_logs_for_user
+   AuditLogsManager.get_audit_logs_for_resource
+   AuditLogsManager.get_failed_actions
+   AuditLogsManager.get_actions_by_type
+
+
+AuditLog
+........
+
+AuditLog objects are returned by the various AuditLogsManager methods.
+
+.. autosummary::
+   :toctree: generated/
+
+   AuditLog
+
+
+PrivateConnectionsManager
+.........................
+
+PrivateConnectionsManager objects are returned by the :func:`manage_private_connections` function.
+They allow you to create and manage private connections in your organization.
+
+.. currentmodule:: singlestoredb.management.private_connections
+
+.. autosummary::
+   :toctree: generated/
+
+   PrivateConnectionsManager
+   PrivateConnectionsManager.create_private_connection
+   PrivateConnectionsManager.get_private_connection
+   PrivateConnectionsManager.private_connections
+   PrivateConnectionsManager.delete_private_connection
+   PrivateConnectionsManager.update_private_connection
+
+
+PrivateConnection
+.................
+
+PrivateConnection objects are retrieved from :meth:`PrivateConnectionsManager.get_private_connection`
+or by retrieving an element from :attr:`PrivateConnectionsManager.private_connections`.
+
+.. autosummary::
+   :toctree: generated/
+
+   PrivateConnection
+
+
+PrivateConnectionKaiInfo
+........................
+
+PrivateConnectionKaiInfo objects contain KAI-specific information for private connections.
+
+.. autosummary::
+   :toctree: generated/
+
+   PrivateConnectionKaiInfo
+
+
+PrivateConnectionOutboundAllowList
+..................................
+
+PrivateConnectionOutboundAllowList objects contain outbound allow list information for private connections.
+
+.. autosummary::
+   :toctree: generated/
+
+   PrivateConnectionOutboundAllowList
+
+
+IdentityRole
+............
+
+IdentityRole objects are used by both teams and users management for role information.
+
+.. currentmodule:: singlestoredb.management.teams
+
+.. autosummary::
+   :toctree: generated/
+
+   IdentityRole
+
+
+StorageDRManager
+................
+
+StorageDRManager objects are returned by the :func:`manage_storage_dr` function.
+They allow you to manage storage disaster recovery for your organization.
+
+.. currentmodule:: singlestoredb.management.storage_dr
+
+.. autosummary::
+   :toctree: generated/
+
+   StorageDRManager
+   StorageDRManager.get_status
+   StorageDRManager.get_available_regions
+   StorageDRManager.setup_storage_dr
+   StorageDRManager.start_failover
+   StorageDRManager.start_failback
+   StorageDRManager.start_pre_provision
+   StorageDRManager.stop_pre_provision
+
+
+Storage DR
+----------
+
+Storage Disaster Recovery objects provide information about replicated databases
+and disaster recovery regions.
+
+.. autosummary::
+   :toctree: generated/
+
+   ReplicatedDatabase
+   StorageDRStatus
+   StorageDRRegion
+   StorageDRCompute
+
+
+MetricsManager
+..............
+
+MetricsManager objects are returned by the :func:`manage_metrics` function.
+They allow you to retrieve metrics for your organization.
+
+.. currentmodule:: singlestoredb.management.metrics
+
+.. autosummary::
+   :toctree: generated/
+
+   MetricsManager
+   MetricsManager.get_workspace_group_metrics
+
+
+Metrics
+-------
+
+Metrics objects provide workspace group metrics and data points.
+
+.. autosummary::
+   :toctree: generated/
+
+   WorkspaceGroupMetrics
+   MetricDataPoint
+
+
+Billing Usage
+-------------
+
+Billing Usage objects provide usage and billing information for workspaces.
+
+.. currentmodule:: singlestoredb.management.billing_usage
+
+.. autosummary::
+   :toctree: generated/
+
+   UsageItem
+   BillingUsageItem
+
+
 Notebook Tools
 --------------
 

singlestoredb/__init__.py

@@ -26,6 +26,8 @@
 )
 from .management import (
     manage_cluster, manage_workspaces, manage_files, manage_regions,
+    manage_teams, manage_private_connections, manage_audit_logs,
+    manage_users,
 )
 from .types import (
     Date, Time, Timestamp, DateFromTicks, TimeFromTicks, TimestampFromTicks,

singlestoredb/management/__init__.py

@@ -1,8 +1,14 @@
 #!/usr/bin/env python
+from .audit_logs import manage_audit_logs
 from .cluster import manage_cluster
 from .files import manage_files
 from .manager import get_token
+from .metrics import manage_metrics
+from .private_connections import manage_private_connections
 from .region import manage_regions
+from .storage_dr import manage_storage_dr
+from .teams import manage_teams
+from .users import manage_users
 from .workspace import get_organization
 from .workspace import get_secret
 from .workspace import get_stage