apollo-deploy-signal-sdk 1.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5d4cf128d1c2b7e000c6b62cbd0c0adbae2d1cf11ffff02840f7bf51269b01d2
+  data.tar.gz: 86caecd7897b9ba8ce03c4cf53d00486d415c81ffb87993b3a9a4cf596251caa
+SHA512:
+  metadata.gz: a0bd3c657a819dedfd3e15076eb6aff52932ae8286d54b5e0428c68c892b6ba5400e50f94f2bc319d6159f0bfa60305b0d05afe937a9a8faa087e8e3a7feedfa
+  data.tar.gz: c31586ba81fb9c35936b113aeb74ab786f213a491b243631178a4de2fc6bc730ea19648b0f04bd5094c79ac0ebd08befa275520aad905dc6ecef4c3891e986b4

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Apollo Signal API SDK contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,79 @@
+# Apollo Signal API Ruby SDK
+
+Ruby client for the Apollo Signal API API.
+
+> Generated by [Tesseract](https://www.npmjs.com/package/@apollo-deploy/tesseract). Generated source files should not be edited manually.
+
+## Installation
+
+```ruby
+gem 'apollo-deploy-signal-sdk'
+```
+
+```bash
+bundle install
+```
+
+## Quick start
+
+```ruby
+require 'apollo-deploy-signal-sdk'
+
+client = ApolloDeploySignalSdk::Client.new(
+  base_url: "https://signal.apollodeploy.com",
+  timeout: 15
+)
+
+api = client.emails
+```
+
+## Configuration and reliability
+
+The transport provides bounded timeouts, exponential-backoff retries, rate-limit handling, default headers, and structured `SDKError` values. Unsafe requests are retried only when explicitly enabled or made idempotent.
+
+```ruby
+client = ApolloDeploySignalSdk::Client.new(
+  timeout: 30,
+  retries: {
+    attempts: 3,
+    backoff: 0.4,
+    jitter: true,
+    max_backoff: 30.0
+  },
+  default_headers: { 'X-Application' => 'my-service' }
+)
+```
+
+## Documentation
+
+- [Documentation index](./docs/README.md)
+- [Generated types](./docs/types.md)
+
+| Domain | Description |
+|---|---|
+| [Emails](./docs/domains/emails.md) | emails operations |
+| [Metrics](./docs/domains/metrics.md) | metrics operations |
+| [Suppressions](./docs/domains/suppressions.md) | suppressions operations |
+| [Segments](./docs/domains/segments.md) | segments operations |
+| [Topics](./docs/domains/topics.md) | topics operations |
+| [ContactProperties](./docs/domains/contact-properties.md) | contactProperties operations |
+| [Contacts](./docs/domains/contacts.md) | contacts operations |
+| [Webhooks](./docs/domains/webhooks.md) | webhooks operations |
+| [ApiKeys](./docs/domains/api-keys.md) | apiKeys operations |
+| [Projects](./docs/domains/projects.md) | projects operations |
+| [SendingDomains](./docs/domains/sending-domains.md) | sendingDomains operations |
+
+## Error handling
+
+```ruby
+begin
+  # Call a domain operation.
+rescue ApolloDeploySignalSdk::SDKError => error
+  warn "#{error.status} #{error.code} request=#{error.request_id}"
+  raise
+end
+```
+
+## License
+
+MIT

data/docs/README.md

@@ -0,0 +1,30 @@
+# Apollo Signal API SDK documentation
+
+Reference documentation for the Apollo Signal API SDK.
+
+[Back to the SDK overview](../README.md)
+
+## API domains
+
+| Domain | Client accessor | Operations | Description |
+|---|---|---:|---|
+| [EmailsAPI](./domains/emails.md) | `client.emails` | 8 | emails operations |
+| [MetricsAPI](./domains/metrics.md) | `client.metrics` | 6 | metrics operations |
+| [SuppressionsAPI](./domains/suppressions.md) | `client.suppressions` | 5 | suppressions operations |
+| [SegmentsAPI](./domains/segments.md) | `client.segments` | 5 | segments operations |
+| [TopicsAPI](./domains/topics.md) | `client.topics` | 6 | topics operations |
+| [ContactPropertiesAPI](./domains/contact-properties.md) | `client.contact_properties` | 5 | contactProperties operations |
+| [ContactsAPI](./domains/contacts.md) | `client.contacts` | 18 | contacts operations |
+| [WebhooksAPI](./domains/webhooks.md) | `client.webhooks` | 9 | webhooks operations |
+| [ApiKeysAPI](./domains/api-keys.md) | `client.api_keys` | 4 | apiKeys operations |
+| [ProjectsAPI](./domains/projects.md) | `client.projects` | 6 | projects operations |
+| [SendingDomainsAPI](./domains/sending-domains.md) | `client.sending_domains` | 7 | sendingDomains operations |
+
+## Models and types
+
+- [Generated types reference](./types.md)
+
+## Reliability behavior
+
+Generated clients use bounded request timeouts, structured SDK errors, request ID propagation, and retry transient failures with exponential backoff. Unsafe requests are not retried unless the generated client can establish idempotency or the caller explicitly enables it.
+

data/docs/domains/api-keys.md

@@ -0,0 +1,92 @@
+# ApiKeysAPI
+
+apiKeys API operations.
+
+[Documentation index](../README.md) · [SDK overview](../../README.md) · [Generated source](../../lib/apollo_deploy_signal_sdk/resources/api-keys.rb)
+
+Client accessor: `client.api_keys`
+
+## Operations
+
+| Method | HTTP | Path | Returns | Description |
+|---|---|---|---|---|
+| [`list_api_keys`](#list-api-keys) | `GET` | `/v1/projects/{projectId}/api-keys` | `ListApiKeysResponse` | — |
+| [`get_api_key`](#get-api-key) | `GET` | `/v1/projects/{projectId}/api-keys/{keyId}` | `ApiKey` | — |
+| [`get_api_key_usage`](#get-api-key-usage) | `GET` | `/v1/projects/{projectId}/api-keys/{keyId}/usage` | `ApiKeyUsageResponse` | — |
+| [`export_api_key_usage`](#export-api-key-usage) | `GET` | `/v1/projects/{projectId}/api-keys/{keyId}/usage/export` | `nil` | — |
+
+## list_api_keys
+
+`GET /v1/projects/{projectId}/api-keys`
+
+### 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: `ListApiKeysResponse`
+
+
+## get_api_key
+
+`GET /v1/projects/{projectId}/api-keys/{keyId}`
+
+### Parameters
+
+| Name | Location | Type | Required | Description |
+|---|---|---|:---:|---|
+| `projectId` | Path | `String` | Yes | — |
+| `keyId` | 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: `ApiKey`
+
+
+## get_api_key_usage
+
+`GET /v1/projects/{projectId}/api-keys/{keyId}/usage`
+
+### Parameters
+
+| Name | Location | Type | Required | Description |
+|---|---|---|:---:|---|
+| `projectId` | Path | `String` | Yes | — |
+| `keyId` | 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: `ApiKeyUsageResponse`
+
+
+## export_api_key_usage
+
+`GET /v1/projects/{projectId}/api-keys/{keyId}/usage/export`
+
+### Parameters
+
+| Name | Location | Type | Required | Description |
+|---|---|---|:---:|---|
+| `projectId` | Path | `String` | Yes | — |
+| `keyId` | 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`
+
+
+---
+
+Generated from the Apollo Signal API manifest by Tesseract.
+

data/docs/domains/contact-properties.md

@@ -0,0 +1,122 @@
+# ContactPropertiesAPI
+
+contactProperties API operations.
+
+[Documentation index](../README.md) · [SDK overview](../../README.md) · [Generated source](../../lib/apollo_deploy_signal_sdk/resources/contact-properties.rb)
+
+Client accessor: `client.contact_properties`
+
+## Operations
+
+| Method | HTTP | Path | Returns | Description |
+|---|---|---|---|---|
+| [`list_contact_properties`](#list-contact-properties) | `GET` | `/v1/projects/{projectId}/contact-properties` | `ContactPropertyPageResponse` | — |
+| [`get_contact_property`](#get-contact-property) | `GET` | `/v1/projects/{projectId}/contact-properties/{propertyId}` | `ContactPropertyResponse` | — |
+| [`create_contact_property`](#create-contact-property) | `POST` | `/v1/projects/{projectId}/contact-properties` | `ContactPropertyResponse` | — |
+| [`update_contact_property`](#update-contact-property) | `PATCH` | `/v1/projects/{projectId}/contact-properties/{propertyId}` | `ContactPropertyResponse` | — |
+| [`delete_contact_property`](#delete-contact-property) | `DELETE` | `/v1/projects/{projectId}/contact-properties/{propertyId}` | `nil` | — |
+
+## list_contact_properties
+
+`GET /v1/projects/{projectId}/contact-properties`
+
+### 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: `ContactPropertyPageResponse`
+
+
+## get_contact_property
+
+`GET /v1/projects/{projectId}/contact-properties/{propertyId}`
+
+### Parameters
+
+| Name | Location | Type | Required | Description |
+|---|---|---|:---:|---|
+| `projectId` | Path | `String` | Yes | — |
+| `propertyId` | 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: `ContactPropertyResponse`
+
+
+## create_contact_property
+
+`POST /v1/projects/{projectId}/contact-properties`
+
+### Parameters
+
+| Name | Location | Type | Required | Description |
+|---|---|---|:---:|---|
+| `projectId` | Path | `String` | Yes | — |
+
+### Request body
+
+- Type: `CreateContactPropertyBody`
+- 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: `ContactPropertyResponse`
+
+
+## update_contact_property
+
+`PATCH /v1/projects/{projectId}/contact-properties/{propertyId}`
+
+### Parameters
+
+| Name | Location | Type | Required | Description |
+|---|---|---|:---:|---|
+| `projectId` | Path | `String` | Yes | — |
+| `propertyId` | Path | `String` | Yes | — |
+
+### Request body
+
+- Type: `UpdateContactPropertyBody`
+- 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: `ContactPropertyResponse`
+
+
+## delete_contact_property
+
+`DELETE /v1/projects/{projectId}/contact-properties/{propertyId}`
+
+### Parameters
+
+| Name | Location | Type | Required | Description |
+|---|---|---|:---:|---|
+| `projectId` | Path | `String` | Yes | — |
+| `propertyId` | 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`
+
+
+---
+
+Generated from the Apollo Signal API manifest by Tesseract.
+