Config CLI Generator #164
Open
fern-support wants to merge 8 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
1 issue found across 4 files
Reply with feedback, questions, or to request a fix.
Fix all with cubic | Re-trigger cubic
Contributor
There was a problem hiding this comment.
12 issues found across 57 files (changes from recent commits).
Tip: instead of fixing issues one by one fix them all with cubic
Re-trigger cubic
…docs; cli: OpenAPI for CLI) - move fern/definition -> fern/apis/api/definition - move openapi.json + overlay.yaml -> fern/apis/cli/ - split root generators.yml into per-API generators.yml (paths remapped) - SDK generation stays on the Fern Definition (websockets preserved); CLI on OpenAPI - update sync-stainless + api-changelog workflows for new paths and --api api
✨ API Changes# API Changelog n/a vs. n/a
## API Changes
### POST /v0/agent/sign-up
- :warning: api path removed without deprecation
### POST /v0/agent/verify
- :warning: api path removed without deprecation
### GET /v0/api-keys
- :warning: deleted the `query` request parameter `ascending`
- :warning: removed the optional property `api_keys/items/inbox_id` from the response with the `200` status
- :warning: removed the optional property `api_keys/items/permissions` from the response with the `200` status
- :warning: removed the optional property `api_keys/items/pod_id` from the response with the `200` status
- api tag `ApiKeys` added
- api tag `APIKeys` removed
### POST /v0/api-keys
- :warning: the request property `name` became required
- :warning: removed the request property `permissions`
- :warning: removed the optional property `inbox_id` from the response with the `200` status
- :warning: removed the optional property `permissions` from the response with the `200` status
- :warning: removed the optional property `pod_id` from the response with the `200` status
- api tag `ApiKeys` added
- api tag `APIKeys` removed
### DELETE /v0/api-keys/{api_key_id}
- api tag `ApiKeys` added
- api tag `APIKeys` removed
### GET /v0/domains
- :warning: removed the required property `domains/items/domain` from the response with the `200` status
- :warning: deleted the `query` request parameter `ascending`
### POST /v0/domains
- :warning: removed the required property `domain` from the response with the `200` status
### GET /v0/domains/{domain_id}
- :warning: removed the required property `domain` from the response with the `200` status
### PATCH /v0/domains/{domain_id}
- :warning: api removed without deprecation
### GET /v0/domains/{domain_id}/zone-file
- :warning: removed the success response with the status `200`
- added the success response with the status `204`
### GET /v0/drafts
- :warning: removed the optional property `drafts/items/in_reply_to` from the response with the `200` status
- added the required property `drafts/items/thread_id` to the response with the `200` status
### GET /v0/drafts/{draft_id}
- added the required property `thread_id` to the response with the `200` status
### GET /v0/drafts/{draft_id}/attachments/{attachment_id}
- :warning: api path removed without deprecation
### GET /v0/inboxes
- :warning: removed the required property `inboxes/items/email` from the response with the `200` status
- :warning: deleted the `query` request parameter `ascending`
### POST /v0/inboxes
- :warning: removed the required property `email` from the response with the `200` status
### GET /v0/inboxes/{inbox_id}
- :warning: removed the required property `email` from the response with the `200` status
### PATCH /v0/inboxes/{inbox_id}
- :warning: removed the required property `email` from the response with the `200` status
### GET /v0/inboxes/{inbox_id}/api-keys
- :warning: api path removed without deprecation
### POST /v0/inboxes/{inbox_id}/api-keys
- :warning: api path removed without deprecation
### DELETE /v0/inboxes/{inbox_id}/api-keys/{api_key_id}
- :warning: api path removed without deprecation
### GET /v0/inboxes/{inbox_id}/drafts
- :warning: removed the optional property `drafts/items/in_reply_to` from the response with the `200` status
- added the required property `drafts/items/thread_id` to the response with the `200` status
### POST /v0/inboxes/{inbox_id}/drafts
- :warning: removed the request property `attachments`
- added the required property `thread_id` to the response with the `200` status
### GET /v0/inboxes/{inbox_id}/drafts/{draft_id}
- added the required property `thread_id` to the response with the `200` status
### PATCH /v0/inboxes/{inbox_id}/drafts/{draft_id}
- added the required property `thread_id` to the response with the `200` status
### GET /v0/inboxes/{inbox_id}/drafts/{draft_id}/attachments/{attachment_id}
- :warning: api path removed without deprecation
### POST /v0/inboxes/{inbox_id}/drafts/{draft_id}/send
- :warning: request property `add_labels` list-of-types was narrowed by removing types `string` from media type `application/json`
- :warning: request property `remove_labels` list-of-types was narrowed by removing types `string` from media type `application/json`
- the request property `add_labels` became nullable
- the request property `remove_labels` became nullable
### GET /v0/inboxes/{inbox_id}/events
- :warning: api path removed without deprecation
### GET /v0/inboxes/{inbox_id}/lists/{direction}/{type}
- :warning: api path removed without deprecation
### POST /v0/inboxes/{inbox_id}/lists/{direction}/{type}
- :warning: api path removed without deprecation
### DELETE /v0/inboxes/{inbox_id}/lists/{direction}/{type}/{entry}
- :warning: api path removed without deprecation
### GET /v0/inboxes/{inbox_id}/lists/{direction}/{type}/{entry}
- :warning: api path removed without deprecation
### GET /v0/inboxes/{inbox_id}/messages
- :warning: deleted the `query` request parameter `include_blocked`
- :warning: deleted the `query` request parameter `include_trash`
- :warning: deleted the `query` request parameter `include_unauthenticated`
### POST /v0/inboxes/{inbox_id}/messages/batch-get
- :warning: api path removed without deprecation
### DELETE /v0/inboxes/{inbox_id}/messages/{message_id}
- :warning: api removed without deprecation
### PATCH /v0/inboxes/{inbox_id}/messages/{message_id}
- :warning: request property `add_labels` list-of-types was narrowed by removing types `string` from media type `application/json`
- :warning: request property `remove_labels` list-of-types was narrowed by removing types `string` from media type `application/json`
- the request property `add_labels` became nullable
- the request property `remove_labels` became nullable
- added the optional property `attachments` to the response with the `200` status
- added the optional property `bcc` to the response with the `200` status
- added the optional property `cc` to the response with the `200` status
- added the optional property `extracted_html` to the response with the `200` status
- added the optional property `extracted_text` to the response with the `200` status
- added the optional property `headers` to the response with the `200` status
- added the optional property `html` to the response with the `200` status
- added the optional property `in_reply_to` to the response with the `200` status
- added the optional property `preview` to the response with the `200` status
- added the optional property `references` to the response with the `200` status
- added the optional property `reply_to` to the response with the `200` status
- added the optional property `subject` to the response with the `200` status
- added the optional property `text` to the response with the `200` status
- added the required property `created_at` to the response with the `200` status
- added the required property `from` to the response with the `200` status
- added the required property `inbox_id` to the response with the `200` status
- added the required property `size` to the response with the `200` status
- added the required property `thread_id` to the response with the `200` status
- added the required property `timestamp` to the response with the `200` status
- added the required property `to` to the response with the `200` status
- added the required property `updated_at` to the response with the `200` status
### GET /v0/inboxes/{inbox_id}/metrics
- :warning: added the new required `query` request parameter `end_timestamp`
- :warning: added the new required `query` request parameter `start_timestamp`
- :warning: deleted the `query` request parameter `descending`
- :warning: deleted the `query` request parameter `end`
- :warning: deleted the `query` request parameter `limit`
- :warning: deleted the `query` request parameter `period`
- :warning: deleted the `query` request parameter `start`
- api operation id `inboxes_metrics_query` removed and replaced with `inboxes_metrics_get`
- added the non-success response with the status `404`
- added the optional property `message` to the response with the `200` status
### GET /v0/inboxes/{inbox_id}/threads
- :warning: deleted the `query` request parameter `include_blocked`
- :warning: deleted the `query` request parameter `include_trash`
- :warning: deleted the `query` request parameter `include_unauthenticated`
### DELETE /v0/inboxes/{inbox_id}/threads/{thread_id}
- :warning: deleted the `query` request parameter `permanent`
### PATCH /v0/inboxes/{inbox_id}/threads/{thread_id}
- :warning: api removed without deprecation
### GET /v0/lists/{direction}/{type}
- :warning: api path removed without deprecation
### POST /v0/lists/{direction}/{type}
- :warning: api path removed without deprecation
### DELETE /v0/lists/{direction}/{type}/{entry}
- :warning: api path removed without deprecation
### GET /v0/lists/{direction}/{type}/{entry}
- :warning: api path removed without deprecation
### GET /v0/metrics
- :warning: added the new required `query` request parameter `end_timestamp`
- :warning: added the new required `query` request parameter `start_timestamp`
- :warning: deleted the `query` request parameter `descending`
- :warning: deleted the `query` request parameter `end`
- :warning: deleted the `query` request parameter `limit`
- :warning: deleted the `query` request parameter `period`
- :warning: deleted the `query` request parameter `start`
- api operation id `metrics_query` removed and replaced with `metrics_list`
- added the non-success response with the status `404`
- removed the non-success response with the status `400`
- added the optional property `message` to the response with the `200` status
### GET /v0/organizations
- :warning: removed the optional property `authentication_id` from the response with the `200` status
- :warning: removed the optional property `authentication_type` from the response with the `200` status
- :warning: removed the optional property `billing_id` from the response with the `200` status
- :warning: removed the optional property `billing_subscription_id` from the response with the `200` status
- :warning: removed the optional property `billing_type` from the response with the `200` status
### GET /v0/pods
- :warning: deleted the `query` request parameter `ascending`
### GET /v0/pods/{pod_id}/api-keys
- :warning: api path removed without deprecation
### POST /v0/pods/{pod_id}/api-keys
- :warning: api path removed without deprecation
### DELETE /v0/pods/{pod_id}/api-keys/{api_key_id}
- :warning: api path removed without deprecation
### GET /v0/pods/{pod_id}/domains
- :warning: removed the required property `domains/items/domain` from the response with the `200` status
- :warning: deleted the `query` request parameter `ascending`
### POST /v0/pods/{pod_id}/domains
- :warning: removed the required property `domain` from the response with the `200` status
### GET /v0/pods/{pod_id}/domains/{domain_id}
- :warning: api removed without deprecation
### PATCH /v0/pods/{pod_id}/domains/{domain_id}
- :warning: api removed without deprecation
### POST /v0/pods/{pod_id}/domains/{domain_id}/verify
- :warning: api path removed without deprecation
### GET /v0/pods/{pod_id}/domains/{domain_id}/zone-file
- :warning: api path removed without deprecation
### GET /v0/pods/{pod_id}/drafts
- :warning: removed the optional property `drafts/items/in_reply_to` from the response with the `200` status
- added the required property `drafts/items/thread_id` to the response with the `200` status
### GET /v0/pods/{pod_id}/drafts/{draft_id}
- added the required property `thread_id` to the response with the `200` status
### GET /v0/pods/{pod_id}/drafts/{draft_id}/attachments/{attachment_id}
- :warning: api path removed without deprecation
### GET /v0/pods/{pod_id}/inboxes
- :warning: removed the required property `inboxes/items/email` from the response with the `200` status
- :warning: deleted the `query` request parameter `ascending`
### POST /v0/pods/{pod_id}/inboxes
- :warning: removed the required property `email` from the response with the `200` status
### GET /v0/pods/{pod_id}/inboxes/{inbox_id}
- :warning: removed the required property `email` from the response with the `200` status
### PATCH /v0/pods/{pod_id}/inboxes/{inbox_id}
- :warning: api removed without deprecation
### GET /v0/pods/{pod_id}/lists/{direction}/{type}
- :warning: api path removed without deprecation
### POST /v0/pods/{pod_id}/lists/{direction}/{type}
- :warning: api path removed without deprecation
### DELETE /v0/pods/{pod_id}/lists/{direction}/{type}/{entry}
- :warning: api path removed without deprecation
### GET /v0/pods/{pod_id}/lists/{direction}/{type}/{entry}
- :warning: api path removed without deprecation
### GET /v0/pods/{pod_id}/metrics
- :warning: api path removed without deprecation
### GET /v0/pods/{pod_id}/threads
- :warning: deleted the `query` request parameter `include_blocked`
- :warning: deleted the `query` request parameter `include_trash`
- :warning: deleted the `query` request parameter `include_unauthenticated`
### DELETE /v0/pods/{pod_id}/threads/{thread_id}
- :warning: api removed without deprecation
### PATCH /v0/pods/{pod_id}/threads/{thread_id}
- :warning: api removed without deprecation
### GET /v0/threads
- :warning: deleted the `query` request parameter `include_blocked`
- :warning: deleted the `query` request parameter `include_trash`
- :warning: deleted the `query` request parameter `include_unauthenticated`
### DELETE /v0/threads/{thread_id}
- :warning: api removed without deprecation
### PATCH /v0/threads/{thread_id}
- :warning: api removed without deprecation
### GET /v0/webhooks
- :warning: deleted the `query` request parameter `ascending`
- removed the `message.received.blocked` enum value from the `webhooks/items/event_types/items/` response property for the response status `200`
- removed the `message.received.spam` enum value from the `webhooks/items/event_types/items/` response property for the response status `200`
- removed the `message.received.unauthenticated` enum value from the `webhooks/items/event_types/items/` response property for the response status `200`
### POST /v0/webhooks
- :warning: removed the enum value `message.received.blocked` of the request property `event_types/items/`
- :warning: removed the enum value `message.received.spam` of the request property `event_types/items/`
- :warning: removed the enum value `message.received.unauthenticated` of the request property `event_types/items/`
- removed the `message.received.blocked` enum value from the `event_types/items/` response property for the response status `200`
- removed the `message.received.spam` enum value from the `event_types/items/` response property for the response status `200`
- removed the `message.received.unauthenticated` enum value from the `event_types/items/` response property for the response status `200`
### GET /v0/webhooks/{webhook_id}
- removed the `message.received.blocked` enum value from the `event_types/items/` response property for the response status `200`
- removed the `message.received.spam` enum value from the `event_types/items/` response property for the response status `200`
- removed the `message.received.unauthenticated` enum value from the `event_types/items/` response property for the response status `200`
### PATCH /v0/webhooks/{webhook_id}
- :warning: removed the request property `event_types`
- removed the `message.received.blocked` enum value from the `event_types/items/` response property for the response status `200`
- removed the `message.received.spam` enum value from the `event_types/items/` response property for the response status `200`
- removed the `message.received.unauthenticated` enum value from the `event_types/items/` response property for the response status `200`
## Components
- removed the schema `AgentSignupRequest`
- removed the schema `AgentSignupResponse`
- removed the schema `AgentVerifyRequest`
- removed the schema `AgentVerifyResponse`
- removed the schema `ApiKeyPermissions`
- removed the schema `BatchGetMessagesMessageIds`
- removed the schema `BatchGetMessagesRequest`
- removed the schema `BatchGetMessagesResponse`
- removed the schema `CreateListEntryRequest`
- removed the schema `Descending`
- removed the schema `Direction`
- removed the schema `End`
- removed the schema `EntryType`
- removed the schema `Error`
- removed the schema `ErrorMessage`
- removed the schema `InboxEvent`
- removed the schema `InboxEventId`
- removed the schema `InboxEventType`
- removed the schema `IncludeBlocked`
- removed the schema `IncludeTrash`
- removed the schema `IncludeUnauthenticated`
- removed the schema `ListEntry`
- removed the schema `ListEntryBase`
- removed the schema `ListInboxEventsResponse`
- removed the schema `ListListEntriesResponse`
- removed the schema `ListType`
- removed the schema `MessageReceivedEventType`
- removed the schema `MetricBucket`
- removed the schema `MetricLimit`
- removed the schema `Period`
- removed the schema `PodListEntry`
- removed the schema `PodListListEntriesResponse`
- removed the schema `QueryMetricsResponse`
- removed the schema `Start`
- removed the schema `Status`
- removed the schema `UpdateDomainRequest`
- removed the schema `UpdateMessageLabels`
- removed the schema `UpdateMessageResponse`
- removed the schema `UpdateThreadRequest`
- removed the schema `UpdateThreadResponse`
- removed the schema `inboxesEmail`💡 Download |
…ate-cli workflow - replace hand-copied openapi.json with openapi.yml (the fern-openapi export of the Fern Definition, same spec sync-stainless pushes) as the CLI input - keep overlay.yaml for nested-group mapping (targets /v0 paths, ports cleanly) - add workflow_dispatch-only regenerate-cli workflow: export spec -> regenerate CLI, no publish (no-op until cli output targets a GitHub repo) - gitignore the transient /openapi/ export
✨ API Changes# API Changelog n/a vs. n/a
## API Changes
### POST /v0/agent/sign-up
- :warning: api path removed without deprecation
### POST /v0/agent/verify
- :warning: api path removed without deprecation
### GET /v0/api-keys
- :warning: deleted the `query` request parameter `ascending`
- :warning: removed the optional property `api_keys/items/inbox_id` from the response with the `200` status
- :warning: removed the optional property `api_keys/items/permissions` from the response with the `200` status
- :warning: removed the optional property `api_keys/items/pod_id` from the response with the `200` status
- api tag `ApiKeys` added
- api tag `APIKeys` removed
### POST /v0/api-keys
- :warning: the request property `name` became required
- :warning: removed the request property `permissions`
- :warning: removed the optional property `inbox_id` from the response with the `200` status
- :warning: removed the optional property `permissions` from the response with the `200` status
- :warning: removed the optional property `pod_id` from the response with the `200` status
- api tag `ApiKeys` added
- api tag `APIKeys` removed
### DELETE /v0/api-keys/{api_key_id}
- api tag `ApiKeys` added
- api tag `APIKeys` removed
### GET /v0/domains
- :warning: removed the required property `domains/items/domain` from the response with the `200` status
- :warning: deleted the `query` request parameter `ascending`
### POST /v0/domains
- :warning: removed the required property `domain` from the response with the `200` status
### GET /v0/domains/{domain_id}
- :warning: removed the required property `domain` from the response with the `200` status
### PATCH /v0/domains/{domain_id}
- :warning: api removed without deprecation
### GET /v0/domains/{domain_id}/zone-file
- :warning: removed the success response with the status `200`
- added the success response with the status `204`
### GET /v0/drafts
- :warning: removed the optional property `drafts/items/in_reply_to` from the response with the `200` status
- added the required property `drafts/items/thread_id` to the response with the `200` status
### GET /v0/drafts/{draft_id}
- added the required property `thread_id` to the response with the `200` status
### GET /v0/drafts/{draft_id}/attachments/{attachment_id}
- :warning: api path removed without deprecation
### GET /v0/inboxes
- :warning: removed the required property `inboxes/items/email` from the response with the `200` status
- :warning: deleted the `query` request parameter `ascending`
### POST /v0/inboxes
- :warning: removed the required property `email` from the response with the `200` status
### GET /v0/inboxes/{inbox_id}
- :warning: removed the required property `email` from the response with the `200` status
### PATCH /v0/inboxes/{inbox_id}
- :warning: removed the required property `email` from the response with the `200` status
### GET /v0/inboxes/{inbox_id}/api-keys
- :warning: api path removed without deprecation
### POST /v0/inboxes/{inbox_id}/api-keys
- :warning: api path removed without deprecation
### DELETE /v0/inboxes/{inbox_id}/api-keys/{api_key_id}
- :warning: api path removed without deprecation
### GET /v0/inboxes/{inbox_id}/drafts
- :warning: removed the optional property `drafts/items/in_reply_to` from the response with the `200` status
- added the required property `drafts/items/thread_id` to the response with the `200` status
### POST /v0/inboxes/{inbox_id}/drafts
- :warning: removed the request property `attachments`
- added the required property `thread_id` to the response with the `200` status
### GET /v0/inboxes/{inbox_id}/drafts/{draft_id}
- added the required property `thread_id` to the response with the `200` status
### PATCH /v0/inboxes/{inbox_id}/drafts/{draft_id}
- added the required property `thread_id` to the response with the `200` status
### GET /v0/inboxes/{inbox_id}/drafts/{draft_id}/attachments/{attachment_id}
- :warning: api path removed without deprecation
### POST /v0/inboxes/{inbox_id}/drafts/{draft_id}/send
- :warning: request property `add_labels` list-of-types was narrowed by removing types `string` from media type `application/json`
- :warning: request property `remove_labels` list-of-types was narrowed by removing types `string` from media type `application/json`
- the request property `add_labels` became nullable
- the request property `remove_labels` became nullable
### GET /v0/inboxes/{inbox_id}/events
- :warning: api path removed without deprecation
### GET /v0/inboxes/{inbox_id}/lists/{direction}/{type}
- :warning: api path removed without deprecation
### POST /v0/inboxes/{inbox_id}/lists/{direction}/{type}
- :warning: api path removed without deprecation
### DELETE /v0/inboxes/{inbox_id}/lists/{direction}/{type}/{entry}
- :warning: api path removed without deprecation
### GET /v0/inboxes/{inbox_id}/lists/{direction}/{type}/{entry}
- :warning: api path removed without deprecation
### GET /v0/inboxes/{inbox_id}/messages
- :warning: deleted the `query` request parameter `include_blocked`
- :warning: deleted the `query` request parameter `include_trash`
- :warning: deleted the `query` request parameter `include_unauthenticated`
### POST /v0/inboxes/{inbox_id}/messages/batch-get
- :warning: api path removed without deprecation
### DELETE /v0/inboxes/{inbox_id}/messages/{message_id}
- :warning: api removed without deprecation
### PATCH /v0/inboxes/{inbox_id}/messages/{message_id}
- :warning: request property `add_labels` list-of-types was narrowed by removing types `string` from media type `application/json`
- :warning: request property `remove_labels` list-of-types was narrowed by removing types `string` from media type `application/json`
- the request property `add_labels` became nullable
- the request property `remove_labels` became nullable
- added the optional property `attachments` to the response with the `200` status
- added the optional property `bcc` to the response with the `200` status
- added the optional property `cc` to the response with the `200` status
- added the optional property `extracted_html` to the response with the `200` status
- added the optional property `extracted_text` to the response with the `200` status
- added the optional property `headers` to the response with the `200` status
- added the optional property `html` to the response with the `200` status
- added the optional property `in_reply_to` to the response with the `200` status
- added the optional property `preview` to the response with the `200` status
- added the optional property `references` to the response with the `200` status
- added the optional property `reply_to` to the response with the `200` status
- added the optional property `subject` to the response with the `200` status
- added the optional property `text` to the response with the `200` status
- added the required property `created_at` to the response with the `200` status
- added the required property `from` to the response with the `200` status
- added the required property `inbox_id` to the response with the `200` status
- added the required property `size` to the response with the `200` status
- added the required property `thread_id` to the response with the `200` status
- added the required property `timestamp` to the response with the `200` status
- added the required property `to` to the response with the `200` status
- added the required property `updated_at` to the response with the `200` status
### GET /v0/inboxes/{inbox_id}/metrics
- :warning: added the new required `query` request parameter `end_timestamp`
- :warning: added the new required `query` request parameter `start_timestamp`
- :warning: deleted the `query` request parameter `descending`
- :warning: deleted the `query` request parameter `end`
- :warning: deleted the `query` request parameter `limit`
- :warning: deleted the `query` request parameter `period`
- :warning: deleted the `query` request parameter `start`
- api operation id `inboxes_metrics_query` removed and replaced with `inboxes_metrics_get`
- added the non-success response with the status `404`
- added the optional property `message` to the response with the `200` status
### GET /v0/inboxes/{inbox_id}/threads
- :warning: deleted the `query` request parameter `include_blocked`
- :warning: deleted the `query` request parameter `include_trash`
- :warning: deleted the `query` request parameter `include_unauthenticated`
### DELETE /v0/inboxes/{inbox_id}/threads/{thread_id}
- :warning: deleted the `query` request parameter `permanent`
### PATCH /v0/inboxes/{inbox_id}/threads/{thread_id}
- :warning: api removed without deprecation
### GET /v0/lists/{direction}/{type}
- :warning: api path removed without deprecation
### POST /v0/lists/{direction}/{type}
- :warning: api path removed without deprecation
### DELETE /v0/lists/{direction}/{type}/{entry}
- :warning: api path removed without deprecation
### GET /v0/lists/{direction}/{type}/{entry}
- :warning: api path removed without deprecation
### GET /v0/metrics
- :warning: added the new required `query` request parameter `end_timestamp`
- :warning: added the new required `query` request parameter `start_timestamp`
- :warning: deleted the `query` request parameter `descending`
- :warning: deleted the `query` request parameter `end`
- :warning: deleted the `query` request parameter `limit`
- :warning: deleted the `query` request parameter `period`
- :warning: deleted the `query` request parameter `start`
- api operation id `metrics_query` removed and replaced with `metrics_list`
- added the non-success response with the status `404`
- removed the non-success response with the status `400`
- added the optional property `message` to the response with the `200` status
### GET /v0/organizations
- :warning: removed the optional property `authentication_id` from the response with the `200` status
- :warning: removed the optional property `authentication_type` from the response with the `200` status
- :warning: removed the optional property `billing_id` from the response with the `200` status
- :warning: removed the optional property `billing_subscription_id` from the response with the `200` status
- :warning: removed the optional property `billing_type` from the response with the `200` status
### GET /v0/pods
- :warning: deleted the `query` request parameter `ascending`
### GET /v0/pods/{pod_id}/api-keys
- :warning: api path removed without deprecation
### POST /v0/pods/{pod_id}/api-keys
- :warning: api path removed without deprecation
### DELETE /v0/pods/{pod_id}/api-keys/{api_key_id}
- :warning: api path removed without deprecation
### GET /v0/pods/{pod_id}/domains
- :warning: removed the required property `domains/items/domain` from the response with the `200` status
- :warning: deleted the `query` request parameter `ascending`
### POST /v0/pods/{pod_id}/domains
- :warning: removed the required property `domain` from the response with the `200` status
### GET /v0/pods/{pod_id}/domains/{domain_id}
- :warning: api removed without deprecation
### PATCH /v0/pods/{pod_id}/domains/{domain_id}
- :warning: api removed without deprecation
### POST /v0/pods/{pod_id}/domains/{domain_id}/verify
- :warning: api path removed without deprecation
### GET /v0/pods/{pod_id}/domains/{domain_id}/zone-file
- :warning: api path removed without deprecation
### GET /v0/pods/{pod_id}/drafts
- :warning: removed the optional property `drafts/items/in_reply_to` from the response with the `200` status
- added the required property `drafts/items/thread_id` to the response with the `200` status
### GET /v0/pods/{pod_id}/drafts/{draft_id}
- added the required property `thread_id` to the response with the `200` status
### GET /v0/pods/{pod_id}/drafts/{draft_id}/attachments/{attachment_id}
- :warning: api path removed without deprecation
### GET /v0/pods/{pod_id}/inboxes
- :warning: removed the required property `inboxes/items/email` from the response with the `200` status
- :warning: deleted the `query` request parameter `ascending`
### POST /v0/pods/{pod_id}/inboxes
- :warning: removed the required property `email` from the response with the `200` status
### GET /v0/pods/{pod_id}/inboxes/{inbox_id}
- :warning: removed the required property `email` from the response with the `200` status
### PATCH /v0/pods/{pod_id}/inboxes/{inbox_id}
- :warning: api removed without deprecation
### GET /v0/pods/{pod_id}/lists/{direction}/{type}
- :warning: api path removed without deprecation
### POST /v0/pods/{pod_id}/lists/{direction}/{type}
- :warning: api path removed without deprecation
### DELETE /v0/pods/{pod_id}/lists/{direction}/{type}/{entry}
- :warning: api path removed without deprecation
### GET /v0/pods/{pod_id}/lists/{direction}/{type}/{entry}
- :warning: api path removed without deprecation
### GET /v0/pods/{pod_id}/metrics
- :warning: api path removed without deprecation
### GET /v0/pods/{pod_id}/threads
- :warning: deleted the `query` request parameter `include_blocked`
- :warning: deleted the `query` request parameter `include_trash`
- :warning: deleted the `query` request parameter `include_unauthenticated`
### DELETE /v0/pods/{pod_id}/threads/{thread_id}
- :warning: api removed without deprecation
### PATCH /v0/pods/{pod_id}/threads/{thread_id}
- :warning: api removed without deprecation
### GET /v0/threads
- :warning: deleted the `query` request parameter `include_blocked`
- :warning: deleted the `query` request parameter `include_trash`
- :warning: deleted the `query` request parameter `include_unauthenticated`
### DELETE /v0/threads/{thread_id}
- :warning: api removed without deprecation
### PATCH /v0/threads/{thread_id}
- :warning: api removed without deprecation
### GET /v0/webhooks
- :warning: deleted the `query` request parameter `ascending`
- removed the `message.received.blocked` enum value from the `webhooks/items/event_types/items/` response property for the response status `200`
- removed the `message.received.spam` enum value from the `webhooks/items/event_types/items/` response property for the response status `200`
- removed the `message.received.unauthenticated` enum value from the `webhooks/items/event_types/items/` response property for the response status `200`
### POST /v0/webhooks
- :warning: removed the enum value `message.received.blocked` of the request property `event_types/items/`
- :warning: removed the enum value `message.received.spam` of the request property `event_types/items/`
- :warning: removed the enum value `message.received.unauthenticated` of the request property `event_types/items/`
- removed the `message.received.blocked` enum value from the `event_types/items/` response property for the response status `200`
- removed the `message.received.spam` enum value from the `event_types/items/` response property for the response status `200`
- removed the `message.received.unauthenticated` enum value from the `event_types/items/` response property for the response status `200`
### GET /v0/webhooks/{webhook_id}
- removed the `message.received.blocked` enum value from the `event_types/items/` response property for the response status `200`
- removed the `message.received.spam` enum value from the `event_types/items/` response property for the response status `200`
- removed the `message.received.unauthenticated` enum value from the `event_types/items/` response property for the response status `200`
### PATCH /v0/webhooks/{webhook_id}
- :warning: removed the request property `event_types`
- removed the `message.received.blocked` enum value from the `event_types/items/` response property for the response status `200`
- removed the `message.received.spam` enum value from the `event_types/items/` response property for the response status `200`
- removed the `message.received.unauthenticated` enum value from the `event_types/items/` response property for the response status `200`
## Components
- removed the schema `AgentSignupRequest`
- removed the schema `AgentSignupResponse`
- removed the schema `AgentVerifyRequest`
- removed the schema `AgentVerifyResponse`
- removed the schema `ApiKeyPermissions`
- removed the schema `BatchGetMessagesMessageIds`
- removed the schema `BatchGetMessagesRequest`
- removed the schema `BatchGetMessagesResponse`
- removed the schema `CreateListEntryRequest`
- removed the schema `Descending`
- removed the schema `Direction`
- removed the schema `End`
- removed the schema `EntryType`
- removed the schema `Error`
- removed the schema `ErrorMessage`
- removed the schema `InboxEvent`
- removed the schema `InboxEventId`
- removed the schema `InboxEventType`
- removed the schema `IncludeBlocked`
- removed the schema `IncludeTrash`
- removed the schema `IncludeUnauthenticated`
- removed the schema `ListEntry`
- removed the schema `ListEntryBase`
- removed the schema `ListInboxEventsResponse`
- removed the schema `ListListEntriesResponse`
- removed the schema `ListType`
- removed the schema `MessageReceivedEventType`
- removed the schema `MetricBucket`
- removed the schema `MetricLimit`
- removed the schema `Period`
- removed the schema `PodListEntry`
- removed the schema `PodListListEntriesResponse`
- removed the schema `QueryMetricsResponse`
- removed the schema `Start`
- removed the schema `Status`
- removed the schema `UpdateDomainRequest`
- removed the schema `UpdateMessageLabels`
- removed the schema `UpdateMessageResponse`
- removed the schema `UpdateThreadRequest`
- removed the schema `UpdateThreadResponse`
- removed the schema `inboxesEmail`💡 Download |
…anduril convention) fern generate --local runs generators in Docker; GitHub-hosted ubuntu runners provide it pre-installed with a running daemon, so no explicit docker setup or guard step is needed (matches fern's python-generator CI and anduril fern-mock-andurilapis generate-sdks).
✨ API Changes# API Changelog n/a vs. n/a
## API Changes
### POST /v0/agent/sign-up
- :warning: api path removed without deprecation
### POST /v0/agent/verify
- :warning: api path removed without deprecation
### GET /v0/api-keys
- :warning: deleted the `query` request parameter `ascending`
- :warning: removed the optional property `api_keys/items/inbox_id` from the response with the `200` status
- :warning: removed the optional property `api_keys/items/permissions` from the response with the `200` status
- :warning: removed the optional property `api_keys/items/pod_id` from the response with the `200` status
- api tag `ApiKeys` added
- api tag `APIKeys` removed
### POST /v0/api-keys
- :warning: the request property `name` became required
- :warning: removed the request property `permissions`
- :warning: removed the optional property `inbox_id` from the response with the `200` status
- :warning: removed the optional property `permissions` from the response with the `200` status
- :warning: removed the optional property `pod_id` from the response with the `200` status
- api tag `ApiKeys` added
- api tag `APIKeys` removed
### DELETE /v0/api-keys/{api_key_id}
- api tag `ApiKeys` added
- api tag `APIKeys` removed
### GET /v0/domains
- :warning: removed the required property `domains/items/domain` from the response with the `200` status
- :warning: deleted the `query` request parameter `ascending`
### POST /v0/domains
- :warning: removed the required property `domain` from the response with the `200` status
### GET /v0/domains/{domain_id}
- :warning: removed the required property `domain` from the response with the `200` status
### PATCH /v0/domains/{domain_id}
- :warning: api removed without deprecation
### GET /v0/domains/{domain_id}/zone-file
- :warning: removed the success response with the status `200`
- added the success response with the status `204`
### GET /v0/drafts
- :warning: removed the optional property `drafts/items/in_reply_to` from the response with the `200` status
- added the required property `drafts/items/thread_id` to the response with the `200` status
### GET /v0/drafts/{draft_id}
- added the required property `thread_id` to the response with the `200` status
### GET /v0/drafts/{draft_id}/attachments/{attachment_id}
- :warning: api path removed without deprecation
### GET /v0/inboxes
- :warning: removed the required property `inboxes/items/email` from the response with the `200` status
- :warning: deleted the `query` request parameter `ascending`
### POST /v0/inboxes
- :warning: removed the required property `email` from the response with the `200` status
### GET /v0/inboxes/{inbox_id}
- :warning: removed the required property `email` from the response with the `200` status
### PATCH /v0/inboxes/{inbox_id}
- :warning: removed the required property `email` from the response with the `200` status
### GET /v0/inboxes/{inbox_id}/api-keys
- :warning: api path removed without deprecation
### POST /v0/inboxes/{inbox_id}/api-keys
- :warning: api path removed without deprecation
### DELETE /v0/inboxes/{inbox_id}/api-keys/{api_key_id}
- :warning: api path removed without deprecation
### GET /v0/inboxes/{inbox_id}/drafts
- :warning: removed the optional property `drafts/items/in_reply_to` from the response with the `200` status
- added the required property `drafts/items/thread_id` to the response with the `200` status
### POST /v0/inboxes/{inbox_id}/drafts
- :warning: removed the request property `attachments`
- added the required property `thread_id` to the response with the `200` status
### GET /v0/inboxes/{inbox_id}/drafts/{draft_id}
- added the required property `thread_id` to the response with the `200` status
### PATCH /v0/inboxes/{inbox_id}/drafts/{draft_id}
- added the required property `thread_id` to the response with the `200` status
### GET /v0/inboxes/{inbox_id}/drafts/{draft_id}/attachments/{attachment_id}
- :warning: api path removed without deprecation
### POST /v0/inboxes/{inbox_id}/drafts/{draft_id}/send
- :warning: request property `add_labels` list-of-types was narrowed by removing types `string` from media type `application/json`
- :warning: request property `remove_labels` list-of-types was narrowed by removing types `string` from media type `application/json`
- the request property `add_labels` became nullable
- the request property `remove_labels` became nullable
### GET /v0/inboxes/{inbox_id}/events
- :warning: api path removed without deprecation
### GET /v0/inboxes/{inbox_id}/lists/{direction}/{type}
- :warning: api path removed without deprecation
### POST /v0/inboxes/{inbox_id}/lists/{direction}/{type}
- :warning: api path removed without deprecation
### DELETE /v0/inboxes/{inbox_id}/lists/{direction}/{type}/{entry}
- :warning: api path removed without deprecation
### GET /v0/inboxes/{inbox_id}/lists/{direction}/{type}/{entry}
- :warning: api path removed without deprecation
### GET /v0/inboxes/{inbox_id}/messages
- :warning: deleted the `query` request parameter `include_blocked`
- :warning: deleted the `query` request parameter `include_trash`
- :warning: deleted the `query` request parameter `include_unauthenticated`
### POST /v0/inboxes/{inbox_id}/messages/batch-get
- :warning: api path removed without deprecation
### DELETE /v0/inboxes/{inbox_id}/messages/{message_id}
- :warning: api removed without deprecation
### PATCH /v0/inboxes/{inbox_id}/messages/{message_id}
- :warning: request property `add_labels` list-of-types was narrowed by removing types `string` from media type `application/json`
- :warning: request property `remove_labels` list-of-types was narrowed by removing types `string` from media type `application/json`
- the request property `add_labels` became nullable
- the request property `remove_labels` became nullable
- added the optional property `attachments` to the response with the `200` status
- added the optional property `bcc` to the response with the `200` status
- added the optional property `cc` to the response with the `200` status
- added the optional property `extracted_html` to the response with the `200` status
- added the optional property `extracted_text` to the response with the `200` status
- added the optional property `headers` to the response with the `200` status
- added the optional property `html` to the response with the `200` status
- added the optional property `in_reply_to` to the response with the `200` status
- added the optional property `preview` to the response with the `200` status
- added the optional property `references` to the response with the `200` status
- added the optional property `reply_to` to the response with the `200` status
- added the optional property `subject` to the response with the `200` status
- added the optional property `text` to the response with the `200` status
- added the required property `created_at` to the response with the `200` status
- added the required property `from` to the response with the `200` status
- added the required property `inbox_id` to the response with the `200` status
- added the required property `size` to the response with the `200` status
- added the required property `thread_id` to the response with the `200` status
- added the required property `timestamp` to the response with the `200` status
- added the required property `to` to the response with the `200` status
- added the required property `updated_at` to the response with the `200` status
### GET /v0/inboxes/{inbox_id}/metrics
- :warning: added the new required `query` request parameter `end_timestamp`
- :warning: added the new required `query` request parameter `start_timestamp`
- :warning: deleted the `query` request parameter `descending`
- :warning: deleted the `query` request parameter `end`
- :warning: deleted the `query` request parameter `limit`
- :warning: deleted the `query` request parameter `period`
- :warning: deleted the `query` request parameter `start`
- api operation id `inboxes_metrics_query` removed and replaced with `inboxes_metrics_get`
- added the non-success response with the status `404`
- added the optional property `message` to the response with the `200` status
### GET /v0/inboxes/{inbox_id}/threads
- :warning: deleted the `query` request parameter `include_blocked`
- :warning: deleted the `query` request parameter `include_trash`
- :warning: deleted the `query` request parameter `include_unauthenticated`
### DELETE /v0/inboxes/{inbox_id}/threads/{thread_id}
- :warning: deleted the `query` request parameter `permanent`
### PATCH /v0/inboxes/{inbox_id}/threads/{thread_id}
- :warning: api removed without deprecation
### GET /v0/lists/{direction}/{type}
- :warning: api path removed without deprecation
### POST /v0/lists/{direction}/{type}
- :warning: api path removed without deprecation
### DELETE /v0/lists/{direction}/{type}/{entry}
- :warning: api path removed without deprecation
### GET /v0/lists/{direction}/{type}/{entry}
- :warning: api path removed without deprecation
### GET /v0/metrics
- :warning: added the new required `query` request parameter `end_timestamp`
- :warning: added the new required `query` request parameter `start_timestamp`
- :warning: deleted the `query` request parameter `descending`
- :warning: deleted the `query` request parameter `end`
- :warning: deleted the `query` request parameter `limit`
- :warning: deleted the `query` request parameter `period`
- :warning: deleted the `query` request parameter `start`
- api operation id `metrics_query` removed and replaced with `metrics_list`
- added the non-success response with the status `404`
- removed the non-success response with the status `400`
- added the optional property `message` to the response with the `200` status
### GET /v0/organizations
- :warning: removed the optional property `authentication_id` from the response with the `200` status
- :warning: removed the optional property `authentication_type` from the response with the `200` status
- :warning: removed the optional property `billing_id` from the response with the `200` status
- :warning: removed the optional property `billing_subscription_id` from the response with the `200` status
- :warning: removed the optional property `billing_type` from the response with the `200` status
### GET /v0/pods
- :warning: deleted the `query` request parameter `ascending`
### GET /v0/pods/{pod_id}/api-keys
- :warning: api path removed without deprecation
### POST /v0/pods/{pod_id}/api-keys
- :warning: api path removed without deprecation
### DELETE /v0/pods/{pod_id}/api-keys/{api_key_id}
- :warning: api path removed without deprecation
### GET /v0/pods/{pod_id}/domains
- :warning: removed the required property `domains/items/domain` from the response with the `200` status
- :warning: deleted the `query` request parameter `ascending`
### POST /v0/pods/{pod_id}/domains
- :warning: removed the required property `domain` from the response with the `200` status
### GET /v0/pods/{pod_id}/domains/{domain_id}
- :warning: api removed without deprecation
### PATCH /v0/pods/{pod_id}/domains/{domain_id}
- :warning: api removed without deprecation
### POST /v0/pods/{pod_id}/domains/{domain_id}/verify
- :warning: api path removed without deprecation
### GET /v0/pods/{pod_id}/domains/{domain_id}/zone-file
- :warning: api path removed without deprecation
### GET /v0/pods/{pod_id}/drafts
- :warning: removed the optional property `drafts/items/in_reply_to` from the response with the `200` status
- added the required property `drafts/items/thread_id` to the response with the `200` status
### GET /v0/pods/{pod_id}/drafts/{draft_id}
- added the required property `thread_id` to the response with the `200` status
### GET /v0/pods/{pod_id}/drafts/{draft_id}/attachments/{attachment_id}
- :warning: api path removed without deprecation
### GET /v0/pods/{pod_id}/inboxes
- :warning: removed the required property `inboxes/items/email` from the response with the `200` status
- :warning: deleted the `query` request parameter `ascending`
### POST /v0/pods/{pod_id}/inboxes
- :warning: removed the required property `email` from the response with the `200` status
### GET /v0/pods/{pod_id}/inboxes/{inbox_id}
- :warning: removed the required property `email` from the response with the `200` status
### PATCH /v0/pods/{pod_id}/inboxes/{inbox_id}
- :warning: api removed without deprecation
### GET /v0/pods/{pod_id}/lists/{direction}/{type}
- :warning: api path removed without deprecation
### POST /v0/pods/{pod_id}/lists/{direction}/{type}
- :warning: api path removed without deprecation
### DELETE /v0/pods/{pod_id}/lists/{direction}/{type}/{entry}
- :warning: api path removed without deprecation
### GET /v0/pods/{pod_id}/lists/{direction}/{type}/{entry}
- :warning: api path removed without deprecation
### GET /v0/pods/{pod_id}/metrics
- :warning: api path removed without deprecation
### GET /v0/pods/{pod_id}/threads
- :warning: deleted the `query` request parameter `include_blocked`
- :warning: deleted the `query` request parameter `include_trash`
- :warning: deleted the `query` request parameter `include_unauthenticated`
### DELETE /v0/pods/{pod_id}/threads/{thread_id}
- :warning: api removed without deprecation
### PATCH /v0/pods/{pod_id}/threads/{thread_id}
- :warning: api removed without deprecation
### GET /v0/threads
- :warning: deleted the `query` request parameter `include_blocked`
- :warning: deleted the `query` request parameter `include_trash`
- :warning: deleted the `query` request parameter `include_unauthenticated`
### DELETE /v0/threads/{thread_id}
- :warning: api removed without deprecation
### PATCH /v0/threads/{thread_id}
- :warning: api removed without deprecation
### GET /v0/webhooks
- :warning: deleted the `query` request parameter `ascending`
- removed the `message.received.blocked` enum value from the `webhooks/items/event_types/items/` response property for the response status `200`
- removed the `message.received.spam` enum value from the `webhooks/items/event_types/items/` response property for the response status `200`
- removed the `message.received.unauthenticated` enum value from the `webhooks/items/event_types/items/` response property for the response status `200`
### POST /v0/webhooks
- :warning: removed the enum value `message.received.blocked` of the request property `event_types/items/`
- :warning: removed the enum value `message.received.spam` of the request property `event_types/items/`
- :warning: removed the enum value `message.received.unauthenticated` of the request property `event_types/items/`
- removed the `message.received.blocked` enum value from the `event_types/items/` response property for the response status `200`
- removed the `message.received.spam` enum value from the `event_types/items/` response property for the response status `200`
- removed the `message.received.unauthenticated` enum value from the `event_types/items/` response property for the response status `200`
### GET /v0/webhooks/{webhook_id}
- removed the `message.received.blocked` enum value from the `event_types/items/` response property for the response status `200`
- removed the `message.received.spam` enum value from the `event_types/items/` response property for the response status `200`
- removed the `message.received.unauthenticated` enum value from the `event_types/items/` response property for the response status `200`
### PATCH /v0/webhooks/{webhook_id}
- :warning: removed the request property `event_types`
- removed the `message.received.blocked` enum value from the `event_types/items/` response property for the response status `200`
- removed the `message.received.spam` enum value from the `event_types/items/` response property for the response status `200`
- removed the `message.received.unauthenticated` enum value from the `event_types/items/` response property for the response status `200`
## Components
- removed the schema `AgentSignupRequest`
- removed the schema `AgentSignupResponse`
- removed the schema `AgentVerifyRequest`
- removed the schema `AgentVerifyResponse`
- removed the schema `ApiKeyPermissions`
- removed the schema `BatchGetMessagesMessageIds`
- removed the schema `BatchGetMessagesRequest`
- removed the schema `BatchGetMessagesResponse`
- removed the schema `CreateListEntryRequest`
- removed the schema `Descending`
- removed the schema `Direction`
- removed the schema `End`
- removed the schema `EntryType`
- removed the schema `Error`
- removed the schema `ErrorMessage`
- removed the schema `InboxEvent`
- removed the schema `InboxEventId`
- removed the schema `InboxEventType`
- removed the schema `IncludeBlocked`
- removed the schema `IncludeTrash`
- removed the schema `IncludeUnauthenticated`
- removed the schema `ListEntry`
- removed the schema `ListEntryBase`
- removed the schema `ListInboxEventsResponse`
- removed the schema `ListListEntriesResponse`
- removed the schema `ListType`
- removed the schema `MessageReceivedEventType`
- removed the schema `MetricBucket`
- removed the schema `MetricLimit`
- removed the schema `Period`
- removed the schema `PodListEntry`
- removed the schema `PodListListEntriesResponse`
- removed the schema `QueryMetricsResponse`
- removed the schema `Start`
- removed the schema `Status`
- removed the schema `UpdateDomainRequest`
- removed the schema `UpdateMessageLabels`
- removed the schema `UpdateMessageResponse`
- removed the schema `UpdateThreadRequest`
- removed the schema `UpdateThreadResponse`
- removed the schema `inboxesEmail`💡 Download |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.