@jinshuju/mcp 0.0.0-stage → 0.3.0

package/dist/generated/operations.json

@@ -0,0 +1,4152 @@
+{
+    "listForms": {
+        "operationId": "listForms",
+        "summary": "List forms",
+        "description": "Returns the forms visible to the current identity (`kind=form`, excluding tables and quick payment forms). A personal token returns the forms the user created and those shared with them; an account token returns every form in the account.\nBy default sorted by id descending (that is, by creation time descending), and `next` is the id of the first row of the next page; when `sort` is passed, rows are sorted by the given field and `next` becomes `row:<offset>`.\n50 per page by default, adjustable with `limit` (max 1000).\n- Each row carries `entries_count` (entry count) and `last_entry_created_at` (when the last entry was received), usable with `filters` / `sort`.\n- With `include_transactions=true`, forms bound to a payment account carry `transactions` payment statistics.",
+        "tag": "Forms",
+        "method": "get",
+        "path": "/forms",
+        "params": [
+            {
+                "name": "q",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "filters",
+                "in": "query",
+                "required": false,
+                "json": true
+            },
+            {
+                "name": "sort",
+                "in": "query",
+                "required": false,
+                "json": true
+            },
+            {
+                "name": "next",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "skip",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "limit",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "include_transactions",
+                "in": "query",
+                "required": false
+            }
+        ],
+        "paramNames": [
+            "q",
+            "filters",
+            "sort",
+            "next",
+            "skip",
+            "limit",
+            "include_transactions"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "forms"
+        ],
+        "responseSchema": "FormListResponse"
+    },
+    "createForm": {
+        "operationId": "createForm",
+        "summary": "Create a form",
+        "description": "Creates a form from a list of field definitions and returns the full form structure. `name` and `fields` are required.\n- `scene` sets the form's scene; exam / evaluation question types (such as `SingleSelect`, `FillInBlank`) can only be used in the scenes that support them.\n- `layout=card` (paged) does not support PageBreak, Matrix*, TableField, GoodsField, ESignatureField, FormAssociation, MultipleBlanksField or any kind of Widget field.\n- The folder named by `folder_token` must be manageable and of kind form; otherwise returns 404 / 400 respectively.\n- `setting` accepts only whitelisted keys (see `FormSettingWriteInput`); `setting.notification_rules` replaces, as a whole, the notification rules created through the API.\n- The returned form structure carries `url` (the public fill URL).",
+        "tag": "Forms",
+        "method": "post",
+        "path": "/forms",
+        "params": [],
+        "paramNames": [],
+        "body": {
+            "contentType": "application/json",
+            "required": true,
+            "flatten": true
+        },
+        "successStatus": 201,
+        "scopes": [
+            "forms"
+        ],
+        "responseSchema": "Form"
+    },
+    "getForm": {
+        "operationId": "getForm",
+        "summary": "Show a form's structure",
+        "description": "Returns the form's name, `kind`, `scene`, public URL (`url`), description, field definitions and settings. Each element of `fields` is a single-key object `{ \"<api_code>\": {...} }`, in field order.\nAlso answers for a table or a quick payment form token; `kind` says which it is.\nThe following are included when the matching parameter is `true`:\n- `include_analytics`: each analysable field's definition carries `analytics`;\n- `include_theme`: carries `theme` (the form theme);\n- `include_field_rules`: carries `field_rules` (field display rules);\n- `include_extended_attributes`: carries `extended_attributes` (source-tracking links);\n- `include_transactions`: carries `transactions` (payment statistics) when the form is bound to a payment account.",
+        "tag": "Forms",
+        "method": "get",
+        "path": "/forms/{form_token}",
+        "params": [
+            {
+                "name": "form_token",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "include_analytics",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "include_theme",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "include_field_rules",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "include_extended_attributes",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "include_transactions",
+                "in": "query",
+                "required": false
+            }
+        ],
+        "paramNames": [
+            "form_token",
+            "include_analytics",
+            "include_theme",
+            "include_field_rules",
+            "include_extended_attributes",
+            "include_transactions"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "forms"
+        ],
+        "responseSchema": "FormDetail"
+    },
+    "createEntryLegacy": {
+        "operationId": "createEntryLegacy",
+        "summary": "Create an entry (legacy path)",
+        "description": "Legacy alias of `POST /forms/{form_token}/entries`, with identical behavior. New integrations should use the new path.",
+        "tag": "Entries",
+        "method": "post",
+        "path": "/forms/{form_token}",
+        "params": [
+            {
+                "name": "form_token",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "form_token"
+        ],
+        "body": {
+            "contentType": "application/json",
+            "required": true,
+            "flatten": false,
+            "param": "body"
+        },
+        "successStatus": 201,
+        "scopes": [
+            "write_entries"
+        ],
+        "responseSchema": "Entry"
+    },
+    "updateForm": {
+        "operationId": "updateForm",
+        "summary": "Edit a form",
+        "description": "Edits a form partially; also accepts `PUT`. The request body must contain at least one of `name` / `description` / `fields` / `setting` / `field_rules`, otherwise returns 400.\n- `fields` is changed incrementally through four kinds of operation, `add` / `remove` / `update` / `update_choices`; fields, choices and api_codes not mentioned are all kept;\n  `update[].type` changes a field's type in place, and a change that clears entry data must carry `confirm_data_loss: true`.\n- `field_rules` does `add` / `remove` / `update` on rules located by the `index` that `GET /forms/{form_token}/field_rules` returns.\n- `setting`, as on create, accepts only whitelisted keys.\nReturns the full updated form structure.",
+        "tag": "Forms",
+        "method": "patch",
+        "path": "/forms/{form_token}",
+        "params": [
+            {
+                "name": "form_token",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "form_token"
+        ],
+        "body": {
+            "contentType": "application/json",
+            "required": true,
+            "flatten": true
+        },
+        "successStatus": 200,
+        "scopes": [
+            "forms"
+        ],
+        "responseSchema": "Form"
+    },
+    "checkFormFieldData": {
+        "operationId": "checkFormFieldData",
+        "summary": "Check whether fields already hold data",
+        "description": "Use before deleting a field or choice: checks in batch whether fields (or single choices of a field) already have submitted entries. Deleting a field or choice that still has entries deletes those entries with it, and they cannot be recovered.\nMatches the check the web editor runs before deleting.\n- Put every deletion target of one edit in the `checks` of a single call (at most 100, may span several fields); `results` matches `checks` one to one, in order.\n- When a target cannot be checked (for example, the field does not exist), its row returns `unavailable` with the reason; the other targets return as usual.\n- Returns 400 when `checks` is missing, empty, over 100, not a JSON array, or has an item that is not an object.",
+        "tag": "Forms",
+        "method": "get",
+        "path": "/forms/{form_token}/fields/check",
+        "params": [
+            {
+                "name": "form_token",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "checks",
+                "in": "query",
+                "required": true,
+                "json": true
+            }
+        ],
+        "paramNames": [
+            "form_token",
+            "checks"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "forms"
+        ],
+        "responseSchema": "FieldDataCheckResponse"
+    },
+    "previewFormFieldTypeChange": {
+        "operationId": "previewFormFieldTypeChange",
+        "summary": "Preview a field type change",
+        "description": "Use before changing a field's type (the field's `type` in PATCH /forms/{form_token}): changes no data, and counts, from the field's current entries, how many would be kept and how many cleared after the conversion.\nThe conversion happens on the original field (api_code and data column unchanged), so only entry data is affected; matches the preview the web editor shows before converting.\n- Put every conversion of one edit in the `checks` of a single call (at most 20); `results` matches `checks` one to one, in order.\n- `supported=false` means the field cannot be converted to the target type, and the actual edit is refused too.\n- When converting multi-line text to a choice field such as single choice / multiple choice, also returns `choice_count`, the number of choices that would be generated from existing entries, and `choice_limit_exceeded`, whether that exceeds the choice limit (when it does, the conversion is refused rather than truncated).\n- When an item cannot be previewed (the field does not exist, `target_type` is not a type available to this form, etc.), its row returns `unavailable` with the reason; the other items return as usual.\n- Returns 400 when `checks` is missing, empty, over 20, not a JSON array, or has an item that is not an object.",
+        "tag": "Forms",
+        "method": "get",
+        "path": "/forms/{form_token}/fields/preview_convert",
+        "params": [
+            {
+                "name": "form_token",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "checks",
+                "in": "query",
+                "required": true,
+                "json": true
+            }
+        ],
+        "paramNames": [
+            "form_token",
+            "checks"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "forms"
+        ],
+        "responseSchema": "FieldTypeChangePreviewResponse"
+    },
+    "listEntries": {
+        "operationId": "listEntries",
+        "summary": "List entries",
+        "description": "Returns form entries page by page, 50 per page by default, set with `limit` (max 1000). Sorted by serial number ascending by default; `next` is the serial number of the first entry of the next page.\n- `filters` / `keyword` trigger a conditional query; `created_at` returns only entries created at or after that time (and sorts by creation time instead);\n  in both these cases, and when `sort` is passed, `next` becomes a row offset.\n- `fields` returns only the given fields (the serial number is always returned).\n- Each entry is keyed by field api_code (a field with api_code_alias set is keyed by its alias); for the value shapes see `EntryData`.",
+        "tag": "Entries",
+        "method": "get",
+        "path": "/forms/{form_token}/entries",
+        "params": [
+            {
+                "name": "form_token",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "fields",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "filters",
+                "in": "query",
+                "required": false,
+                "json": true
+            },
+            {
+                "name": "keyword",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "sort",
+                "in": "query",
+                "required": false,
+                "json": true
+            },
+            {
+                "name": "created_at",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "next",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "skip",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "include_labels",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "limit",
+                "in": "query",
+                "required": false
+            }
+        ],
+        "paramNames": [
+            "form_token",
+            "fields",
+            "filters",
+            "keyword",
+            "sort",
+            "created_at",
+            "next",
+            "skip",
+            "include_labels",
+            "limit"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "read_entries"
+        ],
+        "responseSchema": "EntryListResponse"
+    },
+    "createEntry": {
+        "operationId": "createEntry",
+        "summary": "Create an entry",
+        "description": "Submits one entry keyed by field api_code (or api_code_alias). Unknown keys are ignored; when no valid key remains, returns 400, with `error_description` starting with `Entry attributes cannot be empty` and naming each dropped key (not a field of this form, or a signature / calculated field that cannot be written).\n- The form's field display rules and field validation still apply; a validation failure returns 400, and `error_description` is `{ \"<api_code>\": [\"error\"] }` serialized as a JSON string.\n- Mobile fields skip SMS verification; signature fields and calculated fields cannot be written.\n- Returns 403 when the form's entry count has reached the plan limit.\n- Attachment fields accept several forms of input; see `EntryInput`.",
+        "tag": "Entries",
+        "method": "post",
+        "path": "/forms/{form_token}/entries",
+        "params": [
+            {
+                "name": "form_token",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "form_token"
+        ],
+        "body": {
+            "contentType": "application/json",
+            "required": true,
+            "flatten": false,
+            "param": "body"
+        },
+        "successStatus": 201,
+        "scopes": [
+            "write_entries"
+        ],
+        "responseSchema": "Entry"
+    },
+    "countEntries": {
+        "operationId": "countEntries",
+        "summary": "Count entries",
+        "description": "Returns the number of entries matching the filters, without the entries themselves. `filters` / `keyword` are the same as for `GET /forms/{form_token}/entries`; with neither, returns the total entry count of the form.\nA cooperator counts only the entries visible to their role.",
+        "tag": "Entries",
+        "method": "get",
+        "path": "/forms/{form_token}/entries/count",
+        "params": [
+            {
+                "name": "form_token",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "filters",
+                "in": "query",
+                "required": false,
+                "json": true
+            },
+            {
+                "name": "keyword",
+                "in": "query",
+                "required": false
+            }
+        ],
+        "paramNames": [
+            "form_token",
+            "filters",
+            "keyword"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "read_entries"
+        ],
+        "responseSchema": "EntryCountResponse"
+    },
+    "aggregateEntries": {
+        "operationId": "aggregateEntries",
+        "summary": "Aggregate entries",
+        "description": "Aggregates whole columns on the server over the entries matching the filters (sum, average, count, percentiles, etc.), optionally grouped by 1 to 2 fields. The response size depends only on the number of metrics and groups, not on the amount of data.\n- `metrics` is required, 1 to 20 items; the functions each field takes are in the `analytics.agg_funcs` returned by `GET /forms/{form_token}?include_analytics=true`.\n- `dimensions` is optional, at most 2 items; only fields whose `analytics.groupable` is true (single-value choice fields and date fields) can be grouped by, and a date field must specify `bucket`.\n- Without `dimensions`, `rows` has a single row; when grouped, one row per group, at most `limit` groups; `row_count` is the total number of groups, and `truncated` is true when there are more.\n- `filters` / `keyword` are the same as for the entry list, but `creator_id`, `serial_number` and association field conditions are not supported (returns 400).\n- Returns 400 when a field does not exist or is not readable by the caller, or a function or grouping does not apply to the field, and says which fields / functions / groupings are available.",
+        "tag": "Entries",
+        "method": "get",
+        "path": "/forms/{form_token}/entries/aggregate",
+        "params": [
+            {
+                "name": "form_token",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "metrics",
+                "in": "query",
+                "required": false,
+                "json": true
+            },
+            {
+                "name": "dimensions",
+                "in": "query",
+                "required": false,
+                "json": true
+            },
+            {
+                "name": "limit",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "filters",
+                "in": "query",
+                "required": false,
+                "json": true
+            },
+            {
+                "name": "keyword",
+                "in": "query",
+                "required": false
+            }
+        ],
+        "paramNames": [
+            "form_token",
+            "metrics",
+            "dimensions",
+            "limit",
+            "filters",
+            "keyword"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "read_entries"
+        ],
+        "responseSchema": "EntryAggregateResponse"
+    },
+    "summarizeEntries": {
+        "operationId": "summarizeEntries",
+        "summary": "Summarize entries",
+        "description": "Reads an overall summary of the form's entries in one call: an overview (matching count, added today) plus the distribution or numeric statistics of each analysable field. The response is only a few KB, regardless of the amount of data.\n- Each field returns a uniform structure by `kind`: choice fields give each choice's count and share, matrix fields are grouped by question, numbers give min / max / sum / average, dates give earliest / latest, text gives the distinct count.\n- By default includes every analysable field (fields whose `analytics.summarisable` is true, plus `created_at`), at most 60; fields beyond that are listed in `omitted_fields`, and `truncated` is true.\n- Returns 400 when a field named in `fields` is not analysable or not readable by the caller.\n- `filters` / `keyword` are the same as for the entry list, but `creator_id`, `serial_number` and association field conditions are not supported (returns 400).",
+        "tag": "Entries",
+        "method": "get",
+        "path": "/forms/{form_token}/entries/summary",
+        "params": [
+            {
+                "name": "form_token",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "fields",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "include_overview",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "filters",
+                "in": "query",
+                "required": false,
+                "json": true
+            },
+            {
+                "name": "keyword",
+                "in": "query",
+                "required": false
+            }
+        ],
+        "paramNames": [
+            "form_token",
+            "fields",
+            "include_overview",
+            "filters",
+            "keyword"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "read_entries"
+        ],
+        "responseSchema": "EntrySummaryResponse"
+    },
+    "countFormViewEntries": {
+        "operationId": "countFormViewEntries",
+        "summary": "Count the entries of a view",
+        "description": "Same as `GET /forms/{form_token}/entries/count`, but only over the entries the view's filters select: the view's filters apply first, and `filters` / `keyword` narrow the range further on top of them. The view's columns and sort do not affect the result; a view with no filters is the same as the whole form.\nOnly views visible to the caller are accessible; otherwise 404 (View cannot be found).",
+        "tag": "Views",
+        "method": "get",
+        "path": "/forms/{form_token}/views/{view_token}/entries/count",
+        "params": [
+            {
+                "name": "form_token",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "view_token",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "filters",
+                "in": "query",
+                "required": false,
+                "json": true
+            },
+            {
+                "name": "keyword",
+                "in": "query",
+                "required": false
+            }
+        ],
+        "paramNames": [
+            "form_token",
+            "view_token",
+            "filters",
+            "keyword"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "read_entries"
+        ],
+        "responseSchema": "EntryCountResponse"
+    },
+    "aggregateFormViewEntries": {
+        "operationId": "aggregateFormViewEntries",
+        "summary": "Aggregate the entries of a view",
+        "description": "Same as `GET /forms/{form_token}/entries/aggregate`, but only over the entries the view's filters select: the view's filters apply first, and `filters` / `keyword` narrow the range further on top of them. The view's columns and sort do not affect the result; a view with no filters is the same as the whole form.\nOnly views visible to the caller are accessible; otherwise 404 (View cannot be found).",
+        "tag": "Views",
+        "method": "get",
+        "path": "/forms/{form_token}/views/{view_token}/entries/aggregate",
+        "params": [
+            {
+                "name": "form_token",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "view_token",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "metrics",
+                "in": "query",
+                "required": false,
+                "json": true
+            },
+            {
+                "name": "dimensions",
+                "in": "query",
+                "required": false,
+                "json": true
+            },
+            {
+                "name": "limit",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "filters",
+                "in": "query",
+                "required": false,
+                "json": true
+            },
+            {
+                "name": "keyword",
+                "in": "query",
+                "required": false
+            }
+        ],
+        "paramNames": [
+            "form_token",
+            "view_token",
+            "metrics",
+            "dimensions",
+            "limit",
+            "filters",
+            "keyword"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "read_entries"
+        ],
+        "responseSchema": "EntryAggregateResponse"
+    },
+    "summarizeFormViewEntries": {
+        "operationId": "summarizeFormViewEntries",
+        "summary": "Summarize the entries of a view",
+        "description": "Same as `GET /forms/{form_token}/entries/summary`, but only over the entries the view's filters select: the view's filters apply first, and `filters` / `keyword` narrow the range further on top of them. The view's columns and sort do not affect the result; a view with no filters is the same as the whole form.\nOnly views visible to the caller are accessible; otherwise 404 (View cannot be found).",
+        "tag": "Views",
+        "method": "get",
+        "path": "/forms/{form_token}/views/{view_token}/entries/summary",
+        "params": [
+            {
+                "name": "form_token",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "view_token",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "fields",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "include_overview",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "filters",
+                "in": "query",
+                "required": false,
+                "json": true
+            },
+            {
+                "name": "keyword",
+                "in": "query",
+                "required": false
+            }
+        ],
+        "paramNames": [
+            "form_token",
+            "view_token",
+            "fields",
+            "include_overview",
+            "filters",
+            "keyword"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "read_entries"
+        ],
+        "responseSchema": "EntrySummaryResponse"
+    },
+    "createEntriesBatch": {
+        "operationId": "createEntriesBatch",
+        "summary": "Create entries in batch",
+        "description": "Submits up to 200 entries at a time. Each entry is validated on its own; valid ones are written in bulk, invalid ones are recorded in `errors` (`index` is the position in the request array).\nReturns 201 when at least one succeeds and 422 when all fail; returns 400 when `entries` is empty or has over 200 entries.\nBefore writing, the entry count limit is checked against the number of entries submitted; over the limit returns 403. A batch write does not trigger the callbacks of a single create, but creates one \"import\" activity record and backfills calculated fields.",
+        "tag": "Entries",
+        "method": "post",
+        "path": "/forms/{form_token}/entries/batch",
+        "params": [
+            {
+                "name": "form_token",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "form_token"
+        ],
+        "body": {
+            "contentType": "application/json",
+            "required": true,
+            "flatten": true
+        },
+        "successStatus": 201,
+        "scopes": [
+            "write_entries"
+        ],
+        "responseSchema": "BatchCreateResult"
+    },
+    "patchEntriesBatch": {
+        "operationId": "patchEntriesBatch",
+        "summary": "Update entries in batch",
+        "description": "Partially updates entries in batch by serial number, up to 200 rows at a time. Each row requires `serial_number`; `entry` holds the fields to change (fields not mentioned stay unchanged).\nEach row is validated on its own; failed rows are recorded in `failed_rows` (`reason` is `invalid_serial_number` / `invalid_attributes`, etc.).\nReturns 200 when at least one row succeeds and 422 when all fail; returns 400 when `entries` is empty or has over 200 rows.\nBatch update does not handle the attachment lifecycle, so it **cannot write attachment fields** (including attachment columns inside table fields); update those one entry at a time.",
+        "tag": "Entries",
+        "method": "patch",
+        "path": "/forms/{form_token}/entries/batch",
+        "params": [
+            {
+                "name": "form_token",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "form_token"
+        ],
+        "body": {
+            "contentType": "application/json",
+            "required": true,
+            "flatten": true
+        },
+        "successStatus": 200,
+        "scopes": [
+            "write_entries"
+        ],
+        "responseSchema": "BatchPatchResult"
+    },
+    "getEntry": {
+        "operationId": "getEntry",
+        "summary": "Show an entry",
+        "description": "Returns one entry by serial number. `fields` limits the fields returned.",
+        "tag": "Entries",
+        "method": "get",
+        "path": "/forms/{form_token}/entries/{serial_number}",
+        "params": [
+            {
+                "name": "form_token",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "serial_number",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "fields",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "include_labels",
+                "in": "query",
+                "required": false
+            }
+        ],
+        "paramNames": [
+            "form_token",
+            "serial_number",
+            "fields",
+            "include_labels"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "read_entries"
+        ],
+        "responseSchema": "Entry"
+    },
+    "updateEntryViaPost": {
+        "operationId": "updateEntryViaPost",
+        "summary": "Partially update an entry (POST)",
+        "description": "A POST alias of `PATCH` on the same path, with the same partial-update semantics, for clients that cannot easily send PATCH.",
+        "tag": "Entries",
+        "method": "post",
+        "path": "/forms/{form_token}/entries/{serial_number}",
+        "params": [
+            {
+                "name": "form_token",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "serial_number",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "form_token",
+            "serial_number"
+        ],
+        "body": {
+            "contentType": "application/json",
+            "required": true,
+            "flatten": false,
+            "param": "body"
+        },
+        "successStatus": 200,
+        "scopes": [
+            "write_entries"
+        ],
+        "responseSchema": "Entry"
+    },
+    "replaceEntry": {
+        "operationId": "replaceEntry",
+        "summary": "Replace an entry",
+        "description": "**Full replace**: writable fields absent from the request body are cleared, and only the values submitted in this request are kept. For a partial update use `PATCH`.\nReturns 400 when validation fails, with `error_description` being the JSON string of the field errors.",
+        "tag": "Entries",
+        "method": "put",
+        "path": "/forms/{form_token}/entries/{serial_number}",
+        "params": [
+            {
+                "name": "form_token",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "serial_number",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "form_token",
+            "serial_number"
+        ],
+        "body": {
+            "contentType": "application/json",
+            "required": true,
+            "flatten": false,
+            "param": "body"
+        },
+        "successStatus": 200,
+        "scopes": [
+            "write_entries"
+        ],
+        "responseSchema": "Entry"
+    },
+    "updateEntry": {
+        "operationId": "updateEntry",
+        "summary": "Partially update an entry",
+        "description": "**Partial update**: only the fields present in the request body change; the rest keep their values. An attachment field is replaced as a whole set: to keep existing files, send back the URLs or attachment ids you read along with the new ones.\nReturns 400 when validation fails, with `error_description` being the JSON string of the field errors.",
+        "tag": "Entries",
+        "method": "patch",
+        "path": "/forms/{form_token}/entries/{serial_number}",
+        "params": [
+            {
+                "name": "form_token",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "serial_number",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "form_token",
+            "serial_number"
+        ],
+        "body": {
+            "contentType": "application/json",
+            "required": true,
+            "flatten": false,
+            "param": "body"
+        },
+        "successStatus": 200,
+        "scopes": [
+            "write_entries"
+        ],
+        "responseSchema": "Entry"
+    },
+    "deleteEntry": {
+        "operationId": "deleteEntry",
+        "summary": "Delete an entry",
+        "description": "Deletes one entry and records a delete activity. On success returns the serial number of the deleted entry; returns 400 when deletion fails (for example, the form's state does not allow it).",
+        "tag": "Entries",
+        "method": "delete",
+        "path": "/forms/{form_token}/entries/{serial_number}",
+        "params": [
+            {
+                "name": "form_token",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "serial_number",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "form_token",
+            "serial_number"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "write_entries"
+        ]
+    },
+    "listEntryComments": {
+        "operationId": "listEntryComments",
+        "summary": "List an entry's comments",
+        "description": "Returns all comments on the entry, oldest first, with their creators, mentioned users and attachments. A caller who is a cooperator needs entry read permission on the form, and the entry must be within their data scope; otherwise returns 400.",
+        "tag": "Comments",
+        "method": "get",
+        "path": "/forms/{form_token}/entries/{serial_number}/comments",
+        "params": [
+            {
+                "name": "form_token",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "serial_number",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "form_token",
+            "serial_number"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "read_entries"
+        ]
+    },
+    "createEntryComment": {
+        "operationId": "createEntryComment",
+        "summary": "Comment on an entry",
+        "description": "Creates a comment on the entry, authored by the caller; content is stripped of leading and trailing whitespace. Returns 400 when content is empty or longer than 2000 characters. Mention a user in content with @[<user_id>] (a 24-character hex user id); the mentioned user must be a cooperator on the form, otherwise returns 400 and no comment is created. parent_id makes the comment a reply; the parent comment must belong to the same entry, otherwise returns 400. This endpoint cannot attach files. A caller who is a cooperator needs entry read permission, and the entry must be within their data scope; otherwise returns 400.",
+        "tag": "Comments",
+        "method": "post",
+        "path": "/forms/{form_token}/entries/{serial_number}/comments",
+        "params": [
+            {
+                "name": "form_token",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "serial_number",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "form_token",
+            "serial_number"
+        ],
+        "body": {
+            "contentType": "application/json",
+            "required": true,
+            "flatten": true
+        },
+        "successStatus": 201,
+        "scopes": [
+            "read_entries"
+        ],
+        "responseSchema": "EntryComment"
+    },
+    "updateEntryComment": {
+        "operationId": "updateEntryComment",
+        "summary": "Update a comment on an entry",
+        "description": "Changes a comment's content; PUT is accepted too. Only the comment's author can edit it; not even a form admin can edit someone else's comment; otherwise returns 400. content follows the same rules as on create (leading and trailing whitespace stripped, at most 2000 characters, mentioned users must be cooperators); the comment's existing attachments stay unchanged. Returns 404 (comment cannot be found) when the comment does not belong to the entry.",
+        "tag": "Comments",
+        "method": "patch",
+        "path": "/forms/{form_token}/entries/{serial_number}/comments/{comment_id}",
+        "params": [
+            {
+                "name": "form_token",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "serial_number",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "comment_id",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "form_token",
+            "serial_number",
+            "comment_id"
+        ],
+        "body": {
+            "contentType": "application/json",
+            "required": true,
+            "flatten": true
+        },
+        "successStatus": 200,
+        "scopes": [
+            "read_entries"
+        ],
+        "responseSchema": "EntryComment"
+    },
+    "deleteEntryComment": {
+        "operationId": "deleteEntryComment",
+        "summary": "Delete a comment on an entry",
+        "description": "Deletes a comment. The comment's author, the form's creator, or a cooperator with the admin role can delete it; any other cooperator gets 400. Returns 404 (comment cannot be found) for a comment that is already deleted or does not belong to the entry.",
+        "tag": "Comments",
+        "method": "delete",
+        "path": "/forms/{form_token}/entries/{serial_number}/comments/{comment_id}",
+        "params": [
+            {
+                "name": "form_token",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "serial_number",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "comment_id",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "form_token",
+            "serial_number",
+            "comment_id"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "read_entries"
+        ]
+    },
+    "getFormSetting": {
+        "operationId": "getFormSetting",
+        "summary": "Show a form's settings",
+        "description": "Returns the form's after-submission settings, collection rules (closing rules, fill frequency), access policy, WeChat restrictions and Webhook settings.\nThe `weixin` key is returned only when the form has a WeChat Official Account selected (selected_weixin_appid is present).",
+        "tag": "Form Settings",
+        "method": "get",
+        "path": "/forms/{form_token}/setting",
+        "params": [
+            {
+                "name": "form_token",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "form_token"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "form_setting"
+        ],
+        "responseSchema": "FormSetting"
+    },
+    "updateFormSetting": {
+        "operationId": "updateFormSetting",
+        "summary": "Update a form's settings",
+        "description": "Partially updates the form's settings, writing only the keys present in the request; PUT is accepted too.\n- `submission_region_limited` / `submission_regions` are a paid feature and read-only here; to write them, use `setting` on the \"Edit a form\" endpoint.\n- `manually_close_rule`, `by_time_range_close_rule`, `by_entries_close_rule` and `fill_frequency` are nested objects; the server creates or updates them as nested attributes.\n- Returns `{ \"status\": \"ok\" }` on success; returns 400 when model validation fails, with body `{ \"errors\": \"...\", \"status\": \"failed\" }` (not the common error shape).",
+        "tag": "Form Settings",
+        "method": "patch",
+        "path": "/forms/{form_token}/setting",
+        "params": [
+            {
+                "name": "form_token",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "form_token"
+        ],
+        "body": {
+            "contentType": "application/json",
+            "required": true,
+            "flatten": false,
+            "param": "body"
+        },
+        "successStatus": 200,
+        "scopes": [
+            "form_setting"
+        ],
+        "responseSchema": "FormSettingSaveOk"
+    },
+    "getManuallyCloseRule": {
+        "operationId": "getManuallyCloseRule",
+        "summary": "Show whether a form is manually closed",
+        "description": "Returns whether the form has been manually closed for collection. Returns `{ \"closed\": false }` when no manual closing rule has ever been created.",
+        "tag": "Form Settings",
+        "method": "get",
+        "path": "/forms/{form_token}/manually_close_rule",
+        "params": [
+            {
+                "name": "form_token",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "form_token"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "form_setting"
+        ],
+        "responseSchema": "ManuallyCloseRule"
+    },
+    "updateManuallyCloseRule": {
+        "operationId": "updateManuallyCloseRule",
+        "summary": "Open or close collection manually",
+        "description": "Opens (true) or closes (false) the form for collection manually through `open`; PUT is accepted too.\nCreates the manual closing rule when none exists, updates it otherwise. When the manual closed state changes, the server deletes the form's other closing rules (by time, by entry count, etc.).\nReturns 400 when the `open` parameter is missing (the response body depends on the server implementation); returns 400 when saving fails, with body `{ \"errors\": \"...\", \"status\": \"failed\" }`.",
+        "tag": "Form Settings",
+        "method": "patch",
+        "path": "/forms/{form_token}/manually_close_rule",
+        "params": [
+            {
+                "name": "form_token",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "form_token"
+        ],
+        "body": {
+            "contentType": "application/json",
+            "required": true,
+            "flatten": true
+        },
+        "successStatus": 200,
+        "scopes": [
+            "form_setting"
+        ],
+        "responseSchema": "ManuallyCloseRule"
+    },
+    "updateAccessPolicy": {
+        "operationId": "updateAccessPolicy",
+        "summary": "Update the fill frequency limit",
+        "description": "Updates the form's fill frequency limit (fill_frequency); PUT is accepted too.\nThis endpoint takes only the `fill_frequency` key; for the other access policy keys, use PATCH /forms/{form_token}/setting.\nReturns `{ \"status\": \"ok\" }` on success; returns 400 when validation fails, with body `{ \"errors\": \"...\", \"status\": \"failed\" }` (not the common error shape).",
+        "tag": "Form Settings",
+        "method": "patch",
+        "path": "/forms/{form_token}/access_policy",
+        "params": [
+            {
+                "name": "form_token",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "form_token"
+        ],
+        "body": {
+            "contentType": "application/json",
+            "required": true,
+            "flatten": true
+        },
+        "successStatus": 200,
+        "scopes": [
+            "form_setting"
+        ],
+        "responseSchema": "FormSettingSaveOk"
+    },
+    "createFormWebhook": {
+        "operationId": "createFormWebhook",
+        "summary": "Set the Webhook",
+        "description": "Sets the form's entry push URL `entry_post_url` and turns on pushing new entries (post_new_entry = true).\nThe plan must support Webhook; otherwise returns 402 with an empty body.\nThe server does not check the save result and echoes `entry_post_url` from the settings as is (whether an invalid URL was persisted depends on the server implementation).",
+        "tag": "Form Settings",
+        "method": "post",
+        "path": "/forms/{form_token}/webhook",
+        "params": [
+            {
+                "name": "form_token",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "form_token"
+        ],
+        "body": {
+            "contentType": "application/json",
+            "required": true,
+            "flatten": true
+        },
+        "successStatus": 200,
+        "scopes": [
+            "form_setting"
+        ],
+        "responseSchema": "FormWebhook"
+    },
+    "deleteFormWebhook": {
+        "operationId": "deleteFormWebhook",
+        "summary": "Delete the Webhook",
+        "description": "Removes `entry_post_url` from the form's settings. Returns 200 with an empty body on success.",
+        "tag": "Form Settings",
+        "method": "delete",
+        "path": "/forms/{form_token}/webhook",
+        "params": [
+            {
+                "name": "form_token",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "form_token"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "form_setting"
+        ]
+    },
+    "updateFormTheme": {
+        "operationId": "updateFormTheme",
+        "summary": "Update a form's theme",
+        "description": "Partially updates the form's theme (colors, background, header image, typography, form container, submit button); PUT is accepted too.\n- The request body must contain at least one of primary_color / secondary_color / wallpaper / header / typography / form_container / submit_button (`generate_header_image` is turned into header.header_image_url, so it counts too); otherwise 400.\n- Header image source precedence: header_image_upload_token > header_image_base64 > header_image_url > header_image_attachment_id; when a header image is set and header.type is not given, header.type is set to image.\n- Background image source precedence: background_image_upload_token > background_image_url > background_image_attachment_id. Setting or removing the background image also removes the preset background image that comes with the theme template; the background color is kept.\n- `header_image_attachment_id` / `background_image_attachment_id` take the `attachment_id` returned by \"Upload a form image\" (image_type header / wallpaper); pass an empty string `\"\"` to remove the current image.\n- `header.carousel_images` replaces the carousel images as a whole: at most 5, not empty; each item gives one of image_upload_token / image_url / attachment_id, and an attachment_id must be a carousel image the form already has; when it is passed and header.type is not given, header.type is set to carousel.\n- Keys in `text_style` and `typography.*` use underscores (e.g. font_size); the server converts them to hyphenated CSS keys and merges them into the existing styles; the response uses the hyphenated keys.\n- `generate_header_image` has AI generate a header image and consumes AI points; returns 402 when points are insufficient, 400 when generation fails.\n- An image upload_token is the `form_image_token` used by \"Upload a form image\"; the image purpose it records must match (header / wallpaper / carousel), and its upload must be complete.",
+        "tag": "Form Settings",
+        "method": "patch",
+        "path": "/forms/{form_token}/theme",
+        "params": [
+            {
+                "name": "form_token",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "form_token"
+        ],
+        "body": {
+            "contentType": "application/json",
+            "required": true,
+            "flatten": false,
+            "param": "body"
+        },
+        "successStatus": 200,
+        "scopes": [
+            "form_setting"
+        ],
+        "responseSchema": "FormTheme"
+    },
+    "getExamSetting": {
+        "operationId": "getExamSetting",
+        "summary": "Show a form's exam settings",
+        "description": "Returns an exam form's settings for what is shown after the exam is submitted, the time limit, the pre-exam notice and score range comments.\nOnly for forms in the exam scene (scene = exam); otherwise returns 400. Returns an empty object `{}` when the form has no exam settings record yet.",
+        "tag": "Form Settings",
+        "method": "get",
+        "path": "/forms/{form_token}/exam_setting",
+        "params": [
+            {
+                "name": "form_token",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "form_token"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "form_setting"
+        ],
+        "responseSchema": "ExamSetting"
+    },
+    "updateExamSetting": {
+        "operationId": "updateExamSetting",
+        "summary": "Update a form's exam settings",
+        "description": "Partially updates an exam form's settings; PUT is accepted too. Only for exam-scene forms; otherwise returns 400.\n- When the plan does not support \"show the score after submission\", `notice_after_filling_mode` is forced to none and `success_message_rich_text` is ignored.\n- `interval_comments` replaces the existing range comments as a whole; it takes effect only when `notice_after_filling_mode` (passed in this request or already saved) is grade / explaination / answer; passing an empty array does not turn range comments off.\n- Range comments must have end_point ≥ start_point and must not overlap; otherwise 400.\n- Passing `show_timeout: true` returns 400 when the form already has required questions; once the time limit is on, question fields cannot be made required (required candidate info fields are not affected); to turn on the time limit, make the questions optional first.\n- When `notice_after_filling_mode` is not none, the server clears success_redirect_url / success_redirect_fields in the form's settings.\n- A request body with no recognized keys is a no-op and returns the current settings.",
+        "tag": "Form Settings",
+        "method": "patch",
+        "path": "/forms/{form_token}/exam_setting",
+        "params": [
+            {
+                "name": "form_token",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "form_token"
+        ],
+        "body": {
+            "contentType": "application/json",
+            "required": true,
+            "flatten": true
+        },
+        "successStatus": 200,
+        "scopes": [
+            "form_setting"
+        ],
+        "responseSchema": "ExamSetting"
+    },
+    "getEvaluationSetting": {
+        "operationId": "getEvaluationSetting",
+        "summary": "Show a form's evaluation settings",
+        "description": "Returns an evaluation form's report display, dimension (indicator) settings and total score range comments.\nOnly for forms in the evaluation scene (scene = evaluation); otherwise returns 400. Returns an empty object `{}` when the form has no evaluation settings record yet.",
+        "tag": "Form Settings",
+        "method": "get",
+        "path": "/forms/{form_token}/evaluation_setting",
+        "params": [
+            {
+                "name": "form_token",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "form_token"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "form_setting"
+        ],
+        "responseSchema": "EvaluationSetting"
+    },
+    "updateEvaluationSetting": {
+        "operationId": "updateEvaluationSetting",
+        "summary": "Update a form's evaluation settings",
+        "description": "Partially updates an evaluation form's settings; PUT is accepted too. Only for evaluation-scene forms; otherwise returns 400.\n- When the plan does not support \"show the evaluation report after submission\", `notice_after_filling_mode` is forced to none.\n- `evaluation_comments` replaces the total score range comments as a whole, and an empty array turns range comments off; it takes effect only when `notice_after_filling_mode` (passed in this request or already saved) is reports / customize.\n- A comment by score range must give both start_point and end_point; comments written with conditions in the form editor read back as `id` + `conditions` and must be passed back with their original id when updating (only comment / retry may change; the conditions cannot be changed and no range can be added); leaving one out or changing it returns 400.\n- `indicator_setting.indicators` replaces the dimensions as a whole; pass `api_code` back to keep an existing dimension's identity. A dimension can bind only scorable questions visible on the form, referenced by `field_api_codes` or `field_cids`; referencing an unknown field returns 400.\n- When `notice_after_filling_mode` is not none, the server clears success_redirect_url / success_redirect_fields in the form's settings.\n- A request body with no recognized keys is a no-op and returns the current settings.",
+        "tag": "Form Settings",
+        "method": "patch",
+        "path": "/forms/{form_token}/evaluation_setting",
+        "params": [
+            {
+                "name": "form_token",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "form_token"
+        ],
+        "body": {
+            "contentType": "application/json",
+            "required": true,
+            "flatten": false,
+            "param": "body"
+        },
+        "successStatus": 200,
+        "scopes": [
+            "form_setting"
+        ],
+        "responseSchema": "EvaluationSetting"
+    },
+    "listFieldRules": {
+        "operationId": "listFieldRules",
+        "summary": "Show a form's field display rules",
+        "description": "Returns the form's effective field display rules (logic jumps). `index` is the 0-based position; field_rules updates and removals in PATCH /forms/{form_token} locate rules by this index.",
+        "tag": "Forms",
+        "method": "get",
+        "path": "/forms/{form_token}/field_rules",
+        "params": [
+            {
+                "name": "form_token",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "form_token"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "forms"
+        ]
+    },
+    "listExtendedAttributes": {
+        "operationId": "listExtendedAttributes",
+        "summary": "List the source-tracking links",
+        "description": "Returns the \"track entry source\" extended attributes generated for the form (oldest first), each with the fill link that carries its value.",
+        "tag": "Forms",
+        "method": "get",
+        "path": "/forms/{form_token}/extended_attributes",
+        "params": [
+            {
+                "name": "form_token",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "form_token"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "forms"
+        ]
+    },
+    "listFormCooperators": {
+        "operationId": "listFormCooperators",
+        "summary": "List a form's cooperators",
+        "description": "Returns the form's cooperators and their role names, including roles inherited from folders; when a user gets roles through several paths, only the nearest one is returned.",
+        "tag": "Forms",
+        "method": "get",
+        "path": "/forms/{form_token}/cooperators",
+        "params": [
+            {
+                "name": "form_token",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "form_token"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "forms"
+        ]
+    },
+    "copyForm": {
+        "operationId": "copyForm",
+        "summary": "Copy a form",
+        "description": "Copies the form and returns the new form (same shape as GET /forms/{form_token}). The new form's creator is the calling user (the account owner for an account token).\n- When the source form allows public copying (can_duplicated_in_public), the caller needs no access to the source form; otherwise a caller without access gets 404.\n- Returns 403 when the source form is frozen or its creator's account is disabled, with body `{ \"errors\": ..., \"status_code\": \"form_forbidden\" }` (not the common error shape).\n- `folder_token` takes a folder token or id; returns 404 when the folder does not exist or the caller lacks manage permission on it.\n- Returns 400 when copying fails (model validation does not pass).",
+        "tag": "Forms",
+        "method": "post",
+        "path": "/forms/{form_token}/copy",
+        "params": [
+            {
+                "name": "form_token",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "form_token"
+        ],
+        "body": {
+            "contentType": "application/json",
+            "required": false,
+            "flatten": true
+        },
+        "successStatus": 200,
+        "scopes": [
+            "forms"
+        ],
+        "responseSchema": "Form"
+    },
+    "moveFormToFolder": {
+        "operationId": "moveFormToFolder",
+        "summary": "Move a form into a folder",
+        "description": "Moves the form into a folder, or out of one (pass null as `folder_token`); PUT is accepted too. The move affects only the calling user's folder placement.\n- The request body must contain the `folder_token` key (its value may be null); otherwise 400.\n- `folder_token` takes only a folder token (not an id); returns 404 when the folder does not exist or the current user lacks manage permission on it.\n- The folder type (form / table) must match the form's type; otherwise 400.\n- To move a table, use `PATCH /tables/{table_token}/folder`.",
+        "tag": "Forms",
+        "method": "patch",
+        "path": "/forms/{form_token}/folder",
+        "params": [
+            {
+                "name": "form_token",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "form_token"
+        ],
+        "body": {
+            "contentType": "application/json",
+            "required": true,
+            "flatten": true
+        },
+        "successStatus": 200,
+        "scopes": [
+            "forms"
+        ],
+        "responseSchema": "FormFolderMoveResult"
+    },
+    "createWeixinOauthSession": {
+        "operationId": "createWeixinOauthSession",
+        "summary": "Exchange a WeChat authorization code for an openid",
+        "description": "Exchanges the `code` returned by WeChat web authorization for the user's openid, through the WeChat Official Account the form has selected.\nWhen the form's WeChat authorization scope is userinfo, also returns `unionid` (when WeChat returns one) and `profile`.\n- Returns 400 when the form has no WeChat Official Account configured or that account does not exist; returns 400 when `code` is missing.\n- Returns 502 when the exchange fails on the WeChat side (invalid code, etc.) or fetching the user info fails.",
+        "tag": "Forms",
+        "method": "post",
+        "path": "/forms/{form_token}/weixin_oauth_session",
+        "params": [
+            {
+                "name": "form_token",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "form_token"
+        ],
+        "body": {
+            "contentType": "application/json",
+            "required": true,
+            "flatten": true
+        },
+        "successStatus": 200,
+        "scopes": [
+            "write_entries"
+        ],
+        "responseSchema": "FormWeixinOauthSession"
+    },
+    "listFormViews": {
+        "operationId": "listFormViews",
+        "summary": "List a form's views",
+        "description": "Returns the views the caller can see on the form: views they created, and views whose visibility other cooperators set to cooperators; other users' personal views are not returned. The order follows the caller's own saved view order; views not in it are appended by position, then created_at.",
+        "tag": "Views",
+        "method": "get",
+        "path": "/forms/{form_token}/views",
+        "params": [
+            {
+                "name": "form_token",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "form_token"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "forms"
+        ]
+    },
+    "createFormView": {
+        "operationId": "createFormView",
+        "summary": "Create a view on a form",
+        "description": "Creates a new view on the form, created by the caller; visibility defaults to cooperators when not passed, and position is the highest position among the currently visible views plus 1. Each user can have at most 100 views on one form; at the limit, returns 422 (View limit reached). When view_type is kanban and kanban_group_by_api_code is not passed, the server picks the grouping field; when kanban_hidden_groups is not passed, the __unset__ group is hidden by default; when prefer_columns is empty, the form's default columns are used (at most 5 columns for a kanban view, serial_number included). Returns 422 when filter is invalid (not an array, unknown field, unsupported operator, invalid value). Returns 422 when model validation fails (e.g. name is empty or longer than 120 characters, or the grouping field does not support kanban grouping). Form views (view_type form): supported only on tables, otherwise 422; title defaults to the table name; without field_overrides, all fillable columns are selected in the current column order; published defaults to false (the fill link does not work while unpublished). title / description / published / field_overrides apply only to form views; using them on another type returns 422. Creating, updating or deleting a form view (including switching a view to or from a form view) requires the caller to hold a predefined role on the table that can add entries, otherwise 403; an account token is exempt. Returns 422 when a fill item's column does not exist, cannot be a fill item, or sets a validation its column type does not support; the error message names the column's api_code.",
+        "tag": "Views",
+        "method": "post",
+        "path": "/forms/{form_token}/views",
+        "params": [
+            {
+                "name": "form_token",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "form_token"
+        ],
+        "body": {
+            "contentType": "application/json",
+            "required": true,
+            "flatten": false,
+            "param": "body"
+        },
+        "successStatus": 201,
+        "scopes": [
+            "forms"
+        ],
+        "responseSchema": "FormView"
+    },
+    "getFormView": {
+        "operationId": "getFormView",
+        "summary": "Show a view of a form",
+        "description": "Returns one view. Only views visible to the caller can be read (created by the caller or visible to cooperators); another user's personal view returns 404 (View cannot be found).",
+        "tag": "Views",
+        "method": "get",
+        "path": "/forms/{form_token}/views/{view_token}",
+        "params": [
+            {
+                "name": "form_token",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "view_token",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "form_token",
+            "view_token"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "forms"
+        ],
+        "responseSchema": "FormView"
+    },
+    "updateFormView": {
+        "operationId": "updateFormView",
+        "summary": "Update a view of a form",
+        "description": "Updates the view's configuration; PUT is accepted too. Only the keys present in the request are updated: an empty array for filter clears the filters, and leaving filter out keeps them unchanged; when kanban_group_by_api_code changes and kanban_group_order / kanban_hidden_groups are not passed with it, those two lists reset to their defaults. Cooperators can change the configuration of a view visible to cooperators, but only the view's creator can switch visibility, otherwise returns 403; a view whose view_scope is form cannot switch visibility. Returns 422 when filter is invalid or model validation fails. field_overrides replaces the fill item settings as a whole; form views have the same permission requirements and parameter limits as on create.",
+        "tag": "Views",
+        "method": "patch",
+        "path": "/forms/{form_token}/views/{view_token}",
+        "params": [
+            {
+                "name": "form_token",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "view_token",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "form_token",
+            "view_token"
+        ],
+        "body": {
+            "contentType": "application/json",
+            "required": true,
+            "flatten": false,
+            "param": "body"
+        },
+        "successStatus": 200,
+        "scopes": [
+            "forms"
+        ],
+        "responseSchema": "FormView"
+    },
+    "deleteFormView": {
+        "operationId": "deleteFormView",
+        "summary": "Delete a view of a form",
+        "description": "Deletes a view. Predefined views (predefined) and views whose view_scope is form cannot be deleted, and the deletion is also refused when it would leave the caller with no visible view; all of these return 422. Deleting a form view needs the same permission as creating one (otherwise 403); once it is deleted, its fill link stops working immediately, and this cannot be undone.",
+        "tag": "Views",
+        "method": "delete",
+        "path": "/forms/{form_token}/views/{view_token}",
+        "params": [
+            {
+                "name": "form_token",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "view_token",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "form_token",
+            "view_token"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "forms"
+        ]
+    },
+    "listFormViewEntries": {
+        "operationId": "listFormViewEntries",
+        "summary": "List a view's entries",
+        "description": "Returns the form's entries under the view's filters and sort rules, at most 50 per page. The returned fields are limited to those in the view's prefer_columns (serial_number always included); when prefer_columns is empty, all pushable fields are returned. Sorting follows the view's sort rules, with serial_number ascending appended when they do not include serial_number. Paginate with the next parameter (a row offset); next is null on the last page. Returns 400 when the view's filters use an operator the query engine does not support. Only views visible to the caller are accessible, otherwise 404 (View cannot be found).",
+        "tag": "Views",
+        "method": "get",
+        "path": "/forms/{form_token}/views/{view_token}/entries",
+        "params": [
+            {
+                "name": "form_token",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "view_token",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "next",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "include_labels",
+                "in": "query",
+                "required": false
+            }
+        ],
+        "paramNames": [
+            "form_token",
+            "view_token",
+            "next",
+            "include_labels"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "read_entries"
+        ],
+        "responseSchema": "EntryListResponse"
+    },
+    "uploadEntryAttachment": {
+        "operationId": "uploadEntryAttachment",
+        "summary": "Upload an entry attachment",
+        "description": "Uploads a file ahead of time for a form's attachment field (or an attachment column in a table field) and returns the attachment ID; then, when creating / updating an entry, put that ID (or the upload token) into the matching field to bind it. An uploaded attachment that no entry references stays unused.\nAuthenticate in one of two ways:\n1. Regular API credentials (a Bearer token).\n2. A one-time upload token `attachment_token` (instead of regular credentials): the token starts with `entry_att_tok_`, is valid for 30 minutes, can be used only once, and is bound to the form, field, column and file metadata. When the request carries `attachment_token`, regular credentials are not checked and the request acts as the token's user; returns 400 `attachment_token is invalid or expired; prepare upload again` when the token is invalid, expired, already used, its user has been deleted, or it does not match the requested form / field / column; also returns 400 when the uploaded file's name, Content-Type or byte size does not match the token.\nReturns 401 when there are neither credentials nor `attachment_token`.\nSend the file content in one of two ways: the `file` field of `multipart/form-data`; or a Base64 string in the `base64` (or `data`) field of a JSON / form-encoded body (a `data:<mime>;base64,` prefix is allowed), with `file_name` (or `filename`) and `content_type`. Base64 content cannot exceed 5 MB once decoded; larger returns 400 `attachment exceeds 5MB limit`, and a decoding failure returns 400 `base64 is invalid`; returns 400 `file or base64 is required` when neither is given.\n`field_api_code` must point to an attachment field or a table field; for a table field, `dimension_api_code` must also be passed and point to an attachment column in that table field, otherwise returns 400; returns 404 when the field or column does not exist.\nThe file size is capped by the per-file limit set on the field (or column); a larger file returns 422, with the specific validation message in `error_description` (e.g. `文件超过了10 MB`); returns 422 `上传失败，请重试` when uploading to object storage fails (the server's wording is authoritative).\nReturns 404 `form cannot be found` when the form does not exist or is not accessible to the current identity.",
+        "tag": "Uploads",
+        "method": "post",
+        "path": "/forms/{form_token}/entry_attachments",
+        "params": [
+            {
+                "name": "form_token",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "form_token"
+        ],
+        "body": {
+            "contentType": "application/json",
+            "required": true,
+            "flatten": true
+        },
+        "successStatus": 201,
+        "scopes": [
+            "write_entries"
+        ],
+        "responseSchema": "UploadedEntryAttachment"
+    },
+    "uploadImportFile": {
+        "operationId": "uploadImportFile",
+        "summary": "Upload an import file",
+        "description": "Uploads a spreadsheet file (`.xlsx` / `.xls` / `.csv`) for bulk-importing entries into the given form, and returns the import attachment ID; then pass it as `attachment_id` to \"Import entries from an uploaded spreadsheet\" (`POST /forms/{form_token}/entry_imports`) to start the import.\nAuthenticate in one of two ways:\n1. Regular API credentials (a Bearer token).\n2. A one-time upload token `import_file_token` (instead of regular credentials): the token starts with `import_file_tok_`, is valid for 30 minutes, can be used only once, and is bound to the form and the file metadata. When the request carries `import_file_token`, regular credentials are not checked, and the request acts as the user the token belongs to; the uploaded file's original file name, Content-Type and byte size must match what the token recorded, otherwise returns 400. Returns 400 `import_file_token is invalid or expired; prepare upload again` when the token does not exist, has expired, has been used, or its user has been deleted; returns 400 `import_file_token was issued for another form; prepare upload again` when the token belongs to another form.\nReturns 401 when there are neither credentials nor an `import_file_token`.\nThe request must be `multipart/form-data`, with the file in the `file` field; a missing file returns 400 `file is required`.\nThe file size is capped by the plan's Excel import limit (in MB), and the extension must be xls / xlsx / csv; otherwise returns 422, with the validation details in `error_description` (with an upload token, the token stays usable, so the file can be uploaded again).\nReturns 404 `form cannot be found` when the form does not exist or is not accessible to the current caller.",
+        "tag": "Uploads",
+        "method": "post",
+        "path": "/forms/{form_token}/import_files",
+        "params": [
+            {
+                "name": "form_token",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "form_token"
+        ],
+        "body": {
+            "contentType": "multipart/form-data",
+            "required": true,
+            "flatten": true
+        },
+        "successStatus": 201,
+        "scopes": [
+            "write_entries"
+        ],
+        "responseSchema": "UploadedImportFile"
+    },
+    "createEntryImport": {
+        "operationId": "createEntryImport",
+        "summary": "Import entries from an uploaded spreadsheet",
+        "description": "Appends each row of a spreadsheet uploaded with \"Upload an import file\" as an entry of this form. Upload the file first to get the import attachment ID (`attachment_id`), then say here which column goes into which field.\nProblems that can be detected up front, such as the file, the plan's import limit, the header row and the column mapping, are checked before the job is created; a rejected import writes no entries. Error messages include the spreadsheet's actual layout (row and column range, and the header contents), so the request can be fixed and retried.\nOnce validation passes, returns `201` and the entries are written in the background: `201` means the job has started, not finished; poll \"Show an entry import job\" for the result.\n- `attachment_id` must be an import file the current user uploaded for this form, otherwise returns 400 (the file cannot be found; upload it again); returns 400 when the file is not xls / xlsx / csv or cannot be read.\n- `columns` must not be empty; each item names the target field with `field_api_code`, and the source column with `column_label` (the header text, which must exactly match the header cell after trimming leading and trailing spaces) or `sheet_column_index` (the column number); when both are given, `sheet_column_index` wins.\n- The field must be one this form can import into; one field cannot map to several columns; when several header columns share a name, use `sheet_column_index` instead; the column number must be within the spreadsheet's column range.\n- `header_row_index` defaults to the first row of the spreadsheet, and there must be data rows below it.\n- Every required field of the form must have a column, otherwise returns 400 listing the missing fields.\n- `unique_field_code` names a field to deduplicate on: when a row's value for that field already exists in the form's entries, the row is skipped (counted in `skip_count`).\n- Returns 404 `form cannot be found` when the form does not exist or is not accessible to the current caller.",
+        "tag": "Entries",
+        "method": "post",
+        "path": "/forms/{form_token}/entry_imports",
+        "params": [
+            {
+                "name": "form_token",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "form_token"
+        ],
+        "body": {
+            "contentType": "application/json",
+            "required": true,
+            "flatten": true
+        },
+        "successStatus": 201,
+        "scopes": [
+            "write_entries"
+        ],
+        "responseSchema": "EntryImportCreated"
+    },
+    "getEntryImport": {
+        "operationId": "getEntryImport",
+        "summary": "Show an entry import job",
+        "description": "Returns the progress and result of an entry import job. While `status` is `pending` / `running`, the job is still in progress, and `processed_rows` and `total_rows` can be used to show progress;\n`success` / `failed` / `cancelled` are final states; `imported_count` / `skip_count` / `invalid_count` are the numbers of rows written, skipped and failing validation, `warnings` holds per-row notices, and `error_message` is why the job failed.\nA job can be read only through the form it imports into: when the id does not exist, is not a valid id, or belongs to another form, returns 404 `Import job not found for this form — check the id, and that it belongs to this form.`.\nReturns 404 `form cannot be found` when the form does not exist or is not accessible to the current caller.",
+        "tag": "Entries",
+        "method": "get",
+        "path": "/forms/{form_token}/entry_imports/{id}",
+        "params": [
+            {
+                "name": "form_token",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "id",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "form_token",
+            "id"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "write_entries"
+        ],
+        "responseSchema": "EntryImportJob"
+    },
+    "uploadFormImage": {
+        "operationId": "uploadFormImage",
+        "summary": "Upload a form image",
+        "description": "Uploads an image that belongs to the form itself (a picture choice image, a header image, a background image, one frame of the header carousel, the header image of the form's public query page, or an inline image in the form description / a field description), and returns the image attachment ID. The image is not bound to any form yet; it takes effect only when a form or theme references it later.\nAuthenticate in one of two ways:\n1. Regular API credentials (a Bearer token). `image_type` must then say what the image is for, and can only be `header` (header image), `wallpaper` (background image), `opensearch_header` (public query page header image) or `description` (inline description image): pass the returned `attachment_id` to `header.header_image_attachment_id` / `wallpaper.background_image_attachment_id` of \"Update a form's theme\", or to `header.background_image.attachment_id` of \"Update a public query\"; `description` also returns the image address `url`, which goes into the `<img src>` of the form `description` or of a field's `notes`. When the form is saved, the image belongs to that form (at most 30 per form); images not used by any form within 7 days are cleaned up. Returns 400 `image_type must be one of: field_choice, header, wallpaper, carousel, opensearch_header, description.` when `image_type` is missing or not one of `field_choice` / `header` / `wallpaper` / `carousel` / `opensearch_header` / `description`; `field_choice` / `carousel` have nowhere that accepts an attachment ID, so they can only be uploaded with an upload token, otherwise returns 400.\n2. A one-time upload token `form_image_token` (instead of regular credentials): the token starts with `form_img_tok_`, is valid for 30 minutes, can be used only once, and has already recorded the image purpose (`field_choice` / `header` / `wallpaper` / `carousel` / `opensearch_header` / `description`; `image_type` is then ignored) and the file metadata; the uploaded file's original file name, Content-Type and byte size must match what the token recorded, otherwise returns 400. After a successful upload, do not use the returned `attachment_id` directly; instead reference the same token in a choice's `image_upload_token` in \"Create a form\" / \"Edit a form\", in `header.header_image_upload_token` / `wallpaper.background_image_upload_token` / `header.carousel_images[].image_upload_token` of \"Update a form's theme\", or in `header.background_image.image_upload_token` of \"Update a public query\"; for the `description` purpose nothing references the token, so use the returned `url` directly. Returns 400 `form_image_token is invalid or expired; prepare upload again` when the token does not exist, has expired, has been used, or its user has been deleted.\nReturns 401 when there are neither credentials nor a `form_image_token`. The request must be `multipart/form-data`, with the image binary in the `file` field; a missing file returns 400 `file is required`.",
+        "tag": "Uploads",
+        "method": "post",
+        "path": "/form_image_attachments",
+        "params": [],
+        "paramNames": [],
+        "body": {
+            "contentType": "multipart/form-data",
+            "required": true,
+            "flatten": true
+        },
+        "successStatus": 201,
+        "scopes": [
+            "forms",
+            "form_setting"
+        ],
+        "responseSchema": "UploadedFormImage"
+    },
+    "listTables": {
+        "operationId": "listTables",
+        "summary": "List tables",
+        "description": "Returns the tables (`kind=table`) visible to the current caller. Pagination, `q`, `filters`, `sort`, `next`, `skip` and `limit` mean the same as in the form list; 50 per page by default, up to 1000.",
+        "tag": "Tables",
+        "method": "get",
+        "path": "/tables",
+        "params": [
+            {
+                "name": "q",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "filters",
+                "in": "query",
+                "required": false,
+                "json": true
+            },
+            {
+                "name": "sort",
+                "in": "query",
+                "required": false,
+                "json": true
+            },
+            {
+                "name": "next",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "skip",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "limit",
+                "in": "query",
+                "required": false
+            }
+        ],
+        "paramNames": [
+            "q",
+            "filters",
+            "sort",
+            "next",
+            "skip",
+            "limit"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "forms"
+        ],
+        "responseSchema": "TableListResponse"
+    },
+    "createTable": {
+        "operationId": "createTable",
+        "summary": "Create a table",
+        "description": "Creates a table. Same as creating a form, except:\n- field types can only be the column types tables support: `TextArea`, `RadioButton`, `CheckBox`, `BooleanField`, `MobileField`, `NumberField`, `DateTimeField`, `EmailField`, `LinkField`, `AttachmentField`, `FormulaField`, `RelationField`;\n- attachment columns do not accept limit properties such as count / size limits, and number / formula columns have limited precision; a violation returns 400 listing the offending columns;\n- choice columns do not get an \"Other\" choice; `folder_token` must be a table folder; `layout` is not supported.\n- with `with_default_entries: true`, 3 blank entries are added after creation (as when creating a table in the product); by default none are added.\nReturns the table structure, including fields and views.",
+        "tag": "Tables",
+        "method": "post",
+        "path": "/tables",
+        "params": [],
+        "paramNames": [],
+        "body": {
+            "contentType": "application/json",
+            "required": true,
+            "flatten": true
+        },
+        "successStatus": 201,
+        "scopes": [
+            "forms"
+        ],
+        "responseSchema": "Table"
+    },
+    "getTable": {
+        "operationId": "getTable",
+        "summary": "Show a table's structure",
+        "description": "Returns the table's basic information, field definitions and the views visible to the current caller. Returns 404 `table cannot be found` when the token is not a table (for example, a regular form).",
+        "tag": "Tables",
+        "method": "get",
+        "path": "/tables/{table_token}",
+        "params": [
+            {
+                "name": "table_token",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "include_analytics",
+                "in": "query",
+                "required": false
+            }
+        ],
+        "paramNames": [
+            "table_token",
+            "include_analytics"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "forms"
+        ],
+        "responseSchema": "Table"
+    },
+    "updateTable": {
+        "operationId": "updateTable",
+        "summary": "Edit a table",
+        "description": "Edits a table incrementally; `PUT` is also accepted. The request body is the same as for editing a form (`kind` is ignored); attachment columns in `fields.add` and `fields.update` do not accept limit properties, and types in `fields.add` must be column types tables support.",
+        "tag": "Tables",
+        "method": "patch",
+        "path": "/tables/{table_token}",
+        "params": [
+            {
+                "name": "table_token",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "table_token"
+        ],
+        "body": {
+            "contentType": "application/json",
+            "required": true,
+            "flatten": true
+        },
+        "successStatus": 200,
+        "scopes": [
+            "forms"
+        ],
+        "responseSchema": "Table"
+    },
+    "deleteTable": {
+        "operationId": "deleteTable",
+        "summary": "Delete a table",
+        "description": "Deletes a table and its entries; on success, returns the table token.",
+        "tag": "Tables",
+        "method": "delete",
+        "path": "/tables/{table_token}",
+        "params": [
+            {
+                "name": "table_token",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "table_token"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "forms"
+        ]
+    },
+    "checkTableFieldData": {
+        "operationId": "checkTableFieldData",
+        "summary": "Check whether table columns already hold data",
+        "description": "Same as GET /forms/{form_token}/fields/check, applied to the columns of a table. Returns 404 (`table cannot be found`) when `table_token` does not point to a table.",
+        "tag": "Tables",
+        "method": "get",
+        "path": "/tables/{table_token}/fields/check",
+        "params": [
+            {
+                "name": "table_token",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "checks",
+                "in": "query",
+                "required": true,
+                "json": true
+            }
+        ],
+        "paramNames": [
+            "table_token",
+            "checks"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "forms"
+        ],
+        "responseSchema": "FieldDataCheckResponse"
+    },
+    "previewTableFieldTypeChange": {
+        "operationId": "previewTableFieldTypeChange",
+        "summary": "Preview a table column type change",
+        "description": "Same as GET /forms/{form_token}/fields/preview_convert, applied to the columns of a table; `target_type` accepts only column types tables support (see `GET /field_types?kind=table`).\nReturns 404 (`table cannot be found`) when `table_token` does not point to a table.",
+        "tag": "Tables",
+        "method": "get",
+        "path": "/tables/{table_token}/fields/preview_convert",
+        "params": [
+            {
+                "name": "table_token",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "checks",
+                "in": "query",
+                "required": true,
+                "json": true
+            }
+        ],
+        "paramNames": [
+            "table_token",
+            "checks"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "forms"
+        ],
+        "responseSchema": "FieldTypeChangePreviewResponse"
+    },
+    "listTableEntries": {
+        "operationId": "listTableEntries",
+        "summary": "List table entries",
+        "description": "Exactly the same as `GET /forms/{form_token}/entries`, except that the target must be a table (otherwise 404 `table cannot be found`).",
+        "tag": "Tables",
+        "method": "get",
+        "path": "/tables/{table_token}/entries",
+        "params": [
+            {
+                "name": "table_token",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "fields",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "filters",
+                "in": "query",
+                "required": false,
+                "json": true
+            },
+            {
+                "name": "keyword",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "sort",
+                "in": "query",
+                "required": false,
+                "json": true
+            },
+            {
+                "name": "created_at",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "next",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "skip",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "include_labels",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "limit",
+                "in": "query",
+                "required": false
+            }
+        ],
+        "paramNames": [
+            "table_token",
+            "fields",
+            "filters",
+            "keyword",
+            "sort",
+            "created_at",
+            "next",
+            "skip",
+            "include_labels",
+            "limit"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "read_entries"
+        ],
+        "responseSchema": "EntryListResponse"
+    },
+    "createTableEntry": {
+        "operationId": "createTableEntry",
+        "summary": "Create a table entry",
+        "description": "Same as `POST /forms/{form_token}/entries`.",
+        "tag": "Tables",
+        "method": "post",
+        "path": "/tables/{table_token}/entries",
+        "params": [
+            {
+                "name": "table_token",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "table_token"
+        ],
+        "body": {
+            "contentType": "application/json",
+            "required": true,
+            "flatten": false,
+            "param": "body"
+        },
+        "successStatus": 201,
+        "scopes": [
+            "write_entries"
+        ],
+        "responseSchema": "Entry"
+    },
+    "countTableEntries": {
+        "operationId": "countTableEntries",
+        "summary": "Count table entries",
+        "description": "Exactly the same as `GET /forms/{form_token}/entries/count`, except that the target must be a table (otherwise 404 `table cannot be found`).",
+        "tag": "Tables",
+        "method": "get",
+        "path": "/tables/{table_token}/entries/count",
+        "params": [
+            {
+                "name": "table_token",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "filters",
+                "in": "query",
+                "required": false,
+                "json": true
+            },
+            {
+                "name": "keyword",
+                "in": "query",
+                "required": false
+            }
+        ],
+        "paramNames": [
+            "table_token",
+            "filters",
+            "keyword"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "read_entries"
+        ],
+        "responseSchema": "EntryCountResponse"
+    },
+    "aggregateTableEntries": {
+        "operationId": "aggregateTableEntries",
+        "summary": "Aggregate table entries",
+        "description": "Exactly the same as `GET /forms/{form_token}/entries/aggregate`, except that the target must be a table (otherwise 404 `table cannot be found`).\nFor the functions and groupings each field supports, see `GET /tables/{table_token}?include_analytics=true`.",
+        "tag": "Tables",
+        "method": "get",
+        "path": "/tables/{table_token}/entries/aggregate",
+        "params": [
+            {
+                "name": "table_token",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "metrics",
+                "in": "query",
+                "required": false,
+                "json": true
+            },
+            {
+                "name": "dimensions",
+                "in": "query",
+                "required": false,
+                "json": true
+            },
+            {
+                "name": "limit",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "filters",
+                "in": "query",
+                "required": false,
+                "json": true
+            },
+            {
+                "name": "keyword",
+                "in": "query",
+                "required": false
+            }
+        ],
+        "paramNames": [
+            "table_token",
+            "metrics",
+            "dimensions",
+            "limit",
+            "filters",
+            "keyword"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "read_entries"
+        ],
+        "responseSchema": "EntryAggregateResponse"
+    },
+    "summarizeTableEntries": {
+        "operationId": "summarizeTableEntries",
+        "summary": "Summarize table entries",
+        "description": "Exactly the same as `GET /forms/{form_token}/entries/summary`, except that the target must be a table (otherwise 404 `table cannot be found`).",
+        "tag": "Tables",
+        "method": "get",
+        "path": "/tables/{table_token}/entries/summary",
+        "params": [
+            {
+                "name": "table_token",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "fields",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "include_overview",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "filters",
+                "in": "query",
+                "required": false,
+                "json": true
+            },
+            {
+                "name": "keyword",
+                "in": "query",
+                "required": false
+            }
+        ],
+        "paramNames": [
+            "table_token",
+            "fields",
+            "include_overview",
+            "filters",
+            "keyword"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "read_entries"
+        ],
+        "responseSchema": "EntrySummaryResponse"
+    },
+    "countTableViewEntries": {
+        "operationId": "countTableViewEntries",
+        "summary": "Count the entries of a view",
+        "description": "Exactly the same as `GET /forms/{form_token}/views/{view_token}/entries/count`, except that the target must be a table (otherwise 404 `table cannot be found`).",
+        "tag": "Tables",
+        "method": "get",
+        "path": "/tables/{table_token}/views/{view_token}/entries/count",
+        "params": [
+            {
+                "name": "table_token",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "view_token",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "filters",
+                "in": "query",
+                "required": false,
+                "json": true
+            },
+            {
+                "name": "keyword",
+                "in": "query",
+                "required": false
+            }
+        ],
+        "paramNames": [
+            "table_token",
+            "view_token",
+            "filters",
+            "keyword"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "read_entries"
+        ],
+        "responseSchema": "EntryCountResponse"
+    },
+    "aggregateTableViewEntries": {
+        "operationId": "aggregateTableViewEntries",
+        "summary": "Aggregate the entries of a view",
+        "description": "Exactly the same as `GET /forms/{form_token}/views/{view_token}/entries/aggregate`, except that the target must be a table (otherwise 404 `table cannot be found`).",
+        "tag": "Tables",
+        "method": "get",
+        "path": "/tables/{table_token}/views/{view_token}/entries/aggregate",
+        "params": [
+            {
+                "name": "table_token",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "view_token",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "metrics",
+                "in": "query",
+                "required": false,
+                "json": true
+            },
+            {
+                "name": "dimensions",
+                "in": "query",
+                "required": false,
+                "json": true
+            },
+            {
+                "name": "limit",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "filters",
+                "in": "query",
+                "required": false,
+                "json": true
+            },
+            {
+                "name": "keyword",
+                "in": "query",
+                "required": false
+            }
+        ],
+        "paramNames": [
+            "table_token",
+            "view_token",
+            "metrics",
+            "dimensions",
+            "limit",
+            "filters",
+            "keyword"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "read_entries"
+        ],
+        "responseSchema": "EntryAggregateResponse"
+    },
+    "summarizeTableViewEntries": {
+        "operationId": "summarizeTableViewEntries",
+        "summary": "Summarize the entries of a view",
+        "description": "Exactly the same as `GET /forms/{form_token}/views/{view_token}/entries/summary`, except that the target must be a table (otherwise 404 `table cannot be found`).",
+        "tag": "Tables",
+        "method": "get",
+        "path": "/tables/{table_token}/views/{view_token}/entries/summary",
+        "params": [
+            {
+                "name": "table_token",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "view_token",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "fields",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "include_overview",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "filters",
+                "in": "query",
+                "required": false,
+                "json": true
+            },
+            {
+                "name": "keyword",
+                "in": "query",
+                "required": false
+            }
+        ],
+        "paramNames": [
+            "table_token",
+            "view_token",
+            "fields",
+            "include_overview",
+            "filters",
+            "keyword"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "read_entries"
+        ],
+        "responseSchema": "EntrySummaryResponse"
+    },
+    "getTableEntry": {
+        "operationId": "getTableEntry",
+        "summary": "Show a table entry",
+        "description": "Same as `GET /forms/{form_token}/entries/{serial_number}`.",
+        "tag": "Tables",
+        "method": "get",
+        "path": "/tables/{table_token}/entries/{serial_number}",
+        "params": [
+            {
+                "name": "table_token",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "serial_number",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "fields",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "include_labels",
+                "in": "query",
+                "required": false
+            }
+        ],
+        "paramNames": [
+            "table_token",
+            "serial_number",
+            "fields",
+            "include_labels"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "read_entries"
+        ],
+        "responseSchema": "Entry"
+    },
+    "updateTableEntryViaPost": {
+        "operationId": "updateTableEntryViaPost",
+        "summary": "Partially update a table entry (POST)",
+        "description": "A POST alias for `PATCH` on the same path; it performs an incremental update.",
+        "tag": "Tables",
+        "method": "post",
+        "path": "/tables/{table_token}/entries/{serial_number}",
+        "params": [
+            {
+                "name": "table_token",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "serial_number",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "table_token",
+            "serial_number"
+        ],
+        "body": {
+            "contentType": "application/json",
+            "required": true,
+            "flatten": false,
+            "param": "body"
+        },
+        "successStatus": 200,
+        "scopes": [
+            "write_entries"
+        ],
+        "responseSchema": "Entry"
+    },
+    "replaceTableEntry": {
+        "operationId": "replaceTableEntry",
+        "summary": "Replace a table entry",
+        "description": "Same as `PUT /forms/{form_token}/entries/{serial_number}` (full replacement).",
+        "tag": "Tables",
+        "method": "put",
+        "path": "/tables/{table_token}/entries/{serial_number}",
+        "params": [
+            {
+                "name": "table_token",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "serial_number",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "table_token",
+            "serial_number"
+        ],
+        "body": {
+            "contentType": "application/json",
+            "required": true,
+            "flatten": false,
+            "param": "body"
+        },
+        "successStatus": 200,
+        "scopes": [
+            "write_entries"
+        ],
+        "responseSchema": "Entry"
+    },
+    "updateTableEntry": {
+        "operationId": "updateTableEntry",
+        "summary": "Partially update a table entry",
+        "description": "Same as `PATCH /forms/{form_token}/entries/{serial_number}` (incremental update).",
+        "tag": "Tables",
+        "method": "patch",
+        "path": "/tables/{table_token}/entries/{serial_number}",
+        "params": [
+            {
+                "name": "table_token",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "serial_number",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "table_token",
+            "serial_number"
+        ],
+        "body": {
+            "contentType": "application/json",
+            "required": true,
+            "flatten": false,
+            "param": "body"
+        },
+        "successStatus": 200,
+        "scopes": [
+            "write_entries"
+        ],
+        "responseSchema": "Entry"
+    },
+    "deleteTableEntry": {
+        "operationId": "deleteTableEntry",
+        "summary": "Delete a table entry",
+        "description": "Same as `DELETE /forms/{form_token}/entries/{serial_number}`.",
+        "tag": "Tables",
+        "method": "delete",
+        "path": "/tables/{table_token}/entries/{serial_number}",
+        "params": [
+            {
+                "name": "table_token",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "serial_number",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "table_token",
+            "serial_number"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "write_entries"
+        ]
+    },
+    "listTableEntryComments": {
+        "operationId": "listTableEntryComments",
+        "summary": "List a table entry's comments",
+        "description": "Returns all comments on this table entry in ascending order of creation time, under the same rules as form entry comments. Returns 404 (table cannot be found) when the token is not a table.",
+        "tag": "Comments",
+        "method": "get",
+        "path": "/tables/{table_token}/entries/{serial_number}/comments",
+        "params": [
+            {
+                "name": "table_token",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "serial_number",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "table_token",
+            "serial_number"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "read_entries"
+        ]
+    },
+    "createTableEntryComment": {
+        "operationId": "createTableEntryComment",
+        "summary": "Comment on a table entry",
+        "description": "Creates a comment on this table entry, with the same parameters and limits as form entry comments (content is required, at most 2000 characters, mentioned users must be cooperators, parent_id must belong to the same entry). Returns 404 (table cannot be found) when the token is not a table.",
+        "tag": "Comments",
+        "method": "post",
+        "path": "/tables/{table_token}/entries/{serial_number}/comments",
+        "params": [
+            {
+                "name": "table_token",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "serial_number",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "table_token",
+            "serial_number"
+        ],
+        "body": {
+            "contentType": "application/json",
+            "required": true,
+            "flatten": true
+        },
+        "successStatus": 201,
+        "scopes": [
+            "read_entries"
+        ],
+        "responseSchema": "EntryComment"
+    },
+    "updateTableEntryComment": {
+        "operationId": "updateTableEntryComment",
+        "summary": "Update a comment on a table entry",
+        "description": "Changes the content of a table entry comment; PUT is also accepted. Only the comment's author can edit it, otherwise returns 400; returns 404 when the comment does not belong to this entry. Returns 404 (table cannot be found) when the token is not a table.",
+        "tag": "Comments",
+        "method": "patch",
+        "path": "/tables/{table_token}/entries/{serial_number}/comments/{comment_id}",
+        "params": [
+            {
+                "name": "table_token",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "serial_number",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "comment_id",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "table_token",
+            "serial_number",
+            "comment_id"
+        ],
+        "body": {
+            "contentType": "application/json",
+            "required": true,
+            "flatten": true
+        },
+        "successStatus": 200,
+        "scopes": [
+            "read_entries"
+        ],
+        "responseSchema": "EntryComment"
+    },
+    "deleteTableEntryComment": {
+        "operationId": "deleteTableEntryComment",
+        "summary": "Delete a comment on a table entry",
+        "description": "Deletes a table entry comment. The comment's author, the table's creator, or a cooperator with the admin role can delete it; other cooperators get 400; a comment already deleted returns 404. Returns 404 (table cannot be found) when the token is not a table.",
+        "tag": "Comments",
+        "method": "delete",
+        "path": "/tables/{table_token}/entries/{serial_number}/comments/{comment_id}",
+        "params": [
+            {
+                "name": "table_token",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "serial_number",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "comment_id",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "table_token",
+            "serial_number",
+            "comment_id"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "read_entries"
+        ]
+    },
+    "listTableViews": {
+        "operationId": "listTableViews",
+        "summary": "List a table's views",
+        "description": "Returns the views of this table visible to the current caller, under the same rules as listing form views. Returns 404 (table cannot be found) when the token is not a table (kind is not table).",
+        "tag": "Views",
+        "method": "get",
+        "path": "/tables/{table_token}/views",
+        "params": [
+            {
+                "name": "table_token",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "table_token"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "forms"
+        ]
+    },
+    "createTableView": {
+        "operationId": "createTableView",
+        "summary": "Create a view on a table",
+        "description": "Creates a view on a table, with the same parameters and limits as creating a form view (at most 100 views per user per table, name at most 120 characters, an invalid filter returns 422). Returns 404 (table cannot be found) when the token is not a table. view_type can be form (a form view, a public fill page); see creating a form view for the rules.",
+        "tag": "Views",
+        "method": "post",
+        "path": "/tables/{table_token}/views",
+        "params": [
+            {
+                "name": "table_token",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "table_token"
+        ],
+        "body": {
+            "contentType": "application/json",
+            "required": true,
+            "flatten": false,
+            "param": "body"
+        },
+        "successStatus": 201,
+        "scopes": [
+            "forms"
+        ],
+        "responseSchema": "FormView"
+    },
+    "getTableView": {
+        "operationId": "getTableView",
+        "summary": "Show a view of a table",
+        "description": "Returns one table view; only views visible to the caller can be read. Returns 404 (table cannot be found) when the token is not a table.",
+        "tag": "Views",
+        "method": "get",
+        "path": "/tables/{table_token}/views/{view_token}",
+        "params": [
+            {
+                "name": "table_token",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "view_token",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "table_token",
+            "view_token"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "forms"
+        ],
+        "responseSchema": "FormView"
+    },
+    "updateTableView": {
+        "operationId": "updateTableView",
+        "summary": "Update a view of a table",
+        "description": "Updates a table view's settings; PUT is also accepted. The rules are the same as for updating a form view: only the creator can change visibility (otherwise 403), and a filter or model validation failure returns 422. Returns 404 (table cannot be found) when the token is not a table.",
+        "tag": "Views",
+        "method": "patch",
+        "path": "/tables/{table_token}/views/{view_token}",
+        "params": [
+            {
+                "name": "table_token",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "view_token",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "table_token",
+            "view_token"
+        ],
+        "body": {
+            "contentType": "application/json",
+            "required": true,
+            "flatten": false,
+            "param": "body"
+        },
+        "successStatus": 200,
+        "scopes": [
+            "forms"
+        ],
+        "responseSchema": "FormView"
+    },
+    "deleteTableView": {
+        "operationId": "deleteTableView",
+        "summary": "Delete a view of a table",
+        "description": "Deletes a table view. Predefined views, views whose view_scope is form, and the caller's last visible view cannot be deleted; these return 422. Returns 404 (table cannot be found) when the token is not a table. Deleting a form view requires a predefined role that can add entries (otherwise 403); once deleted, its fill link stops working immediately, and this cannot be undone.",
+        "tag": "Views",
+        "method": "delete",
+        "path": "/tables/{table_token}/views/{view_token}",
+        "params": [
+            {
+                "name": "table_token",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "view_token",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "table_token",
+            "view_token"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "forms"
+        ]
+    },
+    "listTableViewEntries": {
+        "operationId": "listTableViewEntries",
+        "summary": "List a table view's entries",
+        "description": "Returns entries using the table view's filters and sort, at most 50 per page; pagination and the rules for which fields are returned are the same as for form view entries. Returns 404 (table cannot be found) when the token is not a table.",
+        "tag": "Views",
+        "method": "get",
+        "path": "/tables/{table_token}/views/{view_token}/entries",
+        "params": [
+            {
+                "name": "table_token",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "view_token",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "next",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "include_labels",
+                "in": "query",
+                "required": false
+            }
+        ],
+        "paramNames": [
+            "table_token",
+            "view_token",
+            "next",
+            "include_labels"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "read_entries"
+        ],
+        "responseSchema": "EntryListResponse"
+    },
+    "listCheckinCampaigns": {
+        "operationId": "listCheckinCampaigns",
+        "summary": "List check-in campaigns",
+        "description": "Lists the check-in campaigns the caller created, newest first. With an account-level credential, returns the ones the account owner created.",
+        "tag": "Plugins",
+        "method": "get",
+        "path": "/plugins/checkin/campaigns",
+        "params": [
+            {
+                "name": "form_token",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "limit",
+                "in": "query",
+                "required": false
+            }
+        ],
+        "paramNames": [
+            "form_token",
+            "limit"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "form_setting"
+        ]
+    },
+    "createCheckinCampaign": {
+        "operationId": "createCheckinCampaign",
+        "summary": "Create a check-in campaign",
+        "description": "Turns check-in on for a form. The caller must be able to reach the form.\n- Same limits as picking a form in the web app: returns 400 when the form has WeChat red envelope, lucky wheel, certificate or confirmation code on, is bound to a plugin that takes over the after-submit redirect (a check-in campaign with a check-in code included), or its after-submit action is not the default message. Turn that off first.\n- Only one check-in campaign is in effect on a form at a time; creating one turns off the one that was in effect.\n- Without `checkin_field_api_code`, the form's first mobile field is used, then its first name field; with neither, returns 400. The check-in field cannot be changed afterwards.\n- The campaign belongs to the caller, or to the account owner with an account-level credential. The caller is also added as a verifier.\n- `enable_checkin_code` (on by default) rewrites the form's after-submit redirect and data push URL to the check-in code page, and overrides any Webhook already on the form (and the other way round).",
+        "tag": "Plugins",
+        "method": "post",
+        "path": "/plugins/checkin/campaigns",
+        "params": [],
+        "paramNames": [],
+        "body": {
+            "contentType": "application/json",
+            "required": true,
+            "flatten": true
+        },
+        "successStatus": 201,
+        "scopes": [
+            "form_setting"
+        ],
+        "responseSchema": "CheckinCampaign"
+    },
+    "getCheckinCampaign": {
+        "operationId": "getCheckinCampaign",
+        "summary": "Get a check-in campaign",
+        "description": "Returns the campaign's settings, how many have checked in, and its check-in, verifier invite and management links. Only campaigns the caller created.",
+        "tag": "Plugins",
+        "method": "get",
+        "path": "/plugins/checkin/campaigns/{id}",
+        "params": [
+            {
+                "name": "id",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "id"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "form_setting"
+        ],
+        "responseSchema": "CheckinCampaign"
+    },
+    "updateCheckinCampaign": {
+        "operationId": "updateCheckinCampaign",
+        "summary": "Update a check-in campaign",
+        "description": "Updates only the keys present in the body; PUT is accepted too. Only campaigns the caller created.\nTurning it back on with `enabled: true` turns off any other campaign in effect on the form.",
+        "tag": "Plugins",
+        "method": "patch",
+        "path": "/plugins/checkin/campaigns/{id}",
+        "params": [
+            {
+                "name": "id",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "id"
+        ],
+        "body": {
+            "contentType": "application/json",
+            "required": true,
+            "flatten": true
+        },
+        "successStatus": 200,
+        "scopes": [
+            "form_setting"
+        ],
+        "responseSchema": "CheckinCampaign"
+    },
+    "deleteCheckinCampaign": {
+        "operationId": "deleteCheckinCampaign",
+        "summary": "Delete a check-in campaign",
+        "description": "Deletes the campaign and unbinds it from the form; its check-in records are no longer visible. To pause check-in only, PATCH `enabled: false`.",
+        "tag": "Plugins",
+        "method": "delete",
+        "path": "/plugins/checkin/campaigns/{id}",
+        "params": [
+            {
+                "name": "id",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "id"
+        ],
+        "successStatus": 204,
+        "scopes": [
+            "form_setting"
+        ]
+    },
+    "listOpensearchQueries": {
+        "operationId": "listOpensearchQueries",
+        "summary": "List public queries",
+        "description": "Returns the public queries created by the current caller (an account access token counts as the account owner), newest first, with summary fields only. With form_token, returns only the queries under that form; returns 404 when form_token does not exist or the caller cannot access it, instead of ignoring the parameter.",
+        "tag": "OpenSearch",
+        "method": "get",
+        "path": "/opensearch/queries",
+        "params": [
+            {
+                "name": "form_token",
+                "in": "query",
+                "required": false
+            }
+        ],
+        "paramNames": [
+            "form_token"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "forms"
+        ]
+    },
+    "createOpensearchQuery": {
+        "operationId": "createOpensearchQuery",
+        "summary": "Create a public query",
+        "description": "Creates a public query on the form given by form_token, with the current caller as its creator. The caller must be able to manage the form: no access returns 404, read but not manage returns 403; a plan without the public query feature returns 402. Fields referenced in search_field_rules must be searchable fields of the form, and those in display_field_rules must be displayable fields; otherwise returns 400 listing the available api_code values. search_field_rules / display_field_rules, when passed, cannot be empty arrays; scope_conditions requires a plan that supports limiting the range of searchable entries. A preview image is generated asynchronously after saving.",
+        "tag": "OpenSearch",
+        "method": "post",
+        "path": "/opensearch/queries",
+        "params": [],
+        "paramNames": [],
+        "body": {
+            "contentType": "application/json",
+            "required": true,
+            "flatten": false,
+            "param": "body"
+        },
+        "successStatus": 201,
+        "scopes": [
+            "forms"
+        ],
+        "responseSchema": "OpensearchQuery"
+    },
+    "getOpensearchQuery": {
+        "operationId": "getOpensearchQuery",
+        "summary": "Show a public query",
+        "description": "Returns the public query details, including the search field rules and display field rules. The caller can read only queries it created; another user's query returns 404 (opensearch query cannot be found).",
+        "tag": "OpenSearch",
+        "method": "get",
+        "path": "/opensearch/queries/{query_token}",
+        "params": [
+            {
+                "name": "query_token",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "query_token"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "forms"
+        ],
+        "responseSchema": "OpensearchQuery"
+    },
+    "updateOpensearchQuery": {
+        "operationId": "updateOpensearchQuery",
+        "summary": "Update a public query",
+        "description": "Updates a public query the caller created; PUT is also accepted. Only the keys present in the request are updated. Returns 400 when the query's form has been deleted. Field rules are validated as on create: referencing a field that cannot be searched / displayed, an empty rule array, an empty name and the like all return 400. An update does not check form manage permission or whether the plan includes public queries.",
+        "tag": "OpenSearch",
+        "method": "patch",
+        "path": "/opensearch/queries/{query_token}",
+        "params": [
+            {
+                "name": "query_token",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "query_token"
+        ],
+        "body": {
+            "contentType": "application/json",
+            "required": true,
+            "flatten": false,
+            "param": "body"
+        },
+        "successStatus": 200,
+        "scopes": [
+            "forms"
+        ],
+        "responseSchema": "OpensearchQuery"
+    },
+    "listOpensearchQuerySuggestions": {
+        "operationId": "listOpensearchQuerySuggestions",
+        "summary": "Suggest fields for a public query",
+        "description": "Returns the search fields and display fields a form offers for public queries, plus the recommended field api_code values, for building search_field_rules / display_field_rules. The caller must be able to manage the form: no access returns 404, read but not manage returns 403. Whether the plan includes public queries is not checked.",
+        "tag": "OpenSearch",
+        "method": "get",
+        "path": "/opensearch/query_suggestions",
+        "params": [
+            {
+                "name": "form_token",
+                "in": "query",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "form_token"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "forms"
+        ]
+    },
+    "listFolders": {
+        "operationId": "listFolders",
+        "summary": "List folders",
+        "description": "Lists the folders the current user has manage permission on (form folders and table folders alike, told apart by `kind`), newest first. With an account-level credential, returns the account owner's folders.\n`limit` defaults to 50 and is clamped to 1 to 100; there is no paging: `total` is the full count, `count` the number returned this time.",
+        "tag": "Folders",
+        "method": "get",
+        "path": "/folders",
+        "params": [
+            {
+                "name": "limit",
+                "in": "query",
+                "required": false
+            }
+        ],
+        "paramNames": [
+            "limit"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "forms"
+        ]
+    },
+    "createFolder": {
+        "operationId": "createFolder",
+        "summary": "Create a folder",
+        "description": "Creates a folder as the current user; the creator becomes the folder's manager. `kind` decides whether the folder holds forms (`form`, the default) or tables (`table`).\nReturns 400 `Name cannot be empty` when `name` is empty; returns 400 `Kind must be one of: form, table` when `kind` is not form / table; returns 400 when model validation fails, with the validation message in `error_description`.",
+        "tag": "Folders",
+        "method": "post",
+        "path": "/folders",
+        "params": [],
+        "paramNames": [],
+        "body": {
+            "contentType": "application/json",
+            "required": true,
+            "flatten": true
+        },
+        "successStatus": 201,
+        "scopes": [
+            "forms"
+        ],
+        "responseSchema": "Folder"
+    },
+    "listPredefinedChoicesSets": {
+        "operationId": "listPredefinedChoicesSets",
+        "summary": "List predefined choice sets",
+        "description": "Lists the current account's custom predefined choice sets (type custom), only those matching the locale of the current request (as the server implements it); the built-in global choice sets are not returned.",
+        "tag": "Predefined Choices Sets",
+        "method": "get",
+        "path": "/predefined_choices_sets",
+        "params": [],
+        "paramNames": [],
+        "successStatus": 200,
+        "scopes": [
+            "form_setting"
+        ]
+    },
+    "createPredefinedChoicesSet": {
+        "operationId": "createPredefinedChoicesSet",
+        "summary": "Create a predefined choice set",
+        "description": "Creates a custom predefined choice set in the current account. It looks up by `label`: when the account already has a set with the same label, that set's `choices` are overwritten (in effect an update); otherwise a new set is created.\nThe request body must be wrapped under the `predefined_choices_set` key; returns 400 when the key is missing. Empty strings in `choices` are dropped; neither `label` nor the remaining `choices` may be empty, otherwise returns 400 with the body `{ errors, status: \"failed\" }`.\nReturns 200 on success (not 201).",
+        "tag": "Predefined Choices Sets",
+        "method": "post",
+        "path": "/predefined_choices_sets",
+        "params": [],
+        "paramNames": [],
+        "body": {
+            "contentType": "application/json",
+            "required": true,
+            "flatten": true
+        },
+        "successStatus": 200,
+        "scopes": [
+            "form_setting"
+        ],
+        "responseSchema": "PredefinedChoicesSet"
+    },
+    "updatePredefinedChoicesSet": {
+        "operationId": "updatePredefinedChoicesSet",
+        "summary": "Update a predefined choice set",
+        "description": "Updates the `label` and / or `choices` of one of the current account's custom predefined choice sets. PUT is also accepted and behaves the same.\nOnly a set of type custom that belongs to the current account can be updated: a global set or another account's set returns 403 `{ errors: \"forbidden\", status: \"failed\" }`; an ID that does not exist returns 404 `{ errors: \"not found\", status: \"failed\" }`; a validation failure returns 400 `{ errors, status: \"failed\" }`.",
+        "tag": "Predefined Choices Sets",
+        "method": "patch",
+        "path": "/predefined_choices_sets/{id}",
+        "params": [
+            {
+                "name": "id",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "id"
+        ],
+        "body": {
+            "contentType": "application/json",
+            "required": true,
+            "flatten": true
+        },
+        "successStatus": 200,
+        "scopes": [
+            "form_setting"
+        ],
+        "responseSchema": "PredefinedChoicesSet"
+    },
+    "deletePredefinedChoicesSet": {
+        "operationId": "deletePredefinedChoicesSet",
+        "summary": "Delete a predefined choice set",
+        "description": "Deletes one of the current account's custom predefined choice sets; returns 200 with no response body on success.\nOnly a set of type custom that belongs to the current account can be deleted: a global set or another account's set returns 403 `{ errors: \"forbidden\", status: \"failed\" }`; an ID that does not exist returns 404 `{ errors: \"not found\", status: \"failed\" }`.",
+        "tag": "Predefined Choices Sets",
+        "method": "delete",
+        "path": "/predefined_choices_sets/{id}",
+        "params": [
+            {
+                "name": "id",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "id"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "form_setting"
+        ]
+    },
+    "createTemplateUsage": {
+        "operationId": "createTemplateUsage",
+        "summary": "Create a form from a template",
+        "description": "Uses a template from the template market as the current user, copies it into a new form, and returns the new form's token and edit page URL.\nThe template is given by `id` (or `template_id`), which takes a template token or a 24-character hexadecimal ID. Optional parameters: `tags` (tags, an array or a comma-separated string), `tag_id` / `folder_id` (the tag / folder the new form goes into), `scene` (target scene; falls back to form when the template has fields the scene does not allow), `frm` (source marker; affects the recorded created_from), `create_source`, `group_id`.\nPayment-related branches:\n- Paid template the current user has not bought: returns 200 with the body `{ template_url }` (the template purchase page URL), and no form is created.\n- Template uses paid features the current plan does not offer: returns 403 `{ error: \"CAN_FEATURE_TRIAL\", target_plan, target_trial_type, ... }` when the caller is an admin and a feature trial can be started; otherwise returns 403 `{ error: \"PAID_FEATURE_REQUIRED\", target_plan, template_url }`; an account from a channel partner gets 403 `{ error: \"UNAVAILABLE_TO_TRIAL_OR_UPGRADE\" }`.\n- With `form_app_trial_alert` passed and the template bound to form apps that must be bought / tried: returns 200 `{ error: \"CANNOT_FORM_APP_TRIAL\" | \"FORM_APP_TRIAL_REQUIRED\", ... }`; confirm with `confirm_unbind_form_app` / `confirm_form_app_trial` and retry.\nWhen form creation fails (failing the content risk check included), returns 400 `{ error }`. When the template does not exist, returns 404 with an HTML page, not JSON.\n`mobile_editor_forbidden` appears only on a mobile request when the new form has the card layout and the current plan cannot use the mobile editor.",
+        "tag": "Templates",
+        "method": "post",
+        "path": "/template_usages",
+        "params": [],
+        "paramNames": [],
+        "body": {
+            "contentType": "application/json",
+            "required": true,
+            "flatten": true
+        },
+        "successStatus": 200,
+        "scopes": [
+            "forms"
+        ]
+    },
+    "listContacts": {
+        "operationId": "listContacts",
+        "summary": "List contacts",
+        "description": "Lists the current user's contacts page by page, by ID descending, a fixed 50 per page. With an account-level credential, returns the account owner's contacts.\nCursor paging: `next` in the response is the ID of the first contact on the next page; pass it as the query parameter `next` to get that page. `next` is null when there is no more data.",
+        "tag": "Contacts",
+        "method": "get",
+        "path": "/contacts",
+        "params": [
+            {
+                "name": "next",
+                "in": "query",
+                "required": false
+            }
+        ],
+        "paramNames": [
+            "next"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "read_contacts"
+        ]
+    },
+    "getCurrentUser": {
+        "operationId": "getCurrentUser",
+        "summary": "Show the current user",
+        "description": "Returns the user behind the current credential. With an account-level credential (no specific user), returns the account owner.",
+        "tag": "Account",
+        "method": "get",
+        "path": "/me",
+        "params": [],
+        "paramNames": [],
+        "successStatus": 200,
+        "scopes": [
+            "users"
+        ],
+        "responseSchema": "CurrentUser"
+    },
+    "getBillingAccount": {
+        "operationId": "getBillingAccount",
+        "summary": "Show the current account",
+        "description": "Returns the account the current credential belongs to: plan, this month's usage and quota, feature trial status, and the bound payment merchant / WeChat Pay / Alipay accounts.\n`usage` is null when the account has no usage record for this month yet; for an add-on service with unlimited quota, only `unit`, `unlimited: true` and `consumed_quota` are returned.",
+        "tag": "Account",
+        "method": "get",
+        "path": "/billing_account",
+        "params": [],
+        "paramNames": [],
+        "successStatus": 200,
+        "scopes": [
+            "users"
+        ],
+        "responseSchema": "BillingAccount"
+    },
+    "listBillingAccountUsers": {
+        "operationId": "listBillingAccountUsers",
+        "summary": "List account members",
+        "description": "Lists the members of the current account (deactivated members included), by status ascending (active first), then by creation time, newest first.\n`limit` defaults to 50 and is clamped to 1 to 100; there is no paging: `total` is the total number of members, `count` the number returned this time.",
+        "tag": "Account",
+        "method": "get",
+        "path": "/billing_account/users",
+        "params": [
+            {
+                "name": "limit",
+                "in": "query",
+                "required": false
+            }
+        ],
+        "paramNames": [
+            "limit"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "users"
+        ]
+    },
+    "listBillingAccountInvoices": {
+        "operationId": "listBillingAccountInvoices",
+        "summary": "List account e-invoices",
+        "description": "Lists the e-invoices the current account has requested (newest request first, all at once, no paging), and the spending that can be invoiced but has not been yet.\nOnly an account admin can read it: a non-admin member gets 403 (`Only an account admin can read this.`); an account-level credential (no specific user) is treated as the account owner.",
+        "tag": "Account",
+        "method": "get",
+        "path": "/billing_account/invoices",
+        "params": [],
+        "paramNames": [],
+        "successStatus": 200,
+        "scopes": [
+            "users"
+        ],
+        "responseSchema": "BillingAccountInvoicesResponse"
+    },
+    "listBillingAccountPaymentHistories": {
+        "operationId": "listBillingAccountPaymentHistories",
+        "summary": "List account payment history",
+        "description": "Lists the current account's top-ups and spending on Jinshuju (account balance transactions such as buying plans, SMS, AI points and attachment storage), newest first.\nThis is what the account itself spent; money received through payment forms is not included.\nOnly an account admin can read it: a non-admin member gets 403 (`Only an account admin can read this.`); an account-level credential (no specific user) is treated as the account owner.\nThere is no paging: `limit` defaults to 50 and is clamped to 1 to 1000; `total_records` is the number of matching records, `returned_records` the number returned this time.\nWith `include_balance=true`, `current_balance` is included (account balance and the remaining quota of each item); when records are returned, `statistics` is included (counting only the returned records).",
+        "tag": "Account",
+        "method": "get",
+        "path": "/billing_account/payment_histories",
+        "params": [
+            {
+                "name": "start_date",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "end_date",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "verb",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "limit",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "include_balance",
+                "in": "query",
+                "required": false
+            }
+        ],
+        "paramNames": [
+            "start_date",
+            "end_date",
+            "verb",
+            "limit",
+            "include_balance"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "users"
+        ],
+        "responseSchema": "BillingAccountPaymentHistoriesResponse"
+    },
+    "getTradeMerchant": {
+        "operationId": "getTradeMerchant",
+        "summary": "Show the 小金商户",
+        "description": "Returns the current account's 小金商户 (the merchant Jinshuju collects payments for) and its onboarding progress: merchant profile, legal entity and contact details, balance, settlement details, payment channel authorization, freeze status, bound payment forms, and the URL for the next step.\n- When the account has no 小金商户 yet, it still returns 200: `merchant_stage` says how far the onboarding application has got, `merchant` / `subject` / `contact` / `balance` / `settlement` / `freeze` are null, and `channels` is an empty array.\n- An account that collects payments through its own WeChat Pay / Alipay merchant (direct connection) has no rate, settlement account, balance or onboarding status on Jinshuju, and none of these is given here.\n- Sensitive fields such as bank card numbers, mobile numbers, emails and ID numbers are masked by the rules of the product's \"Fund account information\" page: 4 characters are kept at each end (mobile numbers keep the first 3 and last 4), and the middle is replaced with `*`.\n- `payment_form_tokens` holds only the payment forms the current identity can access (quick payment forms included); with an account-level credential, it is computed for the account owner.\n- `balance` is null when the balance lookup fails; that does not mean the balance is 0.",
+        "tag": "Trade",
+        "method": "get",
+        "path": "/trade/merchant",
+        "params": [],
+        "paramNames": [],
+        "successStatus": 200,
+        "scopes": [
+            "users"
+        ],
+        "responseSchema": "TradeMerchant"
+    },
+    "listTradeTransactions": {
+        "operationId": "listTradeTransactions",
+        "summary": "List payment orders",
+        "description": "Lists the payment orders of the 小金商户 (orders customers place by paying on payment forms), newest order first. Only 小金商户 orders are included: orders collected through a direct connection, simulated-payment orders, and unpaid quick payment records are all left out.\n- The date range filters on order time, in Beijing time (UTC+8); `start_date` / `end_date` are both inclusive and must be passed together. Without them, it defaults to the last 90 days; with `order_no` and no dates, there is no time limit. `queried_range` in the response gives the range actually used (both ends null when there is no time limit).\n- Detail limits: the date range spans at most 90 days, and at most 200 orders match. Past either limit, no details are returned: `transactions` is null, `detail_limit` says why, and `stats` gives the transaction amount, paid count and order count for the range; narrow the range and query again.\n- Paging: `limit` is the page size (default and maximum 50), and `next` is a page number. When there is another page, the response carries `next` (the next page number); pass it back as is. `page_info.total` is the total number of matching orders.\n- Returns 404 when the account has no 小金商户.",
+        "tag": "Trade",
+        "method": "get",
+        "path": "/trade/transactions",
+        "params": [
+            {
+                "name": "start_date",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "end_date",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "paid_status",
+                "in": "query",
+                "required": false,
+                "array": true
+            },
+            {
+                "name": "payment_channel",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "form_token",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "order_no",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "limit",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "next",
+                "in": "query",
+                "required": false
+            }
+        ],
+        "paramNames": [
+            "start_date",
+            "end_date",
+            "paid_status",
+            "payment_channel",
+            "form_token",
+            "order_no",
+            "limit",
+            "next"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "users"
+        ],
+        "responseSchema": "TradeTransactionListResponse"
+    },
+    "aggregateTradeTransactions": {
+        "operationId": "aggregateTradeTransactions",
+        "summary": "Aggregate payment orders",
+        "description": "Totals the transaction amount, paid count and order count of the 小金商户 payment orders over a date range, optionally grouped by one dimension. Orders are counted as in \"List payment orders\" (only 小金商户 orders; no simulated payments and no unpaid quick payment records); the totals cover the whole range and are not bound by the detail limits.\n- The date range filters on order time, in Beijing time (UTC+8); both ends are inclusive and must be passed together. Without them, it defaults to the last 30 days. The range spans at most 366 days; a longer one returns 400.\n- `transactions_amount` (transaction amount): the amount of paid-type orders minus each order's successful refunds, counted on the day the order was placed; refunded and unpaid orders contribute 0. `transactions_count` (paid count): the number of paid, partially refunded and refunding orders. `orders_count` (order count): the number of all matching orders, unpaid included.\n- `group_by=time` groups by time: by day for a range under 90 days, by week from 90 days, by month from 365 days; `granularity` gives the granularity, and periods without orders are filled with zero. `paid_status` / `payment_channel` make one group per value; the group whose `payment_channel` is null holds orders that have not started payment. Under the same filters, the groups add up to the total.\n- Returns 404 when the account has no 小金商户.",
+        "tag": "Trade",
+        "method": "get",
+        "path": "/trade/transactions/aggregate",
+        "params": [
+            {
+                "name": "start_date",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "end_date",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "group_by",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "paid_status",
+                "in": "query",
+                "required": false,
+                "array": true
+            },
+            {
+                "name": "payment_channel",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "form_token",
+                "in": "query",
+                "required": false
+            }
+        ],
+        "paramNames": [
+            "start_date",
+            "end_date",
+            "group_by",
+            "paid_status",
+            "payment_channel",
+            "form_token"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "users"
+        ],
+        "responseSchema": "TradeTransactionAggregateResponse"
+    },
+    "listTradeRefunds": {
+        "operationId": "listTradeRefunds",
+        "summary": "List refunds",
+        "description": "Lists the refunds the 小金商户 issued to customers, with statistics. Refunds are filtered and sorted newest first by the time they were issued, not by the order time or the time the refund arrived. Only a 小金商户 has refund records; an account collecting payments through a direct connection has no data here.\n- The date range is in Beijing time (UTC+8); both ends are inclusive and must be passed together. Without them, it defaults to the last 90 days; with `refund_no` and no dates, there is no time limit. `queried_range` gives the range actually used.\n- `include` decides what is returned: `both` (default) returns `stats` and `refunds` together, `stats` returns the statistics alone, `records` returns the records alone.\n- The detail limits are those of \"List payment orders\" (at most 90 days, 200 records): past them, `refunds` is null, `detail_limit` says why, and `stats` is returned as usual.\n- `stats`: the count and amount of all matching refunds, the count and amount per status, the number of distinct orders with a successful refund, and the trend by refund issue date (only when there is a date range; by day under 90 days, by week from 90 days, by month from 365 days, periods without refunds filled with zero). In the trend, order counts are deduplicated within each period, so the sum over periods can exceed the total order count.\n- Paging works as in \"List payment orders\"; with `include=stats`, `next` is not returned.\n- Returns 404 when the account has no 小金商户.",
+        "tag": "Trade",
+        "method": "get",
+        "path": "/trade/refunds",
+        "params": [
+            {
+                "name": "start_date",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "end_date",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "status",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "refund_no",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "include",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "limit",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "next",
+                "in": "query",
+                "required": false
+            }
+        ],
+        "paramNames": [
+            "start_date",
+            "end_date",
+            "status",
+            "refund_no",
+            "include",
+            "limit",
+            "next"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "users"
+        ],
+        "responseSchema": "TradeRefundListResponse"
+    },
+    "listTradePayouts": {
+        "operationId": "listTradePayouts",
+        "summary": "List payouts",
+        "description": "Lists the payouts the 小金商户 made from its Jinshuju balance to its own bank account, with statistics. Payouts are filtered and sorted newest first by request time; each record carries the settlement date range the payout covers, but it cannot be filtered on. Only a 小金商户 has payout records; an account collecting payments through a direct connection has no data here.\n- The date range is in Beijing time (UTC+8); both ends are inclusive and must be passed together. Without them, it defaults to the last 90 days. `queried_range` gives the range actually used.\n- `include` decides what is returned: `both` (default) returns `stats` and `payouts` together, `stats` returns the statistics alone, `records` returns the records alone.\n- The detail limits are those of \"List payment orders\" (at most 90 days, 200 records): past them, `payouts` is null, `detail_limit` says why, and `stats` is returned as usual.\n- `stats`: the count and amount of all matching payouts, and the count and amount per status.\n- Paging works as in \"List payment orders\"; with `include=stats`, `next` is not returned.\n- For the balance awaiting payout and the settlement cycle, see \"Show the 小金商户\". Returns 404 when the account has no 小金商户.",
+        "tag": "Trade",
+        "method": "get",
+        "path": "/trade/payouts",
+        "params": [
+            {
+                "name": "start_date",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "end_date",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "status",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "include",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "limit",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "next",
+                "in": "query",
+                "required": false
+            }
+        ],
+        "paramNames": [
+            "start_date",
+            "end_date",
+            "status",
+            "include",
+            "limit",
+            "next"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "users"
+        ],
+        "responseSchema": "TradePayoutListResponse"
+    },
+    "listSmsAuditStatuses": {
+        "operationId": "listSmsAuditStatuses",
+        "summary": "Show SMS signature review status",
+        "description": "Lists the SMS signatures the current user applied for and the SMS templates under each signature, with review status and the reason a review failed, newest signature first.\nReturns only the current user's own signatures, not those of other members of the account; with an account-level credential, returns the account owner's signatures. Any member can call it; admin is not required.",
+        "tag": "Account",
+        "method": "get",
+        "path": "/sms/audit_statuses",
+        "params": [],
+        "paramNames": [],
+        "successStatus": 200,
+        "scopes": [
+            "users"
+        ],
+        "responseSchema": "SMSAuditStatusResponse"
+    },
+    "verifyRedirectParams": {
+        "operationId": "verifyRedirectParams",
+        "summary": "Verify redirect parameters",
+        "description": "Lets the receiver of a \"redirect to an external URL after submission\" verify that the redirect parameters have not been tampered with. This endpoint needs no API credentials.\nWhen a form has redirect after submission turned on and \"Fields to carry on redirect\" configured, Jinshuju appends the values of the selected fields to the redirect URL, plus the signature parameter `jamr_h` (signed over the form token, the entry token and a 10-minute validity period). The receiver forwards the received `jamr_h` and all field parameters to this endpoint unchanged: the server verifies the signature, finds the form and entry, and compares the current value of each configured field with the passed parameter value (array values must be equal as a whole; other values are compared as strings).\nReturns 200 `{ status: \"SUCCESS\", message: \"验证成功\" }` when all match; 400 `{ status: \"FAIL\", message: \"无效Token或者过期\" }` when the `jamr_h` signature is invalid or expired; 400 `{ status: \"FAIL\", message: \"验证失败\" }` when the form / entry does not exist, a field value does not match, or a field parameter is missing. The message text follows the request language.",
+        "tag": "Utilities",
+        "method": "get",
+        "path": "/jamr_v",
+        "params": [
+            {
+                "name": "jamr_h",
+                "in": "query",
+                "required": true
+            },
+            {
+                "name": "serial_number",
+                "in": "query",
+                "required": false
+            }
+        ],
+        "paramNames": [
+            "jamr_h",
+            "serial_number"
+        ],
+        "successStatus": 200,
+        "scopes": []
+    },
+    "listFieldTypes": {
+        "operationId": "listFieldTypes",
+        "summary": "List field types",
+        "description": "Returns every field type available when creating / editing a form (or table), with the validation switches and type-specific settings each type accepts, for building `type` and the type-specific parameters in `fields`.\nKept in line with the types and parameters the create endpoints actually accept.",
+        "tag": "Forms",
+        "method": "get",
+        "path": "/field_types",
+        "params": [
+            {
+                "name": "kind",
+                "in": "query",
+                "required": false
+            }
+        ],
+        "paramNames": [
+            "kind"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "forms"
+        ],
+        "responseSchema": "FieldTypeListResponse"
+    },
+    "getFieldType": {
+        "operationId": "getFieldType",
+        "summary": "Show a field type",
+        "description": "Returns the validation switches and type-specific settings one field type accepts, shaped like one item of the `GET /field_types` list.\nReturns 404, listing the available types in `error_description`, when the type name does not exist or is not among the types available for `kind` (e.g. querying a type tables do not support with `kind=table`).",
+        "tag": "Forms",
+        "method": "get",
+        "path": "/field_types/{type}",
+        "params": [
+            {
+                "name": "type",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "kind",
+                "in": "query",
+                "required": false
+            }
+        ],
+        "paramNames": [
+            "type",
+            "kind"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "forms"
+        ],
+        "responseSchema": "FieldTypeDescription"
+    },
+    "countEntriesAcrossForms": {
+        "operationId": "countEntriesAcrossForms",
+        "summary": "Count entries across several forms",
+        "description": "Counts, in one call, the entries matching the filters in each of up to 10 forms / tables, plus their total.\n- A token that cannot be accessed (does not exist, or does not belong to the caller) does not fail the whole request; its row returns `unavailable` with the reason instead. The total adds up only the rows that could be counted.\n- Field api_codes mean different things in each form, so `filters` can use only the three form-independent conditions `created_at` / `updated_at` / `creator_id`; any other field returns 400.\n- `keyword` is not supported (passing it returns 400); to search several forms by keyword, use `GET /entries/search`.",
+        "tag": "Entries",
+        "method": "get",
+        "path": "/entries/count",
+        "params": [
+            {
+                "name": "form_tokens",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "filters",
+                "in": "query",
+                "required": false,
+                "json": true
+            }
+        ],
+        "paramNames": [
+            "form_tokens",
+            "filters"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "read_entries"
+        ],
+        "responseSchema": "EntryCountBatchResponse"
+    },
+    "searchEntriesAcrossForms": {
+        "operationId": "searchEntriesAcrossForms",
+        "summary": "Search entries across forms",
+        "description": "Runs one keyword as a full-text search across several forms / tables and returns, per form, the match count and some of the matching serial numbers (at most 50 per form), without entry content.\n- Search scope: the forms in `form_tokens` when given; otherwise every form and table the caller can access (for an account access token, every form and table in the account).\n  Either way, `filters` then narrows the scope; unless `filters` specifies `entries_count`, only forms with entries are searched by default (`entries_count > 0`).\n- The scope holds at most 10 forms; beyond that it returns 400: narrow it with `filters`, or pass `form_tokens` directly.\n- Forms with no match are left out of the result; forms that cannot be accessed, where the caller's role does not allow reading entries, whose search timed out or whose search service did not respond are listed with `unavailable` giving the reason (this does not mean there was no match).",
+        "tag": "Entries",
+        "method": "get",
+        "path": "/entries/search",
+        "params": [
+            {
+                "name": "keyword",
+                "in": "query",
+                "required": true
+            },
+            {
+                "name": "form_tokens",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "filters",
+                "in": "query",
+                "required": false,
+                "json": true
+            }
+        ],
+        "paramNames": [
+            "keyword",
+            "form_tokens",
+            "filters"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "read_entries"
+        ],
+        "responseSchema": "EntrySearchResponse"
+    },
+    "getEntryStats": {
+        "operationId": "getEntryStats",
+        "summary": "Count submissions per form over a date range",
+        "description": "Counts the submissions received within a date range by every form / table the caller can access (for an account access token, every form and table in the account): returns the total, and a list of the forms that received submissions, most submissions first.\n- Dates are in Beijing time (UTC+8); `from` / `to` are both inclusive.\n- It counts submissions as they happened: imported entries count on the day of the import, and deleted entries are not subtracted, so the result may differ from a count by entry `created_at`.\n- The list has at most `limit` rows; when there are more, `truncated` is true, and `total` and `forms_with_data` still cover every form.\n- With `by` (`day` / `week` / `month`), the response also carries `buckets`: one count of the same shape for each period in the range (periods with no submissions included); weeks start on Monday, and the first and last periods are clipped to the range. The range covers at most 92 days / 53 weeks / 24 months; beyond that it returns 400, suggesting a coarser granularity or dropping `by`.",
+        "tag": "Entries",
+        "method": "get",
+        "path": "/entries/stats",
+        "params": [
+            {
+                "name": "from",
+                "in": "query",
+                "required": true
+            },
+            {
+                "name": "to",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "kind",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "by",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "limit",
+                "in": "query",
+                "required": false
+            }
+        ],
+        "paramNames": [
+            "from",
+            "to",
+            "kind",
+            "by",
+            "limit"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "read_entries"
+        ],
+        "responseSchema": "EntryStatsResponse"
+    },
+    "listMyFilledForms": {
+        "operationId": "listMyFilledForms",
+        "summary": "List the forms I have submitted to",
+        "description": "Returns the forms the current user has submitted entries to as a submitter (quick payment forms excluded), most recent submission first. These forms need not be created by or shared with the current user;\neach row gives the current user's own submission count and latest submission time, not the form's total entry count. Deleted forms do not appear in `data` (`total` still counts them).\n- Pagination: `next` is a row offset, passed back as is for the next page; `skip` and `next` cannot be combined. 50 rows per page by default, adjustable with `limit` (at most 1000).\n- An account access token has no \"current user\"; calling with one returns 400.",
+        "tag": "Forms",
+        "method": "get",
+        "path": "/my/forms",
+        "params": [
+            {
+                "name": "limit",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "next",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "skip",
+                "in": "query",
+                "required": false
+            }
+        ],
+        "paramNames": [
+            "limit",
+            "next",
+            "skip"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "forms"
+        ],
+        "responseSchema": "MyFilledFormListResponse"
+    },
+    "listMySubmittedEntries": {
+        "operationId": "listMySubmittedEntries",
+        "summary": "List my entries in a form",
+        "description": "Returns the entries the current user submitted to the given form, newest first. The form need not be created by or shared with the current user: only the user's own entries are returned,\nwith only the fields the form makes public to submitters (hidden fields are neither returned nor usable for filtering or searching). Returns an empty list when the user has not submitted.\n- `fields` keeps only the given public fields; unknown or non-public api_codes are skipped (no error).\n- `filters` works as in the entry list, but cannot filter by `creator_id` (results are already limited to the user's own) or on non-public fields; doing so returns 400.\n- `keyword` searches only the user's own entries and is not subject to the form's entry-count limit.\n- Pagination: `next` is a row offset; `skip` and `next` cannot be combined. 50 rows per page by default, adjustable with `limit` (at most 1000).\n- An account access token has no \"current user\"; calling with one returns 400. Returns 404 when the form does not exist.",
+        "tag": "Entries",
+        "method": "get",
+        "path": "/my/forms/{form_token}/entries",
+        "params": [
+            {
+                "name": "form_token",
+                "in": "path",
+                "required": true
+            },
+            {
+                "name": "fields",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "filters",
+                "in": "query",
+                "required": false,
+                "json": true
+            },
+            {
+                "name": "keyword",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "include_labels",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "limit",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "next",
+                "in": "query",
+                "required": false
+            },
+            {
+                "name": "skip",
+                "in": "query",
+                "required": false
+            }
+        ],
+        "paramNames": [
+            "form_token",
+            "fields",
+            "filters",
+            "keyword",
+            "include_labels",
+            "limit",
+            "next",
+            "skip"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "read_entries"
+        ],
+        "responseSchema": "MySubmittedEntryListResponse"
+    },
+    "searchMySubmittedEntries": {
+        "operationId": "searchMySubmittedEntries",
+        "summary": "Search my entries",
+        "description": "Searches the current user's own entries across forms with one keyword (only fields the form makes public to submitters are searched), and returns the match count and serial numbers for each matching form.\n- `keyword` is required; returns 400 when empty.\n- By default, searches every form the current user has submitted to (quick payment forms excluded); `form_tokens` limits it to some of them, and tokens not in the user's submission history are ignored.\n  Returns 400 when more than 20 forms are in the search; narrow them with `form_tokens`.\n- Forms with no match are left out of the result; when a form cannot be searched (e.g. the keyword is too long), that form returns `unavailable` with an explanation and the other forms return as usual.\n- At most 50 serial numbers are returned per form; `matched` is the form's actual total match count.\n- An account access token has no \"current user\"; calling with one returns 400.",
+        "tag": "Entries",
+        "method": "get",
+        "path": "/my/search",
+        "params": [
+            {
+                "name": "keyword",
+                "in": "query",
+                "required": true
+            },
+            {
+                "name": "form_tokens",
+                "in": "query",
+                "required": false
+            }
+        ],
+        "paramNames": [
+            "keyword",
+            "form_tokens"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "read_entries"
+        ],
+        "responseSchema": "MySearchResponse"
+    },
+    "getFillFormPage": {
+        "operationId": "getFillFormPage",
+        "summary": "Show a form's fill page",
+        "description": "Reads the fill page behind a fill link (`/f/<token>`): its title, description, the fields to fill in, and whether the current user can submit right now.\nThe caller reads it as a submitter holding the link and needs no permission on the form or table; only what the fill page shows is returned.\n- `fields` lists the public fields in fill-page order, shaped like `fields` when reading a form; for a form view, column names, descriptions and required flags already follow the view's settings.\n- Submission is possible only when `status.key` is `open`; other values (such as `not_opened`, `closed`, `password_required`, `unauthorized`, `submission_prevented`,\n  `fill_frequency_limited`: the current user has used up the submissions the fill page allows) are explained in `status.message`; when the page is not yet open or has closed on schedule, `status.open_info` gives the open period.\n- `blockers` lists requirements only the submitter can complete on the page (captcha, SMS verification, WeChat identity, payment, etc.); when it is not empty, submission is refused and the form must be filled in a browser.\n- `manageable` is returned only when the current user can already read the underlying form or table, and gives its token and name.\n- An account access token has no \"current user\"; calling with one returns 400.",
+        "tag": "Fill",
+        "method": "get",
+        "path": "/fill/f/{form_token}",
+        "params": [
+            {
+                "name": "form_token",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "form_token"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "submit_entries"
+        ],
+        "responseSchema": "FillPage"
+    },
+    "createFillFormEntry": {
+        "operationId": "createFillFormEntry",
+        "summary": "Submit an entry through a form's fill page",
+        "description": "Submits one entry through the fill page as the current user, the same as clicking \"Submit\" on the page: only fields visible on the fill page are accepted, required fields are checked as the fill page sets them,\nthe submitter is recorded as the current user (the entry shows up in \"My submissions\"), and an entry submitted through a form view records which view it came from.\n- Returns 403 when the fill page is not open, with the reason in `status`; returns 422 listing the reasons when `blockers` is not empty.\n- Returns 422 when a field value is invalid, with `errors` explaining each by field api_code.\n- Each user can submit at most 30 times per hour; beyond that returns 429.\n- An account access token has no \"current user\"; calling with one returns 400.",
+        "tag": "Fill",
+        "method": "post",
+        "path": "/fill/f/{form_token}/entries",
+        "params": [
+            {
+                "name": "form_token",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "form_token"
+        ],
+        "body": {
+            "contentType": "application/json",
+            "required": true,
+            "flatten": true
+        },
+        "successStatus": 201,
+        "scopes": [
+            "submit_entries"
+        ],
+        "responseSchema": "FillEntryCreated"
+    },
+    "getFillViewPage": {
+        "operationId": "getFillViewPage",
+        "summary": "Show a form view's fill page",
+        "description": "Reads the fill page behind a fill link (`/v/<token>`): its title, description, the fields to fill in, and whether the current user can submit right now.\nThe caller reads it as a submitter holding the link and needs no permission on the form or table; only what the fill page shows is returned.\n- `fields` lists the public fields in fill-page order, shaped like `fields` when reading a form; for a form view, column names, descriptions and required flags already follow the view's settings.\n- Submission is possible only when `status.key` is `open`; other values (such as `not_opened`, `closed`, `password_required`, `unauthorized`, `submission_prevented`,\n  `fill_frequency_limited`: the current user has used up the submissions the fill page allows) are explained in `status.message`; when the page is not yet open or has closed on schedule, `status.open_info` gives the open period.\n- `blockers` lists requirements only the submitter can complete on the page (captcha, SMS verification, WeChat identity, payment, etc.); when it is not empty, submission is refused and the form must be filled in a browser.\n- `manageable` is returned only when the current user can already read the underlying form or table, and gives its token and name.\n- An account access token has no \"current user\"; calling with one returns 400.",
+        "tag": "Fill",
+        "method": "get",
+        "path": "/fill/v/{view_token}",
+        "params": [
+            {
+                "name": "view_token",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "view_token"
+        ],
+        "successStatus": 200,
+        "scopes": [
+            "submit_entries"
+        ],
+        "responseSchema": "FillPage"
+    },
+    "createFillViewEntry": {
+        "operationId": "createFillViewEntry",
+        "summary": "Submit an entry through a form view's fill page",
+        "description": "Submits one entry through the fill page as the current user, the same as clicking \"Submit\" on the page: only fields visible on the fill page are accepted, required fields are checked as the fill page sets them,\nthe submitter is recorded as the current user (the entry shows up in \"My submissions\"), and an entry submitted through a form view records which view it came from.\n- Returns 403 when the fill page is not open, with the reason in `status`; returns 422 listing the reasons when `blockers` is not empty.\n- Returns 422 when a field value is invalid, with `errors` explaining each by field api_code.\n- Each user can submit at most 30 times per hour; beyond that returns 429.\n- An account access token has no \"current user\"; calling with one returns 400.",
+        "tag": "Fill",
+        "method": "post",
+        "path": "/fill/v/{view_token}/entries",
+        "params": [
+            {
+                "name": "view_token",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "view_token"
+        ],
+        "body": {
+            "contentType": "application/json",
+            "required": true,
+            "flatten": true
+        },
+        "successStatus": 201,
+        "scopes": [
+            "submit_entries"
+        ],
+        "responseSchema": "FillEntryCreated"
+    },
+    "moveTableToFolder": {
+        "operationId": "moveTableToFolder",
+        "summary": "Move a table into a folder",
+        "description": "Moves a table into a folder, or out of its folder (`folder_token` set to null); PUT is also accepted. The move affects only the calling user's folder placement.\n- The request body must include the `folder_token` key (its value may be null); otherwise 400.\n- `folder_token` accepts only a folder token (not an id); returns 404 when the folder does not exist or the current user lacks manage permission on it.\n- The target folder's kind must be table; otherwise 400.\n- Returns 404 `table cannot be found` when the token is not a table's.",
+        "tag": "Tables",
+        "method": "patch",
+        "path": "/tables/{table_token}/folder",
+        "params": [
+            {
+                "name": "table_token",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "paramNames": [
+            "table_token"
+        ],
+        "body": {
+            "contentType": "application/json",
+            "required": true,
+            "flatten": true
+        },
+        "successStatus": 200,
+        "scopes": [
+            "forms"
+        ],
+        "responseSchema": "TableFolderMoveResult"
+    }
+}