@scaffold-llc/sdk 0.0.0-stage → 0.2.0

package/dist/generated/methods.js

@@ -0,0 +1,321 @@
+/** Each public command's route, by resource and action. */
+export const COMMANDS = {
+    account: {
+        get: { method: "GET", path: "/v1/account" },
+        avatar_set: { method: "POST", path: "/v1/account/avatar", idempotent: true },
+    },
+    image: {
+        get: { method: "GET", path: "/v1/images/{image_id}" },
+    },
+    workspace: {
+        create: { method: "POST", path: "/v1/workspaces", idempotent: true },
+        rename: { method: "POST", path: "/v1/workspaces/{workspace_id}/rename", idempotent: true },
+        logo_set: { method: "POST", path: "/v1/workspaces/{workspace_id}/logo", idempotent: true },
+        delete: { method: "DELETE", path: "/v1/workspaces/{workspace_id}", idempotent: true },
+        restore: { method: "POST", path: "/v1/workspaces/{workspace_id}/restore", idempotent: true },
+        export_start: { method: "POST", path: "/v1/workspaces/{workspace_id}/exports", idempotent: true },
+        export_get: { method: "GET", path: "/v1/workspaces/{workspace_id}/export" },
+        export_download: { method: "GET", path: "/v1/workspaces/{workspace_id}/exports/{export_id}/download" },
+        list: { method: "GET", path: "/v1/workspaces" },
+        member_invite: { method: "POST", path: "/v1/workspaces/{workspace_id}/invites", idempotent: true },
+        invite_revoke: { method: "DELETE", path: "/v1/invites/{invite_id}", idempotent: true },
+        invite_restore: { method: "POST", path: "/v1/invites/{invite_id}/restore", idempotent: true },
+        invite_dismiss: { method: "POST", path: "/v1/invites/{invite_id}/dismiss", idempotent: true },
+        invite_list_mine: { method: "GET", path: "/v1/invites/mine" },
+        invite_accept: { method: "POST", path: "/v1/invites/accept", idempotent: true },
+        invite_join: { method: "POST", path: "/v1/invites/{invite_id}/join", idempotent: true },
+        invite_decline: { method: "POST", path: "/v1/invites/decline", idempotent: true },
+        invite_get: { method: "POST", path: "/v1/invites/preview" },
+        member_list: { method: "GET", path: "/v1/workspaces/{workspace_id}/members" },
+        ownership_transfer: { method: "POST", path: "/v1/workspaces/{workspace_id}/transfer-ownership", idempotent: true },
+        member_remove: { method: "DELETE", path: "/v1/workspaces/{workspace_id}/members/{person_id}", idempotent: true },
+    },
+    project: {
+        create: { method: "POST", path: "/v1/projects", idempotent: true },
+        list: { method: "GET", path: "/v1/projects", list: true },
+        get: { method: "GET", path: "/v1/projects/{project_id}" },
+        metrics_get: { method: "GET", path: "/v1/projects/{project_id}/metrics" },
+        address_check: { method: "GET", path: "/v1/projects/address-check" },
+        delete: { method: "DELETE", path: "/v1/projects/{project_id}", idempotent: true },
+        restore: { method: "POST", path: "/v1/projects/{project_id}/restore", idempotent: true },
+        erase: { method: "POST", path: "/v1/projects/{project_id}/erase", idempotent: true },
+        health_get: { method: "GET", path: "/v1/projects/{project_id}/health" },
+        status_get: { method: "GET", path: "/v1/projects/{project_id}/status" },
+        limits_get: { method: "GET", path: "/v1/projects/{project_id}/limits" },
+        alert_get: { method: "GET", path: "/v1/projects/{project_id}/alerts" },
+        alert_set: { method: "PUT", path: "/v1/projects/{project_id}/alerts", idempotent: true },
+        maintenance_set: { method: "PUT", path: "/v1/projects/{project_id}/maintenance", idempotent: true },
+        move: { method: "POST", path: "/v1/projects/{project_id}/move", idempotent: true },
+        claim_link_create: { method: "POST", path: "/v1/projects/{project_id}/claim-link" },
+        claim_link_cancel: { method: "DELETE", path: "/v1/projects/{project_id}/claim-link", idempotent: true },
+    },
+    env: {
+        set: { method: "POST", path: "/v1/projects/{project_id}/env" },
+        list: { method: "GET", path: "/v1/projects/{project_id}/env" },
+        delete: { method: "DELETE", path: "/v1/projects/{project_id}/env/{name}", idempotent: true },
+        restore: { method: "POST", path: "/v1/projects/{project_id}/env/{name}/restore", idempotent: true },
+    },
+    source: {
+        upload: { method: "PUT", path: "/v1/projects/{project_id}/sources", zip: "archive", idempotent: true },
+        delete: { method: "DELETE", path: "/v1/projects/{project_id}/sources/{sha256}", idempotent: true },
+        list: { method: "GET", path: "/v1/projects/{project_id}/sources" },
+        file_list: { method: "GET", path: "/v1/projects/{project_id}/sources/{sha256}/files" },
+        file_get: { method: "GET", path: "/v1/projects/{project_id}/sources/{sha256}/file" },
+    },
+    github: {
+        repository_list: { method: "GET", path: "/v1/workspaces/{workspace_id}/github/repositories" },
+        connect: { method: "POST", path: "/v1/projects/{project_id}/github", idempotent: true },
+        get: { method: "GET", path: "/v1/projects/{project_id}/github" },
+        branch_set: { method: "PATCH", path: "/v1/projects/{project_id}/github", idempotent: true },
+        release_command_set: { method: "PUT", path: "/v1/projects/{project_id}/github/release_command", idempotent: true },
+        disconnect: { method: "DELETE", path: "/v1/projects/{project_id}/github", idempotent: true },
+        deploy: { method: "POST", path: "/v1/projects/{project_id}/github/deploy", idempotent: true },
+    },
+    app_db: {
+        get: { method: "GET", path: "/v1/projects/{project_id}/database" },
+        backup_list: { method: "GET", path: "/v1/projects/{project_id}/database/backups" },
+        backup_restore: { method: "POST", path: "/v1/projects/{project_id}/database/backups/{backup_id}/restore", idempotent: true },
+        dump_create: { method: "POST", path: "/v1/projects/{project_id}/database/dumps", idempotent: true },
+        dump_download: { method: "GET", path: "/v1/projects/{project_id}/database/dumps/{dump_id}" },
+    },
+    cron: {
+        create: { method: "POST", path: "/v1/projects/{project_id}/cron-jobs", idempotent: true },
+        list: { method: "GET", path: "/v1/projects/{project_id}/cron-jobs" },
+        update: { method: "PATCH", path: "/v1/cron-jobs/{cron_job_id}", idempotent: true },
+        delete: { method: "DELETE", path: "/v1/cron-jobs/{cron_job_id}", idempotent: true },
+    },
+    test_run: {
+        start: { method: "POST", path: "/v1/projects/{project_id}/test-runs", idempotent: true },
+        report: { method: "POST", path: "/v1/test-runs/{test_run_id}/results", idempotent: true },
+        fix: { method: "PUT", path: "/v1/test-runs/{test_run_id}/fix", idempotent: true },
+        rerun: { method: "POST", path: "/v1/test-runs/{test_run_id}/reruns", idempotent: true },
+        list: { method: "GET", path: "/v1/projects/{project_id}/test-runs" },
+        get: { method: "GET", path: "/v1/test-runs/{test_run_id}" },
+        delete: { method: "DELETE", path: "/v1/test-runs/{test_run_id}", idempotent: true },
+    },
+    storage: {
+        list: { method: "GET", path: "/v1/projects/{project_id}/storage", list: true },
+        usage_get: { method: "GET", path: "/v1/workspaces/{workspace_id}/storage" },
+        upload_sign: { method: "POST", path: "/v1/projects/{project_id}/storage/upload-url", idempotent: true },
+        download_sign: { method: "GET", path: "/v1/projects/{project_id}/storage/download-url" },
+        delete: { method: "DELETE", path: "/v1/projects/{project_id}/storage", idempotent: true },
+    },
+    token: {
+        create: { method: "POST", path: "/v1/tokens", idempotent: true },
+        list: { method: "GET", path: "/v1/tokens" },
+        revoke: { method: "DELETE", path: "/v1/tokens/{token_id}", idempotent: true },
+    },
+    oauth: {
+        grant_list: { method: "GET", path: "/v1/oauth/grants" },
+        grant_revoke: { method: "DELETE", path: "/v1/oauth/grants/{grant_id}", idempotent: true },
+    },
+    credit: {
+        balance_get: { method: "GET", path: "/v1/workspaces/{workspace_id}/credits" },
+        ledger_list: { method: "GET", path: "/v1/workspaces/{workspace_id}/credits/ledger" },
+        cap_set: { method: "POST", path: "/v1/workspaces/{workspace_id}/credits/cap", idempotent: true },
+        pack_list: { method: "GET", path: "/v1/credits/packs" },
+        top_up_start: { method: "POST", path: "/v1/workspaces/{workspace_id}/credits/top-ups", idempotent: true },
+        top_up_get: { method: "GET", path: "/v1/workspaces/{workspace_id}/credits/top-ups/{top_up_id}" },
+        top_up_request: { method: "POST", path: "/v1/workspaces/{workspace_id}/credits/top-up-requests", idempotent: true },
+        top_up_withdraw: { method: "POST", path: "/v1/workspaces/{workspace_id}/credits/top-ups/{top_up_id}/withdraw", idempotent: true },
+    },
+    billing: {
+        get: { method: "GET", path: "/v1/workspaces/{workspace_id}/billing" },
+        prices_get: { method: "GET", path: "/v1/billing/prices" },
+        subscribe_start: { method: "POST", path: "/v1/workspaces/{workspace_id}/billing/subscribe", idempotent: true },
+        subscribe_cancel: { method: "POST", path: "/v1/workspaces/{workspace_id}/billing/subscribe/cancel", idempotent: true },
+        cancel: { method: "POST", path: "/v1/workspaces/{workspace_id}/billing/cancel", idempotent: true },
+        resume: { method: "POST", path: "/v1/workspaces/{workspace_id}/billing/resume", idempotent: true },
+        portal_open: { method: "POST", path: "/v1/workspaces/{workspace_id}/billing/portal" },
+        withdraw: { method: "POST", path: "/v1/workspaces/{workspace_id}/billing/withdraw", idempotent: true },
+    },
+    change: {
+        list: { method: "GET", path: "/v1/workspaces/{workspace_id}/changes" },
+        command_get: { method: "GET", path: "/v1/commands/{command_id}/changes" },
+        export: { method: "GET", path: "/v1/workspaces/{workspace_id}/changes/export" },
+    },
+    trash: {
+        list: { method: "GET", path: "/v1/workspaces/{workspace_id}/trash" },
+    },
+    database: {
+        create: { method: "POST", path: "/v1/workspaces/{workspace_id}/databases", idempotent: true },
+        list: { method: "GET", path: "/v1/workspaces/{workspace_id}/databases" },
+        rename: { method: "POST", path: "/v1/databases/{database_id}/rename", idempotent: true },
+        archive: { method: "POST", path: "/v1/databases/{database_id}/archive", idempotent: true },
+        restore: { method: "POST", path: "/v1/databases/{database_id}/restore", idempotent: true },
+    },
+    field: {
+        create: { method: "POST", path: "/v1/databases/{database_id}/fields", idempotent: true },
+        rename: { method: "POST", path: "/v1/fields/{field_id}/rename", idempotent: true },
+        options_set: { method: "POST", path: "/v1/fields/{field_id}/options", idempotent: true },
+        relation_set: { method: "POST", path: "/v1/fields/{field_id}/relation", idempotent: true },
+        archive: { method: "POST", path: "/v1/fields/{field_id}/archive", idempotent: true },
+        restore: { method: "POST", path: "/v1/fields/{field_id}/restore", idempotent: true },
+    },
+    record: {
+        create: { method: "POST", path: "/v1/databases/{database_id}/records", idempotent: true },
+        query: { method: "POST", path: "/v1/databases/{database_id}/query", list: true },
+        get: { method: "GET", path: "/v1/records/{record_id}" },
+        update: { method: "POST", path: "/v1/records/{record_id}", idempotent: true },
+        subtasks_set: { method: "POST", path: "/v1/records/{record_id}/subtasks", idempotent: true },
+        archive: { method: "POST", path: "/v1/records/{record_id}/archive", idempotent: true },
+        restore: { method: "POST", path: "/v1/records/{record_id}/restore", idempotent: true },
+        bulk_update: { method: "POST", path: "/v1/databases/{database_id}/records/bulk-update", idempotent: true },
+        bulk_create: { method: "POST", path: "/v1/databases/{database_id}/records/bulk-create", idempotent: true },
+        bulk_archive: { method: "POST", path: "/v1/databases/{database_id}/records/bulk-archive", idempotent: true },
+        bulk_restore: { method: "POST", path: "/v1/databases/{database_id}/records/bulk-restore", idempotent: true },
+        history: { method: "GET", path: "/v1/records/{record_id}/history" },
+        undo: { method: "POST", path: "/v1/record-commands/{command_id}/undo", idempotent: true },
+    },
+    card: {
+        move: { method: "POST", path: "/v1/records/{record_id}/move", idempotent: true },
+        assigned_list: { method: "GET", path: "/v1/workspaces/{workspace_id}/records/assigned", list: true },
+    },
+    task: {
+        list: { method: "GET", path: "/v1/tasks", list: true },
+        create: { method: "POST", path: "/v1/tasks", idempotent: true },
+        update: { method: "PATCH", path: "/v1/tasks/{task_id}", idempotent: true },
+        move: { method: "POST", path: "/v1/tasks/{task_id}/move", idempotent: true },
+    },
+    view: {
+        create: { method: "POST", path: "/v1/databases/{database_id}/views", idempotent: true },
+        list: { method: "GET", path: "/v1/databases/{database_id}/views" },
+        update: { method: "POST", path: "/v1/views/{view_id}", idempotent: true },
+        rename: { method: "POST", path: "/v1/views/{view_id}/rename", idempotent: true },
+        archive: { method: "POST", path: "/v1/views/{view_id}/archive", idempotent: true },
+        restore: { method: "POST", path: "/v1/views/{view_id}/restore", idempotent: true },
+        record_list: { method: "GET", path: "/v1/views/{view_id}/records", list: true },
+    },
+    page: {
+        create: { method: "POST", path: "/v1/workspaces/{workspace_id}/pages", idempotent: true },
+        list: { method: "GET", path: "/v1/workspaces/{workspace_id}/pages" },
+        get: { method: "GET", path: "/v1/pages/{page_id}" },
+        rename: { method: "POST", path: "/v1/pages/{page_id}/rename", idempotent: true },
+        archive: { method: "POST", path: "/v1/pages/{page_id}/archive", idempotent: true },
+        restore: { method: "POST", path: "/v1/pages/{page_id}/restore", idempotent: true },
+        edit: { method: "POST", path: "/v1/pages/{page_id}/edit", idempotent: true },
+        append: { method: "POST", path: "/v1/pages/{page_id}/blocks", idempotent: true },
+        propose: { method: "POST", path: "/v1/pages/{page_id}/proposals", idempotent: true },
+        proposal_get: { method: "GET", path: "/v1/pages/{page_id}/proposals/{proposal_id}" },
+        proposal_list: { method: "GET", path: "/v1/pages/{page_id}/proposals" },
+        proposal_discard: { method: "POST", path: "/v1/pages/{page_id}/proposals/{proposal_id}/discard", idempotent: true },
+    },
+    model: {
+        list: { method: "GET", path: "/v1/models" },
+    },
+    command: {
+        describe: { method: "GET", path: "/v1/commands/{name}" },
+    },
+    app_auth: {
+        user_list: { method: "GET", path: "/v1/projects/{project_id}/auth/users", list: true },
+        user_show: { method: "GET", path: "/v1/projects/{project_id}/auth/users/{user_id}" },
+        user_unlock: { method: "POST", path: "/v1/projects/{project_id}/auth/users/{user_id}/unlock", idempotent: true },
+        user_email_send: { method: "POST", path: "/v1/projects/{project_id}/auth/users/{user_id}/email", idempotent: true },
+        user_session_list: { method: "GET", path: "/v1/projects/{project_id}/auth/users/{user_id}/sessions" },
+        user_session_revoke: { method: "DELETE", path: "/v1/projects/{project_id}/auth/users/{user_id}/sessions/{session_id}", idempotent: true },
+        user_sign_out_everywhere: { method: "POST", path: "/v1/projects/{project_id}/auth/users/{user_id}/sign-out", idempotent: true },
+        sign_in_event_list: { method: "GET", path: "/v1/projects/{project_id}/auth/sign-ins" },
+        user_delete: { method: "DELETE", path: "/v1/projects/{project_id}/auth/users/{user_id}", idempotent: true },
+        settings_get: { method: "GET", path: "/v1/projects/{project_id}/auth/settings" },
+        settings_update: { method: "POST", path: "/v1/projects/{project_id}/auth/settings", idempotent: true },
+        email_usage_get: { method: "GET", path: "/v1/projects/{project_id}/auth/email-usage" },
+        email_suppression_list: { method: "GET", path: "/v1/projects/{project_id}/auth/email-suppressions" },
+        email_suppression_add: { method: "POST", path: "/v1/projects/{project_id}/auth/email-suppressions", idempotent: true },
+        email_suppression_remove: { method: "POST", path: "/v1/projects/{project_id}/auth/email-suppressions/remove", idempotent: true },
+        sender_get: { method: "GET", path: "/v1/projects/{project_id}/auth/sender" },
+    },
+    email: {
+        send: { method: "POST", path: "/v1/projects/{project_id}/email", idempotent: true },
+    },
+    app_payments: {
+        connect_start: { method: "POST", path: "/v1/projects/{project_id}/payments/connect" },
+        account_get: { method: "GET", path: "/v1/projects/{project_id}/payments/account" },
+        revenue_get: { method: "GET", path: "/v1/projects/{project_id}/payments/revenue" },
+        disconnect: { method: "DELETE", path: "/v1/projects/{project_id}/payments/account", idempotent: true },
+        dashboard_link: { method: "GET", path: "/v1/projects/{project_id}/payments/dashboard" },
+        webhook_delivery_list: { method: "GET", path: "/v1/projects/{project_id}/payments/deliveries" },
+        webhook_delivery_resend: { method: "POST", path: "/v1/projects/{project_id}/payments/deliveries/{event_id}/resend", idempotent: true },
+    },
+    realtime: {
+        publish: { method: "POST", path: "/v1/projects/{project_id}/realtime/channels/{channel}/messages" },
+        channel_list: { method: "GET", path: "/v1/projects/{project_id}/realtime/channels" },
+    },
+    run: {
+        create: { method: "POST", path: "/v1/runs", idempotent: true },
+        quote: { method: "POST", path: "/v1/runs/quote" },
+        list: { method: "GET", path: "/v1/runs", list: true },
+        get: { method: "GET", path: "/v1/runs/{run_id}" },
+        stop: { method: "POST", path: "/v1/runs/{run_id}/stop", idempotent: true },
+        approval_list: { method: "GET", path: "/v1/workspaces/{workspace_id}/approvals" },
+        approve: { method: "POST", path: "/v1/runs/{run_id}/approve", idempotent: true },
+        deny: { method: "POST", path: "/v1/runs/{run_id}/deny", idempotent: true },
+        resume: { method: "POST", path: "/v1/runs/{run_id}/resume", idempotent: true },
+        follow_up: { method: "POST", path: "/v1/runs/{run_id}/follow-up", idempotent: true },
+        undo: { method: "POST", path: "/v1/runs/{run_id}/undo", idempotent: true },
+    },
+    agent: {
+        list: { method: "GET", path: "/v1/workspaces/{workspace_id}/agents" },
+        get: { method: "GET", path: "/v1/agents/{agent_id}" },
+        update: { method: "PATCH", path: "/v1/agents/{agent_id}", idempotent: true },
+        pause: { method: "POST", path: "/v1/agents/{agent_id}/pause", idempotent: true },
+        resume: { method: "POST", path: "/v1/agents/{agent_id}/resume", idempotent: true },
+    },
+    schedule: {
+        list: { method: "GET", path: "/v1/workspaces/{workspace_id}/schedules" },
+        create: { method: "POST", path: "/v1/workspaces/{workspace_id}/schedules", idempotent: true },
+        update: { method: "PATCH", path: "/v1/schedules/{schedule_id}", idempotent: true },
+        delete: { method: "DELETE", path: "/v1/schedules/{schedule_id}", idempotent: true },
+        restore: { method: "POST", path: "/v1/schedules/{schedule_id}/restore", idempotent: true },
+        run_now: { method: "POST", path: "/v1/schedules/{schedule_id}/run", idempotent: true },
+    },
+    onboarding: {
+        get: { method: "GET", path: "/v1/workspaces/{workspace_id}/onboarding" },
+        step_skip: { method: "POST", path: "/v1/workspaces/{workspace_id}/onboarding/{step}/skip", idempotent: true },
+        step_resume: { method: "POST", path: "/v1/workspaces/{workspace_id}/onboarding/{step}/resume", idempotent: true },
+    },
+    notification: {
+        list: { method: "GET", path: "/v1/workspaces/{workspace_id}/notifications", list: true },
+        read: { method: "POST", path: "/v1/workspaces/{workspace_id}/notifications/read", idempotent: true },
+        unread: { method: "POST", path: "/v1/workspaces/{workspace_id}/notifications/unread", idempotent: true },
+        read_all: { method: "POST", path: "/v1/workspaces/{workspace_id}/notifications/read-all", idempotent: true },
+        unread_count: { method: "GET", path: "/v1/workspaces/{workspace_id}/notifications/unread-count" },
+        preferences_get: { method: "GET", path: "/v1/workspaces/{workspace_id}/notifications/preferences" },
+        preferences_set: { method: "POST", path: "/v1/workspaces/{workspace_id}/notifications/preferences", idempotent: true },
+    },
+    search: {
+        query: { method: "GET", path: "/v1/workspaces/{workspace_id}/search" },
+    },
+    comment: {
+        create: { method: "POST", path: "/v1/records/{record_id}/comments", idempotent: true },
+        list: { method: "GET", path: "/v1/records/{record_id}/comments", list: true },
+        delete: { method: "DELETE", path: "/v1/comments/{comment_id}", idempotent: true },
+        restore: { method: "POST", path: "/v1/comments/{comment_id}/restore", idempotent: true },
+    },
+    status: {
+        get: { method: "GET", path: "/v1/status" },
+        incident_list: { method: "GET", path: "/v1/status/incidents" },
+        incident_get: { method: "GET", path: "/v1/status/incidents/{incident_id}" },
+    },
+    deploy: {
+        create: { method: "POST", path: "/v1/projects/{project_id}/deploys", idempotent: true },
+        list: { method: "GET", path: "/v1/projects/{project_id}/deploys" },
+        recent_list: { method: "GET", path: "/v1/workspaces/{workspace_id}/deploys" },
+        get: { method: "GET", path: "/v1/deploys/{deploy_id}" },
+        rollback: { method: "POST", path: "/v1/deploys/{deploy_id}/rollback", idempotent: true },
+        logs: { method: "GET", path: "/v1/deploys/{deploy_id}/logs" },
+    },
+    domain: {
+        add: { method: "POST", path: "/v1/projects/{project_id}/domains", idempotent: true },
+        list: { method: "GET", path: "/v1/projects/{project_id}/domains" },
+        check: { method: "POST", path: "/v1/domains/{domain_id}/check", idempotent: true },
+        remove: { method: "DELETE", path: "/v1/domains/{domain_id}", idempotent: true },
+    },
+    webhook: {
+        endpoint_create: { method: "POST", path: "/v1/projects/{project_id}/webhooks", idempotent: true },
+        endpoint_list: { method: "GET", path: "/v1/projects/{project_id}/webhooks" },
+        endpoint_update: { method: "PATCH", path: "/v1/webhooks/{endpoint_id}", idempotent: true },
+        endpoint_delete: { method: "DELETE", path: "/v1/webhooks/{endpoint_id}", idempotent: true },
+        delivery_list: { method: "GET", path: "/v1/projects/{project_id}/webhook-deliveries", list: true },
+        delivery_resend: { method: "POST", path: "/v1/webhook-deliveries/{delivery_id}/resend", idempotent: true },
+    },
+};