@graph8/sdk 0.251.0 → 0.260.0

package/docs/api/surveys.md

@@ -0,0 +1,1223 @@
+<!-- Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. -->
+
+# `g8.api.surveys`: Surveys
+
+21 operations (14 read, 3 write, 2 destructive, 2 external).
+
+No hand-written client covers this area. Call it through `g8.api.surveys.*` as shown below, or by operationId with `g8.api.call(operationId, input)`.
+
+Every example below assumes this setup (server-side, API key):
+
+```ts
+import { g8 } from "@graph8/sdk";
+
+g8.init({ apiKey: process.env.G8_API_KEY! });
+```
+
+Example values are placeholders that match each field's type. Only required fields are shown. Every example is type-checked against the SDK in CI.
+
+Exact TypeScript types for every operation on this page, and every schema they use: [surveys.d.ts](surveys.d.ts).
+
+## Operations
+
+| Call | HTTP | Tier | Scope | Summary |
+|---|---|---|---|---|
+| [`createSurvey`](#op-createsurvey) | `POST /api/v1/feedback/surveys` | write | `surveys:write` | Create Survey |
+| [`createSurveyTrigger`](#op-createsurveytrigger) | `POST /api/v1/feedback/surveys/{survey_id}/triggers` | write | `surveys:write` | Create Survey Trigger |
+| [`deleteSurvey`](#op-deletesurvey) | `DELETE /api/v1/feedback/surveys/{survey_id}` | destructive | `surveys:delete` | Delete Survey |
+| [`deleteSurveyTrigger`](#op-deletesurveytrigger) | `DELETE /api/v1/feedback/surveys/{survey_id}/triggers/{trigger_id}` | destructive | `surveys:delete` | Delete Survey Trigger |
+| [`getCompanySurveyNps`](#op-getcompanysurveynps) | `GET /api/v1/feedback/companies/{company_id}/nps` | read | `surveys:read` | Get Company Survey Nps |
+| [`getContactSurveyHistory`](#op-getcontactsurveyhistory) | `GET /api/v1/feedback/contacts/{contact_id}/history` | read | `surveys:read` | Get Contact Survey History |
+| [`getSurvey`](#op-getsurvey) | `GET /api/v1/feedback/surveys/{survey_id}` | read | `surveys:read` | Get Survey |
+| [`getSurveyAppUserResponses`](#op-getsurveyappuserresponses) | `GET /api/v1/feedback/surveys/{survey_id}/app-user-responses` | read | `surveys:read` | Get Survey App User Responses |
+| [`getSurveyOrgSummary`](#op-getsurveyorgsummary) | `GET /api/v1/feedback/org-summary` | read | `surveys:read` | Get Survey Org Summary |
+| [`getSurveyResponses`](#op-getsurveyresponses) | `GET /api/v1/feedback/surveys/{survey_id}/responses` | read | `surveys:read` | Get Survey Responses |
+| [`getSurveySend`](#op-getsurveysend) | `GET /api/v1/feedback/sends/{send_id}` | read | `surveys:read` | Get Survey Send |
+| [`getSurveySends`](#op-getsurveysends) | `GET /api/v1/feedback/surveys/{survey_id}/sends` | read | `surveys:read` | Get Survey Sends |
+| [`getSurveySummary`](#op-getsurveysummary) | `GET /api/v1/feedback/surveys/{survey_id}/summary` | read | `surveys:read` | Get Survey Summary |
+| [`getSurveyTrends`](#op-getsurveytrends) | `GET /api/v1/feedback/surveys/{survey_id}/trends` | read | `surveys:read` | Get Survey Trends |
+| [`listSurveySendingDomains`](#op-listsurveysendingdomains) | `GET /api/v1/feedback/sending-domains` | read | `surveys:read` | List Survey Sending Domains |
+| [`listSurveyTriggers`](#op-listsurveytriggers) | `GET /api/v1/feedback/surveys/{survey_id}/triggers` | read | `surveys:read` | List Survey Triggers |
+| [`listSurveys`](#op-listsurveys) | `GET /api/v1/feedback/surveys` | read | `surveys:read` | List Surveys |
+| [`sendSurvey`](#op-sendsurvey) | `POST /api/v1/feedback/surveys/{survey_id}/send` | external | `surveys:run` | Send Survey |
+| [`surveyDomainStatus`](#op-surveydomainstatus) | `GET /api/v1/feedback/sending-domains/status` | read | `surveys:read` | Survey Domain Status |
+| [`updateSurvey`](#op-updatesurvey) | `PATCH /api/v1/feedback/surveys/{survey_id}` | write | `surveys:write` | Update Survey |
+| [`verifySurveyDomain`](#op-verifysurveydomain) | `POST /api/v1/feedback/sending-domains/verify` | external | `surveys:run` | Verify Survey Domain |
+
+---
+
+<a id="op-createsurvey"></a>
+
+### `g8.api.surveys.createSurvey(input)`
+
+**Create Survey**
+
+- HTTP: `POST /api/v1/feedback/surveys`
+- operationId: `create_survey_feedback_surveys_post` (also callable as `g8.api.call("create_survey_feedback_surveys_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `surveys:write`
+
+Create an NPS or CSAT survey.
+
+``type`` fixes the scale (NPS 0-10, CSAT 1-5 unless you override
+``scale_min`` / ``scale_max``). ``delivery_channel`` chooses email, the
+messaging bridge, or the in-app widget. ``comment_mode`` controls whether a
+respondent can add free text: ``none``, ``link`` (score click opens a form) or
+``html`` (textarea inside the email).
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `CreateSurveyRequest` | yes | Request body; fields below. |
+
+Body fields (`CreateSurveyRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.name` | `string` | yes | min length 1, max length 255 |
+| `body.question_text` | `string` | yes | min length 1 |
+| `body.type` | `string` | yes | pattern `^(nps\|csat)$` |
+| `body.comment_mode` | `string \| null` | no | default `"none"`, pattern `^(none\|link\|html)$` |
+| `body.delivery_channel` | `string` | no | default `"email"`, pattern `^(email\|bridge\|in_app)$` |
+| `body.scale_max` | `integer \| null` | no |  |
+| `body.scale_min` | `integer \| null` | no |  |
+| `body.template_id` | `integer \| null` | no |  |
+| `body.thank_you_copy` | `string \| null` | no |  |
+
+**Returns** `ApiResponse_SurveyResponseDTO_`: the envelope `{ data: SurveyResponseDTO, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`SurveyResponseDTO` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `delivery_channel` | `string` | yes |  |
+| `id` | `string` | yes |  |
+| `is_active` | `boolean` | yes |  |
+| `name` | `string` | yes |  |
+| `question_text` | `string` | yes |  |
+| `scale_max` | `integer` | yes |  |
+| `scale_min` | `integer` | yes |  |
+| `type` | `string` | yes |  |
+| `comment_mode` | `string \| null` | no |  |
+| `created_at` | `string (date-time) \| null` | no |  |
+| `score_field_column_id` | `string \| null` | no |  |
+| `template_id` | `integer \| null` | no |  |
+| `thank_you_copy` | `string \| null` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.surveys.createSurvey({
+  body: { name: "Example", question_text: "example", type: "example" },
+});
+```
+
+---
+
+<a id="op-createsurveytrigger"></a>
+
+### `g8.api.surveys.createSurveyTrigger(input)`
+
+**Create Survey Trigger**
+
+- HTTP: `POST /api/v1/feedback/surveys/{survey_id}/triggers`
+- operationId: `create_survey_trigger_feedback_surveys__survey_id__triggers_post` (also callable as `g8.api.call("create_survey_trigger_feedback_surveys__survey_id__triggers_post", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `surveys:write`
+
+Bind an automated send to this survey.
+
+``scheduled`` needs ``audience_ref`` + ``cadence_days``; ``list_entry`` needs
+``audience_ref``; ``stage_entry`` needs ``stage_value``. An ``audience_ref``
+that does not exist in this org is refused rather than silently never firing.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.survey_id` | `string` | yes | Survey id (UUID) — from GET /feedback/surveys |
+| `body` | `CreateSurveyTriggerRequest` | yes | Request body; fields below. |
+
+Body fields (`CreateSurveyTriggerRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.sender_email` | `string (email)` | yes |  |
+| `body.subject` | `string` | yes | min length 1, max length 2000 |
+| `body.trigger_kind` | `string` | yes | pattern `^(scheduled\|list_entry\|stage_entry)$` |
+| `body.audience_ref` | `string \| null` | no |  |
+| `body.cadence_days` | `integer \| null` | no | min 1, max 3650 |
+| `body.reply_to` | `string (email) \| null` | no |  |
+| `body.sender_name` | `string \| null` | no |  |
+| `body.stage_value` | `string \| null` | no |  |
+
+**Returns** `ApiResponse_SurveyTriggerDTO_`: the envelope `{ data: SurveyTriggerDTO, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`SurveyTriggerDTO` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `id` | `string` | yes |  |
+| `is_active` | `boolean` | yes |  |
+| `sender_email` | `string` | yes |  |
+| `subject` | `string` | yes |  |
+| `survey_id` | `string` | yes |  |
+| `trigger_kind` | `string` | yes |  |
+| `audience_ref` | `string \| null` | no |  |
+| `cadence_days` | `integer \| null` | no |  |
+| `reply_to` | `string \| null` | no |  |
+| `sender_name` | `string \| null` | no |  |
+| `stage_value` | `string \| null` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.surveys.createSurveyTrigger({
+  path: { survey_id: "id" },
+  body: {
+    sender_email: "jane@acme.com",
+    subject: "Example",
+    trigger_kind: "example",
+  },
+});
+```
+
+---
+
+<a id="op-deletesurvey"></a>
+
+### `g8.api.surveys.deleteSurvey(input)`
+
+**Delete Survey**
+
+- HTTP: `DELETE /api/v1/feedback/surveys/{survey_id}`
+- operationId: `delete_survey_feedback_surveys__survey_id__delete` (also callable as `g8.api.call("delete_survey_feedback_surveys__survey_id__delete", input)`)
+- Tier: `destructive`: deletes or archives data; confirm with a human before calling
+- API-key scope: `surveys:delete`
+
+Delete a survey. Deactivate instead (``PATCH is_active: false``) if you
+still need its responses for reporting.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.survey_id` | `string` | yes | Survey id (UUID) — from GET /feedback/surveys |
+
+**Returns** `ApiResponse_SurveyDeleteResponse_`: the envelope `{ data: SurveyDeleteResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`SurveyDeleteResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `deleted` | `boolean` | yes |  |
+| `survey_id` | `string` | yes |  |
+
+**Example**
+
+```ts
+// destructive: deletes or archives data; confirm with a human before calling.
+const result = await g8.api.surveys.deleteSurvey({ path: { survey_id: "id" } });
+```
+
+---
+
+<a id="op-deletesurveytrigger"></a>
+
+### `g8.api.surveys.deleteSurveyTrigger(input)`
+
+**Delete Survey Trigger**
+
+- HTTP: `DELETE /api/v1/feedback/surveys/{survey_id}/triggers/{trigger_id}`
+- operationId: `delete_survey_trigger_feedback_surveys__survey_id__triggers__trigger_id__delete` (also callable as `g8.api.call("delete_survey_trigger_feedback_surveys__survey_id__triggers__trigger_id__delete", input)`)
+- Tier: `destructive`: deletes or archives data; confirm with a human before calling
+- API-key scope: `surveys:delete`
+
+Remove an automated-send trigger. Scoped to its parent survey.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.survey_id` | `string` | yes | Survey id (UUID) — from GET /feedback/surveys |
+| `path.trigger_id` | `string` | yes | Trigger id — from GET /feedback/surveys/{survey_id}/triggers |
+
+**Returns** `ApiResponse_SurveyTriggerDeleteResponse_`: the envelope `{ data: SurveyTriggerDeleteResponse, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`SurveyTriggerDeleteResponse` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `deleted` | `boolean` | yes |  |
+| `trigger_id` | `string` | yes |  |
+| `survey_id` | `string \| null` | no |  |
+
+**Example**
+
+```ts
+// destructive: deletes or archives data; confirm with a human before calling.
+const result = await g8.api.surveys.deleteSurveyTrigger({ path: { survey_id: "id", trigger_id: "id" } });
+```
+
+---
+
+<a id="op-getcompanysurveynps"></a>
+
+### `g8.api.surveys.getCompanySurveyNps(input)`
+
+**Get Company Survey Nps**
+
+- HTTP: `GET /api/v1/feedback/companies/{company_id}/nps`
+- operationId: `get_company_survey_nps_feedback_companies__company_id__nps_get` (also callable as `g8.api.call("get_company_survey_nps_feedback_companies__company_id__nps_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `surveys:read`
+
+Account-level NPS: score, promoter/detractor split, coverage and per-contact rows.
+
+The headline score is suppressed (null) below the minimum-respondent
+threshold rather than published from a handful of answers. Contacts the
+calling key cannot see are excluded from every figure, so the coverage
+denominator matches the rows returned.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.company_id` | `integer` | yes | Company id (mashup_companies.id) |
+| `query.bucket` | `string` | no | Trend bucket: day, week or month. default `"week"` |
+| `query.survey_id` | `string \| null` | no | Restrict to one survey. Omit to combine every NPS survey. |
+
+**Returns** `ApiResponse_CompanyNpsDTO_`: the envelope `{ data: CompanyNpsDTO, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`CompanyNpsDTO` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `bucket` | `string` | yes |  |
+| `company_id` | `integer` | yes |  |
+| `contacts` | `Array<CompanyContactScoreDTO>` | yes |  |
+| `coverage` | `CoverageDTO` | yes |  |
+| `detractors` | `integer` | yes |  |
+| `passives` | `integer` | yes |  |
+| `promoters` | `integer` | yes |  |
+| `suppressed` | `boolean` | yes |  |
+| `time_series` | `Array<TrendBarDTO>` | yes |  |
+| `total_respondents` | `integer` | yes |  |
+| `nps_score` | `number \| null` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.surveys.getCompanySurveyNps({ path: { company_id: 123 } });
+```
+
+---
+
+<a id="op-getcontactsurveyhistory"></a>
+
+### `g8.api.surveys.getContactSurveyHistory(input)`
+
+**Get Contact Survey History**
+
+- HTTP: `GET /api/v1/feedback/contacts/{contact_id}/history`
+- operationId: `get_contact_survey_history_feedback_contacts__contact_id__history_get` (also callable as `g8.api.call("get_contact_survey_history_feedback_contacts__contact_id__history_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `surveys:read`
+
+Every survey answer this contact has given, newest first.
+
+``contact_id`` is the mashup_contacts PRIMARY KEY, which is what survey
+responses are keyed on — not the ``CONTACT_ID`` business key.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.contact_id` | `integer` | yes | Contact id (mashup_contacts.id — the primary key) |
+
+**Returns** `ApiResponse_ContactHistoryDTO_`: the envelope `{ data: ContactHistoryDTO, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`ContactHistoryDTO` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `contact_id` | `integer` | yes |  |
+| `responses` | `Array<ContactHistoryItemDTO>` | yes |  |
+
+**Example**
+
+```ts
+const result = await g8.api.surveys.getContactSurveyHistory({ path: { contact_id: 123 } });
+```
+
+---
+
+<a id="op-getsurvey"></a>
+
+### `g8.api.surveys.getSurvey(input)`
+
+**Get Survey**
+
+- HTTP: `GET /api/v1/feedback/surveys/{survey_id}`
+- operationId: `get_survey_feedback_surveys__survey_id__get` (also callable as `g8.api.call("get_survey_feedback_surveys__survey_id__get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `surveys:read`
+
+Read one survey definition.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.survey_id` | `string` | yes | Survey id (UUID) — from GET /feedback/surveys |
+
+**Returns** `ApiResponse_SurveyResponseDTO_`: the envelope `{ data: SurveyResponseDTO, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`SurveyResponseDTO` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `delivery_channel` | `string` | yes |  |
+| `id` | `string` | yes |  |
+| `is_active` | `boolean` | yes |  |
+| `name` | `string` | yes |  |
+| `question_text` | `string` | yes |  |
+| `scale_max` | `integer` | yes |  |
+| `scale_min` | `integer` | yes |  |
+| `type` | `string` | yes |  |
+| `comment_mode` | `string \| null` | no |  |
+| `created_at` | `string (date-time) \| null` | no |  |
+| `score_field_column_id` | `string \| null` | no |  |
+| `template_id` | `integer \| null` | no |  |
+| `thank_you_copy` | `string \| null` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.surveys.getSurvey({ path: { survey_id: "id" } });
+```
+
+---
+
+<a id="op-getsurveyappuserresponses"></a>
+
+### `g8.api.surveys.getSurveyAppUserResponses(input)`
+
+**Get Survey App User Responses**
+
+- HTTP: `GET /api/v1/feedback/surveys/{survey_id}/app-user-responses`
+- operationId: `get_survey_app_user_responses_feedback_surveys__survey_id__app_user_responses_get` (also callable as `g8.api.call("get_survey_app_user_responses_feedback_surveys__survey_id__app_user_responses_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `surveys:read`
+
+Responses collected from your own seat-holders via the in-app widget.
+
+Kept separate from contact responses: these are colleagues answering inside
+the product, not customers answering an email.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.survey_id` | `string` | yes | Survey id (UUID) — from GET /feedback/surveys |
+
+**Returns** `ApiResponse_AppUserResponsesDTO_`: the envelope `{ data: AppUserResponsesDTO, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`AppUserResponsesDTO` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `responses` | `Array<AppUserResponseRowDTO>` | yes |  |
+| `survey_id` | `string` | yes |  |
+
+**Example**
+
+```ts
+const result = await g8.api.surveys.getSurveyAppUserResponses({ path: { survey_id: "id" } });
+```
+
+---
+
+<a id="op-getsurveyorgsummary"></a>
+
+### `g8.api.surveys.getSurveyOrgSummary(input?)`
+
+**Get Survey Org Summary**
+
+- HTTP: `GET /api/v1/feedback/org-summary`
+- operationId: `get_survey_org_summary_feedback_org_summary_get` (also callable as `g8.api.call("get_survey_org_summary_feedback_org_summary_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `surveys:read`
+
+Org-wide NPS and CSAT: headline scores, response rates and per-survey rollups.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.segment` | `string \| null` | no | Restrict to one audience list id. Omit for all contacts. |
+| `query.bucket` | `string` | no | Trend bucket: day, week or month. default `"week"` |
+
+**Returns** `ApiResponse_OrgSummaryDTO_`: the envelope `{ data: OrgSummaryDTO, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`OrgSummaryDTO` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `bucket` | `string` | yes |  |
+| `org_csat` | `OrgCsatBlockDTO` | yes |  |
+| `org_nps` | `OrgNpsBlockDTO` | yes |  |
+| `per_survey` | `Array<PerSurveyDTO>` | yes |  |
+| `time_series` | `Array<TrendBarDTO>` | yes |  |
+| `in_app_csat_avg` | `number \| null` | no |  |
+| `in_app_respondents` | `integer` | no | default `0` |
+| `segment` | `string \| null` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.surveys.getSurveyOrgSummary();
+```
+
+---
+
+<a id="op-getsurveyresponses"></a>
+
+### `g8.api.surveys.getSurveyResponses(input)`
+
+**Get Survey Responses**
+
+- HTTP: `GET /api/v1/feedback/surveys/{survey_id}/responses`
+- operationId: `get_survey_responses_feedback_surveys__survey_id__responses_get` (also callable as `g8.api.call("get_survey_responses_feedback_surveys__survey_id__responses_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `surveys:read`
+
+Individual contact responses: score, comment, contact and timestamp.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.survey_id` | `string` | yes | Survey id (UUID) — from GET /feedback/surveys |
+
+**Returns** `ApiResponse_SurveyResponsesDTO_`: the envelope `{ data: SurveyResponsesDTO, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`SurveyResponsesDTO` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `responses` | `Array<SurveyResponseRowDTO>` | yes |  |
+| `survey_id` | `string` | yes |  |
+
+**Example**
+
+```ts
+const result = await g8.api.surveys.getSurveyResponses({ path: { survey_id: "id" } });
+```
+
+---
+
+<a id="op-getsurveysend"></a>
+
+### `g8.api.surveys.getSurveySend(input)`
+
+**Get Survey Send**
+
+- HTTP: `GET /api/v1/feedback/sends/{send_id}`
+- operationId: `get_survey_send_feedback_sends__send_id__get` (also callable as `g8.api.call("get_survey_send_feedback_sends__send_id__get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `surveys:read`
+
+Read one send's status and recipient count — the poll target after a send.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.send_id` | `integer` | yes | Send id returned by POST /feedback/surveys/{survey_id}/send |
+
+**Returns** `ApiResponse_SurveySendDTO_`: the envelope `{ data: SurveySendDTO, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`SurveySendDTO` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `channel` | `string` | yes |  |
+| `id` | `integer` | yes |  |
+| `recipient_count` | `integer` | yes |  |
+| `status` | `string` | yes |  |
+| `survey_id` | `string` | yes |  |
+| `audience_ref` | `string \| null` | no |  |
+| `scheduled_at` | `string (date-time) \| null` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.surveys.getSurveySend({ path: { send_id: 123 } });
+```
+
+---
+
+<a id="op-getsurveysends"></a>
+
+### `g8.api.surveys.getSurveySends(input)`
+
+**Get Survey Sends**
+
+- HTTP: `GET /api/v1/feedback/surveys/{survey_id}/sends`
+- operationId: `get_survey_sends_feedback_surveys__survey_id__sends_get` (also callable as `g8.api.call("get_survey_sends_feedback_surveys__survey_id__sends_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `surveys:read`
+
+Send history with per-send delivery breakdown and responder counts.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.survey_id` | `string` | yes | Survey id (UUID) — from GET /feedback/surveys |
+
+**Returns** `ApiResponse_SurveySendsDTO_`: the envelope `{ data: SurveySendsDTO, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`SurveySendsDTO` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `sends` | `Array<SurveySendRowDTO>` | yes |  |
+| `survey_id` | `string` | yes |  |
+
+**Example**
+
+```ts
+const result = await g8.api.surveys.getSurveySends({ path: { survey_id: "id" } });
+```
+
+---
+
+<a id="op-getsurveysummary"></a>
+
+### `g8.api.surveys.getSurveySummary(input)`
+
+**Get Survey Summary**
+
+- HTTP: `GET /api/v1/feedback/surveys/{survey_id}/summary`
+- operationId: `get_survey_summary_feedback_surveys__survey_id__summary_get` (also callable as `g8.api.call("get_survey_summary_feedback_surveys__survey_id__summary_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `surveys:read`
+
+Headline score, response rate and distribution for one survey.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.survey_id` | `string` | yes | Survey id (UUID) — from GET /feedback/surveys |
+| `query.bucket` | `string` | no | Trend bucket: day, week or month. default `"week"` |
+
+**Returns** `ApiResponse_SummaryDTO_`: the envelope `{ data: SummaryDTO, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`SummaryDTO` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `bucket` | `string` | yes |  |
+| `delivery_channel` | `string` | yes |  |
+| `detractors` | `integer` | yes |  |
+| `passives` | `integer` | yes |  |
+| `promoters` | `integer` | yes |  |
+| `response_rate` | `ResponseRateDTO` | yes |  |
+| `survey_id` | `string` | yes |  |
+| `time_series` | `Array<TrendBarDTO>` | yes |  |
+| `total_respondents` | `integer` | yes |  |
+| `type` | `string` | yes |  |
+| `csat_avg` | `number \| null` | no |  |
+| `dissatisfied` | `integer \| null` | no |  |
+| `neutral` | `integer \| null` | no |  |
+| `nps_score` | `number \| null` | no |  |
+| `satisfied` | `integer \| null` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.surveys.getSurveySummary({ path: { survey_id: "id" } });
+```
+
+---
+
+<a id="op-getsurveytrends"></a>
+
+### `g8.api.surveys.getSurveyTrends(input)`
+
+**Get Survey Trends**
+
+- HTTP: `GET /api/v1/feedback/surveys/{survey_id}/trends`
+- operationId: `get_survey_trends_feedback_surveys__survey_id__trends_get` (also callable as `g8.api.call("get_survey_trends_feedback_surveys__survey_id__trends_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `surveys:read`
+
+Score over time, bucketed by day, week or month.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.survey_id` | `string` | yes | Survey id (UUID) — from GET /feedback/surveys |
+| `query.bucket` | `string` | no | Trend bucket: day, week or month. default `"week"` |
+
+**Returns** `ApiResponse_TrendsDTO_`: the envelope `{ data: TrendsDTO, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`TrendsDTO` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `bars` | `Array<TrendBarDTO>` | yes |  |
+| `bucket` | `string` | yes |  |
+| `delivery_channel` | `string` | yes |  |
+| `survey_id` | `string` | yes |  |
+| `type` | `string` | yes |  |
+
+**Example**
+
+```ts
+const result = await g8.api.surveys.getSurveyTrends({ path: { survey_id: "id" } });
+```
+
+---
+
+<a id="op-listsurveysendingdomains"></a>
+
+### `g8.api.surveys.listSurveySendingDomains(input?)`
+
+**List Survey Sending Domains**
+
+- HTTP: `GET /api/v1/feedback/sending-domains`
+- operationId: `list_survey_sending_domains_feedback_sending_domains_get` (also callable as `g8.api.call("list_survey_sending_domains_feedback_sending_domains_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `surveys:read`
+
+Domains this org can send surveys from.
+
+``sender_email`` on a send or a trigger must belong to one of the
+``verified`` domains here. Unstamped domains are reconciled against the mail
+service on the way through, so a domain verified out of band shows up without
+any extra call.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.include_unverified` | `boolean` | no | Include domains that are pending or not set up, with their status. default `false` |
+
+**Returns** `ApiResponse_list_SurveySendingDomainDTO__`: the envelope `{ data: Array<SurveySendingDomainDTO>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`SurveySendingDomainDTO` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `domain` | `string` | yes |  |
+| `id` | `integer` | yes |  |
+| `status` | `"verified" \| "pending" \| "not_set_up"` | yes |  |
+
+**Example**
+
+```ts
+const result = await g8.api.surveys.listSurveySendingDomains();
+```
+
+---
+
+<a id="op-listsurveytriggers"></a>
+
+### `g8.api.surveys.listSurveyTriggers(input)`
+
+**List Survey Triggers**
+
+- HTTP: `GET /api/v1/feedback/surveys/{survey_id}/triggers`
+- operationId: `list_survey_triggers_feedback_surveys__survey_id__triggers_get` (also callable as `g8.api.call("list_survey_triggers_feedback_surveys__survey_id__triggers_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `surveys:read`
+
+List this survey's automated-send triggers.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.survey_id` | `string` | yes | Survey id (UUID) — from GET /feedback/surveys |
+
+**Returns** `ApiResponse_list_SurveyTriggerDTO__`: the envelope `{ data: Array<SurveyTriggerDTO>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`SurveyTriggerDTO` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `id` | `string` | yes |  |
+| `is_active` | `boolean` | yes |  |
+| `sender_email` | `string` | yes |  |
+| `subject` | `string` | yes |  |
+| `survey_id` | `string` | yes |  |
+| `trigger_kind` | `string` | yes |  |
+| `audience_ref` | `string \| null` | no |  |
+| `cadence_days` | `integer \| null` | no |  |
+| `reply_to` | `string \| null` | no |  |
+| `sender_name` | `string \| null` | no |  |
+| `stage_value` | `string \| null` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.surveys.listSurveyTriggers({ path: { survey_id: "id" } });
+```
+
+---
+
+<a id="op-listsurveys"></a>
+
+### `g8.api.surveys.listSurveys(input?)`
+
+**List Surveys**
+
+- HTTP: `GET /api/v1/feedback/surveys`
+- operationId: `list_surveys_feedback_surveys_get` (also callable as `g8.api.call("list_surveys_feedback_surveys_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `surveys:read`
+
+List every survey in the org, active and inactive.
+
+**Input**: none.
+
+**Returns** `ApiResponse_list_SurveyResponseDTO__`: the envelope `{ data: Array<SurveyResponseDTO>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`SurveyResponseDTO` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `delivery_channel` | `string` | yes |  |
+| `id` | `string` | yes |  |
+| `is_active` | `boolean` | yes |  |
+| `name` | `string` | yes |  |
+| `question_text` | `string` | yes |  |
+| `scale_max` | `integer` | yes |  |
+| `scale_min` | `integer` | yes |  |
+| `type` | `string` | yes |  |
+| `comment_mode` | `string \| null` | no |  |
+| `created_at` | `string (date-time) \| null` | no |  |
+| `score_field_column_id` | `string \| null` | no |  |
+| `template_id` | `integer \| null` | no |  |
+| `thank_you_copy` | `string \| null` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.surveys.listSurveys();
+```
+
+---
+
+<a id="op-sendsurvey"></a>
+
+### `g8.api.surveys.sendSurvey(input)`
+
+**Send Survey**
+
+- HTTP: `POST /api/v1/feedback/surveys/{survey_id}/send`
+- operationId: `send_survey_feedback_surveys__survey_id__send_post` (also callable as `g8.api.call("send_survey_feedback_surveys__survey_id__send_post", input)`)
+- Tier: `external`: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first
+- API-key scope: `surveys:run`
+
+Send a survey to an audience. Real mail goes to real people.
+
+``audience_ref`` is a list id. For the email channel ``sender_email`` must sit
+on a verified sending domain (``GET /surveys/sending-domains``) and
+``subject`` is required. Set ``scheduled_at`` to queue it for later. Returns
+202 with a ``send_id`` — dispatch is asynchronous; poll
+``GET /surveys/sends/{send_id}``.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.survey_id` | `string` | yes | Survey id (UUID) — from GET /feedback/surveys |
+| `body` | `SendSurveyRequest` | yes | Request body; fields below. |
+
+Body fields (`SendSurveyRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.audience_ref` | `string` | yes | min length 1 |
+| `body.channel` | `string` | no | default `"email"`, pattern `^(email\|bridge)$` |
+| `body.reply_to` | `string (email) \| null` | no |  |
+| `body.scheduled_at` | `string (date-time) \| null` | no |  |
+| `body.sender_email` | `string (email) \| null` | no |  |
+| `body.sender_name` | `string \| null` | no |  |
+| `body.subject` | `string \| null` | no | max length 2000 |
+
+**Returns** `ApiResponse_SurveySendAccepted_`: the envelope `{ data: SurveySendAccepted, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`SurveySendAccepted` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `recipient_count` | `integer` | yes | Contacts resolved from the audience at accept time. |
+| `send_id` | `integer` | yes | Poll GET /surveys/sends/{send_id} for progress. |
+| `status` | `string` | yes | Dispatch state, e.g. queued or scheduled. |
+
+**Example**
+
+```ts
+// external: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first.
+const result = await g8.api.surveys.sendSurvey({ path: { survey_id: "id" }, body: { audience_ref: "example" } });
+```
+
+---
+
+<a id="op-surveydomainstatus"></a>
+
+### `g8.api.surveys.surveyDomainStatus(input)`
+
+**Survey Domain Status**
+
+- HTTP: `GET /api/v1/feedback/sending-domains/status`
+- operationId: `survey_domain_status_feedback_sending_domains_status_get` (also callable as `g8.api.call("survey_domain_status_feedback_sending_domains_status_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `surveys:read`
+
+Whether the domain and its DKIM keys have verified yet.
+
+Not a passive read: when the provider reports the domain verified, THIS
+call is what promotes it into `GET /feedback/sending-domains`. A caller
+that never polls can end up with a domain that verified upstream and still
+does not appear in the picker.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.domain` | `string` | yes | The domain to check. |
+
+**Returns** `ApiResponse_SurveyDomainPayload_`: the envelope `{ data: SurveyDomainPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+const result = await g8.api.surveys.surveyDomainStatus({ query: { domain: "acme.com" } });
+```
+
+---
+
+<a id="op-updatesurvey"></a>
+
+### `g8.api.surveys.updateSurvey(input)`
+
+**Update Survey**
+
+- HTTP: `PATCH /api/v1/feedback/surveys/{survey_id}`
+- operationId: `update_survey_feedback_surveys__survey_id__patch` (also callable as `g8.api.call("update_survey_feedback_surveys__survey_id__patch", input)`)
+- Tier: `write`: creates or changes records; the SDK sends an Idempotency-Key and retries transient failures
+- API-key scope: `surveys:write`
+
+Update a survey. Only supplied fields change.
+
+Setting ``is_active: false`` stops new sends and in-app impressions while
+keeping every response already collected.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.survey_id` | `string` | yes | Survey id (UUID) — from GET /feedback/surveys |
+| `body` | `UpdateSurveyRequest` | yes | Request body; fields below. |
+
+Body fields (`UpdateSurveyRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.delivery_channel` | `string \| null` | no | pattern `^(email\|bridge\|in_app)$` |
+| `body.is_active` | `boolean \| null` | no |  |
+| `body.name` | `string \| null` | no | max length 255 |
+| `body.question_text` | `string \| null` | no |  |
+| `body.template_id` | `integer \| null` | no |  |
+| `body.thank_you_copy` | `string \| null` | no |  |
+
+**Returns** `ApiResponse_SurveyResponseDTO_`: the envelope `{ data: SurveyResponseDTO, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+`SurveyResponseDTO` fields:
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `delivery_channel` | `string` | yes |  |
+| `id` | `string` | yes |  |
+| `is_active` | `boolean` | yes |  |
+| `name` | `string` | yes |  |
+| `question_text` | `string` | yes |  |
+| `scale_max` | `integer` | yes |  |
+| `scale_min` | `integer` | yes |  |
+| `type` | `string` | yes |  |
+| `comment_mode` | `string \| null` | no |  |
+| `created_at` | `string (date-time) \| null` | no |  |
+| `score_field_column_id` | `string \| null` | no |  |
+| `template_id` | `integer \| null` | no |  |
+| `thank_you_copy` | `string \| null` | no |  |
+
+**Example**
+
+```ts
+const result = await g8.api.surveys.updateSurvey({ path: { survey_id: "id" }, body: {} });
+```
+
+---
+
+<a id="op-verifysurveydomain"></a>
+
+### `g8.api.surveys.verifySurveyDomain(input)`
+
+**Verify Survey Domain**
+
+- HTTP: `POST /api/v1/feedback/sending-domains/verify`
+- operationId: `verify_survey_domain_feedback_sending_domains_verify_post` (also callable as `g8.api.call("verify_survey_domain_feedback_sending_domains_verify_post", input)`)
+- Tier: `external`: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first
+- API-key scope: `surveys:run`
+
+Start verification of a domain for SURVEY sending, and get the DNS
+records back.
+
+The records include DMARC, which Gmail and Yahoo require of bulk senders -
+publishing SPF and DKIM alone passes this check and still lands in spam.
+
+Idempotent: re-running it on a domain already being verified re-reads the
+records rather than starting again, and a previously FAILED domain is reset
+to pending so the reconciler picks it up.
+
+A domain bought through graph8 has its DNS added automatically; a domain
+you own needs the records added at your own provider before
+`/status` will ever turn green.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body` | `VerifySurveyDomainRequest` | yes | Request body; fields below. |
+
+Body fields (`VerifySurveyDomainRequest`):
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `body.domain` | `string` | yes | The sending domain or subdomain, e.g. `feedback.acme.com`. min length 1 |
+
+**Returns** `ApiResponse_SurveyDomainPayload_`: the envelope `{ data: SurveyDomainPayload, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `pagination` (PaginationMeta).
+
+**Example**
+
+```ts
+// external: reaches real people (sends email/SMS, places a call, launches a send); the SDK never blindly retries it; confirm with a human first.
+const result = await g8.api.surveys.verifySurveyDomain({ body: { domain: "acme.com" } });
+```
+
+---
+
+## Referenced types
+
+Named types that appear in the tables above. Full TypeScript definitions: `G8Contract.<Name>` (`import type { G8Contract } from "@graph8/sdk"`).
+
+<a id="type-appuserresponserowdto"></a>
+
+### `AppUserResponseRowDTO`
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `app_user_id` | `string` | yes |  |
+| `channel` | `string` | yes |  |
+| `score` | `integer` | yes |  |
+| `comment` | `string \| null` | no |  |
+| `responded_at` | `string \| null` | no |  |
+
+<a id="type-companycontactscoredto"></a>
+
+### `CompanyContactScoreDTO`
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `contact_id` | `integer` | yes |  |
+| `classification` | `string \| null` | no |  |
+| `first_name` | `string \| null` | no |  |
+| `history` | `Array<SurveyScorePointDTO>` | no | default `[]` |
+| `last_name` | `string \| null` | no |  |
+| `last_responded_at` | `string \| null` | no |  |
+| `responded` | `boolean` | no | default `false` |
+| `score` | `integer \| null` | no |  |
+| `trend` | `string \| null` | no |  |
+
+<a id="type-contacthistoryitemdto"></a>
+
+### `ContactHistoryItemDTO`
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `score` | `integer` | yes |  |
+| `survey_id` | `string` | yes |  |
+| `type` | `string` | yes |  |
+| `channel` | `string \| null` | no |  |
+| `classification` | `string \| null` | no |  |
+| `responded_at` | `string \| null` | no |  |
+| `survey_name` | `string \| null` | no |  |
+
+<a id="type-coveragedto"></a>
+
+### `CoverageDTO`
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `rate` | `number` | yes |  |
+| `responded` | `integer` | yes |  |
+| `total_contacts` | `integer` | yes |  |
+
+<a id="type-orgcsatblockdto"></a>
+
+### `OrgCsatBlockDTO`
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `total_respondents` | `integer` | yes |  |
+| `csat_avg` | `number \| null` | no |  |
+
+<a id="type-orgnpsblockdto"></a>
+
+### `OrgNpsBlockDTO`
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `detractors` | `integer` | yes |  |
+| `passives` | `integer` | yes |  |
+| `promoters` | `integer` | yes |  |
+| `total_respondents` | `integer` | yes |  |
+| `nps_score` | `number \| null` | no |  |
+
+<a id="type-persurveydto"></a>
+
+### `PerSurveyDTO`
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `detractors` | `integer` | yes |  |
+| `passives` | `integer` | yes |  |
+| `promoters` | `integer` | yes |  |
+| `survey_id` | `string` | yes |  |
+| `total_respondents` | `integer` | yes |  |
+| `type` | `string` | yes |  |
+| `audience_count` | `integer \| null` | no |  |
+| `audience_name` | `string \| null` | no |  |
+| `audience_ref` | `string \| null` | no |  |
+| `cadence_days` | `integer \| null` | no |  |
+| `cadence_kind` | `string \| null` | no |  |
+| `cadence_label` | `string \| null` | no |  |
+| `csat_avg` | `number \| null` | no |  |
+| `delivery_channel` | `string \| null` | no |  |
+| `is_active` | `boolean` | no | default `true` |
+| `name` | `string \| null` | no |  |
+| `nps_score` | `number \| null` | no |  |
+| `sent_count` | `integer` | no | default `0` |
+| `status` | `string \| null` | no |  |
+| `trend` | `Array<TrendBarDTO>` | no | default `[]` |
+
+<a id="type-responseratedto"></a>
+
+### `ResponseRateDTO`
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `rate` | `number` | yes |  |
+| `responded` | `integer` | yes |  |
+| `sent` | `integer` | yes |  |
+
+<a id="type-surveyresponserowdto"></a>
+
+### `SurveyResponseRowDTO`
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `contact_id` | `integer` | yes |  |
+| `score` | `integer` | yes |  |
+| `channel` | `string \| null` | no |  |
+| `classification` | `string \| null` | no |  |
+| `comment` | `string \| null` | no |  |
+| `first_name` | `string \| null` | no |  |
+| `history` | `Array<SurveyScorePointDTO>` | no | default `[]` |
+| `last_name` | `string \| null` | no |  |
+| `responded_at` | `string \| null` | no |  |
+| `response_count` | `integer` | no | default `1` |
+| `trend` | `string \| null` | no |  |
+
+<a id="type-surveysendrowdto"></a>
+
+### `SurveySendRowDTO`
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `channel` | `string` | yes |  |
+| `delivery_breakdown` | `SendDeliveryBreakdownDTO` | yes |  |
+| `id` | `integer` | yes |  |
+| `status` | `string` | yes |  |
+| `audience_name` | `string \| null` | no |  |
+| `audience_ref` | `string \| null` | no |  |
+| `created_at` | `string \| null` | no |  |
+| `recipient_count` | `integer` | no | default `0` |
+| `responded_count` | `integer` | no | default `0` |
+| `scheduled_at` | `string \| null` | no |  |
+| `trigger_kind` | `string \| null` | no |  |
+
+<a id="type-trendbardto"></a>
+
+### `TrendBarDTO`
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `detractors` | `integer` | yes |  |
+| `passives` | `integer` | yes |  |
+| `period` | `string` | yes |  |
+| `promoters` | `integer` | yes |  |
+| `total` | `integer` | yes |  |
+| `csat_avg` | `number \| null` | no |  |
+| `nps_score` | `number \| null` | no |  |