apollo-deploy-signal-sdk 1.0.5

data/docs/domains/contacts.md

@@ -0,0 +1,394 @@
+# ContactsAPI
+
+contacts API operations.
+
+[Documentation index](../README.md) · [SDK overview](../../README.md) · [Generated source](../../lib/apollo_deploy_signal_sdk/resources/contacts.rb)
+
+Client accessor: `client.contacts`
+
+## Operations
+
+| Method | HTTP | Path | Returns | Description |
+|---|---|---|---|---|
+| [`list_contacts`](#list-contacts) | `GET` | `/v1/projects/{projectId}/contacts` | `ContactPageResponse` | — |
+| [`get_contact`](#get-contact) | `GET` | `/v1/projects/{projectId}/contacts/{contactId}` | `ContactResponse` | — |
+| [`list_contact_segments`](#list-contact-segments) | `GET` | `/v1/projects/{projectId}/contacts/{contactId}/segments` | `ListContactSegmentsResponse` | — |
+| [`get_contact_topics`](#get-contact-topics) | `GET` | `/v1/projects/{projectId}/contacts/{contactId}/topics` | `GetContactTopicsResponse` | — |
+| [`create_contact`](#create-contact) | `POST` | `/v1/projects/{projectId}/contacts` | `ContactResponse` | — |
+| [`update_contact`](#update-contact) | `PATCH` | `/v1/projects/{projectId}/contacts/{contactId}` | `ContactResponse` | — |
+| [`delete_contact`](#delete-contact) | `DELETE` | `/v1/projects/{projectId}/contacts/{contactId}` | `nil` | — |
+| [`upload_contact_image`](#upload-contact-image) | `POST` | `/v1/projects/{projectId}/contacts/{contactId}/image` | `ContactResponse` | — |
+| [`set_contact_image_url`](#set-contact-image-url) | `PUT` | `/v1/projects/{projectId}/contacts/{contactId}/image` | `ContactResponse` | — |
+| [`delete_contact_image`](#delete-contact-image) | `DELETE` | `/v1/projects/{projectId}/contacts/{contactId}/image` | `nil` | — |
+| [`add_contact_to_segment`](#add-contact-to-segment) | `POST` | `/v1/projects/{projectId}/contacts/{contactId}/segments` | `nil` | — |
+| [`remove_contact_from_segment`](#remove-contact-from-segment) | `DELETE` | `/v1/projects/{projectId}/contacts/{contactId}/segments/{segmentId}` | `nil` | — |
+| [`update_contact_topics`](#update-contact-topics) | `PATCH` | `/v1/projects/{projectId}/contacts/{contactId}/topics` | `nil` | — |
+| [`get_contact_activity`](#get-contact-activity) | `GET` | `/v1/projects/{projectId}/contacts/{contactId}/activity` | `GetContactActivityResponse` | — |
+| [`get_contact_engagement_score`](#get-contact-engagement-score) | `GET` | `/v1/projects/{projectId}/contacts/{contactId}/engagement` | `EngagementScoreResponse` | — |
+| [`get_contact_email_validation_status`](#get-contact-email-validation-status) | `GET` | `/v1/projects/{projectId}/contacts/{contactId}/email-validation` | `EmailValidationStatusResponse` | — |
+| [`refresh_contact_engagement_score`](#refresh-contact-engagement-score) | `POST` | `/v1/projects/{projectId}/contacts/{contactId}/engagement/refresh` | `EngagementScoreResponse` | — |
+| [`record_contact_email_validation`](#record-contact-email-validation) | `POST` | `/v1/projects/{projectId}/contacts/{contactId}/email-validation` | `nil` | — |
+
+## list_contacts
+
+`GET /v1/projects/{projectId}/contacts`
+
+### Parameters
+
+| Name | Location | Type | Required | Description |
+|---|---|---|:---:|---|
+| `projectId` | Path | `String` | Yes | — |
+
+### Response
+
+- Response schema selectors: `200`
+- HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
+- Type: `ContactPageResponse`
+
+
+## get_contact
+
+`GET /v1/projects/{projectId}/contacts/{contactId}`
+
+### Parameters
+
+| Name | Location | Type | Required | Description |
+|---|---|---|:---:|---|
+| `projectId` | Path | `String` | Yes | — |
+| `contactId` | Path | `String` | Yes | — |
+
+### Response
+
+- Response schema selectors: `200`
+- HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
+- Type: `ContactResponse`
+
+
+## list_contact_segments
+
+`GET /v1/projects/{projectId}/contacts/{contactId}/segments`
+
+### Parameters
+
+| Name | Location | Type | Required | Description |
+|---|---|---|:---:|---|
+| `projectId` | Path | `String` | Yes | — |
+| `contactId` | Path | `String` | Yes | — |
+
+### Response
+
+- Response schema selectors: `200`
+- HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
+- Type: `ListContactSegmentsResponse`
+
+
+## get_contact_topics
+
+`GET /v1/projects/{projectId}/contacts/{contactId}/topics`
+
+### Parameters
+
+| Name | Location | Type | Required | Description |
+|---|---|---|:---:|---|
+| `projectId` | Path | `String` | Yes | — |
+| `contactId` | Path | `String` | Yes | — |
+
+### Response
+
+- Response schema selectors: `200`
+- HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
+- Type: `GetContactTopicsResponse`
+
+
+## create_contact
+
+`POST /v1/projects/{projectId}/contacts`
+
+### Parameters
+
+| Name | Location | Type | Required | Description |
+|---|---|---|:---:|---|
+| `projectId` | Path | `String` | Yes | — |
+
+### Request body
+
+- Type: `CreateContactBody`
+- Required: Yes
+- Content type: `application/json`
+
+### Response
+
+- Response schema selectors: `201`
+- HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
+- Type: `ContactResponse`
+
+
+## update_contact
+
+`PATCH /v1/projects/{projectId}/contacts/{contactId}`
+
+### Parameters
+
+| Name | Location | Type | Required | Description |
+|---|---|---|:---:|---|
+| `projectId` | Path | `String` | Yes | — |
+| `contactId` | Path | `String` | Yes | — |
+
+### Request body
+
+- Type: `UpdateContactBody`
+- Required: Yes
+- Content type: `application/json`
+
+### Response
+
+- Response schema selectors: `200`
+- HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
+- Type: `ContactResponse`
+
+
+## delete_contact
+
+`DELETE /v1/projects/{projectId}/contacts/{contactId}`
+
+### Parameters
+
+| Name | Location | Type | Required | Description |
+|---|---|---|:---:|---|
+| `projectId` | Path | `String` | Yes | — |
+| `contactId` | Path | `String` | Yes | — |
+
+### Response
+
+- Response schema selectors: `2XX`
+- HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
+- Type: `nil`
+
+
+## upload_contact_image
+
+`POST /v1/projects/{projectId}/contacts/{contactId}/image`
+
+### Parameters
+
+| Name | Location | Type | Required | Description |
+|---|---|---|:---:|---|
+| `projectId` | Path | `String` | Yes | — |
+| `contactId` | Path | `String` | Yes | — |
+
+### Response
+
+- Response schema selectors: `200`
+- HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
+- Type: `ContactResponse`
+
+
+## set_contact_image_url
+
+`PUT /v1/projects/{projectId}/contacts/{contactId}/image`
+
+### Parameters
+
+| Name | Location | Type | Required | Description |
+|---|---|---|:---:|---|
+| `projectId` | Path | `String` | Yes | — |
+| `contactId` | Path | `String` | Yes | — |
+
+### Request body
+
+- Type: `SetImageUrlBody`
+- Required: Yes
+- Content type: `application/json`
+
+### Response
+
+- Response schema selectors: `200`
+- HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
+- Type: `ContactResponse`
+
+
+## delete_contact_image
+
+`DELETE /v1/projects/{projectId}/contacts/{contactId}/image`
+
+### Parameters
+
+| Name | Location | Type | Required | Description |
+|---|---|---|:---:|---|
+| `projectId` | Path | `String` | Yes | — |
+| `contactId` | Path | `String` | Yes | — |
+
+### Response
+
+- Response schema selectors: `2XX`
+- HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
+- Type: `nil`
+
+
+## add_contact_to_segment
+
+`POST /v1/projects/{projectId}/contacts/{contactId}/segments`
+
+### Parameters
+
+| Name | Location | Type | Required | Description |
+|---|---|---|:---:|---|
+| `projectId` | Path | `String` | Yes | — |
+| `contactId` | Path | `String` | Yes | — |
+
+### Request body
+
+- Type: `AddToSegmentBody`
+- Required: Yes
+- Content type: `application/json`
+
+### Response
+
+- Response schema selectors: `2XX`
+- HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
+- Type: `nil`
+
+
+## remove_contact_from_segment
+
+`DELETE /v1/projects/{projectId}/contacts/{contactId}/segments/{segmentId}`
+
+### Parameters
+
+| Name | Location | Type | Required | Description |
+|---|---|---|:---:|---|
+| `projectId` | Path | `String` | Yes | — |
+| `contactId` | Path | `String` | Yes | — |
+| `segmentId` | Path | `String` | Yes | — |
+
+### Response
+
+- Response schema selectors: `2XX`
+- HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
+- Type: `nil`
+
+
+## update_contact_topics
+
+`PATCH /v1/projects/{projectId}/contacts/{contactId}/topics`
+
+### Parameters
+
+| Name | Location | Type | Required | Description |
+|---|---|---|:---:|---|
+| `projectId` | Path | `String` | Yes | — |
+| `contactId` | Path | `String` | Yes | — |
+
+### Request body
+
+- Type: `UpdateTopicsBody`
+- Required: Yes
+- Content type: `application/json`
+
+### Response
+
+- Response schema selectors: `2XX`
+- HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
+- Type: `nil`
+
+
+## get_contact_activity
+
+`GET /v1/projects/{projectId}/contacts/{contactId}/activity`
+
+### Parameters
+
+| Name | Location | Type | Required | Description |
+|---|---|---|:---:|---|
+| `projectId` | Path | `String` | Yes | — |
+| `contactId` | Path | `String` | Yes | — |
+
+### Response
+
+- Response schema selectors: `200`
+- HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
+- Type: `GetContactActivityResponse`
+
+
+## get_contact_engagement_score
+
+`GET /v1/projects/{projectId}/contacts/{contactId}/engagement`
+
+### Parameters
+
+| Name | Location | Type | Required | Description |
+|---|---|---|:---:|---|
+| `projectId` | Path | `String` | Yes | — |
+| `contactId` | Path | `String` | Yes | — |
+
+### Response
+
+- Response schema selectors: `200`
+- HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
+- Type: `EngagementScoreResponse`
+
+
+## get_contact_email_validation_status
+
+`GET /v1/projects/{projectId}/contacts/{contactId}/email-validation`
+
+### Parameters
+
+| Name | Location | Type | Required | Description |
+|---|---|---|:---:|---|
+| `projectId` | Path | `String` | Yes | — |
+| `contactId` | Path | `String` | Yes | — |
+
+### Response
+
+- Response schema selectors: `200`
+- HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
+- Type: `EmailValidationStatusResponse`
+
+
+## refresh_contact_engagement_score
+
+`POST /v1/projects/{projectId}/contacts/{contactId}/engagement/refresh`
+
+### Parameters
+
+| Name | Location | Type | Required | Description |
+|---|---|---|:---:|---|
+| `projectId` | Path | `String` | Yes | — |
+| `contactId` | Path | `String` | Yes | — |
+
+### Response
+
+- Response schema selectors: `200`
+- HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
+- Type: `EngagementScoreResponse`
+
+
+## record_contact_email_validation
+
+`POST /v1/projects/{projectId}/contacts/{contactId}/email-validation`
+
+### Parameters
+
+| Name | Location | Type | Required | Description |
+|---|---|---|:---:|---|
+| `projectId` | Path | `String` | Yes | — |
+| `contactId` | Path | `String` | Yes | — |
+
+### Request body
+
+- Type: `RecordValidationBody`
+- Required: Yes
+- Content type: `application/json`
+
+### Response
+
+- Response schema selectors: `2XX`
+- HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
+- Type: `nil`
+
+
+---
+
+Generated from the Apollo Signal API manifest by Tesseract.
+

data/docs/domains/emails.md

@@ -0,0 +1,150 @@
+# EmailsAPI
+
+emails API operations.
+
+[Documentation index](../README.md) · [SDK overview](../../README.md) · [Generated source](../../lib/apollo_deploy_signal_sdk/resources/emails.rb)
+
+Client accessor: `client.emails`
+
+## Operations
+
+| Method | HTTP | Path | Returns | Description |
+|---|---|---|---|---|
+| [`send_email`](#send-email) | `POST` | `/v1/emails` | `SendEmailResponse` | — |
+| [`get_email`](#get-email) | `GET` | `/v1/emails/{emailId}` | `EmailDetailResponse` | — |
+| [`batch_send_emails`](#batch-send-emails) | `POST` | `/v1/emails/batch` | `BatchSendResponse` | — |
+| [`cancel_email`](#cancel-email) | `DELETE` | `/v1/emails/{emailId}` | `CancelResponse` | — |
+| [`bulk_cancel_emails`](#bulk-cancel-emails) | `DELETE` | `/v1/emails` | `BulkCancelResponse` | — |
+| [`issue_stream_token`](#issue-stream-token) | `POST` | `/v1/emails/{projectId}/stream/token` | `StreamTokenResponse` | — |
+| [`stream_email_events`](#stream-email-events) | `GET` | `/v1/emails/stream` | `StreamEventResponse` | — |
+| [`validate_links`](#validate-links) | `POST` | `/v1/emails/validate` | `ValidateLinksResponse` | — |
+
+## send_email
+
+`POST /v1/emails`
+
+### Request body
+
+- Type: `SendEmailRequest`
+- Required: Yes
+- Content type: `application/json`
+
+### Response
+
+- Response schema selectors: `201`
+- HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
+- Type: `SendEmailResponse`
+
+
+## get_email
+
+`GET /v1/emails/{emailId}`
+
+### Parameters
+
+| Name | Location | Type | Required | Description |
+|---|---|---|:---:|---|
+| `emailId` | Path | `String` | Yes | — |
+
+### Response
+
+- Response schema selectors: `200`
+- HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
+- Type: `EmailDetailResponse`
+
+
+## batch_send_emails
+
+`POST /v1/emails/batch`
+
+### Request body
+
+- Type: `BatchSendRequest`
+- Required: Yes
+- Content type: `application/json`
+
+### Response
+
+- Response schema selectors: `200`
+- HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
+- Type: `BatchSendResponse`
+
+
+## cancel_email
+
+`DELETE /v1/emails/{emailId}`
+
+### Parameters
+
+| Name | Location | Type | Required | Description |
+|---|---|---|:---:|---|
+| `emailId` | Path | `String` | Yes | — |
+
+### Response
+
+- Response schema selectors: `200`
+- HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
+- Type: `CancelResponse`
+
+
+## bulk_cancel_emails
+
+`DELETE /v1/emails`
+
+### Response
+
+- Response schema selectors: `200`
+- HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
+- Type: `BulkCancelResponse`
+
+
+## issue_stream_token
+
+`POST /v1/emails/{projectId}/stream/token`
+
+### Parameters
+
+| Name | Location | Type | Required | Description |
+|---|---|---|:---:|---|
+| `projectId` | Path | `String` | Yes | — |
+
+### Response
+
+- Response schema selectors: `200`
+- HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
+- Type: `StreamTokenResponse`
+
+
+## stream_email_events
+
+`GET /v1/emails/stream`
+
+### Response
+
+- Response schema selectors: `200`
+- HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
+- Type: `StreamEventResponse`
+- Streaming: Server-Sent Events with payload `StreamEventResponse`
+
+
+## validate_links
+
+`POST /v1/emails/validate`
+
+### Request body
+
+- Type: `ValidateLinksRequest`
+- Required: Yes
+- Content type: `application/json`
+
+### Response
+
+- Response schema selectors: `200`
+- HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
+- Type: `ValidateLinksResponse`
+
+
+---
+
+Generated from the Apollo Signal API manifest by Tesseract.
+

data/docs/domains/metrics.md

@@ -0,0 +1,131 @@
+# MetricsAPI
+
+metrics API operations.
+
+[Documentation index](../README.md) · [SDK overview](../../README.md) · [Generated source](../../lib/apollo_deploy_signal_sdk/resources/metrics.rb)
+
+Client accessor: `client.metrics`
+
+## Operations
+
+| Method | HTTP | Path | Returns | Description |
+|---|---|---|---|---|
+| [`get_topic_performance`](#get-topic-performance) | `GET` | `/v1/metrics/topics/{id}` | `TopicPerformanceResponse` | — |
+| [`get_email_performance`](#get-email-performance) | `GET` | `/v1/metrics/emails/{id}` | `EmailPerformanceResponse` | — |
+| [`get_email_engagement`](#get-email-engagement) | `GET` | `/v1/metrics/emails/{id}/engagement` | `EmailReadScrollAnalyticsResponse` | — |
+| [`get_project_metrics_summary`](#get-project-metrics-summary) | `GET` | `/v1/metrics/summary` | `ProjectMetricsSummaryResponse` | — |
+| [`get_project_metrics_timeline`](#get-project-metrics-timeline) | `GET` | `/v1/metrics/timeline` | `ProjectMetricsTimelineResponse` | — |
+| [`get_metrics_advisor`](#get-metrics-advisor) | `GET` | `/v1/metrics/advisor` | `AdvisorReportResponse` | — |
+
+## get_topic_performance
+
+`GET /v1/metrics/topics/{id}`
+
+### Parameters
+
+| Name | Location | Type | Required | Description |
+|---|---|---|:---:|---|
+| `id` | Path | `String` | Yes | — |
+| `window` | Query | `String` | No | Time window. |
+| `projectId` | Query | `String` | No | Required for session auth; ignored for API key auth. |
+
+### Response
+
+- Response schema selectors: `200`
+- HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
+- Type: `TopicPerformanceResponse`
+
+
+## get_email_performance
+
+`GET /v1/metrics/emails/{id}`
+
+### Parameters
+
+| Name | Location | Type | Required | Description |
+|---|---|---|:---:|---|
+| `id` | Path | `String` | Yes | — |
+
+### Response
+
+- Response schema selectors: `200`
+- HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
+- Type: `EmailPerformanceResponse`
+
+
+## get_email_engagement
+
+`GET /v1/metrics/emails/{id}/engagement`
+
+### Parameters
+
+| Name | Location | Type | Required | Description |
+|---|---|---|:---:|---|
+| `id` | Path | `String` | Yes | — |
+
+### Response
+
+- Response schema selectors: `200`
+- HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
+- Type: `EmailReadScrollAnalyticsResponse`
+
+
+## get_project_metrics_summary
+
+`GET /v1/metrics/summary`
+
+### Parameters
+
+| Name | Location | Type | Required | Description |
+|---|---|---|:---:|---|
+| `window` | Query | `String` | No | Metrics time window. |
+| `projectId` | Query | `String` | No | Required for session auth; ignored for API key auth. |
+
+### Response
+
+- Response schema selectors: `200`
+- HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
+- Type: `ProjectMetricsSummaryResponse`
+
+
+## get_project_metrics_timeline
+
+`GET /v1/metrics/timeline`
+
+### Parameters
+
+| Name | Location | Type | Required | Description |
+|---|---|---|:---:|---|
+| `window` | Query | `String` | No | Metrics time window. |
+| `granularity` | Query | `String` | No | `hour` or `day`. |
+| `format` | Query | `String` | No | `compact` or `detailed`. |
+| `projectId` | Query | `String` | No | Required for session auth; ignored for API key auth. |
+
+### Response
+
+- Response schema selectors: `200`
+- HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
+- Type: `ProjectMetricsTimelineResponse`
+
+
+## get_metrics_advisor
+
+`GET /v1/metrics/advisor`
+
+### Parameters
+
+| Name | Location | Type | Required | Description |
+|---|---|---|:---:|---|
+| `projectId` | Query | `String` | No | Required for session auth; ignored for API key auth. |
+
+### Response
+
+- Response schema selectors: `200`
+- HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
+- Type: `AdvisorReportResponse`
+
+
+---
+
+Generated from the Apollo Signal API manifest by Tesseract.
+