databay-cli 0.1.0__py3-none-any.whl

databay/spec.py

@@ -0,0 +1,362 @@
+"""The API version this client speaks, and where each noun and operation is generated.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+API_VERSION = '1.0'
+
+#: CLI noun -> (its module under ``databay.cli.commands``, the verbs it has).
+NOUNS: dict[str, tuple[str, tuple[str, ...]]] = {
+    'alerting-webhook': ('alerting_webhook', ('create', 'delete', 'get', 'list', 'notify', 'update')),
+    'alerting-webhook-tag': ('alerting_webhook_tag', ('list',)),
+    'alerting-webhook-type': ('alerting_webhook_type', ('list',)),
+    'alerting-webhook-undelivered': ('alerting_webhook_undelivered', ('list', 'replay')),
+    'announcement': ('announcement', ('list', 'mark-all-read', 'mark-read', 'mark-unread')),
+    'api-key': ('api_key', ('create', 'get', 'list', 'revoke', 'rotate')),
+    'api-key-project': ('api_key_project', ('add', 'bi-connection', 'remove')),
+    'backfill-reason-code': ('backfill_reason_code', ('list',)),
+    'backfill-run': ('backfill_run', ('cancel', 'create', 'get', 'list')),
+    'canvas': ('canvas', ('activate', 'list', 'volumes')),
+    'canvas-graph': ('canvas_graph', ('get', 'put')),
+    'canvas-table-check': ('canvas_table_check', ('get', 'start')),
+    'dashboards': ('dashboards', ('create', 'delete', 'duplicate', 'get', 'list', 'replace', 'run', 'update')),
+    'dashboards-card': ('dashboards_card', ('create', 'delete', 'get', 'list', 'preview', 'run', 'update')),
+    'dashboards-dataset': ('dashboards_dataset', ('list',)),
+    'dashboards-folder': ('dashboards_folder', ('create', 'delete', 'update')),
+    'dashboards-home': ('dashboards_home', ('get', 'pin', 'pin-many', 'set')),
+    'dashboards-placement': ('dashboards_placement', ('create', 'delete', 'run')),
+    'db': ('db', ('create', 'delete', 'get', 'get-by-name', 'list', 'test')),
+    'db-column': ('db_column', ('list',)),
+    'docs-article': ('docs_article', ('get', 'list', 'search')),
+    'dq-result': ('dq_result', ('list',)),
+    'dq-rule': ('dq_rule', ('create', 'dag', 'list')),
+    'feature': ('feature', ('list',)),
+    'google-ads-source': ('google_ads_source', ('list',)),
+    'google-analytics-source': ('google_analytics_source', ('list',)),
+    'instagram-account': ('instagram_account', ('list',)),
+    'instagram-source': ('instagram_source', ('list',)),
+    'linkedin-account': ('linkedin_account', ('list',)),
+    'linkedin-source': ('linkedin_source', ('list',)),
+    'me': ('me', ('get',)),
+    'meta-ads-source': ('meta_ads_source', ('list',)),
+    'metric-models': ('metric_models', ('changes', 'import-dbt', 'list', 'metric-add', 'metric-list', 'metric-remove', 'metric-update', 'publish', 'push', 'set-breakdowns', 'show-draft', 'show-published', 'validate')),
+    'metrics': ('metrics', ('list',)),
+    'models': ('models', ('check', 'sync', 'sync-status')),
+    'nlq': ('nlq', ('ask', 'usage')),
+    'notebook-credential': ('notebook_credential', ('get-binding', 'issue', 'renew')),
+    'org': ('org', ('list',)),
+    'org-member': ('org_member', ('add', 'list', 'remove', 'set-role')),
+    'org-offboarding': ('org_offboarding', ('get',)),
+    'pipe': ('pipe', ('create', 'delete', 'get', 'list', 'move', 'pause', 'rebuild', 'restart', 'resume', 'retry', 'rollup', 'status', 'update')),
+    'pipe-backfill-run': ('pipe_backfill_run', ('list',)),
+    'pipe-config-option': ('pipe_config_option', ('get',)),
+    'pipe-destination': ('pipe_destination', ('check', 'get', 'preview')),
+    'pipe-leftover': ('pipe_leftover', ('check', 'dismiss', 'list')),
+    'pipe-sink-type': ('pipe_sink_type', ('list',)),
+    'pipe-source-type': ('pipe_source_type', ('list',)),
+    'pipe-status-bucket': ('pipe_status_bucket', ('list',)),
+    'pipe-stuck-delete': ('pipe_stuck_delete', ('list',)),
+    'plan': ('plan', ('list',)),
+    'project': ('project', ('create', 'delete', 'delete-preview', 'delete-retry', 'get', 'list', 'my-access', 'update')),
+    'project-budget': ('project_budget', ('list', 'set')),
+    'project-member': ('project_member', ('list', 'people', 'remove', 'search', 'set')),
+    'project-privilege': ('project_privilege', ('grant', 'list', 'revoke')),
+    'project-share': ('project_share', ('create', 'list', 'revoke')),
+    'provision': ('provision', ('ensure-defaults',)),
+    'provisioning': ('provisioning', ('status',)),
+    'registry': ('registry', ('get',)),
+    'resource-home': ('resource_home', ('transfer',)),
+    'schema-change': ('schema_change', ('apply', 'ignore', 'list', 'pending', 'state')),
+    'schema-history': ('schema_history', ('create', 'get', 'list', 'summary')),
+    'schema-version': ('schema_version', ('current', 'get', 'list')),
+    'shopify-store': ('shopify_store', ('list',)),
+    'sink-data-type': ('sink_data_type', ('list',)),
+    'source': ('source', ('cascade-delete', 'create', 'delete', 'force-delete', 'get', 'list', 'precheck', 'recheck', 'renew-credentials', 'setup-script', 'update')),
+    'source-catalog': ('source_catalog', ('list', 'setup-script')),
+    'source-check-run': ('source_check_run', ('get', 'latest', 'start', 'tables')),
+    'source-hidden-type': ('source_hidden_type', ('list',)),
+    'source-name': ('source_name', ('check',)),
+    'source-pipe': ('source_pipe', ('list',)),
+    'source-publication': ('source_publication', ('check', 'get', 'set')),
+    'source-readiness-override': ('source_readiness_override', ('delete', 'set')),
+    'source-setup-choice': ('source_setup_choice', ('check', 'get', 'set')),
+    'source-stream': ('source_stream', ('get', 'list')),
+    'source-table': ('source_table', ('check',)),
+    'ssbi-job': ('ssbi_job', ('create', 'delete', 'get', 'list', 'update')),
+    'transform-type': ('transform_type', ('list',)),
+    'usage': ('usage', ('get',)),
+    'warehouse': ('warehouse', ('create', 'delete', 'get', 'impact', 'list', 'rename', 'retry', 'stats')),
+    'warehouse-access-assignment': ('warehouse_access_assignment', ('list', 'preview', 'set')),
+    'warehouse-access-role': ('warehouse_access_role', ('create', 'delete', 'get-metrics', 'list', 'list-tables', 'set-metrics', 'set-rules', 'set-scope-mode', 'update')),
+    'warehouse-access-settings': ('warehouse_access_settings', ('get', 'get-default-role', 'set', 'set-default-role')),
+    'warehouse-login': ('warehouse_login', ('create', 'delete', 'list', 'list-mine', 'policy', 'rotate', 'update')),
+    'warehouse-principal': ('warehouse_principal', ('disable', 'enable', 'list', 'list-project')),
+    'warehouse-service-account': ('warehouse_service_account', ('create', 'delete', 'list', 'update')),
+    'warehouse-service-account-credential': ('warehouse_service_account_credential', ('create', 'delete', 'list', 'rotate', 'update')),
+}
+
+#: Operation id -> (its module under ``databay.operations``, its constant).
+OPERATIONS = {
+    'alerting_webhook_create': ('alerting_webhook', 'ALERTING_WEBHOOK_CREATE'),
+    'alerting_webhook_delete': ('alerting_webhook', 'ALERTING_WEBHOOK_DELETE'),
+    'alerting_webhook_get': ('alerting_webhook', 'ALERTING_WEBHOOK_GET'),
+    'alerting_webhook_list': ('alerting_webhook', 'ALERTING_WEBHOOK_LIST'),
+    'alerting_webhook_notify': ('alerting_webhook', 'ALERTING_WEBHOOK_NOTIFY'),
+    'alerting_webhook_tag_list': ('alerting_webhook_tag', 'ALERTING_WEBHOOK_TAG_LIST'),
+    'alerting_webhook_type_list': ('alerting_webhook_type', 'ALERTING_WEBHOOK_TYPE_LIST'),
+    'alerting_webhook_undelivered_list': ('alerting_webhook_undelivered', 'ALERTING_WEBHOOK_UNDELIVERED_LIST'),
+    'alerting_webhook_undelivered_replay': ('alerting_webhook_undelivered', 'ALERTING_WEBHOOK_UNDELIVERED_REPLAY'),
+    'alerting_webhook_update': ('alerting_webhook', 'ALERTING_WEBHOOK_UPDATE'),
+    'announcement_list': ('announcement', 'ANNOUNCEMENT_LIST'),
+    'announcement_mark_all_read': ('announcement', 'ANNOUNCEMENT_MARK_ALL_READ'),
+    'announcement_mark_read': ('announcement', 'ANNOUNCEMENT_MARK_READ'),
+    'announcement_mark_unread': ('announcement', 'ANNOUNCEMENT_MARK_UNREAD'),
+    'api_key_create': ('api_key', 'API_KEY_CREATE'),
+    'api_key_get': ('api_key', 'API_KEY_GET'),
+    'api_key_list': ('api_key', 'API_KEY_LIST'),
+    'api_key_project_add': ('api_key_project', 'API_KEY_PROJECT_ADD'),
+    'api_key_project_bi_connection': ('api_key_project', 'API_KEY_PROJECT_BI_CONNECTION'),
+    'api_key_project_remove': ('api_key_project', 'API_KEY_PROJECT_REMOVE'),
+    'api_key_revoke': ('api_key', 'API_KEY_REVOKE'),
+    'api_key_rotate': ('api_key', 'API_KEY_ROTATE'),
+    'backfill_reason_code_list': ('backfill_reason_code', 'BACKFILL_REASON_CODE_LIST'),
+    'backfill_run_cancel': ('backfill_run', 'BACKFILL_RUN_CANCEL'),
+    'backfill_run_create': ('backfill_run', 'BACKFILL_RUN_CREATE'),
+    'backfill_run_get': ('backfill_run', 'BACKFILL_RUN_GET'),
+    'backfill_run_list': ('backfill_run', 'BACKFILL_RUN_LIST'),
+    'canvas_activate': ('canvas', 'CANVAS_ACTIVATE'),
+    'canvas_graph_get': ('canvas_graph', 'CANVAS_GRAPH_GET'),
+    'canvas_graph_put': ('canvas_graph', 'CANVAS_GRAPH_PUT'),
+    'canvas_list': ('canvas', 'CANVAS_LIST'),
+    'canvas_table_check_get': ('canvas_table_check', 'CANVAS_TABLE_CHECK_GET'),
+    'canvas_table_check_start': ('canvas_table_check', 'CANVAS_TABLE_CHECK_START'),
+    'canvas_volumes': ('canvas', 'CANVAS_VOLUMES'),
+    'dashboards_card_create': ('dashboards_card', 'DASHBOARDS_CARD_CREATE'),
+    'dashboards_card_delete': ('dashboards_card', 'DASHBOARDS_CARD_DELETE'),
+    'dashboards_card_get': ('dashboards_card', 'DASHBOARDS_CARD_GET'),
+    'dashboards_card_list': ('dashboards_card', 'DASHBOARDS_CARD_LIST'),
+    'dashboards_card_preview': ('dashboards_card', 'DASHBOARDS_CARD_PREVIEW'),
+    'dashboards_card_run': ('dashboards_card', 'DASHBOARDS_CARD_RUN'),
+    'dashboards_card_update': ('dashboards_card', 'DASHBOARDS_CARD_UPDATE'),
+    'dashboards_create': ('dashboards', 'DASHBOARDS_CREATE'),
+    'dashboards_dataset_list': ('dashboards_dataset', 'DASHBOARDS_DATASET_LIST'),
+    'dashboards_delete': ('dashboards', 'DASHBOARDS_DELETE'),
+    'dashboards_duplicate': ('dashboards', 'DASHBOARDS_DUPLICATE'),
+    'dashboards_folder_create': ('dashboards_folder', 'DASHBOARDS_FOLDER_CREATE'),
+    'dashboards_folder_delete': ('dashboards_folder', 'DASHBOARDS_FOLDER_DELETE'),
+    'dashboards_folder_update': ('dashboards_folder', 'DASHBOARDS_FOLDER_UPDATE'),
+    'dashboards_get': ('dashboards', 'DASHBOARDS_GET'),
+    'dashboards_home_get': ('dashboards_home', 'DASHBOARDS_HOME_GET'),
+    'dashboards_home_pin': ('dashboards_home', 'DASHBOARDS_HOME_PIN'),
+    'dashboards_home_pin_many': ('dashboards_home', 'DASHBOARDS_HOME_PIN_MANY'),
+    'dashboards_home_set': ('dashboards_home', 'DASHBOARDS_HOME_SET'),
+    'dashboards_list': ('dashboards', 'DASHBOARDS_LIST'),
+    'dashboards_placement_create': ('dashboards_placement', 'DASHBOARDS_PLACEMENT_CREATE'),
+    'dashboards_placement_delete': ('dashboards_placement', 'DASHBOARDS_PLACEMENT_DELETE'),
+    'dashboards_placement_run': ('dashboards_placement', 'DASHBOARDS_PLACEMENT_RUN'),
+    'dashboards_replace': ('dashboards', 'DASHBOARDS_REPLACE'),
+    'dashboards_run': ('dashboards', 'DASHBOARDS_RUN'),
+    'dashboards_update': ('dashboards', 'DASHBOARDS_UPDATE'),
+    'db_column_list': ('db_column', 'DB_COLUMN_LIST'),
+    'db_create': ('db', 'DB_CREATE'),
+    'db_delete': ('db', 'DB_DELETE'),
+    'db_get': ('db', 'DB_GET'),
+    'db_get_by_name': ('db', 'DB_GET_BY_NAME'),
+    'db_list': ('db', 'DB_LIST'),
+    'db_test': ('db', 'DB_TEST'),
+    'docs_article_get': ('docs_article', 'DOCS_ARTICLE_GET'),
+    'docs_article_list': ('docs_article', 'DOCS_ARTICLE_LIST'),
+    'docs_article_search': ('docs_article', 'DOCS_ARTICLE_SEARCH'),
+    'dq_result_list': ('dq_result', 'DQ_RESULT_LIST'),
+    'dq_rule_create': ('dq_rule', 'DQ_RULE_CREATE'),
+    'dq_rule_dag': ('dq_rule', 'DQ_RULE_DAG'),
+    'dq_rule_list': ('dq_rule', 'DQ_RULE_LIST'),
+    'feature_list': ('feature', 'FEATURE_LIST'),
+    'google_ads_source_list': ('google_ads_source', 'GOOGLE_ADS_SOURCE_LIST'),
+    'google_analytics_source_list': ('google_analytics_source', 'GOOGLE_ANALYTICS_SOURCE_LIST'),
+    'instagram_account_list': ('instagram_account', 'INSTAGRAM_ACCOUNT_LIST'),
+    'instagram_source_list': ('instagram_source', 'INSTAGRAM_SOURCE_LIST'),
+    'linkedin_account_list': ('linkedin_account', 'LINKEDIN_ACCOUNT_LIST'),
+    'linkedin_source_list': ('linkedin_source', 'LINKEDIN_SOURCE_LIST'),
+    'me_get': ('me', 'ME_GET'),
+    'meta_ads_source_list': ('meta_ads_source', 'META_ADS_SOURCE_LIST'),
+    'metric_models_changes': ('metric_models', 'METRIC_MODELS_CHANGES'),
+    'metric_models_import_dbt': ('metric_models', 'METRIC_MODELS_IMPORT_DBT'),
+    'metric_models_list': ('metric_models', 'METRIC_MODELS_LIST'),
+    'metric_models_metric_add': ('metric_models', 'METRIC_MODELS_METRIC_ADD'),
+    'metric_models_metric_list': ('metric_models', 'METRIC_MODELS_METRIC_LIST'),
+    'metric_models_metric_remove': ('metric_models', 'METRIC_MODELS_METRIC_REMOVE'),
+    'metric_models_metric_update': ('metric_models', 'METRIC_MODELS_METRIC_UPDATE'),
+    'metric_models_publish': ('metric_models', 'METRIC_MODELS_PUBLISH'),
+    'metric_models_push': ('metric_models', 'METRIC_MODELS_PUSH'),
+    'metric_models_set_breakdowns': ('metric_models', 'METRIC_MODELS_SET_BREAKDOWNS'),
+    'metric_models_show_draft': ('metric_models', 'METRIC_MODELS_SHOW_DRAFT'),
+    'metric_models_show_published': ('metric_models', 'METRIC_MODELS_SHOW_PUBLISHED'),
+    'metric_models_validate': ('metric_models', 'METRIC_MODELS_VALIDATE'),
+    'metrics_describe': ('metrics', 'METRICS_DESCRIBE'),
+    'metrics_list': ('metrics', 'METRICS_LIST'),
+    'metrics_query': ('metrics', 'METRICS_QUERY'),
+    'models_check': ('models', 'MODELS_CHECK'),
+    'models_sync': ('models', 'MODELS_SYNC'),
+    'models_sync_status': ('models', 'MODELS_SYNC_STATUS'),
+    'nlq_ask': ('nlq', 'NLQ_ASK'),
+    'nlq_usage': ('nlq', 'NLQ_USAGE'),
+    'notebook_credential_get_binding': ('notebook_credential', 'NOTEBOOK_CREDENTIAL_GET_BINDING'),
+    'notebook_credential_issue': ('notebook_credential', 'NOTEBOOK_CREDENTIAL_ISSUE'),
+    'notebook_credential_renew': ('notebook_credential', 'NOTEBOOK_CREDENTIAL_RENEW'),
+    'org_list': ('org', 'ORG_LIST'),
+    'org_member_add': ('org_member', 'ORG_MEMBER_ADD'),
+    'org_member_list': ('org_member', 'ORG_MEMBER_LIST'),
+    'org_member_remove': ('org_member', 'ORG_MEMBER_REMOVE'),
+    'org_member_set_role': ('org_member', 'ORG_MEMBER_SET_ROLE'),
+    'org_offboarding_get': ('org_offboarding', 'ORG_OFFBOARDING_GET'),
+    'org_switch': ('org', 'ORG_SWITCH'),
+    'pipe_backfill_run_list': ('pipe_backfill_run', 'PIPE_BACKFILL_RUN_LIST'),
+    'pipe_config_option_get': ('pipe_config_option', 'PIPE_CONFIG_OPTION_GET'),
+    'pipe_create': ('pipe', 'PIPE_CREATE'),
+    'pipe_delete': ('pipe', 'PIPE_DELETE'),
+    'pipe_destination_check': ('pipe_destination', 'PIPE_DESTINATION_CHECK'),
+    'pipe_destination_get': ('pipe_destination', 'PIPE_DESTINATION_GET'),
+    'pipe_destination_preview': ('pipe_destination', 'PIPE_DESTINATION_PREVIEW'),
+    'pipe_get': ('pipe', 'PIPE_GET'),
+    'pipe_leftover_check': ('pipe_leftover', 'PIPE_LEFTOVER_CHECK'),
+    'pipe_leftover_dismiss': ('pipe_leftover', 'PIPE_LEFTOVER_DISMISS'),
+    'pipe_leftover_list': ('pipe_leftover', 'PIPE_LEFTOVER_LIST'),
+    'pipe_list': ('pipe', 'PIPE_LIST'),
+    'pipe_move': ('pipe', 'PIPE_MOVE'),
+    'pipe_pause': ('pipe', 'PIPE_PAUSE'),
+    'pipe_rebuild': ('pipe', 'PIPE_REBUILD'),
+    'pipe_restart': ('pipe', 'PIPE_RESTART'),
+    'pipe_resume': ('pipe', 'PIPE_RESUME'),
+    'pipe_retry': ('pipe', 'PIPE_RETRY'),
+    'pipe_rollup': ('pipe', 'PIPE_ROLLUP'),
+    'pipe_sink_type_list': ('pipe_sink_type', 'PIPE_SINK_TYPE_LIST'),
+    'pipe_source_type_list': ('pipe_source_type', 'PIPE_SOURCE_TYPE_LIST'),
+    'pipe_status': ('pipe', 'PIPE_STATUS'),
+    'pipe_status_bucket_list': ('pipe_status_bucket', 'PIPE_STATUS_BUCKET_LIST'),
+    'pipe_stuck_delete_list': ('pipe_stuck_delete', 'PIPE_STUCK_DELETE_LIST'),
+    'pipe_update': ('pipe', 'PIPE_UPDATE'),
+    'plan_list': ('plan', 'PLAN_LIST'),
+    'project_budget_list': ('project_budget', 'PROJECT_BUDGET_LIST'),
+    'project_budget_set': ('project_budget', 'PROJECT_BUDGET_SET'),
+    'project_create': ('project', 'PROJECT_CREATE'),
+    'project_delete': ('project', 'PROJECT_DELETE'),
+    'project_delete_preview': ('project', 'PROJECT_DELETE_PREVIEW'),
+    'project_delete_retry': ('project', 'PROJECT_DELETE_RETRY'),
+    'project_get': ('project', 'PROJECT_GET'),
+    'project_list': ('project', 'PROJECT_LIST'),
+    'project_member_list': ('project_member', 'PROJECT_MEMBER_LIST'),
+    'project_member_people': ('project_member', 'PROJECT_MEMBER_PEOPLE'),
+    'project_member_remove': ('project_member', 'PROJECT_MEMBER_REMOVE'),
+    'project_member_search': ('project_member', 'PROJECT_MEMBER_SEARCH'),
+    'project_member_set': ('project_member', 'PROJECT_MEMBER_SET'),
+    'project_my_access': ('project', 'PROJECT_MY_ACCESS'),
+    'project_privilege_grant': ('project_privilege', 'PROJECT_PRIVILEGE_GRANT'),
+    'project_privilege_list': ('project_privilege', 'PROJECT_PRIVILEGE_LIST'),
+    'project_privilege_revoke': ('project_privilege', 'PROJECT_PRIVILEGE_REVOKE'),
+    'project_share_create': ('project_share', 'PROJECT_SHARE_CREATE'),
+    'project_share_list': ('project_share', 'PROJECT_SHARE_LIST'),
+    'project_share_revoke': ('project_share', 'PROJECT_SHARE_REVOKE'),
+    'project_update': ('project', 'PROJECT_UPDATE'),
+    'provision_ensure_defaults': ('provision', 'PROVISION_ENSURE_DEFAULTS'),
+    'provisioning_status': ('provisioning', 'PROVISIONING_STATUS'),
+    'registry_get': ('registry', 'REGISTRY_GET'),
+    'resource_home_transfer': ('resource_home', 'RESOURCE_HOME_TRANSFER'),
+    'schema_change_apply': ('schema_change', 'SCHEMA_CHANGE_APPLY'),
+    'schema_change_ignore': ('schema_change', 'SCHEMA_CHANGE_IGNORE'),
+    'schema_change_list': ('schema_change', 'SCHEMA_CHANGE_LIST'),
+    'schema_change_pending': ('schema_change', 'SCHEMA_CHANGE_PENDING'),
+    'schema_change_state': ('schema_change', 'SCHEMA_CHANGE_STATE'),
+    'schema_history_create': ('schema_history', 'SCHEMA_HISTORY_CREATE'),
+    'schema_history_get': ('schema_history', 'SCHEMA_HISTORY_GET'),
+    'schema_history_list': ('schema_history', 'SCHEMA_HISTORY_LIST'),
+    'schema_history_summary': ('schema_history', 'SCHEMA_HISTORY_SUMMARY'),
+    'schema_version_current': ('schema_version', 'SCHEMA_VERSION_CURRENT'),
+    'schema_version_get': ('schema_version', 'SCHEMA_VERSION_GET'),
+    'schema_version_list': ('schema_version', 'SCHEMA_VERSION_LIST'),
+    'shopify_store_list': ('shopify_store', 'SHOPIFY_STORE_LIST'),
+    'sink_data_type_list': ('sink_data_type', 'SINK_DATA_TYPE_LIST'),
+    'source_cascade_delete': ('source', 'SOURCE_CASCADE_DELETE'),
+    'source_catalog_list': ('source_catalog', 'SOURCE_CATALOG_LIST'),
+    'source_catalog_setup_script': ('source_catalog', 'SOURCE_CATALOG_SETUP_SCRIPT'),
+    'source_check_run_get': ('source_check_run', 'SOURCE_CHECK_RUN_GET'),
+    'source_check_run_latest': ('source_check_run', 'SOURCE_CHECK_RUN_LATEST'),
+    'source_check_run_start': ('source_check_run', 'SOURCE_CHECK_RUN_START'),
+    'source_check_run_tables': ('source_check_run', 'SOURCE_CHECK_RUN_TABLES'),
+    'source_create': ('source', 'SOURCE_CREATE'),
+    'source_delete': ('source', 'SOURCE_DELETE'),
+    'source_force_delete': ('source', 'SOURCE_FORCE_DELETE'),
+    'source_get': ('source', 'SOURCE_GET'),
+    'source_hidden_type_list': ('source_hidden_type', 'SOURCE_HIDDEN_TYPE_LIST'),
+    'source_list': ('source', 'SOURCE_LIST'),
+    'source_name_check': ('source_name', 'SOURCE_NAME_CHECK'),
+    'source_pipe_list': ('source_pipe', 'SOURCE_PIPE_LIST'),
+    'source_precheck': ('source', 'SOURCE_PRECHECK'),
+    'source_publication_check': ('source_publication', 'SOURCE_PUBLICATION_CHECK'),
+    'source_publication_get': ('source_publication', 'SOURCE_PUBLICATION_GET'),
+    'source_publication_set': ('source_publication', 'SOURCE_PUBLICATION_SET'),
+    'source_readiness_override_delete': ('source_readiness_override', 'SOURCE_READINESS_OVERRIDE_DELETE'),
+    'source_readiness_override_set': ('source_readiness_override', 'SOURCE_READINESS_OVERRIDE_SET'),
+    'source_recheck': ('source', 'SOURCE_RECHECK'),
+    'source_renew_credentials': ('source', 'SOURCE_RENEW_CREDENTIALS'),
+    'source_setup_choice_check': ('source_setup_choice', 'SOURCE_SETUP_CHOICE_CHECK'),
+    'source_setup_choice_get': ('source_setup_choice', 'SOURCE_SETUP_CHOICE_GET'),
+    'source_setup_choice_set': ('source_setup_choice', 'SOURCE_SETUP_CHOICE_SET'),
+    'source_setup_script': ('source', 'SOURCE_SETUP_SCRIPT'),
+    'source_stream_get': ('source_stream', 'SOURCE_STREAM_GET'),
+    'source_stream_list': ('source_stream', 'SOURCE_STREAM_LIST'),
+    'source_table_check': ('source_table', 'SOURCE_TABLE_CHECK'),
+    'source_update': ('source', 'SOURCE_UPDATE'),
+    'sql_execute': ('sql', 'SQL_EXECUTE'),
+    'ssbi_job_create': ('ssbi_job', 'SSBI_JOB_CREATE'),
+    'ssbi_job_delete': ('ssbi_job', 'SSBI_JOB_DELETE'),
+    'ssbi_job_get': ('ssbi_job', 'SSBI_JOB_GET'),
+    'ssbi_job_list': ('ssbi_job', 'SSBI_JOB_LIST'),
+    'ssbi_job_update': ('ssbi_job', 'SSBI_JOB_UPDATE'),
+    'transform_type_list': ('transform_type', 'TRANSFORM_TYPE_LIST'),
+    'usage_get': ('usage', 'USAGE_GET'),
+    'warehouse_access_assignment_list': ('warehouse_access_assignment', 'WAREHOUSE_ACCESS_ASSIGNMENT_LIST'),
+    'warehouse_access_assignment_preview': ('warehouse_access_assignment', 'WAREHOUSE_ACCESS_ASSIGNMENT_PREVIEW'),
+    'warehouse_access_assignment_set': ('warehouse_access_assignment', 'WAREHOUSE_ACCESS_ASSIGNMENT_SET'),
+    'warehouse_access_role_create': ('warehouse_access_role', 'WAREHOUSE_ACCESS_ROLE_CREATE'),
+    'warehouse_access_role_delete': ('warehouse_access_role', 'WAREHOUSE_ACCESS_ROLE_DELETE'),
+    'warehouse_access_role_get_metrics': ('warehouse_access_role', 'WAREHOUSE_ACCESS_ROLE_GET_METRICS'),
+    'warehouse_access_role_list': ('warehouse_access_role', 'WAREHOUSE_ACCESS_ROLE_LIST'),
+    'warehouse_access_role_list_tables': ('warehouse_access_role', 'WAREHOUSE_ACCESS_ROLE_LIST_TABLES'),
+    'warehouse_access_role_set_metrics': ('warehouse_access_role', 'WAREHOUSE_ACCESS_ROLE_SET_METRICS'),
+    'warehouse_access_role_set_rules': ('warehouse_access_role', 'WAREHOUSE_ACCESS_ROLE_SET_RULES'),
+    'warehouse_access_role_set_scope_mode': ('warehouse_access_role', 'WAREHOUSE_ACCESS_ROLE_SET_SCOPE_MODE'),
+    'warehouse_access_role_update': ('warehouse_access_role', 'WAREHOUSE_ACCESS_ROLE_UPDATE'),
+    'warehouse_access_settings_get': ('warehouse_access_settings', 'WAREHOUSE_ACCESS_SETTINGS_GET'),
+    'warehouse_access_settings_get_default_role': ('warehouse_access_settings', 'WAREHOUSE_ACCESS_SETTINGS_GET_DEFAULT_ROLE'),
+    'warehouse_access_settings_set': ('warehouse_access_settings', 'WAREHOUSE_ACCESS_SETTINGS_SET'),
+    'warehouse_access_settings_set_default_role': ('warehouse_access_settings', 'WAREHOUSE_ACCESS_SETTINGS_SET_DEFAULT_ROLE'),
+    'warehouse_create': ('warehouse', 'WAREHOUSE_CREATE'),
+    'warehouse_delete': ('warehouse', 'WAREHOUSE_DELETE'),
+    'warehouse_get': ('warehouse', 'WAREHOUSE_GET'),
+    'warehouse_impact': ('warehouse', 'WAREHOUSE_IMPACT'),
+    'warehouse_list': ('warehouse', 'WAREHOUSE_LIST'),
+    'warehouse_login_create': ('warehouse_login', 'WAREHOUSE_LOGIN_CREATE'),
+    'warehouse_login_delete': ('warehouse_login', 'WAREHOUSE_LOGIN_DELETE'),
+    'warehouse_login_list': ('warehouse_login', 'WAREHOUSE_LOGIN_LIST'),
+    'warehouse_login_list_mine': ('warehouse_login', 'WAREHOUSE_LOGIN_LIST_MINE'),
+    'warehouse_login_policy': ('warehouse_login', 'WAREHOUSE_LOGIN_POLICY'),
+    'warehouse_login_rotate': ('warehouse_login', 'WAREHOUSE_LOGIN_ROTATE'),
+    'warehouse_login_update': ('warehouse_login', 'WAREHOUSE_LOGIN_UPDATE'),
+    'warehouse_principal_disable': ('warehouse_principal', 'WAREHOUSE_PRINCIPAL_DISABLE'),
+    'warehouse_principal_enable': ('warehouse_principal', 'WAREHOUSE_PRINCIPAL_ENABLE'),
+    'warehouse_principal_list': ('warehouse_principal', 'WAREHOUSE_PRINCIPAL_LIST'),
+    'warehouse_principal_list_project': ('warehouse_principal', 'WAREHOUSE_PRINCIPAL_LIST_PROJECT'),
+    'warehouse_rename': ('warehouse', 'WAREHOUSE_RENAME'),
+    'warehouse_retry': ('warehouse', 'WAREHOUSE_RETRY'),
+    'warehouse_service_account_create': ('warehouse_service_account', 'WAREHOUSE_SERVICE_ACCOUNT_CREATE'),
+    'warehouse_service_account_credential_create': ('warehouse_service_account_credential', 'WAREHOUSE_SERVICE_ACCOUNT_CREDENTIAL_CREATE'),
+    'warehouse_service_account_credential_delete': ('warehouse_service_account_credential', 'WAREHOUSE_SERVICE_ACCOUNT_CREDENTIAL_DELETE'),
+    'warehouse_service_account_credential_list': ('warehouse_service_account_credential', 'WAREHOUSE_SERVICE_ACCOUNT_CREDENTIAL_LIST'),
+    'warehouse_service_account_credential_rotate': ('warehouse_service_account_credential', 'WAREHOUSE_SERVICE_ACCOUNT_CREDENTIAL_ROTATE'),
+    'warehouse_service_account_credential_update': ('warehouse_service_account_credential', 'WAREHOUSE_SERVICE_ACCOUNT_CREDENTIAL_UPDATE'),
+    'warehouse_service_account_delete': ('warehouse_service_account', 'WAREHOUSE_SERVICE_ACCOUNT_DELETE'),
+    'warehouse_service_account_list': ('warehouse_service_account', 'WAREHOUSE_SERVICE_ACCOUNT_LIST'),
+    'warehouse_service_account_update': ('warehouse_service_account', 'WAREHOUSE_SERVICE_ACCOUNT_UPDATE'),
+    'warehouse_stats': ('warehouse', 'WAREHOUSE_STATS'),
+}

databay/stored_token.py

@@ -0,0 +1,134 @@
+"""
+The token source of a profile that signed in: ``auth = "login"`` (a person) or ``auth = "api_key"``.
+
+The access token is read from the profile's credential with its expiry. With less than
+``refresh_margin_s`` left it is renewed under the credential's file lock, so parallel commands
+renew once: a process that waited for the lock reads the store again and finds the new token.
+A login renews with its refresh token, an API key with the client-credentials grant, both at the
+token endpoint the credential's issuer names in its discovery document.
+"""
+
+from __future__ import annotations
+
+import time
+from dataclasses import dataclass
+from typing import TYPE_CHECKING
+
+from databay import oidc
+from databay.credentials import Credential, key_sub, open_store
+from databay.errors import DatabayProfileError
+from databay.locks import locked
+from databay.profiles import login_command
+from databay.settings import SETTINGS
+
+if TYPE_CHECKING:
+    import httpx
+
+    from databay.credentials import TokenStore
+    from databay.profiles import Profile
+
+#: OAuth errors that mean the stored credential no longer works: only a new sign-in helps.
+DEAD_CREDENTIAL = frozenset({"invalid_grant", "invalid_client", "unauthorized_client"})
+
+
+def login_required(profile: Profile, why: str) -> DatabayProfileError:
+    return DatabayProfileError(
+        f"profile {profile.name}: {why}; sign in again", code="login_required", next_command=login_command(profile)
+    )
+
+
+@dataclass
+class StoredToken:
+    profile: Profile
+    key: str
+    store: TokenStore
+    http: httpx.Client | None = None
+    #: The access token this source last handed out: a 401 on it means it, not a newer one, is refused.
+    sent: str | None = None
+    #: The access token and its expiry as last read, so a command's requests read the store once.
+    _held: tuple[str, float] | None = None
+    #: The issuer's endpoints, discovered at this source's first renewal.
+    _endpoints: oidc.Endpoints | None = None
+
+    def _load(self) -> Credential:
+        record = self.store.get(self.key)
+        if record is None or record.sub != key_sub(self.key) or record.kind != self.profile.auth:
+            raise DatabayProfileError(
+                f"profile {self.profile.name} names credential {self.key}, which the {self.store.kind} store "
+                "does not hold for that user",
+                code="credential_missing",
+                next_command=login_command(self.profile),
+            )
+        return record
+
+    def token(self) -> str:
+        if self._held is not None and self._held[1] - time.time() > SETTINGS.refresh_margin_s:
+            return self._hand_out(self._held[0], self._held[1])
+        record = self._load()
+        if record.expires_at - time.time() <= SETTINGS.refresh_margin_s:
+            with locked(self.key):
+                record = self._load()
+                if record.expires_at - time.time() <= SETTINGS.refresh_margin_s:
+                    record = self._renew(record)
+        return self._hand_out(record.access_token, record.expires_at)
+
+    def refreshed(self) -> str | None:
+        with locked(self.key):
+            record = self._load()
+            if record.access_token == self.sent:
+                record = self._renew(record)
+        return self._hand_out(record.access_token, record.expires_at)
+
+    def renewed(self) -> str:
+        """A token issued now, whatever the current one's expiry: it carries a change the server just stored."""
+        with locked(self.key):
+            record = self._renew(self._load())
+        return self._hand_out(record.access_token, record.expires_at)
+
+    def _hand_out(self, token: str, expires_at: float) -> str:
+        self.sent = token
+        self._held = (token, expires_at)
+        return token
+
+    def _renew(self, record: Credential) -> Credential:
+        # Credential.from_json refuses a login without its refresh token and a key without its secret.
+        if record.kind == "login":
+            data = {"grant_type": "refresh_token", "client_id": record.client_id, "refresh_token": record.refresh_token}
+        else:
+            data = {
+                "grant_type": "client_credentials",
+                "client_id": record.client_id,
+                "client_secret": record.client_secret,
+            }
+        try:
+            if self.http is not None:
+                issued = self._grant(self.http, record.issuer, data)
+            else:
+                from databay.transport import new_http_client  # noqa: PLC0415
+
+                with new_http_client(SETTINGS) as http:
+                    issued = self._grant(http, record.issuer, data)
+        except oidc.OAuthRefusal as exc:
+            if exc.error in DEAD_CREDENTIAL:
+                why = f"the identity provider refused the stored credential ({exc.error})"
+                raise login_required(self.profile, why) from None
+            raise
+        renewed = record.with_tokens(issued.access_token, issued.expires_at, issued.refresh_token)
+        self.store.put(self.key, renewed)
+        return renewed
+
+    def _grant(self, http: httpx.Client, issuer: str, data: dict[str, str]) -> oidc.Grant:
+        if self._endpoints is None:
+            self._endpoints = oidc.discover(http, issuer)
+        return oidc.grant(http, self._endpoints.token, data)
+
+
+def stored_token(profile: Profile, http: httpx.Client | None) -> StoredToken:
+    """The source for a signed-in profile; one without a credential is ``credential_missing``."""
+    if profile.credential is None or profile.token_store is None:
+        raise DatabayProfileError(
+            f"profile {profile.name} is not signed in",
+            code="credential_missing",
+            next_command=login_command(profile),
+        )
+    return StoredToken(profile, profile.credential, open_store(profile.token_store), http)

databay/tokens.py

@@ -0,0 +1,108 @@
+"""
+Where a request's bearer token comes from.
+
+The profile alone decides, by its ``auth``; nothing else is consulted:
+
+- ``login``: the credential ``databay login`` stored for a person, renewed with its refresh token;
+- ``api_key``: the credential ``databay login --api-key-id`` stored for an org API key, renewed
+  with the client-credentials grant;
+- ``env``: ``$DATABAY_TOKEN``, read on every request, for a token minted elsewhere.
+
+``$DATABAY_TOKEN`` set while the profile's ``auth`` is ``login`` or ``api_key`` is
+``token_source_conflict``: two token sources are in play and the CLI does not pick one.
+"""
+
+from __future__ import annotations
+
+import os
+from dataclasses import dataclass
+from typing import TYPE_CHECKING, Protocol
+
+from databay.errors import DatabayProfileError, DatabayUsageError
+from databay.settings import ENV_TOKEN
+
+if TYPE_CHECKING:
+    from collections.abc import Callable
+
+    import httpx
+
+    from databay.profiles import Profile
+
+
+class TokenProvider(Protocol):
+    def token(self) -> str | None:
+        """The access token to send now; ``None`` sends no ``Authorization`` header."""
+        ...
+
+    def refreshed(self) -> str | None:
+        """A new token after the server refused the current one, or ``None`` when this source cannot refresh."""
+        ...
+
+
+@dataclass(frozen=True, slots=True)
+class EnvToken:
+    """The token in ``$DATABAY_TOKEN``, read on each request; unset or empty is ``token_missing``."""
+
+    variable: str = ENV_TOKEN
+
+    def token(self) -> str:
+        value = os.environ.get(self.variable, "")
+        if not value:
+            raise DatabayProfileError(
+                f"the profile reads its token from ${self.variable}, which is not set",
+                code="token_missing",
+            )
+        return value
+
+    def refreshed(self) -> str | None:
+        return None
+
+
+@dataclass(frozen=True, slots=True)
+class StaticToken:
+    """A token the SDK caller already holds."""
+
+    value: str
+
+    def token(self) -> str:
+        return self.value
+
+    def refreshed(self) -> str | None:
+        return None
+
+
+@dataclass(frozen=True, slots=True)
+class NoToken:
+    """No ``Authorization`` header: the routes a client reads before it has a token (``client-config``)."""
+
+    def token(self) -> None:
+        return None
+
+    def refreshed(self) -> str | None:
+        return None
+
+
+def _stored(profile: Profile, http: httpx.Client | None) -> TokenProvider:
+    from databay.stored_token import stored_token  # noqa: PLC0415 — loads the OAuth code only when used
+
+    return stored_token(profile, http)
+
+
+#: ``auth`` value in a profile -> the token source it builds.
+TOKEN_SOURCES: dict[str, Callable[[Profile, httpx.Client | None], TokenProvider]] = {
+    "env": lambda _profile, _http: EnvToken(),
+    "login": _stored,
+    "api_key": _stored,
+}
+
+
+def token_provider(profile: Profile, http: httpx.Client | None = None) -> TokenProvider:
+    """The profile's token source; ``http`` is the client a renewal is sent with (a new one when ``None``)."""
+    if profile.auth != "env" and os.environ.get(ENV_TOKEN):
+        raise DatabayUsageError(
+            f"${ENV_TOKEN} is set, but profile {profile.name} signs in with auth = {profile.auth!r}: "
+            f"unset {ENV_TOKEN}, or use a profile whose auth is env",
+            code="token_source_conflict",
+            details={"profile": profile.name, "auth": profile.auth},
+        )
+    return TOKEN_SOURCES[profile.auth](profile, http)