George Lambert
10c663cc0c
74 source modules documented with extracted signatures, JSDoc params, imports, and call graphs. 10 first-class models (PriceRule through StatusResponse) have their own MD/RST/PDF. Sphinx HTML builds from docs/sphinx. Per-module PDFs in docs/modules-pdf and docs/models-pdf. Middleware gates 2–6 and 10 pass on MOCK_VERAE without NATS. Learned: RST includes are relative to the RST file; keep one PDF per module; Add Numbers remains the only push required tomorrow.
48 lines
1.5 KiB
Markdown
48 lines
1.5 KiB
Markdown
# `verae-zapier/index`
|
|
|
|
**Package:** `verae-zapier`
|
|
**Source:** `packages/verae-zapier/index.js`
|
|
**Lines:** 79
|
|
|
|
## What this module is
|
|
|
|
Implementation module in `verae-zapier`. The tables below are extracted from the source (signatures + JSDoc).
|
|
|
|
## Exports
|
|
|
|
`version`, `platformVersion`, `authentication`, `beforeRequest`, `afterResponse`, `triggers`, `timestampCompleted`
|
|
|
|
## Types / interfaces / classes
|
|
|
|
_None extracted._
|
|
|
|
## Functions
|
|
|
|
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
|
|------|------------|---------------------|---------|-----------------------------|
|
|
| `addApiKey` | `request, _z, bundle` | request: `object`, _z: `object`, bundle: `object` | `unknown` | see Call graph |
|
|
| `mapMiddlewareErrors` | `response, z` | response: `object`, z: `object` | `unknown` | see Call graph |
|
|
|
|
## What it imports / requires
|
|
|
|
- `./authentication`
|
|
- `./creates/timestamp_and_wait`
|
|
- `./creates/create_timestamp`
|
|
- `./creates/verify_timestamp`
|
|
- `./creates/batch_timestamp`
|
|
- `./creates/add_numbers`
|
|
- `./searches/job_status`
|
|
- `./triggers/timestamp_completed`
|
|
- `zapier-platform-core`
|
|
- `./package.json`
|
|
|
|
## Call graph (identifiers invoked)
|
|
|
|
_No local call identifiers extracted._
|
|
|
|
## Return values (how to read this)
|
|
|
|
- HTTP route handlers return Express `res.json(...)` bodies (see route docs).
|
|
- Zapier `perform` functions return a **single object** (creates) or an **array** (triggers/searches).
|
|
- Pricing functions return integer **cents** on `Quote.totalCents`.
|
|
|