databay-cli 0.1.0__py3-none-any.whl

databay/operations/me.py

@@ -0,0 +1,57 @@
+"""The ``me`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Operation, Param, Response
+
+
+ME_GET = Operation(
+    operation_id='me_get',
+    noun='me',
+    verb='get',
+    method='get',
+    path='/api/auth/me',
+    summary='Me',
+    description='',
+    project=None,
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='refresh_plan',
+            location='query',
+            kind='boolean',
+            required=False,
+            description='Bypass the plan cache and re-read the plan',
+        ),
+        Param(
+            name='include_usage',
+            location='query',
+            kind='boolean',
+            required=False,
+            description='Also return billing usage and the plan state',
+        ),
+        Param(
+            name='include_orgs',
+            location='query',
+            kind='boolean',
+            required=False,
+            description='Also return active_org and needs_org_choice, read from the identity provider',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='me:User',
+        shape='object',
+    ),
+    examples=(
+        'databay me get',
+    ),
+)
+
+OPERATIONS = (
+    ME_GET,
+)

databay/operations/meta_ads_source.py

@@ -0,0 +1,40 @@
+"""The ``meta-ads-source`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Operation, Response
+
+
+META_ADS_SOURCE_LIST = Operation(
+    operation_id='meta_ads_source_list',
+    noun='meta-ads-source',
+    verb='list',
+    method='get',
+    path='/api/configstore/meta-ads/accounts-connected',
+    summary='List Connected',
+    description="List the org's connected Meta Ads sources (token never serialized).",
+    project='header',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(),
+    body=None,
+    response=Response(
+        kind='json',
+        model='meta_ads_source:MetaAdsSourceListResponse',
+        shape='array',
+    ),
+    examples=(
+        'databay meta-ads-source list',
+    ),
+    columns=(
+        'uuid',
+        'external_ref',
+        'status',
+    ),
+)
+
+OPERATIONS = (
+    META_ADS_SOURCE_LIST,
+)

databay/operations/metric_models.py

@@ -0,0 +1,612 @@
+"""The ``metric-models`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Body, Operation, Param, Response
+
+
+METRIC_MODELS_CHANGES = Operation(
+    operation_id='metric_models_changes',
+    noun='metric-models',
+    verb='changes',
+    method='get',
+    path='/api/semantic/projects/{project_id}/models/changes',
+    summary='Get Changes',
+    description='Compare the draft metric model with the published one: the metrics and breakdowns a publish would change.',
+    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='metric_models:ModelChangesOut',
+        shape='object',
+    ),
+    examples=(
+        'databay metric-models changes',
+    ),
+)
+
+METRIC_MODELS_IMPORT_DBT = Operation(
+    operation_id='metric_models_import_dbt',
+    noun='metric-models',
+    verb='import-dbt',
+    method='post',
+    path='/api/semantic/projects/{project_id}/models/import-dbt',
+    summary='Post Import Dbt',
+    description="Add cubes for the project's built dbt models to the draft metric model; it is never published.",
+    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='DbtImportRequest',
+        fields=(
+            Param(
+                name='dry_run',
+                location='body',
+                kind='boolean',
+                required=False,
+                description='Dry Run',
+            ),
+            Param(
+                name='relations',
+                location='body',
+                kind='list',
+                required=False,
+                description='Relations',
+                item_kind='string',
+                nullable=True,
+            ),
+            Param(
+                name='replace_draft',
+                location='body',
+                kind='boolean',
+                required=False,
+                description='Replace Draft',
+            ),
+            Param(
+                name='revision',
+                location='body',
+                kind='integer',
+                required=False,
+                description='Revision',
+                nullable=True,
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='metric_models:DbtImportOut',
+        shape='object',
+    ),
+    examples=(
+        'databay metric-models import-dbt --dry-run',
+    ),
+)
+
+METRIC_MODELS_LIST = Operation(
+    operation_id='metric_models_list',
+    noun='metric-models',
+    verb='list',
+    method='get',
+    path='/api/semantic/projects/{project_id}/models/versions',
+    summary='Get Versions',
+    description="List every version of the project's metric model, newest 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',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='metric_models:ModelVersionListOut',
+        shape='object',
+    ),
+    examples=(
+        'databay metric-models list',
+    ),
+)
+
+METRIC_MODELS_METRIC_ADD = Operation(
+    operation_id='metric_models_metric_add',
+    noun='metric-models',
+    verb='metric-add',
+    method='post',
+    path='/api/semantic/projects/{project_id}/models/draft/metrics',
+    summary='Post Metric',
+    description='Add one metric to the draft metric model.',
+    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='MetricWrite',
+        fields=(
+            Param(
+                name='breakdowns',
+                location='body',
+                kind='json',
+                required=False,
+                description='Breakdowns',
+                nullable=True,
+            ),
+            Param(
+                name='metric',
+                location='body',
+                kind='json',
+                required=True,
+            ),
+            Param(
+                name='revision',
+                location='body',
+                kind='integer',
+                required=True,
+                description='Revision',
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='metric_models:MetricEditOut',
+        shape='object',
+    ),
+    examples=(
+        'databay metric-models metric-add --file metric.json',
+    ),
+)
+
+METRIC_MODELS_METRIC_LIST = Operation(
+    operation_id='metric_models_metric_list',
+    noun='metric-models',
+    verb='metric-list',
+    method='get',
+    path='/api/semantic/projects/{project_id}/models/draft/metrics',
+    summary='Get Form',
+    description='List the tables and metrics of the draft (or published) metric model, and which the metric form can edit.',
+    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='metric_models:MetricFormOut',
+        shape='object',
+    ),
+    examples=(
+        'databay metric-models metric-list',
+    ),
+)
+
+METRIC_MODELS_METRIC_REMOVE = Operation(
+    operation_id='metric_models_metric_remove',
+    noun='metric-models',
+    verb='metric-remove',
+    method='delete',
+    path='/api/semantic/projects/{project_id}/models/draft/metrics/{metric_name}',
+    summary='Delete Metric',
+    description='Remove one metric from the draft metric model.',
+    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='metric_name',
+            location='path',
+            kind='string',
+            required=True,
+            description='Metric Name',
+        ),
+        Param(
+            name='revision',
+            location='query',
+            kind='integer',
+            required=True,
+            description='The revision the form read.',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='metric_models:MetricEditOut',
+        shape='object',
+    ),
+    examples=(
+        'databay metric-models metric-remove <project_id> order_total --revision 5 --yes',
+    ),
+)
+
+METRIC_MODELS_METRIC_UPDATE = Operation(
+    operation_id='metric_models_metric_update',
+    noun='metric-models',
+    verb='metric-update',
+    method='put',
+    path='/api/semantic/projects/{project_id}/models/draft/metrics/{metric_name}',
+    summary='Put Metric',
+    description='Replace one metric of the draft metric model.',
+    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='metric_name',
+            location='path',
+            kind='string',
+            required=True,
+            description='Metric Name',
+        ),
+    ),
+    body=Body(
+        schema='MetricWrite',
+        fields=(
+            Param(
+                name='breakdowns',
+                location='body',
+                kind='json',
+                required=False,
+                description='Breakdowns',
+                nullable=True,
+            ),
+            Param(
+                name='metric',
+                location='body',
+                kind='json',
+                required=True,
+            ),
+            Param(
+                name='revision',
+                location='body',
+                kind='integer',
+                required=True,
+                description='Revision',
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='metric_models:MetricEditOut',
+        shape='object',
+    ),
+    examples=(
+        'databay metric-models metric-update <project_id> order_total --file metric.json',
+    ),
+)
+
+METRIC_MODELS_PUBLISH = Operation(
+    operation_id='metric_models_publish',
+    noun='metric-models',
+    verb='publish',
+    method='post',
+    path='/api/semantic/projects/{project_id}/models/publish',
+    summary='Post Publish',
+    description="Publish the project's draft metric model; the published version it replaces is kept as superseded.",
+    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='PublishRequest',
+        fields=(
+            Param(
+                name='revision',
+                location='body',
+                kind='integer',
+                required=False,
+                description='Revision',
+                nullable=True,
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='metric_models:ModelVersionOut',
+        shape='object',
+    ),
+    examples=(
+        'databay metric-models publish',
+    ),
+)
+
+METRIC_MODELS_PUSH = Operation(
+    operation_id='metric_models_push',
+    noun='metric-models',
+    verb='push',
+    method='put',
+    path='/api/semantic/projects/{project_id}/models/draft',
+    summary='Put Draft',
+    description="Validate a metric model and store it as the project's draft, replacing the draft there is.",
+    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='ModelPush',
+        fields=(
+            Param(
+                name='revision',
+                location='body',
+                kind='integer',
+                required=False,
+                description='Revision',
+                nullable=True,
+            ),
+            Param(
+                name='yaml',
+                location='body',
+                kind='string',
+                required=True,
+                description='Yaml',
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='metric_models:ModelVersionOut',
+        shape='object',
+    ),
+    examples=(
+        'databay metric-models push --yaml "$(cat metrics.yml)"',
+    ),
+)
+
+METRIC_MODELS_SET_BREAKDOWNS = Operation(
+    operation_id='metric_models_set_breakdowns',
+    noun='metric-models',
+    verb='set-breakdowns',
+    method='put',
+    path='/api/semantic/projects/{project_id}/models/draft/tables/{table}/breakdowns',
+    summary='Put Breakdowns',
+    description="Set the columns one table's metrics break down by; the answer lists the metrics this affects.",
+    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='table',
+            location='path',
+            kind='string',
+            required=True,
+            description='Table',
+        ),
+    ),
+    body=Body(
+        schema='BreakdownsWrite',
+        fields=(
+            Param(
+                name='breakdowns',
+                location='body',
+                kind='json',
+                required=True,
+                description='Breakdowns',
+            ),
+            Param(
+                name='revision',
+                location='body',
+                kind='integer',
+                required=True,
+                description='Revision',
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='metric_models:MetricEditOut',
+        shape='object',
+    ),
+    examples=(
+        'databay metric-models set-breakdowns <project_id> orders --file breakdowns.json',
+    ),
+)
+
+METRIC_MODELS_SHOW_DRAFT = Operation(
+    operation_id='metric_models_show_draft',
+    noun='metric-models',
+    verb='show-draft',
+    method='get',
+    path='/api/semantic/projects/{project_id}/models/draft',
+    summary='Get Draft',
+    description="Show the project's draft metric model.",
+    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='metric_models:ModelVersionOut',
+        shape='object',
+    ),
+    examples=(
+        'databay metric-models show-draft',
+    ),
+)
+
+METRIC_MODELS_SHOW_PUBLISHED = Operation(
+    operation_id='metric_models_show_published',
+    noun='metric-models',
+    verb='show-published',
+    method='get',
+    path='/api/semantic/projects/{project_id}/models/published',
+    summary='Get Published',
+    description="Show the project's published metric model.",
+    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='metric_models:ModelVersionOut',
+        shape='object',
+    ),
+    examples=(
+        'databay metric-models show-published',
+    ),
+)
+
+METRIC_MODELS_VALIDATE = Operation(
+    operation_id='metric_models_validate',
+    noun='metric-models',
+    verb='validate',
+    method='post',
+    path='/api/semantic/projects/{project_id}/models/validate',
+    summary='Post Validate',
+    description='Validate a metric model without storing it.',
+    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='ModelUpload',
+        fields=(
+            Param(
+                name='yaml',
+                location='body',
+                kind='string',
+                required=True,
+                description='Yaml',
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='metric_models:ModelValidationOut',
+        shape='object',
+    ),
+    examples=(
+        'databay metric-models validate --yaml "$(cat metrics.yml)"',
+    ),
+)
+
+OPERATIONS = (
+    METRIC_MODELS_CHANGES,
+    METRIC_MODELS_IMPORT_DBT,
+    METRIC_MODELS_LIST,
+    METRIC_MODELS_METRIC_ADD,
+    METRIC_MODELS_METRIC_LIST,
+    METRIC_MODELS_METRIC_REMOVE,
+    METRIC_MODELS_METRIC_UPDATE,
+    METRIC_MODELS_PUBLISH,
+    METRIC_MODELS_PUSH,
+    METRIC_MODELS_SET_BREAKDOWNS,
+    METRIC_MODELS_SHOW_DRAFT,
+    METRIC_MODELS_SHOW_PUBLISHED,
+    METRIC_MODELS_VALIDATE,
+)