databay-cli 0.1.0__py3-none-any.whl

databay/operations/project_privilege.py

@@ -0,0 +1,143 @@
+"""The ``project-privilege`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Operation, Param, Response
+
+
+PROJECT_PRIVILEGE_GRANT = Operation(
+    operation_id='project_privilege_grant',
+    noun='project-privilege',
+    verb='grant',
+    method='put',
+    path='/api/workspace/projects/{project_id}/members/{user_id}/privileges/{privilege}',
+    summary='Grant Privilege',
+    description='Project admins: grant an explicit member a privilege (404 ``project_member_not_found`` for anyone else).',
+    project='path:project_id',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='project_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Project Id',
+        ),
+        Param(
+            name='user_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='User Id',
+        ),
+        Param(
+            name='privilege',
+            location='path',
+            kind='string',
+            required=True,
+            description='Privilege',
+            choices=(
+                'semantic.model.write',
+                'semantic.model.publish',
+            ),
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='project_privilege:MemberPrivilege',
+        shape='object',
+    ),
+    examples=(
+        'databay project-privilege grant <project_id> <user_id> semantic.model.publish',
+    ),
+)
+
+PROJECT_PRIVILEGE_LIST = Operation(
+    operation_id='project_privilege_list',
+    noun='project-privilege',
+    verb='list',
+    method='get',
+    path='/api/workspace/projects/{project_id}/privileges',
+    summary='List Privileges',
+    description='Project admins: the privileges granted to members. Admins hold every privilege without a grant.',
+    project='path:project_id',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='project_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Project Id',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='project_privilege:ProjectPrivilegeListResponse',
+        shape='array',
+    ),
+    examples=(
+        'databay project-privilege list <project_id>',
+    ),
+)
+
+PROJECT_PRIVILEGE_REVOKE = Operation(
+    operation_id='project_privilege_revoke',
+    noun='project-privilege',
+    verb='revoke',
+    method='delete',
+    path='/api/workspace/projects/{project_id}/members/{user_id}/privileges/{privilege}',
+    summary='Revoke Privilege',
+    description='',
+    project='path:project_id',
+    destructive=True,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='project_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Project Id',
+        ),
+        Param(
+            name='user_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='User Id',
+        ),
+        Param(
+            name='privilege',
+            location='path',
+            kind='string',
+            required=True,
+            description='Privilege',
+            choices=(
+                'semantic.model.write',
+                'semantic.model.publish',
+            ),
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='empty',
+    ),
+    examples=(
+        'databay project-privilege revoke <project_id> <user_id> semantic.model.publish',
+    ),
+)
+
+OPERATIONS = (
+    PROJECT_PRIVILEGE_GRANT,
+    PROJECT_PRIVILEGE_LIST,
+    PROJECT_PRIVILEGE_REVOKE,
+)

databay/operations/project_share.py

@@ -0,0 +1,160 @@
+"""The ``project-share`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Body, Operation, Param, Response
+
+
+PROJECT_SHARE_CREATE = Operation(
+    operation_id='project_share_create',
+    noun='project-share',
+    verb='create',
+    method='post',
+    path='/api/workspace/resources/{resource_type}/{resource_id}/shares',
+    summary='Share Resource',
+    description='Share into ``target_project_id``: home project editor + target visible. 201, or 200 when already shared.\n\nA repeated key returns the first answer and its status, even when the share no longer exists.',
+    project=None,
+    destructive=False,
+    idempotent=True,
+    since='1.0',
+    params=(
+        Param(
+            name='resource_type',
+            location='path',
+            kind='string',
+            required=True,
+            description='Resource Type',
+            choices=(
+                'warehouse',
+                'source',
+            ),
+        ),
+        Param(
+            name='resource_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Resource Id',
+        ),
+    ),
+    body=Body(
+        schema='ShareRequest',
+        fields=(
+            Param(
+                name='target_project_id',
+                location='body',
+                kind='string',
+                required=True,
+                description='Target Project Id',
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='project_share:Binding',
+        shape='object',
+    ),
+    examples=(
+        'databay project-share create source <resource_id> --target-project-id <target_project_id>',
+    ),
+)
+
+PROJECT_SHARE_LIST = Operation(
+    operation_id='project_share_list',
+    noun='project-share',
+    verb='list',
+    method='get',
+    path='/api/workspace/resources/{resource_type}/{resource_id}/shares',
+    summary='List Resource Shares',
+    description='List the home, org-wide flag and shares (projects the caller cannot see are masked).',
+    project=None,
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='resource_type',
+            location='path',
+            kind='string',
+            required=True,
+            description='Resource Type',
+            choices=(
+                'warehouse',
+                'source',
+            ),
+        ),
+        Param(
+            name='resource_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Resource Id',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='project_share:Shares',
+        shape='object',
+    ),
+    examples=(
+        'databay project-share list source <resource_id>',
+    ),
+)
+
+PROJECT_SHARE_REVOKE = Operation(
+    operation_id='project_share_revoke',
+    noun='project-share',
+    verb='revoke',
+    method='delete',
+    path='/api/workspace/resources/{resource_type}/{resource_id}/shares/{target_project_id}',
+    summary='Unshare Resource',
+    description='Unshare: 409 ``share_in_use`` while pipes there use it; canvas drafts come back as a warning.',
+    project=None,
+    destructive=True,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='resource_type',
+            location='path',
+            kind='string',
+            required=True,
+            description='Resource Type',
+            choices=(
+                'warehouse',
+                'source',
+            ),
+        ),
+        Param(
+            name='resource_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Resource Id',
+        ),
+        Param(
+            name='target_project_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Target Project Id',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='project_share:UnshareResult',
+        shape='object',
+    ),
+    examples=(
+        'databay project-share revoke source <resource_id> <target_project_id>',
+    ),
+)
+
+OPERATIONS = (
+    PROJECT_SHARE_CREATE,
+    PROJECT_SHARE_LIST,
+    PROJECT_SHARE_REVOKE,
+)

databay/operations/provision.py

@@ -0,0 +1,35 @@
+"""The ``provision`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Operation, Response
+
+
+PROVISION_ENSURE_DEFAULTS = Operation(
+    operation_id='provision_ensure_defaults',
+    noun='provision',
+    verb='ensure-defaults',
+    method='post',
+    path='/api/configstore/provision/defaults',
+    summary='Provision Defaults',
+    description="Manual default-DB provisioning trigger.\n\nEnsures the org's default ClickHouse database exists.",
+    project=None,
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(),
+    body=None,
+    response=Response(
+        kind='json',
+        model='provision:ProvisionDefaultsResponse',
+        shape='object',
+    ),
+    examples=(
+        'databay provision ensure-defaults',
+    ),
+)
+
+OPERATIONS = (
+    PROVISION_ENSURE_DEFAULTS,
+)

databay/operations/provisioning.py

@@ -0,0 +1,35 @@
+"""The ``provisioning`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Operation, Response
+
+
+PROVISIONING_STATUS = Operation(
+    operation_id='provisioning_status',
+    noun='provisioning',
+    verb='status',
+    method='get',
+    path='/api/auth/me/provisioning-status',
+    summary='Get Provisioning Status',
+    description='Report the user\'s workspace-provisioning progress.\n\nAggregates the user\'s provisioning attempts per kind. Poll it after sign-up until\n``ready``; ``ready=true`` means the user\'s default ClickHouse DB exists. Each kind is ``"pending"`` (not run yet or\nretrying), ``"ready"``, or ``"failed"`` with ``errors[kind]`` set to the last error.',
+    project=None,
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(),
+    body=None,
+    response=Response(
+        kind='json',
+        model='provisioning:ProvisioningStatusResponse',
+        shape='object',
+    ),
+    examples=(
+        'databay provisioning status',
+    ),
+)
+
+OPERATIONS = (
+    PROVISIONING_STATUS,
+)

databay/operations/registry.py

@@ -0,0 +1,35 @@
+"""The ``registry`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Operation, Response
+
+
+REGISTRY_GET = Operation(
+    operation_id='registry_get',
+    noun='registry',
+    verb='get',
+    method='get',
+    path='/api/configstore/registry',
+    summary='Get Registry Manifest',
+    description='Return which product this deployment is: its enabled plugins and auth providers.\n\nPublic for the same reason as ``/features``: the login page must know whether to\nrender the email form or "Sign in with Shopify" before anyone has signed in.\n\nIt also says which source types sync on a schedule here (``dlt_source_types``, the ones\nwith "Sync now" and backfill ceilings) and how many GA4 properties one connection may sync.',
+    project=None,
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(),
+    body=None,
+    response=Response(
+        kind='json',
+        model='registry:RegistryManifestResponse',
+        shape='object',
+    ),
+    examples=(
+        'databay registry get',
+    ),
+)
+
+OPERATIONS = (
+    REGISTRY_GET,
+)

databay/operations/resource_home.py

@@ -0,0 +1,80 @@
+"""The ``resource-home`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Body, Operation, Param, Response
+
+
+RESOURCE_HOME_TRANSFER = Operation(
+    operation_id='resource_home_transfer',
+    noun='resource-home',
+    verb='transfer',
+    method='post',
+    path='/api/workspace/resources/{resource_type}/{resource_id}/home',
+    summary='Transfer Resource Home',
+    description="Org admins: move (or assign) the resource's home project; ``dry_run`` previews it.",
+    project=None,
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='resource_type',
+            location='path',
+            kind='string',
+            required=True,
+            description='Resource Type',
+            choices=(
+                'warehouse',
+                'source',
+            ),
+        ),
+        Param(
+            name='resource_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Resource Id',
+        ),
+    ),
+    body=Body(
+        schema='HomeTransferRequest',
+        fields=(
+            Param(
+                name='dry_run',
+                location='body',
+                kind='boolean',
+                required=False,
+                description='Dry Run',
+            ),
+            Param(
+                name='keep_previous_as_share',
+                location='body',
+                kind='boolean',
+                required=False,
+                description='Keep Previous As Share',
+            ),
+            Param(
+                name='target_project_id',
+                location='body',
+                kind='string',
+                required=True,
+                description='Target Project Id',
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='resource_home:HomeTransferResult',
+        shape='object',
+    ),
+    examples=(
+        'databay resource-home transfer source <resource_id> --target-project-id <target_project_id> --dry-run',
+        'databay resource-home transfer warehouse <resource_id> --target-project-id <target_project_id>',
+    ),
+)
+
+OPERATIONS = (
+    RESOURCE_HOME_TRANSFER,
+)