databay-cli 0.1.0__py3-none-any.whl

databay/operations/dashboards_card.py

@@ -0,0 +1,406 @@
+"""The ``dashboards-card`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Body, Operation, Param, Response
+
+
+DASHBOARDS_CARD_CREATE = Operation(
+    operation_id='dashboards_card_create',
+    noun='dashboards-card',
+    verb='create',
+    method='post',
+    path='/api/insights/projects/{project_id}/cards',
+    summary='Add a card',
+    description="Add a card to the project; with ``board_id``, also place it below that dashboard's other cards.",
+    project='path:project_id',
+    destructive=False,
+    idempotent=True,
+    since='1.0',
+    params=(
+        Param(
+            name='project_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Project Id',
+        ),
+    ),
+    body=Body(
+        schema='CardCreate',
+        fields=(
+            Param(
+                name='board_id',
+                location='body',
+                kind='string',
+                required=False,
+                description='A board of the project to place the new card on.',
+                nullable=True,
+            ),
+            Param(
+                name='spec',
+                location='body',
+                kind='json',
+                required=True,
+                description='A card spec: {spec_version: 1, query: {sql, ...}, chart: {type, ...}}; 422 invalid_spec when it does not fit.',
+            ),
+            Param(
+                name='title',
+                location='body',
+                kind='string',
+                required=True,
+                description='Title',
+            ),
+            Param(
+                name='warehouse_id',
+                location='body',
+                kind='string',
+                required=True,
+                description="The warehouse of the project the card's query runs in.",
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='shared:CardOut',
+        shape='object',
+    ),
+    examples=(
+        'databay dashboards-card create --file <card_json_file>',
+    ),
+)
+
+DASHBOARDS_CARD_DELETE = Operation(
+    operation_id='dashboards_card_delete',
+    noun='dashboards-card',
+    verb='delete',
+    method='delete',
+    path='/api/insights/cards/{card_id}',
+    summary='Delete a card',
+    description='Delete a card and take it off every dashboard it sits on.',
+    project=None,
+    destructive=True,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='card_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Card Id',
+        ),
+        Param(
+            name='revision',
+            location='query',
+            kind='integer',
+            required=True,
+            description='The card revision this change was made on.',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='empty',
+    ),
+    examples=(
+        'databay dashboards-card delete <card_id> --revision <revision> --yes',
+    ),
+)
+
+DASHBOARDS_CARD_GET = Operation(
+    operation_id='dashboards_card_get',
+    noun='dashboards-card',
+    verb='get',
+    method='get',
+    path='/api/insights/cards/{card_id}',
+    summary='Read a card',
+    description='Return a card with the dashboards it sits on; ``revision`` is what a change to it sends.',
+    project=None,
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='card_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Card Id',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='shared:CardOut',
+        shape='object',
+    ),
+    examples=(
+        'databay dashboards-card get <card_id>',
+    ),
+)
+
+DASHBOARDS_CARD_LIST = Operation(
+    operation_id='dashboards_card_list',
+    noun='dashboards-card',
+    verb='list',
+    method='get',
+    path='/api/insights/projects/{project_id}/cards',
+    summary="List the project's cards",
+    description="List one page of the project's cards, the most recently changed first, each with the dashboards it sits on.\n\n``next_cursor`` pages on with the same ``q`` and ``placement``; another list's cursor is 422 ``request_invalid``.",
+    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='limit',
+            location='query',
+            kind='integer',
+            required=False,
+            description='How many cards to answer, from 1 to 100; 20 when left out.',
+        ),
+        Param(
+            name='q',
+            location='query',
+            kind='string',
+            required=False,
+            description='Keep the cards whose title holds this text, in any case.',
+            nullable=True,
+        ),
+        Param(
+            name='placement',
+            location='query',
+            kind='string',
+            required=False,
+            description='any: every card (when left out); unplaced: only the cards on no dashboard.',
+            choices=(
+                'any',
+                'unplaced',
+            ),
+        ),
+        Param(
+            name='cursor',
+            location='query',
+            kind='string',
+            required=False,
+            description='The next_cursor of the page before, sent with the same q and placement.',
+            nullable=True,
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='dashboards_card:CardList',
+        shape='object',
+        rows='/cards',
+    ),
+    examples=(
+        'databay dashboards-card list --limit 20',
+        'databay dashboards-card list --q revenue --placement unplaced',
+    ),
+    columns=(
+        'id',
+        'title',
+        'warehouse_id',
+        'updated_at',
+    ),
+)
+
+DASHBOARDS_CARD_PREVIEW = Operation(
+    operation_id='dashboards_card_preview',
+    noun='dashboards-card',
+    verb='preview',
+    method='post',
+    path='/api/insights/projects/{project_id}/cards/preview',
+    summary='Run an unsaved card',
+    description='Run an unsaved card on a warehouse of the project, as the editor.',
+    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='CardPreviewRequest',
+        fields=(
+            Param(
+                name='board_filters',
+                location='body',
+                kind='json',
+                required=False,
+                description='Board filters (date_range, select, and at most one warehouse filter whose default is a warehouse of the project); 422 invalid_filters when they do not fit.',
+            ),
+            Param(
+                name='filters',
+                location='body',
+                kind='json',
+                required=False,
+                description='Filter values by filter key; absent filters take their defaults.',
+            ),
+            Param(
+                name='spec',
+                location='body',
+                kind='json',
+                required=True,
+                description='A card spec: {spec_version: 1, query: {sql, ...}, chart: {type, ...}}; 422 invalid_spec when it does not fit.',
+            ),
+            Param(
+                name='warehouse_id',
+                location='body',
+                kind='string',
+                required=True,
+                description='The warehouse of the project the card reads.',
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='shared:CardResult',
+        shape='object',
+    ),
+    examples=(
+        'databay dashboards-card preview --file <preview_json_file>',
+    ),
+)
+
+DASHBOARDS_CARD_RUN = Operation(
+    operation_id='dashboards_card_run',
+    noun='dashboards-card',
+    verb='run',
+    method='post',
+    path='/api/insights/cards/{card_id}/run',
+    summary='Run a card on its own',
+    description="Run a card for the viewer with its variables' defaults, outside any dashboard.",
+    project=None,
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='card_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Card Id',
+        ),
+    ),
+    body=Body(
+        schema='CardRunRequest',
+        fields=(
+            Param(
+                name='filters',
+                location='body',
+                kind='json',
+                required=False,
+                description='Filter values by filter key; absent filters take their defaults.',
+            ),
+            Param(
+                name='refresh',
+                location='body',
+                kind='boolean',
+                required=False,
+                description='Skip the per-viewer result cache.',
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='shared:CardResult',
+        shape='object',
+    ),
+    examples=(
+        'databay dashboards-card run <card_id>',
+    ),
+)
+
+DASHBOARDS_CARD_UPDATE = Operation(
+    operation_id='dashboards_card_update',
+    noun='dashboards-card',
+    verb='update',
+    method='patch',
+    path='/api/insights/cards/{card_id}',
+    summary='Change a card',
+    description="Change a card's title, query, chart or warehouse, everywhere it sits.",
+    project=None,
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='card_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Card Id',
+        ),
+    ),
+    body=Body(
+        schema='CardPatch',
+        fields=(
+            Param(
+                name='revision',
+                location='body',
+                kind='integer',
+                required=True,
+                description='The card revision this change was made on.',
+            ),
+            Param(
+                name='spec',
+                location='body',
+                kind='json',
+                required=False,
+                description='A card spec: {spec_version: 1, query: {sql, ...}, chart: {type, ...}}; 422 invalid_spec when it does not fit.',
+                nullable=True,
+            ),
+            Param(
+                name='title',
+                location='body',
+                kind='string',
+                required=False,
+                description='Title',
+                nullable=True,
+            ),
+            Param(
+                name='warehouse_id',
+                location='body',
+                kind='string',
+                required=False,
+                description="The warehouse of the project the card's query runs in.",
+                nullable=True,
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='shared:CardOut',
+        shape='object',
+    ),
+    examples=(
+        'databay dashboards-card update <card_id> --revision <revision> --title <title>',
+    ),
+)
+
+OPERATIONS = (
+    DASHBOARDS_CARD_CREATE,
+    DASHBOARDS_CARD_DELETE,
+    DASHBOARDS_CARD_GET,
+    DASHBOARDS_CARD_LIST,
+    DASHBOARDS_CARD_PREVIEW,
+    DASHBOARDS_CARD_RUN,
+    DASHBOARDS_CARD_UPDATE,
+)

databay/operations/dashboards_dataset.py

@@ -0,0 +1,50 @@
+"""The ``dashboards-dataset`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Operation, Param, Response
+
+
+DASHBOARDS_DATASET_LIST = Operation(
+    operation_id='dashboards_dataset_list',
+    noun='dashboards-dataset',
+    verb='list',
+    method='get',
+    path='/api/insights/projects/{project_id}/datasets',
+    summary='List the datasets cards can read',
+    description='List the datasets cards can read as ``ds.<name>``, and whether each landed on the warehouse; never rows.',
+    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='warehouse_id',
+            location='query',
+            kind='string',
+            required=True,
+            description='A warehouse of the project.',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='dashboards_dataset:DatasetList',
+        shape='object',
+    ),
+    examples=(
+        'databay dashboards-dataset list --warehouse-id <warehouse_id>',
+    ),
+)
+
+OPERATIONS = (
+    DASHBOARDS_DATASET_LIST,
+)

databay/operations/dashboards_folder.py

@@ -0,0 +1,146 @@
+"""The ``dashboards-folder`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Body, Operation, Param, Response
+
+
+DASHBOARDS_FOLDER_CREATE = Operation(
+    operation_id='dashboards_folder_create',
+    noun='dashboards-folder',
+    verb='create',
+    method='post',
+    path='/api/insights/projects/{project_id}/folders',
+    summary='Add a folder',
+    description="Add a folder at the project's root, or under ``parent_id``; a sibling with the same name is 409.",
+    project='path:project_id',
+    destructive=False,
+    idempotent=True,
+    since='1.0',
+    params=(
+        Param(
+            name='project_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Project Id',
+        ),
+    ),
+    body=Body(
+        schema='FolderCreate',
+        fields=(
+            Param(
+                name='name',
+                location='body',
+                kind='string',
+                required=True,
+                description='Name',
+            ),
+            Param(
+                name='parent_id',
+                location='body',
+                kind='string',
+                required=False,
+                description="The parent folder; absent or null for the project's root.",
+                nullable=True,
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='shared:FolderOut',
+        shape='object',
+    ),
+    examples=(
+        'databay dashboards-folder create --name <name>',
+    ),
+)
+
+DASHBOARDS_FOLDER_DELETE = Operation(
+    operation_id='dashboards_folder_delete',
+    noun='dashboards-folder',
+    verb='delete',
+    method='delete',
+    path='/api/insights/folders/{folder_id}',
+    summary='Delete an empty folder',
+    description='Delete an empty folder; one holding folders or dashboards is 409 ``folder_not_empty``.',
+    project=None,
+    destructive=True,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='folder_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Folder Id',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='empty',
+    ),
+    examples=(
+        'databay dashboards-folder delete <folder_id> --yes',
+    ),
+)
+
+DASHBOARDS_FOLDER_UPDATE = Operation(
+    operation_id='dashboards_folder_update',
+    noun='dashboards-folder',
+    verb='update',
+    method='patch',
+    path='/api/insights/folders/{folder_id}',
+    summary='Rename or move a folder',
+    description='Rename a folder, or move it under another folder of its project.',
+    project=None,
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='folder_id',
+            location='path',
+            kind='string',
+            required=True,
+            description='Folder Id',
+        ),
+    ),
+    body=Body(
+        schema='FolderPatch',
+        fields=(
+            Param(
+                name='name',
+                location='body',
+                kind='string',
+                required=False,
+                description='Name',
+                nullable=True,
+            ),
+            Param(
+                name='parent_id',
+                location='body',
+                kind='string',
+                required=False,
+                description="The folder to move it to; null, sent in a body file, moves it to the project's root.",
+                nullable=True,
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='shared:FolderOut',
+        shape='object',
+    ),
+    examples=(
+        'databay dashboards-folder update <folder_id> --name <name>',
+    ),
+)
+
+OPERATIONS = (
+    DASHBOARDS_FOLDER_CREATE,
+    DASHBOARDS_FOLDER_DELETE,
+    DASHBOARDS_FOLDER_UPDATE,
+)