databay-cli 0.1.0__py3-none-any.whl

databay/operations/source.py

@@ -0,0 +1,1207 @@
+"""The ``source`` operations.
+
+Generated by python/tools/gen_client.py from contract/core.json; do not edit.
+"""
+
+from databay.operation import Body, Operation, Param, Response, Verdict
+
+
+SOURCE_CASCADE_DELETE = Operation(
+    operation_id='source_cascade_delete',
+    noun='source',
+    verb='cascade-delete',
+    method='post',
+    path='/api/configstore/source/{source_uuid}/cascade-delete',
+    summary='Connected Source Cascade Delete',
+    description='Delete a source and the pipelines that depend on it, in the background, and return 202.\n\nThe source turns DELETING and the server records which pipelines it will tear down; a\nclient cannot add targets. The source itself is deleted only once every dependency is\nresolved: pipelines created meanwhile and unfinished teardowns keep it (and its\ncredentials). Calling it again on a source already DELETING is supported for recovery.',
+    project='header',
+    destructive=True,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='source_uuid',
+            location='path',
+            kind='string',
+            required=True,
+            description='uuid of the connected source',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='source:SourceCascadeDeleteResponse',
+        shape='object',
+    ),
+    examples=(
+        'databay source cascade-delete <source_uuid> --yes',
+    ),
+)
+
+SOURCE_CREATE = Operation(
+    operation_id='source_create',
+    noun='source',
+    verb='create',
+    method='post',
+    path='/api/configstore/source',
+    summary='Connected Source Create',
+    description="Connect a source: check its credentials and setup, then store it encrypted.\n\nA connection that fails is refused unless ``allow_incomplete`` is set; a failing setup check\nsaves as ``setup_incomplete``, and the source's readiness report is the to-do list.",
+    project='header',
+    destructive=False,
+    idempotent=True,
+    since='1.0',
+    params=(),
+    body=Body(
+        schema='ConnectedSourceCreate',
+        fields=(
+            Param(
+                name='acknowledge_org_visible',
+                location='body',
+                kind='boolean',
+                required=False,
+                description='For a SaaS source created in a restricted project, allow the automatic pipelines to land in the organization-wide warehouse, whose tables every organization member can see. Without it no automatic pipeline is created.',
+            ),
+            Param(
+                name='allow_incomplete',
+                location='body',
+                kind='boolean',
+                required=False,
+                description='Save and finish later: save even when Databay cannot connect yet. The source lands in setup_incomplete instead of the request failing. Other failing setup checks save as setup_incomplete regardless.',
+            ),
+            Param(
+                name='name',
+                location='body',
+                kind='string',
+                required=True,
+                description='logical name for the connected source',
+            ),
+            Param(
+                name='publication_mode',
+                location='body',
+                kind='string',
+                required=False,
+                description="Who creates a Postgres source's publication: customer_managed (your admin) or databay_managed. Left out, the source waits for the choice where the deployment offers one.",
+                choices=(
+                    'customer_managed',
+                    'databay_managed',
+                ),
+                nullable=True,
+            ),
+        ),
+        discriminator='source_type',
+        variants=(
+            (
+                'file_upload',
+                'FileUploadConnectedConfig',
+                (
+                    Param(
+                        name='settings',
+                        location='body',
+                        kind='json',
+                        required=False,
+                    ),
+                ),
+            ),
+            (
+                'ga4',
+                'Ga4ConnectedConfig',
+                (
+                    Param(
+                        name='extra_account_ids',
+                        location='body',
+                        kind='list',
+                        required=False,
+                        description='Further properties, chosen when connecting with Google sign-in. POST /source ignores them.',
+                        item_kind='string',
+                    ),
+                    Param(
+                        name='multi_property',
+                        location='body',
+                        kind='boolean',
+                        required=False,
+                        description='Sync several properties, chosen when connecting with Google sign-in. POST /source ignores it.',
+                    ),
+                    Param(
+                        name='property_id',
+                        location='body',
+                        kind='string',
+                        required=True,
+                        description='Property Id',
+                    ),
+                    Param(
+                        name='refresh_token',
+                        location='body',
+                        kind='string',
+                        required=False,
+                        description='Refresh Token',
+                        secret=True,
+                    ),
+                    Param(
+                        name='service_account_json',
+                        location='body',
+                        kind='string',
+                        required=False,
+                        description='Service Account Json',
+                        secret=True,
+                    ),
+                    Param(
+                        name='start_date',
+                        location='body',
+                        kind='string',
+                        required=False,
+                        description='Start Date',
+                    ),
+                ),
+            ),
+            (
+                'google_ads',
+                'GoogleAdsConnectedConfig',
+                (
+                    Param(
+                        name='client_id',
+                        location='body',
+                        kind='string',
+                        required=False,
+                        description='Client Id',
+                    ),
+                    Param(
+                        name='client_secret',
+                        location='body',
+                        kind='string',
+                        required=False,
+                        description='Client Secret',
+                        secret=True,
+                    ),
+                    Param(
+                        name='customer_id',
+                        location='body',
+                        kind='string',
+                        required=True,
+                        description='Customer Id',
+                    ),
+                    Param(
+                        name='developer_token',
+                        location='body',
+                        kind='string',
+                        required=False,
+                        description='Developer Token',
+                        secret=True,
+                    ),
+                    Param(
+                        name='login_customer_id',
+                        location='body',
+                        kind='string',
+                        required=False,
+                        description='Login Customer Id',
+                        nullable=True,
+                    ),
+                    Param(
+                        name='refresh_token',
+                        location='body',
+                        kind='string',
+                        required=True,
+                        description='Refresh Token',
+                        secret=True,
+                    ),
+                    Param(
+                        name='start_date',
+                        location='body',
+                        kind='string',
+                        required=False,
+                        description='Start Date',
+                    ),
+                ),
+            ),
+            (
+                'instagram',
+                'InstagramConnectedConfig',
+                (
+                    Param(
+                        name='access_token',
+                        location='body',
+                        kind='string',
+                        required=True,
+                        description='Access Token',
+                        secret=True,
+                    ),
+                    Param(
+                        name='account_id',
+                        location='body',
+                        kind='string',
+                        required=False,
+                        description='Account Id',
+                    ),
+                    Param(
+                        name='login',
+                        location='body',
+                        kind='string',
+                        required=False,
+                        description='Login',
+                        choices=(
+                            'facebook',
+                            'instagram',
+                        ),
+                    ),
+                    Param(
+                        name='start_date',
+                        location='body',
+                        kind='string',
+                        required=False,
+                        description='Start Date',
+                    ),
+                ),
+            ),
+            (
+                'linkedin_pages',
+                'LinkedInPagesConnectedConfig',
+                (
+                    Param(
+                        name='access_token',
+                        location='body',
+                        kind='string',
+                        required=True,
+                        description='Access Token',
+                        secret=True,
+                    ),
+                    Param(
+                        name='organization_id',
+                        location='body',
+                        kind='string',
+                        required=False,
+                        description='Organization Id',
+                    ),
+                    Param(
+                        name='start_date',
+                        location='body',
+                        kind='string',
+                        required=False,
+                        description='Start Date',
+                    ),
+                ),
+            ),
+            (
+                'meta_ads',
+                'MetaAdsConnectedConfig',
+                (
+                    Param(
+                        name='access_token',
+                        location='body',
+                        kind='string',
+                        required=True,
+                        description='Access Token',
+                        secret=True,
+                    ),
+                    Param(
+                        name='account_id',
+                        location='body',
+                        kind='string',
+                        required=True,
+                        description='Account Id',
+                    ),
+                    Param(
+                        name='app_id',
+                        location='body',
+                        kind='string',
+                        required=False,
+                        description='App Id',
+                    ),
+                    Param(
+                        name='app_secret',
+                        location='body',
+                        kind='string',
+                        required=False,
+                        description='App Secret',
+                        secret=True,
+                    ),
+                    Param(
+                        name='extra_account_ids',
+                        location='body',
+                        kind='list',
+                        required=False,
+                        description='Further ad accounts, synced into the same tables. Depending on the deployment, POST /source either checks each one against the granted accounts (400 account_not_in_grant) or drops them.',
+                        item_kind='string',
+                    ),
+                    Param(
+                        name='start_date',
+                        location='body',
+                        kind='string',
+                        required=False,
+                        description='Start Date',
+                    ),
+                ),
+            ),
+            (
+                'mongodb',
+                'MongoDBConnectedConfig',
+                (
+                    Param(
+                        name='db_name',
+                        location='body',
+                        kind='string',
+                        required=True,
+                        description='Db Name',
+                    ),
+                    Param(
+                        name='host',
+                        location='body',
+                        kind='string',
+                        required=True,
+                        description='Host',
+                    ),
+                    Param(
+                        name='password',
+                        location='body',
+                        kind='string',
+                        required=False,
+                        description='Password',
+                        secret=True,
+                    ),
+                    Param(
+                        name='port',
+                        location='body',
+                        kind='integer',
+                        required=True,
+                        description='Port',
+                    ),
+                    Param(
+                        name='ssl_mode',
+                        location='body',
+                        kind='string',
+                        required=False,
+                        description='Ssl Mode',
+                    ),
+                    Param(
+                        name='username',
+                        location='body',
+                        kind='string',
+                        required=True,
+                        description='Username',
+                    ),
+                ),
+            ),
+            (
+                'mssql',
+                'MSSQLConnectedConfig',
+                (
+                    Param(
+                        name='db_name',
+                        location='body',
+                        kind='string',
+                        required=True,
+                        description='Db Name',
+                    ),
+                    Param(
+                        name='host',
+                        location='body',
+                        kind='string',
+                        required=True,
+                        description='Host',
+                    ),
+                    Param(
+                        name='password',
+                        location='body',
+                        kind='string',
+                        required=False,
+                        description='Password',
+                        secret=True,
+                    ),
+                    Param(
+                        name='port',
+                        location='body',
+                        kind='integer',
+                        required=True,
+                        description='Port',
+                    ),
+                    Param(
+                        name='ssl_mode',
+                        location='body',
+                        kind='string',
+                        required=False,
+                        description='Ssl Mode',
+                    ),
+                    Param(
+                        name='username',
+                        location='body',
+                        kind='string',
+                        required=True,
+                        description='Username',
+                    ),
+                ),
+            ),
+            (
+                'mysql',
+                'MySQLConnectedConfig',
+                (
+                    Param(
+                        name='db_name',
+                        location='body',
+                        kind='string',
+                        required=True,
+                        description='Db Name',
+                    ),
+                    Param(
+                        name='host',
+                        location='body',
+                        kind='string',
+                        required=True,
+                        description='Host',
+                    ),
+                    Param(
+                        name='password',
+                        location='body',
+                        kind='string',
+                        required=False,
+                        description='Password',
+                        secret=True,
+                    ),
+                    Param(
+                        name='port',
+                        location='body',
+                        kind='integer',
+                        required=True,
+                        description='Port',
+                    ),
+                    Param(
+                        name='ssl_mode',
+                        location='body',
+                        kind='string',
+                        required=False,
+                        description='Ssl Mode',
+                    ),
+                    Param(
+                        name='username',
+                        location='body',
+                        kind='string',
+                        required=True,
+                        description='Username',
+                    ),
+                ),
+            ),
+            (
+                'postgres',
+                'PostgresConnectedConfig',
+                (
+                    Param(
+                        name='db_name',
+                        location='body',
+                        kind='string',
+                        required=True,
+                        description='Db Name',
+                    ),
+                    Param(
+                        name='host',
+                        location='body',
+                        kind='string',
+                        required=True,
+                        description='Host',
+                    ),
+                    Param(
+                        name='password',
+                        location='body',
+                        kind='string',
+                        required=False,
+                        description='Password',
+                        secret=True,
+                    ),
+                    Param(
+                        name='port',
+                        location='body',
+                        kind='integer',
+                        required=True,
+                        description='Port',
+                    ),
+                    Param(
+                        name='ssl_mode',
+                        location='body',
+                        kind='string',
+                        required=False,
+                        description='Ssl Mode',
+                    ),
+                    Param(
+                        name='username',
+                        location='body',
+                        kind='string',
+                        required=True,
+                        description='Username',
+                    ),
+                ),
+            ),
+            (
+                'shopify',
+                'ShopifyConnectedConfig',
+                (
+                    Param(
+                        name='access_token',
+                        location='body',
+                        kind='string',
+                        required=True,
+                        description='Access Token',
+                        secret=True,
+                    ),
+                    Param(
+                        name='bulk_window_in_days',
+                        location='body',
+                        kind='integer',
+                        required=False,
+                        description='Bulk Window In Days',
+                    ),
+                    Param(
+                        name='start_date',
+                        location='body',
+                        kind='string',
+                        required=False,
+                        description='Start Date',
+                    ),
+                ),
+            ),
+        ),
+        variant_field='config',
+    ),
+    response=Response(
+        kind='json',
+        model='shared:ConnectedSourceResponse',
+        shape='object',
+    ),
+    examples=(
+        'databay source create postgres --name <name> --host <host> --port <port> --db-name <db_name> --username <username> --password-env <password_env>',
+        'databay source create mysql --name <name> --host <host> --port <port> --db-name <db_name> --username <username> --password-env <password_env>',
+        'databay source create mssql --name <name> --host <host> --port <port> --db-name <db_name> --username <username> --password-env <password_env>',
+        'databay source create mongodb --name <name> --host <host> --port <port> --db-name <db_name> --username <username> --password-env <password_env>',
+        'databay source create shopify --name <name> --access-token-env <access_token_env>',
+        'databay source create meta_ads --name <name> --access-token-env <access_token_env> --account-id <account_id>',
+        'databay source create google_ads --name <name> --refresh-token-env <refresh_token_env> --customer-id <customer_id>',
+        'databay source create ga4 --name <name> --property-id <property_id> --service-account-json-env <service_account_json_env>',
+        'databay source create instagram --name <name> --access-token-env <access_token_env>',
+        'databay source create linkedin_pages --name <name> --access-token-env <access_token_env>',
+    ),
+    columns=(
+        'uuid',
+        'name',
+        'source_type',
+        'status',
+    ),
+)
+
+SOURCE_DELETE = Operation(
+    operation_id='source_delete',
+    noun='source',
+    verb='delete',
+    method='delete',
+    path='/api/configstore/source/{source_uuid}',
+    summary='Connected Source Delete',
+    description="Delete a source that nothing depends on; never cascades.\n\nIn an org that scopes resources only its home project's editors may delete it\n(403 ``not_home`` for a shared source). 204 when the source is unused, 409 (with the\ndependent list) when it is not; ``POST /source/{uuid}/cascade-delete`` tears down\ndependents. The source is resolved (404) before the dependency check, so a 409 never\nleaks another tenant's source. ``DELETING`` is set before the check so a concurrent\npipe create sees it; a failed lookup restores ``CONNECTED`` and answers 502.\nRe-issuing DELETE on a source stranded in ``DELETING`` re-checks and finalizes it.",
+    project='header',
+    destructive=True,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='source_uuid',
+            location='path',
+            kind='string',
+            required=True,
+            description='uuid of the connected source',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='empty',
+    ),
+    examples=(
+        'databay source delete <source_uuid> --yes',
+    ),
+)
+
+SOURCE_FORCE_DELETE = Operation(
+    operation_id='source_force_delete',
+    noun='source',
+    verb='force-delete',
+    method='post',
+    path='/api/configstore/source/{source_uuid}/force-delete',
+    summary='Connected Source Force Delete',
+    description="Break-glass: destroy a source's credentials now, dependency check skipped. Superadmin only.\n\nFor a leaked credential when the dependency check that every other delete path fails\nclosed on cannot be answered. The source and its stored credentials are deleted at once;\nits pipes are torn down later. Consequence: teardown can no longer read the credentials, so\nthe replication slot survives in the customer's database until dropped by hand; the\nresponse body carries that remediation. The dependent-pipe count is best-effort and does\nnot block; ``pipes_at_deletion: null`` means it was unknown, not zero.",
+    project=None,
+    destructive=True,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='source_uuid',
+            location='path',
+            kind='string',
+            required=True,
+            description='uuid of the connected source',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='source:SourceForceDeleteResponse',
+        shape='object',
+    ),
+    examples=(
+        'databay source force-delete <source_uuid> --yes',
+    ),
+)
+
+SOURCE_GET = Operation(
+    operation_id='source_get',
+    noun='source',
+    verb='get',
+    method='get',
+    path='/api/configstore/source/{source_uuid}',
+    summary='Connected Source Get',
+    description="Detail view for one source: the allowlisted connection params + timestamps.\n\nOnly the source type's allowlisted, non-secret connection params are returned.\n``secrets_set`` reports only *whether* each credential is populated, never its value.",
+    project='header',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='source_uuid',
+            location='path',
+            kind='string',
+            required=True,
+            description='uuid of the connected source',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='source:ConnectedSourceDetailResponse',
+        shape='object',
+    ),
+    examples=(
+        'databay source get <source_uuid>',
+    ),
+)
+
+SOURCE_LIST = Operation(
+    operation_id='source_list',
+    noun='source',
+    verb='list',
+    method='get',
+    path='/api/configstore/source',
+    summary='Connected Source List',
+    description='List the org\'s sources; in an org that scopes resources, those usable in the active project.\n\nHome and shared sources of ``X-Databay-Project-ID`` (General with a\n``Deprecation`` header when missing) plus ones pending a home there; quarantined ones\n("Needs a home") for org admins only.',
+    project='header',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(),
+    body=None,
+    response=Response(
+        kind='json',
+        model='source:SourceListResponse',
+        shape='array',
+    ),
+    examples=(
+        'databay source list',
+        'databay source list --project <project_id>',
+    ),
+    columns=(
+        'uuid',
+        'name',
+        'source_type',
+        'status',
+    ),
+)
+
+SOURCE_PRECHECK = Operation(
+    operation_id='source_precheck',
+    noun='source',
+    verb='precheck',
+    method='post',
+    path='/api/configstore/source/precheck',
+    summary='Connected Source Precheck',
+    description='Check an unsaved DB source against everything its type needs.\n\nEvery requirement comes back pass / fail / warn / unknown with the exact fix, rendered\nfor this user and database. Persists nothing and gates nothing: a failing report is a\n200, because "this is what to fix" is the answer, not an error. 422 ``host_not_allowed``,\n429 ``precheck_rate_limited`` and 503 ``precheck_busy`` / ``precheck_limiter_unavailable``\n(with ``Retry-After``) are the refusals.',
+    project=None,
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='publication_mode',
+            location='query',
+            kind='string',
+            required=False,
+            description='the publication path to check a Postgres source for',
+            choices=(
+                'customer_managed',
+                'databay_managed',
+            ),
+            nullable=True,
+        ),
+    ),
+    body=Body(
+        schema=None,
+        discriminator='source_type',
+        variants=(
+            (
+                'mongodb',
+                'MongoDBConnectedConfig',
+                (
+                    Param(
+                        name='db_name',
+                        location='body',
+                        kind='string',
+                        required=True,
+                        description='Db Name',
+                    ),
+                    Param(
+                        name='host',
+                        location='body',
+                        kind='string',
+                        required=True,
+                        description='Host',
+                    ),
+                    Param(
+                        name='password',
+                        location='body',
+                        kind='string',
+                        required=False,
+                        description='Password',
+                        secret=True,
+                    ),
+                    Param(
+                        name='port',
+                        location='body',
+                        kind='integer',
+                        required=True,
+                        description='Port',
+                    ),
+                    Param(
+                        name='ssl_mode',
+                        location='body',
+                        kind='string',
+                        required=False,
+                        description='Ssl Mode',
+                    ),
+                    Param(
+                        name='username',
+                        location='body',
+                        kind='string',
+                        required=True,
+                        description='Username',
+                    ),
+                ),
+            ),
+            (
+                'mssql',
+                'MSSQLConnectedConfig',
+                (
+                    Param(
+                        name='db_name',
+                        location='body',
+                        kind='string',
+                        required=True,
+                        description='Db Name',
+                    ),
+                    Param(
+                        name='host',
+                        location='body',
+                        kind='string',
+                        required=True,
+                        description='Host',
+                    ),
+                    Param(
+                        name='password',
+                        location='body',
+                        kind='string',
+                        required=False,
+                        description='Password',
+                        secret=True,
+                    ),
+                    Param(
+                        name='port',
+                        location='body',
+                        kind='integer',
+                        required=True,
+                        description='Port',
+                    ),
+                    Param(
+                        name='ssl_mode',
+                        location='body',
+                        kind='string',
+                        required=False,
+                        description='Ssl Mode',
+                    ),
+                    Param(
+                        name='username',
+                        location='body',
+                        kind='string',
+                        required=True,
+                        description='Username',
+                    ),
+                ),
+            ),
+            (
+                'mysql',
+                'MySQLConnectedConfig',
+                (
+                    Param(
+                        name='db_name',
+                        location='body',
+                        kind='string',
+                        required=True,
+                        description='Db Name',
+                    ),
+                    Param(
+                        name='host',
+                        location='body',
+                        kind='string',
+                        required=True,
+                        description='Host',
+                    ),
+                    Param(
+                        name='password',
+                        location='body',
+                        kind='string',
+                        required=False,
+                        description='Password',
+                        secret=True,
+                    ),
+                    Param(
+                        name='port',
+                        location='body',
+                        kind='integer',
+                        required=True,
+                        description='Port',
+                    ),
+                    Param(
+                        name='ssl_mode',
+                        location='body',
+                        kind='string',
+                        required=False,
+                        description='Ssl Mode',
+                    ),
+                    Param(
+                        name='username',
+                        location='body',
+                        kind='string',
+                        required=True,
+                        description='Username',
+                    ),
+                ),
+            ),
+            (
+                'postgres',
+                'PostgresConnectedConfig',
+                (
+                    Param(
+                        name='db_name',
+                        location='body',
+                        kind='string',
+                        required=True,
+                        description='Db Name',
+                    ),
+                    Param(
+                        name='host',
+                        location='body',
+                        kind='string',
+                        required=True,
+                        description='Host',
+                    ),
+                    Param(
+                        name='password',
+                        location='body',
+                        kind='string',
+                        required=False,
+                        description='Password',
+                        secret=True,
+                    ),
+                    Param(
+                        name='port',
+                        location='body',
+                        kind='integer',
+                        required=True,
+                        description='Port',
+                    ),
+                    Param(
+                        name='ssl_mode',
+                        location='body',
+                        kind='string',
+                        required=False,
+                        description='Ssl Mode',
+                    ),
+                    Param(
+                        name='username',
+                        location='body',
+                        kind='string',
+                        required=True,
+                        description='Username',
+                    ),
+                ),
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='source:PrecheckReportView',
+        shape='object',
+    ),
+    examples=(
+        'databay source precheck postgres --host db.example.com --port 5432 --db-name shop --username databay --password-env PGPASSWORD',
+    ),
+    verdict=Verdict(
+        field='/ready',
+        ok=(
+            'true',
+        ),
+        not_ready=(
+            'false',
+        ),
+    ),
+)
+
+SOURCE_RECHECK = Operation(
+    operation_id='source_recheck',
+    noun='source',
+    verb='recheck',
+    method='post',
+    path='/api/configstore/source/{source_uuid}/precheck',
+    summary='Connected Source Recheck',
+    description="Re-check a saved source with its stored credentials, and store the verdict.\n\nThe source's status follows the report (``CONNECTED`` / ``SETUP_INCOMPLETE`` /\n``NEEDS_ATTENTION``) unless a lifecycle status (deleting, updating, needs_reauth, ...)\nholds it; ``source_status`` in the response is what the row says afterwards.",
+    project='header',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='source_uuid',
+            location='path',
+            kind='string',
+            required=True,
+            description='uuid of the connected source',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='json',
+        model='source:PrecheckReportView',
+        shape='object',
+    ),
+    examples=(
+        'databay source recheck <source_uuid>',
+    ),
+    verdict=Verdict(
+        field='/ready',
+        ok=(
+            'true',
+        ),
+        not_ready=(
+            'false',
+        ),
+    ),
+)
+
+SOURCE_RENEW_CREDENTIALS = Operation(
+    operation_id='source_renew_credentials',
+    noun='source',
+    verb='renew-credentials',
+    method='post',
+    path='/api/configstore/source/{source_uuid}/credentials',
+    summary='Renew Source Credentials',
+    description="Replace a manual ad-platform source's credentials in place and sync it now.\n\n**404** unknown in this org. **422** a type renewed through its own flow (Shopify,\ndatabases), a key this type does not accept, a blank value, or a merged config that\ndoes not validate. **409** a source that is being deleted / updated. **400** the new\nMeta token does not reach the source's ad account.",
+    project='header',
+    destructive=True,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='source_uuid',
+            location='path',
+            kind='string',
+            required=True,
+            description='uuid of the connected source',
+        ),
+    ),
+    body=Body(
+        schema='SourceCredentialsRenew',
+        fields=(
+            Param(
+                name='credentials',
+                location='body',
+                kind='json',
+                required=True,
+                description="credential fields to replace, e.g. {'access_token': '...'}",
+                secret=True,
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='shared:ConnectedSourceResponse',
+        shape='object',
+    ),
+    examples=(
+        'databay source renew-credentials <source_uuid> --credentials-stdin --yes',
+    ),
+)
+
+SOURCE_SETUP_SCRIPT = Operation(
+    operation_id='source_setup_script',
+    noun='source',
+    verb='setup-script',
+    method='get',
+    path='/api/configstore/source/{source_uuid}/setup.sql',
+    summary='Connected Source Fix Script',
+    description="Download the fixes for what this source's latest check found, for its detected provider.",
+    project='header',
+    destructive=False,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='source_uuid',
+            location='path',
+            kind='string',
+            required=True,
+            description='uuid of the connected source',
+        ),
+    ),
+    body=None,
+    response=Response(
+        kind='text',
+    ),
+    examples=(
+        'databay source setup-script <source_uuid>',
+    ),
+)
+
+SOURCE_UPDATE = Operation(
+    operation_id='source_update',
+    noun='source',
+    verb='update',
+    method='patch',
+    path='/api/configstore/source/{source_uuid}',
+    summary='Connected Source Patch',
+    description="Update a source's name and/or connection credentials.\n\n**200** when no live pipes hold the old credentials, or only ``name`` changed; **202 +\nstatus=UPDATING** when live pipes need the new credentials pushed to them.\n\n``source_type`` / ``db_name`` are rejected on change, not on presence: create a new\nsource instead. OAuth sources accept ``name`` only. Credentials are re-verified against\nthe merged config with the check ``POST /source`` runs. A ``host``/``port`` change fails\nlive streaming pipes with a terminal error instead of resuming from the old server's\nposition.",
+    project='header',
+    destructive=True,
+    idempotent=False,
+    since='1.0',
+    params=(
+        Param(
+            name='source_uuid',
+            location='path',
+            kind='string',
+            required=True,
+            description='uuid of the connected source',
+        ),
+    ),
+    body=Body(
+        schema='ConnectedSourceUpdate',
+        fields=(
+            Param(
+                name='allow_incomplete',
+                location='body',
+                kind='boolean',
+                required=False,
+                description='Allow Incomplete',
+            ),
+            Param(
+                name='db_name',
+                location='body',
+                kind='string',
+                required=False,
+                description='Db Name',
+                nullable=True,
+            ),
+            Param(
+                name='host',
+                location='body',
+                kind='string',
+                required=False,
+                description='Host',
+                nullable=True,
+            ),
+            Param(
+                name='name',
+                location='body',
+                kind='string',
+                required=False,
+                description='Name',
+                nullable=True,
+            ),
+            Param(
+                name='password',
+                location='body',
+                kind='string',
+                required=False,
+                description='Password',
+                secret=True,
+                nullable=True,
+            ),
+            Param(
+                name='port',
+                location='body',
+                kind='integer',
+                required=False,
+                description='Port',
+                nullable=True,
+            ),
+            Param(
+                name='source_type',
+                location='body',
+                kind='string',
+                required=False,
+                choices=(
+                    'postgres',
+                    'mysql',
+                    'mssql',
+                    'mongodb',
+                    'shopify',
+                    'meta_ads',
+                    'google_ads',
+                    'ga4',
+                    'instagram',
+                    'linkedin_pages',
+                    'x',
+                    'tiktok_ads',
+                    'file_upload',
+                ),
+                nullable=True,
+            ),
+            Param(
+                name='ssl_mode',
+                location='body',
+                kind='string',
+                required=False,
+                description='Ssl Mode',
+                nullable=True,
+            ),
+            Param(
+                name='username',
+                location='body',
+                kind='string',
+                required=False,
+                description='Username',
+                nullable=True,
+            ),
+        ),
+    ),
+    response=Response(
+        kind='json',
+        model='shared:ConnectedSourceResponse',
+        shape='object',
+    ),
+    examples=(
+        'databay source update <source_uuid> --name "Orders replica" --yes',
+        'databay source update <source_uuid> --password-env PGPASSWORD --yes',
+    ),
+)
+
+OPERATIONS = (
+    SOURCE_CASCADE_DELETE,
+    SOURCE_CREATE,
+    SOURCE_DELETE,
+    SOURCE_FORCE_DELETE,
+    SOURCE_GET,
+    SOURCE_LIST,
+    SOURCE_PRECHECK,
+    SOURCE_RECHECK,
+    SOURCE_RENEW_CREDENTIALS,
+    SOURCE_SETUP_SCRIPT,
+    SOURCE_UPDATE,
+)