83 lines
1.7 KiB
Markdown
83 lines
1.7 KiB
Markdown
---
|
|
name: cards-routes
|
|
description: Handle 7 OpenAPI operation(s) under /cards for the cards route group.
|
|
---
|
|
|
|
# cards API Routes
|
|
|
|
Handle 7 OpenAPI operation(s) under /cards for the cards route group.
|
|
|
|
Use the generated operation tools to make real API calls. Do not invent API responses.
|
|
If a tool reports missing setup, return the exact setup field name to the caller.
|
|
For write, update, or delete operations, state the intended action before calling the tool.
|
|
|
|
## Operations
|
|
|
|
### cards_list
|
|
|
|
- Operation ID: `cards_list`
|
|
- Route: `GET /cards`
|
|
- Mode: READ
|
|
- Summary: List
|
|
- Parameters:
|
|
- `limit` in `query`
|
|
- `before/after` in `query`
|
|
- `include` in `query`
|
|
|
|
### card_create
|
|
|
|
- Operation ID: `card_create`
|
|
- Route: `POST /cards`
|
|
- Mode: WRITE
|
|
- Summary: Create
|
|
- Body: JSON request body accepted.
|
|
|
|
### card_retrieve
|
|
|
|
- Operation ID: `card_retrieve`
|
|
- Route: `GET /cards/{card_id}`
|
|
- Mode: READ
|
|
- Summary: Retrieve
|
|
- Parameters:
|
|
- `card_id` in `path` required
|
|
|
|
### card_update
|
|
|
|
- Operation ID: `card_update`
|
|
- Route: `POST /cards/{card_id}`
|
|
- Mode: WRITE
|
|
- Summary: Update
|
|
- Parameters:
|
|
- `card_id` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### card_delete
|
|
|
|
- Operation ID: `card_delete`
|
|
- Route: `DELETE /cards/{card_id}`
|
|
- Mode: WRITE
|
|
- Summary: Delete
|
|
- Parameters:
|
|
- `card_id` in `path` required
|
|
|
|
### card_orders_retrieve
|
|
|
|
- Operation ID: `card_orders_retrieve`
|
|
- Route: `GET /cards/{card_id}/orders`
|
|
- Mode: READ
|
|
- Summary: Retrieve
|
|
- Parameters:
|
|
- `card_id` in `path` required
|
|
- `limit` in `query`
|
|
- `offset` in `query`
|
|
|
|
### card_order_create
|
|
|
|
- Operation ID: `card_order_create`
|
|
- Route: `POST /cards/{card_id}/orders`
|
|
- Mode: WRITE
|
|
- Summary: Create
|
|
- Parameters:
|
|
- `card_id` in `path` required
|
|
- Body: JSON request body accepted.
|