databay-cli 0.1.0__py3-none-any.whl

databay/operations/project.py

@@ -0,0 +1,346 @@
+"""The ``project`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Body, Operation, Param, Response
+
+
+PROJECT_CREATE = Operation(
+    operation_id='project_create',
+    noun='project',
+    verb='create',
+    method='post',
+    path='/api/workspace/projects',
+    summary='Create Project',
+    description="Create a project with the caller as its admin.\n\nA repeated key answers the project as it is now, with the caller's own role: 404 once it is\ndeleted or when the caller can't see it, and 403 while it is being deleted.",
+    project=None,
+    destructive=False,
+    idempotent=True,
+    since='1.0',
+    params=(),
+    body=Body(
+        schema='ProjectCreate',
+        fields=(
+            Param(
+                name='access',
+                location='body',
+                kind='string',
+                required=False,
+                description='Access',
+                choices=(
+                    'restricted',
+                    'organization',
+                ),
+            ),
+            Param(
+                name='name',
+                location='body',
+                kind='string',
+                required=True,
+                description='Name',
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='project:Project',
+        shape='object',
+    ),
+    examples=(
+        'databay project create --name <name> --access restricted',
+    ),
+)
+
+PROJECT_DELETE = Operation(
+    operation_id='project_delete',
+    noun='project',
+    verb='delete',
+    method='delete',
+    path='/api/workspace/projects/{project_id}',
+    summary='Delete Project',
+    description='Empty projects (any project admin), or ``force=true`` into a target (org admins).',
+    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='force',
+            location='query',
+            kind='boolean',
+            required=False,
+            description='Force',
+        ),
+        Param(
+            name='target_project_id',
+            location='query',
+            kind='string',
+            required=False,
+            description='Target Project Id',
+            nullable=True,
+        ),
+        Param(
+            name='manifest_version',
+            location='query',
+            kind='integer',
+            required=False,
+            description='Manifest Version',
+            nullable=True,
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='empty',
+    ),
+    examples=(
+        'databay project delete <project_id>',
+        'databay project delete <project_id> --force --target-project-id <target> --manifest-version <version>',
+    ),
+)
+
+PROJECT_DELETE_PREVIEW = Operation(
+    operation_id='project_delete_preview',
+    noun='project',
+    verb='delete-preview',
+    method='get',
+    path='/api/workspace/projects/{project_id}/delete-preview',
+    summary='Delete Preview',
+    description='Build the versioned manifest of a forced delete into ``target_project_id`` (org admins).',
+    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='target_project_id',
+            location='query',
+            kind='string',
+            required=True,
+            description='Target Project Id',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='project:DeleteManifest',
+        shape='object',
+    ),
+    examples=(
+        'databay project delete-preview <project_id> --target-project-id <target_project_id>',
+    ),
+)
+
+PROJECT_DELETE_RETRY = Operation(
+    operation_id='project_delete_retry',
+    noun='project',
+    verb='delete-retry',
+    method='post',
+    path='/api/workspace/projects/{project_id}/delete-retry',
+    summary='Retry Project Delete',
+    description='Org admins: re-announce a delete still awaiting acknowledgements (409 ``project_not_deleting``).',
+    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',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='project:DeleteRetry',
+        shape='object',
+    ),
+    examples=(
+        'databay project delete-retry <project_id>',
+    ),
+)
+
+PROJECT_GET = Operation(
+    operation_id='project_get',
+    noun='project',
+    verb='get',
+    method='get',
+    path='/api/workspace/projects/{project_id}',
+    summary='Get Project',
+    description='',
+    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:Project',
+        shape='object',
+    ),
+    examples=(
+        'databay project get <project_id>',
+    ),
+)
+
+PROJECT_LIST = Operation(
+    operation_id='project_list',
+    noun='project',
+    verb='list',
+    method='get',
+    path='/api/workspace/projects',
+    summary='List Projects',
+    description='',
+    project=None,
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(),
+    body=None,
+    response=Response(
+        kind='json',
+        model='project:ProjectListResponse',
+        shape='array',
+    ),
+    examples=(
+        'databay project list',
+    ),
+)
+
+PROJECT_MY_ACCESS = Operation(
+    operation_id='project_my_access',
+    noun='project',
+    verb='my-access',
+    method='get',
+    path='/api/workspace/projects/{project_id}/my-access',
+    summary='Get My Access',
+    description='Your own role in the project and what it lets you do, the privileges granted to you included.',
+    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:MyAccess',
+        shape='object',
+    ),
+    examples=(
+        'databay project my-access <project_id>',
+    ),
+)
+
+PROJECT_UPDATE = Operation(
+    operation_id='project_update',
+    noun='project',
+    verb='update',
+    method='patch',
+    path='/api/workspace/projects/{project_id}',
+    summary='Update Project',
+    description='',
+    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=Body(
+        schema='ProjectUpdate',
+        fields=(
+            Param(
+                name='access',
+                location='body',
+                kind='string',
+                required=False,
+                description='Access',
+                choices=(
+                    'restricted',
+                    'organization',
+                ),
+                nullable=True,
+            ),
+            Param(
+                name='name',
+                location='body',
+                kind='string',
+                required=False,
+                description='Name',
+                nullable=True,
+            ),
+            Param(
+                name='new_columns_default',
+                location='body',
+                kind='string',
+                required=False,
+                description='What a new pipe in this project does with a new source column: add it automatically (`add`) or wait for a decision (`ask`). Each pipe takes it when it is created and can override it.',
+                choices=(
+                    'add',
+                    'ask',
+                ),
+                nullable=True,
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='project:Project',
+        shape='object',
+    ),
+    examples=(
+        'databay project update <project_id> --name "Marketing analytics" --access organization',
+        'databay project update <project_id> --new-columns-default ask',
+    ),
+)
+
+OPERATIONS = (
+    PROJECT_CREATE,
+    PROJECT_DELETE,
+    PROJECT_DELETE_PREVIEW,
+    PROJECT_DELETE_RETRY,
+    PROJECT_GET,
+    PROJECT_LIST,
+    PROJECT_MY_ACCESS,
+    PROJECT_UPDATE,
+)

databay/operations/project_budget.py

@@ -0,0 +1,135 @@
+"""The ``project-budget`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Body, Operation, Param, Response
+
+
+PROJECT_BUDGET_LIST = Operation(
+    operation_id='project_budget_list',
+    noun='project-budget',
+    verb='list',
+    method='get',
+    path='/api/entitlements/projects/{project_id}/budgets',
+    summary='Get Budgets',
+    description="Return the project's budgets and its usage of each budget meter.",
+    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_budget:ProjectBudgetsView',
+        shape='object',
+    ),
+    examples=(
+        'databay project-budget list <project_id>',
+    ),
+)
+
+PROJECT_BUDGET_SET = Operation(
+    operation_id='project_budget_set',
+    noun='project-budget',
+    verb='set',
+    method='put',
+    path='/api/entitlements/projects/{project_id}/budgets',
+    summary='Put Budget',
+    description='Set or (``limit`` null) remove one budget; 409 ``budget_below_usage`` without ``confirm_pause``.',
+    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=Body(
+        schema='BudgetPut',
+        fields=(
+            Param(
+                name='confirm_pause',
+                location='body',
+                kind='boolean',
+                required=False,
+                description="Save a flow budget below this period's usage anyway.",
+            ),
+            Param(
+                name='limit',
+                location='body',
+                kind='integer',
+                required=False,
+                description='The budget; null removes it.',
+                nullable=True,
+            ),
+            Param(
+                name='meter',
+                location='body',
+                kind='string',
+                required=True,
+                choices=(
+                    'pipes',
+                    'sources_db',
+                    'sources_saas',
+                    'warehouses_managed',
+                    'projects',
+                    'seats_editor',
+                    'api_keys',
+                    'ssbi_jobs',
+                    'rows_landed',
+                    'snapshot_rows',
+                    'saas_sync_runs',
+                    'max_backfill_days',
+                    'max_streams_per_source',
+                    'console_ch_queries',
+                    'console_ch_errors',
+                    'console_ch_read_rows',
+                    'console_ch_execution_time',
+                    'notebook_ch_queries',
+                    'notebook_ch_errors',
+                    'notebook_ch_read_rows',
+                    'notebook_ch_execution_time',
+                    'semantic_ch_queries',
+                    'semantic_ch_errors',
+                    'semantic_ch_read_rows',
+                    'semantic_ch_execution_time',
+                    'warehouse_cpu_seconds',
+                    'warehouse_read_bytes',
+                    'warehouse_principals',
+                    'warehouse_login_ch_queries',
+                    'warehouse_login_ch_errors',
+                    'warehouse_login_ch_read_rows',
+                    'warehouse_login_ch_execution_time',
+                ),
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='project_budget:ProjectBudgetsView',
+        shape='object',
+    ),
+    examples=(
+        'databay project-budget set <project_id> --meter rows_landed --limit 5000000',
+    ),
+)
+
+OPERATIONS = (
+    PROJECT_BUDGET_LIST,
+    PROJECT_BUDGET_SET,
+)

databay/operations/project_member.py

@@ -0,0 +1,226 @@
+"""The ``project-member`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Body, Operation, Param, Response
+
+
+PROJECT_MEMBER_LIST = Operation(
+    operation_id='project_member_list',
+    noun='project-member',
+    verb='list',
+    method='get',
+    path='/api/workspace/projects/{project_id}/members',
+    summary='List Members',
+    description='',
+    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_member:ProjectMemberListResponse',
+        shape='array',
+    ),
+    examples=(
+        'databay project-member list <project_id>',
+    ),
+)
+
+PROJECT_MEMBER_PEOPLE = Operation(
+    operation_id='project_member_people',
+    noun='project-member',
+    verb='people',
+    method='get',
+    path='/api/workspace/projects/{project_id}/people',
+    summary='List People',
+    description='Project admins: one page of everyone who reads the project now, with their role; follow ``next_first``.',
+    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='first',
+            location='query',
+            kind='integer',
+            required=False,
+            description='First',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='project_member:ProjectPeopleOut',
+        shape='object',
+    ),
+    examples=(
+        'databay project-member people <project_id> --first 0',
+    ),
+)
+
+PROJECT_MEMBER_REMOVE = Operation(
+    operation_id='project_member_remove',
+    noun='project-member',
+    verb='remove',
+    method='delete',
+    path='/api/workspace/projects/{project_id}/members/{user_id}',
+    summary='Remove Member',
+    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',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='empty',
+    ),
+    examples=(
+        'databay project-member remove <project_id> <user_id>',
+    ),
+)
+
+PROJECT_MEMBER_SEARCH = Operation(
+    operation_id='project_member_search',
+    noun='project-member',
+    verb='search',
+    method='get',
+    path='/api/workspace/projects/{project_id}/member-search',
+    summary='Member Search',
+    description='Project admins: organization members to add, matching ``q`` or exactly ``user_id`` (at most 50).',
+    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='q',
+            location='query',
+            kind='string',
+            required=False,
+            description='Q',
+            nullable=True,
+        ),
+        Param(
+            name='user_id',
+            location='query',
+            kind='string',
+            required=False,
+            description='User Id',
+            nullable=True,
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='project_member:MemberSearchOut',
+        shape='object',
+    ),
+    examples=(
+        'databay project-member search <project_id> --q ana',
+    ),
+)
+
+PROJECT_MEMBER_SET = Operation(
+    operation_id='project_member_set',
+    noun='project-member',
+    verb='set',
+    method='put',
+    path='/api/workspace/projects/{project_id}/members/{user_id}',
+    summary='Put Member',
+    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',
+        ),
+    ),
+    body=Body(
+        schema='MemberWrite',
+        fields=(
+            Param(
+                name='role',
+                location='body',
+                kind='string',
+                required=True,
+                description='Role',
+                choices=(
+                    'viewer',
+                    'editor',
+                    'admin',
+                ),
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='project_member:Member',
+        shape='object',
+    ),
+    examples=(
+        'databay project-member set <project_id> <user_id> --role editor',
+    ),
+)
+
+OPERATIONS = (
+    PROJECT_MEMBER_LIST,
+    PROJECT_MEMBER_PEOPLE,
+    PROJECT_MEMBER_REMOVE,
+    PROJECT_MEMBER_SEARCH,
+    PROJECT_MEMBER_SET,
+)