openapi.json

{
  "openapi": "3.0.2",
  "info": {
    "title": "NinjaAPI",
    "version": "1.0.0",
    "description": ""
  },
  "paths": {
    "/exports": {
      "post": {
        "operationId": "create_export",
        "summary": "Create Export",
        "parameters": [],
        "responses": {
          "201": {
            "description": "Created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Export"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage_CreateExportErrorCode_"
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ExportInput"
              }
            }
          },
          "required": true
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      },
      "get": {
        "operationId": "list_exports",
        "summary": "List Exports",
        "parameters": [],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExportPage"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      }
    },
    "/exports/{id}": {
      "get": {
        "operationId": "retrieve_export",
        "summary": "Retrieve Export",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "schema": {
              "title": "Id",
              "type": "string",
              "format": "uuid"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Export"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      }
    },
    "/tags": {
      "post": {
        "operationId": "create_tag",
        "summary": "Create Tag",
        "parameters": [],
        "responses": {
          "201": {
            "description": "Created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Tag"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TagInput"
              }
            }
          },
          "required": true
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      },
      "get": {
        "operationId": "list_tags",
        "summary": "List Tags",
        "parameters": [],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TagPage"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      }
    },
    "/tags/{id}": {
      "get": {
        "operationId": "retrieve_tag",
        "summary": "Retrieve Tag",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "schema": {
              "title": "Id",
              "type": "string",
              "format": "uuid"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Tag"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      },
      "patch": {
        "operationId": "update_tag",
        "summary": "Update Tag",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "schema": {
              "title": "Id",
              "type": "string",
              "format": "uuid"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Tag"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage_UpdateTagErrorCode_"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TagUpdateInput"
              }
            }
          },
          "required": true
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      },
      "delete": {
        "operationId": "delete_tag",
        "summary": "Delete Tag",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "schema": {
              "title": "Id",
              "type": "string",
              "format": "uuid"
            },
            "required": true
          }
        ],
        "responses": {
          "204": {
            "description": "No Content"
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      }
    },
    "/tags/{id}/analytics": {
      "get": {
        "operationId": "retrieve_tag_analytics",
        "summary": "Retrieve Tag Analytics",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "schema": {
              "title": "Id",
              "type": "string",
              "format": "uuid"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TagAnalytics"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          }
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      }
    },
    "/ping": {
      "get": {
        "operationId": "ping",
        "summary": "Ping",
        "parameters": [],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Empty"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "security": [
          {
            "GlobalAuth": []
          },
          {
            "OAuthAuth": []
          },
          {
            "FallbackForNoAuth": []
          }
        ]
      }
    },
    "/accounts/me": {
      "get": {
        "operationId": "get_account",
        "summary": "Get Account",
        "parameters": [],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Account"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "security": [
          {
            "GlobalAuth": []
          },
          {
            "OAuthAuth": []
          },
          {
            "FallbackForNoAuth": []
          }
        ]
      }
    },
    "/images": {
      "post": {
        "operationId": "create_image",
        "summary": "Create Image",
        "parameters": [],
        "responses": {
          "201": {
            "description": "Created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Image"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "requestBody": {
          "content": {
            "multipart/form-data": {
              "schema": {
                "title": "FileParams",
                "type": "object",
                "properties": {
                  "image": {
                    "title": "Image",
                    "type": "string",
                    "format": "binary"
                  }
                },
                "required": [
                  "image"
                ]
              }
            }
          },
          "required": true
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      },
      "get": {
        "operationId": "list_images",
        "summary": "List Images",
        "parameters": [],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ImagePage"
                }
              }
            }
          }
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      }
    },
    "/images/{id}": {
      "delete": {
        "operationId": "delete_image",
        "summary": "Delete Image",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "schema": {
              "title": "Id",
              "type": "string",
              "format": "uuid"
            },
            "required": true
          }
        ],
        "responses": {
          "204": {
            "description": "No Content"
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      }
    },
    "/emails": {
      "post": {
        "operationId": "create_email",
        "summary": "Create Email",
        "parameters": [],
        "responses": {
          "201": {
            "description": "Created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Email"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage_EmailCreationErrorCode_"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EmailInput"
              }
            }
          },
          "required": true
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      },
      "get": {
        "operationId": "list_emails",
        "summary": "List Emails",
        "parameters": [
          {
            "in": "query",
            "name": "status",
            "schema": {
              "description": "Note that for historical reasons, if `status` is not included in the query, the default is to only return emails with a status of `about_to_send`, `in_flight`, or `sent`. This is a legacy behavior and may change in the future.\n\nIf you want to include drafts, you must explicitly include `draft` in the `status` query parameter. (Same thing with imported emails.)\n",
              "default": [
                "about_to_send",
                "in_flight",
                "sent"
              ],
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/EmailStatus"
              }
            },
            "required": false,
            "description": "Note that for historical reasons, if `status` is not included in the query, the default is to only return emails with a status of `about_to_send`, `in_flight`, or `sent`. This is a legacy behavior and may change in the future.\n\nIf you want to include drafts, you must explicitly include `draft` in the `status` query parameter. (Same thing with imported emails.)\n"
          },
          {
            "in": "query",
            "name": "automations",
            "schema": {
              "title": "Automations",
              "default": [],
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "required": false
          },
          {
            "in": "query",
            "name": "ids",
            "schema": {
              "title": "Ids",
              "description": "If provided, only return emails with the given ids.",
              "type": "array",
              "items": {
                "type": "string",
                "format": "uuid"
              }
            },
            "required": false,
            "description": "If provided, only return emails with the given ids."
          },
          {
            "in": "query",
            "name": "ordering",
            "schema": {
              "default": "creation_date",
              "allOf": [
                {
                  "title": "Ordering",
                  "description": "An enumeration.",
                  "enum": [
                    "creation_date",
                    "-creation_date",
                    "status",
                    "-status",
                    "publish_date",
                    "-publish_date",
                    "subject",
                    "-subject",
                    "email_type",
                    "-email_type",
                    "modification_date",
                    "-modification_date",
                    "clicks",
                    "-clicks",
                    "opens",
                    "-opens",
                    "click_rate",
                    "-click_rate",
                    "open_rate",
                    "-open_rate",
                    "page_views__lifetime",
                    "-page_views__lifetime",
                    "page_views__30",
                    "-page_views__30",
                    "page_views__7",
                    "-page_views__7",
                    "webmentions",
                    "-webmentions",
                    "subscriptions",
                    "-subscriptions",
                    "paid_subscriptions",
                    "-paid_subscriptions",
                    "unsubscriptions",
                    "-unsubscriptions",
                    "replies",
                    "-replies",
                    "comments",
                    "-comments",
                    "social_mentions",
                    "-social_mentions"
                  ],
                  "type": "string"
                }
              ]
            },
            "required": false
          },
          {
            "in": "query",
            "name": "creation_date__start",
            "schema": {
              "title": "Creation Date  Start",
              "type": "string"
            },
            "required": false
          },
          {
            "in": "query",
            "name": "creation_date__end",
            "schema": {
              "title": "Creation Date  End",
              "type": "string"
            },
            "required": false
          },
          {
            "in": "query",
            "name": "publish_date__start",
            "schema": {
              "title": "Publish Date  Start",
              "type": "string"
            },
            "required": false
          },
          {
            "in": "query",
            "name": "publish_date__end",
            "schema": {
              "title": "Publish Date  End",
              "type": "string"
            },
            "required": false
          },
          {
            "in": "query",
            "name": "excluded_fields",
            "schema": {
              "default": [],
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/EmailExcludableField"
              }
            },
            "required": false
          },
          {
            "in": "query",
            "name": "source",
            "schema": {
              "default": [],
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/EmailSource"
              }
            },
            "required": false
          },
          {
            "in": "query",
            "name": "email_type",
            "schema": {
              "default": [],
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/EmailType"
              }
            },
            "required": false
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EmailPage"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage_EmailListErrorCode_"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "404": {
            "description": "Not Found"
          },
          "409": {
            "description": "Conflict"
          }
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      }
    },
    "/emails/{id}": {
      "patch": {
        "operationId": "update_email",
        "summary": "Update Email",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "schema": {
              "title": "Id",
              "type": "string",
              "format": "uuid"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Email"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EmailUpdateInput"
              }
            }
          },
          "required": true
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      },
      "get": {
        "operationId": "retrieve_email",
        "summary": "Retrieve Email",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "schema": {
              "title": "Id",
              "type": "string",
              "format": "uuid"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Email"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      }
    },
    "/emails/{id}/history": {
      "get": {
        "operationId": "retrieve_email_history",
        "summary": "Retrieve Email History",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "schema": {
              "title": "Id",
              "type": "string",
              "format": "uuid"
            },
            "required": true
          },
          {
            "in": "query",
            "name": "expand",
            "schema": {
              "title": "Expand",
              "description": "If provided, expand the given field.",
              "type": "array",
              "items": {
                "enum": [
                  "user"
                ],
                "type": "string"
              }
            },
            "required": false,
            "description": "If provided, expand the given field."
          },
          {
            "in": "query",
            "name": "field",
            "schema": {
              "title": "Field",
              "type": "string"
            },
            "required": true
          },
          {
            "in": "query",
            "name": "page",
            "schema": {
              "title": "Page",
              "type": "integer"
            },
            "required": false
          },
          {
            "in": "query",
            "name": "ordering",
            "schema": {
              "title": "Ordering",
              "default": "creation_date",
              "enum": [
                "creation_date",
                "-creation_date"
              ],
              "type": "string"
            },
            "required": false
          },
          {
            "in": "query",
            "name": "query",
            "schema": {
              "title": "Query",
              "type": "string"
            },
            "required": false
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HistoryPage"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      }
    },
    "/emails/{id}/history/body/{history_id}": {
      "get": {
        "operationId": "retrieve_email_history_by_id",
        "summary": "Retrieve Email History By Id",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "schema": {
              "title": "Id",
              "type": "string",
              "format": "uuid"
            },
            "required": true
          },
          {
            "in": "path",
            "name": "history_id",
            "schema": {
              "title": "History Id",
              "type": "integer"
            },
            "required": true
          },
          {
            "in": "query",
            "name": "expand",
            "schema": {
              "title": "Expand",
              "description": "If provided, expand the given field.",
              "type": "array",
              "items": {
                "enum": [
                  "user"
                ],
                "type": "string"
              }
            },
            "required": false,
            "description": "If provided, expand the given field."
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/History"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      }
    },
    "/emails/{id}/analytics": {
      "get": {
        "operationId": "retrieve_email_analytics",
        "summary": "Retrieve Email Analytics",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "schema": {
              "title": "Id",
              "type": "string",
              "format": "uuid"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Analytics"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      }
    },
    "/emails/{id}/send-draft": {
      "post": {
        "operationId": "send_draft",
        "summary": "Send Draft",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "schema": {
              "title": "Id",
              "type": "string",
              "format": "uuid"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SendDraftInput"
              }
            }
          },
          "required": true
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      }
    },
    "/subscribers": {
      "post": {
        "operationId": "create_subscriber",
        "summary": "Create Subscriber",
        "parameters": [
          {
            "in": "header",
            "name": "X-Buttondown-Collision-Behavior",
            "schema": {
              "description": "The behavior to apply when a subscriber with the same email address already exists.\nDefaults to \"no_op\", which will return a 400 error if a subscriber with the same email address already exists. Other values include:\n\n- \"overwrite\", which will overwrite the existing subscriber's data with the new one.\n- \"add\", which will add the new subscriber data to the existing one.\n        ",
              "default": "no_op",
              "allOf": [
                {
                  "title": "CollisionBehavior",
                  "description": "An enumeration.",
                  "enum": [
                    "no_op",
                    "add",
                    "overwrite",
                    "fail"
                  ]
                }
              ]
            },
            "required": false,
            "description": "The behavior to apply when a subscriber with the same email address already exists.\nDefaults to \"no_op\", which will return a 400 error if a subscriber with the same email address already exists. Other values include:\n\n- \"overwrite\", which will overwrite the existing subscriber's data with the new one.\n- \"add\", which will add the new subscriber data to the existing one.\n        "
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Subscriber"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage_ValidationErrorCode_"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SubscriberInput"
              }
            }
          },
          "required": true
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      },
      "get": {
        "operationId": "list_subscribers",
        "summary": "List Subscribers",
        "parameters": [
          {
            "in": "query",
            "name": "type",
            "schema": {
              "description": "If provided, only return subscribers with the given type.",
              "example": "regular",
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/SubscriberType"
              }
            },
            "required": false,
            "description": "If provided, only return subscribers with the given type."
          },
          {
            "in": "query",
            "name": "ids",
            "schema": {
              "title": "Ids",
              "description": "If provided, only return subscribers with the given IDs.",
              "type": "array",
              "items": {
                "type": "string",
                "format": "uuid"
              }
            },
            "required": false,
            "description": "If provided, only return subscribers with the given IDs."
          },
          {
            "in": "query",
            "name": "email_address",
            "schema": {
              "title": "Email Address",
              "description": "If provided, only return subscribers whose email address contains the given string.",
              "default": "",
              "example": "telemachus@buttondown.email",
              "type": "string"
            },
            "required": false,
            "description": "If provided, only return subscribers whose email address contains the given string."
          },
          {
            "in": "query",
            "name": "tag",
            "schema": {
              "title": "Tag",
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "required": false
          },
          {
            "in": "query",
            "name": "-tag",
            "schema": {
              "title": "-Tag",
              "type": "string"
            },
            "required": false
          },
          {
            "in": "query",
            "name": "ordering",
            "schema": {
              "title": "Ordering",
              "default": "-creation_date",
              "type": "string"
            },
            "required": false
          },
          {
            "in": "query",
            "name": "utm_source",
            "schema": {
              "title": "Utm Source",
              "description": "If provided, only return subscribers with the given UTM source(s).",
              "example": "paid_campaign_2024",
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "required": false,
            "description": "If provided, only return subscribers with the given UTM source(s)."
          },
          {
            "in": "query",
            "name": "price",
            "schema": {
              "title": "Price",
              "description": "If provided, only return subscribers with the given price ID(s).",
              "example": "price_whatever",
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "required": false,
            "description": "If provided, only return subscribers with the given price ID(s)."
          },
          {
            "in": "query",
            "name": "coupon",
            "schema": {
              "title": "Coupon",
              "description": "If provided, only return subscribers with the given coupon ID(s).",
              "example": "coupon_whatever",
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "required": false,
            "description": "If provided, only return subscribers with the given coupon ID(s)."
          },
          {
            "in": "query",
            "name": "referral_code",
            "schema": {
              "title": "Referral Code",
              "description": "If provided, only return subscribers with the given referral code(s).",
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "required": false,
            "description": "If provided, only return subscribers with the given referral code(s)."
          },
          {
            "in": "query",
            "name": "date",
            "schema": {
              "title": "Date",
              "description": "If provided, only return subscribers created on or after the given date.",
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "required": false,
            "description": "If provided, only return subscribers created on or after the given date."
          },
          {
            "in": "query",
            "name": "last_open_date",
            "schema": {
              "title": "Last Open Date",
              "description": "If provided, only return subscribers with the given last open date(s).",
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "required": false,
            "description": "If provided, only return subscribers with the given last open date(s)."
          },
          {
            "in": "query",
            "name": "last_click_date",
            "schema": {
              "title": "Last Click Date",
              "description": "If provided, only return subscribers with the given last click date(s).",
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "required": false,
            "description": "If provided, only return subscribers with the given last click date(s)."
          },
          {
            "in": "query",
            "name": "subscriber_import",
            "schema": {
              "title": "Subscriber Import",
              "description": "If provided, only return subscribers that were imported by the given subscriber import.",
              "type": "array",
              "items": {
                "type": "string",
                "format": "uuid"
              }
            },
            "required": false,
            "description": "If provided, only return subscribers that were imported by the given subscriber import."
          },
          {
            "in": "query",
            "name": "expand",
            "schema": {
              "title": "Expand",
              "description": "If provided, expand the given field. (Only supported fields: 'stripe_customer')",
              "type": "array",
              "items": {
                "enum": [
                  "stripe_customer"
                ],
                "type": "string"
              }
            },
            "required": false,
            "description": "If provided, expand the given field. (Only supported fields: 'stripe_customer')"
          },
          {
            "in": "query",
            "name": "ip_address",
            "schema": {
              "title": "Ip Address",
              "description": "If provided, only return subscribers with the given IP address(es).",
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "required": false,
            "description": "If provided, only return subscribers with the given IP address(es)."
          },
          {
            "in": "query",
            "name": "referrer_url",
            "schema": {
              "title": "Referrer Url",
              "description": "If provided, only return subscribers with the given referrer URL(s).",
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "required": false,
            "description": "If provided, only return subscribers with the given referrer URL(s)."
          },
          {
            "in": "query",
            "name": "upgrade_date__start",
            "schema": {
              "title": "Upgrade Date  Start",
              "type": "string"
            },
            "required": false
          },
          {
            "in": "query",
            "name": "upgrade_date__end",
            "schema": {
              "title": "Upgrade Date  End",
              "type": "string"
            },
            "required": false
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SubscriberPage"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage_ListSubscribersErrorCode_"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      }
    },
    "/subscribers/{id_or_email}": {
      "get": {
        "operationId": "retrieve_subscriber",
        "summary": "Retrieve Subscriber",
        "parameters": [
          {
            "in": "path",
            "name": "id_or_email",
            "schema": {
              "title": "Id Or Email",
              "type": "string"
            },
            "required": true
          },
          {
            "in": "query",
            "name": "expand",
            "schema": {
              "title": "Expand",
              "default": [],
              "type": "array",
              "items": {
                "enum": [
                  "stripe_customer"
                ],
                "type": "string"
              }
            },
            "required": false
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Subscriber"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      },
      "delete": {
        "operationId": "delete_subscriber",
        "summary": "Delete Subscriber",
        "parameters": [
          {
            "in": "path",
            "name": "id_or_email",
            "schema": {
              "title": "Id Or Email",
              "type": "string"
            },
            "required": true
          }
        ],
        "responses": {
          "204": {
            "description": "No Content"
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      },
      "patch": {
        "operationId": "update_subscriber",
        "summary": "Update Subscriber",
        "parameters": [
          {
            "in": "path",
            "name": "id_or_email",
            "schema": {
              "title": "Id Or Email",
              "type": "string"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Subscriber"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage_UpdateSubscriberErrorCode_"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SubscriberUpdateInput"
              }
            }
          },
          "required": true
        },
        "security": [
          {
            "GlobalAuth": []
          }
        ]
      }
    },
    "/subscribers/{id_or_email}/send-reminder": {
      "post": {
        "operationId": "send_reminder",
        "summary": "Send Reminder",
        "parameters": [
          {
            "in": "path",
            "name": "id_or_email",
            "schema": {
              "title": "Id Or Email",
              "type": "string"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      }
    },
    "/subscribers/{id_or_email}/emails/{email_id}": {
      "post": {
        "operationId": "send_email_to",
        "summary": "Send Email To",
        "parameters": [
          {
            "in": "path",
            "name": "id_or_email",
            "schema": {
              "title": "Id Or Email",
              "type": "string"
            },
            "required": true
          },
          {
            "in": "path",
            "name": "email_id",
            "schema": {
              "title": "Email Id",
              "type": "string",
              "format": "uuid"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Empty"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      }
    },
    "/subscribers/{id_or_email}/clients": {
      "get": {
        "operationId": "get_clients",
        "summary": "Get Clients",
        "parameters": [
          {
            "in": "path",
            "name": "id_or_email",
            "schema": {
              "title": "Id Or Email",
              "type": "string"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ClientPage"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      }
    },
    "/subscribers/{id_or_email}/referrals": {
      "get": {
        "operationId": "get_referrals",
        "summary": "Get Referrals",
        "parameters": [
          {
            "in": "path",
            "name": "id_or_email",
            "schema": {
              "title": "Id Or Email",
              "type": "string"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SubscriberPage"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      }
    },
    "/subscribers/{id_or_email}/automations": {
      "get": {
        "operationId": "get_automations",
        "summary": "Get Automations",
        "parameters": [
          {
            "in": "path",
            "name": "id_or_email",
            "schema": {
              "title": "Id Or Email",
              "type": "string"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AutomationForSubscriberPage"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      }
    },
    "/subscribers/{id_or_email}/stripe-subscriptions": {
      "get": {
        "operationId": "get_stripe_subscriptions",
        "summary": "Get Stripe Subscriptions",
        "parameters": [
          {
            "in": "path",
            "name": "id_or_email",
            "schema": {
              "title": "Id Or Email",
              "type": "string"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StripeSubscriptionPage"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      }
    },
    "/newsletters": {
      "get": {
        "operationId": "list_newsletters",
        "summary": "List Newsletters",
        "parameters": [],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NewsletterPage"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      },
      "post": {
        "operationId": "create_newsletter",
        "summary": "Create Newsletter",
        "parameters": [],
        "responses": {
          "201": {
            "description": "Created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Newsletter"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage_CreateNewsletterErrorCode_"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NewsletterInput"
              }
            }
          },
          "required": true
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      }
    },
    "/newsletters/{id}": {
      "patch": {
        "operationId": "update_newsletter",
        "summary": "Update Newsletter",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "schema": {
              "title": "Id",
              "type": "string",
              "format": "uuid"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Newsletter"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NewsletterUpdateInput"
              }
            }
          },
          "required": true
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      },
      "delete": {
        "operationId": "delete_newsletter",
        "summary": "Delete Newsletter",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "schema": {
              "title": "Id",
              "type": "string",
              "format": "uuid"
            },
            "required": true
          }
        ],
        "responses": {
          "204": {
            "description": "No Content"
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      }
    },
    "/bulk_actions": {
      "post": {
        "operationId": "create_bulk_action",
        "summary": "Create Bulk Action",
        "parameters": [],
        "responses": {
          "201": {
            "description": "Created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BulkAction"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/BulkActionInput"
              }
            }
          },
          "required": true
        },
        "security": [
          {
            "BulkActionAuth": []
          }
        ]
      }
    },
    "/bulk_actions/{id}": {
      "get": {
        "operationId": "retrieve_bulk_action",
        "summary": "Retrieve Bulk Action",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "schema": {
              "title": "Id",
              "type": "string",
              "format": "uuid"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BulkAction"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      }
    },
    "/external_feeds": {
      "post": {
        "operationId": "create_external_feed",
        "summary": "Create External Feed",
        "parameters": [],
        "responses": {
          "201": {
            "description": "Created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExternalFeed"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ExternalFeedInput"
              }
            }
          },
          "required": true
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      },
      "get": {
        "operationId": "list_external_feed",
        "summary": "List External Feed",
        "parameters": [],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExternalFeedPage"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      }
    },
    "/external_feeds/{id}": {
      "patch": {
        "operationId": "update_external_feed",
        "summary": "Update External Feed",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "schema": {
              "title": "Id",
              "type": "string",
              "format": "uuid"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExternalFeed"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ExternalFeedUpdateInput"
              }
            }
          },
          "required": true
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      },
      "delete": {
        "operationId": "delete_external_feed",
        "summary": "Delete External Feed",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "schema": {
              "title": "Id",
              "type": "string",
              "format": "uuid"
            },
            "required": true
          }
        ],
        "responses": {
          "204": {
            "description": "No Content"
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      },
      "get": {
        "operationId": "retrieve_external_feed",
        "summary": "Retrieve External Feed",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "schema": {
              "title": "Id",
              "type": "string",
              "format": "uuid"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExternalFeed"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      }
    },
    "/external_feeds/{id}/items": {
      "post": {
        "operationId": "poll_items",
        "summary": "Poll Items",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "schema": {
              "title": "Id",
              "type": "string",
              "format": "uuid"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Empty"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      },
      "get": {
        "operationId": "retrieve_items",
        "summary": "Retrieve Items",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "schema": {
              "title": "Id",
              "type": "string",
              "format": "uuid"
            },
            "required": true
          },
          {
            "in": "query",
            "name": "expand",
            "schema": {
              "title": "Expand",
              "description": "If provided, expand the given field.",
              "type": "array",
              "items": {
                "enum": [
                  "email"
                ],
                "type": "string"
              }
            },
            "required": false,
            "description": "If provided, expand the given field."
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExternalFeedItemPage"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      }
    },
    "/automations": {
      "get": {
        "operationId": "list_automations",
        "summary": "List Automations",
        "parameters": [],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AutomationPage"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      },
      "post": {
        "operationId": "create_automation",
        "summary": "Create Automation",
        "parameters": [],
        "responses": {
          "201": {
            "description": "Created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Automation"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage_AutomationCreationErrorCode_"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AutomationInput"
              }
            }
          },
          "required": true
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      }
    },
    "/automations/{id}/subscribers": {
      "get": {
        "operationId": "retrieve_automation_subscribers",
        "summary": "Retrieve Automation Subscribers",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "schema": {
              "title": "Id",
              "type": "string",
              "format": "uuid"
            },
            "required": true
          },
          {
            "in": "query",
            "name": "expand",
            "schema": {
              "title": "Expand",
              "description": "If provided, expand the given field. (Only supported field: 'subscriber').",
              "type": "array",
              "items": {
                "enum": [
                  "subscriber"
                ],
                "type": "string"
              }
            },
            "required": false,
            "description": "If provided, expand the given field. (Only supported field: 'subscriber')."
          },
          {
            "in": "query",
            "name": "page",
            "schema": {
              "title": "Page",
              "default": 1,
              "type": "integer"
            },
            "required": false
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SubscriberForAutomationPage"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      }
    },
    "/automations/{id}": {
      "get": {
        "operationId": "retrieve_automation",
        "summary": "Retrieve Automation",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "schema": {
              "title": "Id",
              "type": "string",
              "format": "uuid"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Automation"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      },
      "patch": {
        "operationId": "update_automation",
        "summary": "Update Automation",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "schema": {
              "title": "Id",
              "type": "string",
              "format": "uuid"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Automation"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AutomationUpdateInput"
              }
            }
          },
          "required": true
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      },
      "delete": {
        "operationId": "delete_automation",
        "summary": "Delete Automation",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "schema": {
              "title": "Id",
              "type": "string",
              "format": "uuid"
            },
            "required": true
          }
        ],
        "responses": {
          "204": {
            "description": "No Content"
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      }
    },
    "/automations/{id}/invoke": {
      "post": {
        "operationId": "invoke_automation",
        "summary": "Invoke Automation",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "schema": {
              "title": "Id",
              "type": "string",
              "format": "uuid"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      }
    },
    "/automations/{id}/analytics": {
      "get": {
        "operationId": "retrieve_automation_analytics",
        "summary": "Retrieve Automation Analytics",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "schema": {
              "title": "Id",
              "type": "string",
              "format": "uuid"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Analytics"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      }
    },
    "/users": {
      "post": {
        "operationId": "create_user",
        "summary": "Create User",
        "parameters": [],
        "responses": {
          "201": {
            "description": "Created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/User"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage_Failure_"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UserInput"
              }
            }
          },
          "required": true
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      },
      "get": {
        "operationId": "list_users",
        "summary": "List Users",
        "parameters": [],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UserPage"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      }
    },
    "/users/{id}": {
      "delete": {
        "operationId": "delete_user",
        "summary": "Delete User",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "schema": {
              "title": "Id",
              "type": "string",
              "format": "uuid"
            },
            "required": true
          }
        ],
        "responses": {
          "204": {
            "description": "No Content"
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      },
      "patch": {
        "operationId": "update_user",
        "summary": "Update User",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "schema": {
              "title": "Id",
              "type": "string",
              "format": "uuid"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/User"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UserUpdateInput"
              }
            }
          },
          "required": true
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      }
    },
    "/prices": {
      "get": {
        "operationId": "list_prices",
        "summary": "List Prices",
        "parameters": [
          {
            "in": "query",
            "name": "expand",
            "schema": {
              "title": "Expand",
              "description": "If provided, expand the given field.",
              "type": "array",
              "items": {
                "enum": [
                  "product"
                ],
                "type": "string"
              }
            },
            "required": false,
            "description": "If provided, expand the given field."
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PricePage"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage_ListPricesErrorCode_"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      },
      "post": {
        "operationId": "create_price",
        "summary": "Create Price",
        "parameters": [],
        "responses": {
          "201": {
            "description": "Created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Price"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage_CreatePriceErrorCode_"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PriceInput"
              }
            }
          },
          "required": true
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      }
    },
    "/coupons": {
      "get": {
        "operationId": "list_coupons",
        "summary": "List Coupons",
        "parameters": [],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StripeCouponPage"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      }
    },
    "/surveys": {
      "post": {
        "operationId": "create_survey",
        "summary": "Create Survey",
        "parameters": [],
        "responses": {
          "201": {
            "description": "Created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Survey"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage_CreateSurveyErrorCode_"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SurveyInput"
              }
            }
          },
          "required": true
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      },
      "get": {
        "operationId": "list_surveys",
        "summary": "List Surveys",
        "parameters": [],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SurveyPage"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      }
    },
    "/surveys/{id}": {
      "get": {
        "operationId": "retrieve_survey",
        "summary": "Retrieve Survey",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "schema": {
              "title": "Id",
              "type": "string",
              "format": "uuid"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Survey"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      },
      "patch": {
        "operationId": "update_survey",
        "summary": "Update Survey",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "schema": {
              "title": "Id",
              "type": "string",
              "format": "uuid"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Survey"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage_UpdateSurveyErrorCode_"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SurveyUpdateInput"
              }
            }
          },
          "required": true
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      },
      "delete": {
        "operationId": "delete_survey",
        "summary": "Delete Survey",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "schema": {
              "title": "Id",
              "type": "string",
              "format": "uuid"
            },
            "required": true
          }
        ],
        "responses": {
          "204": {
            "description": "No Content"
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      }
    },
    "/api_requests/{id}": {
      "get": {
        "operationId": "retrieve_api_request",
        "summary": "Retrieve Api Request",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "schema": {
              "title": "Id",
              "type": "string",
              "format": "uuid"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/APIRequestDetail"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      }
    },
    "/api_requests": {
      "get": {
        "operationId": "list_api_requests",
        "summary": "List Api Requests",
        "parameters": [
          {
            "in": "query",
            "name": "status_code",
            "schema": {
              "title": "Status Code",
              "default": [],
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "required": false
          },
          {
            "in": "query",
            "name": "method",
            "schema": {
              "title": "Method",
              "default": [],
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "required": false
          },
          {
            "in": "query",
            "name": "source",
            "schema": {
              "default": [],
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/APIRequestSource"
              }
            },
            "required": false
          },
          {
            "in": "query",
            "name": "version",
            "schema": {
              "title": "Version",
              "type": "array",
              "items": {
                "enum": [
                  "2024-07-01",
                  "2024-08-01",
                  "2024-08-15",
                  "2024-09-30",
                  "2024-12-30",
                  "2025-01-02"
                ],
                "type": "string"
              }
            },
            "required": false
          },
          {
            "in": "query",
            "name": "page",
            "schema": {
              "title": "Page",
              "default": 1,
              "type": "integer"
            },
            "required": false
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/APIRequestPage"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      }
    },
    "/advertising_units": {
      "get": {
        "operationId": "list_advertising_units",
        "summary": "List Advertising Units",
        "parameters": [],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AdvertisingUnitPage"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      },
      "post": {
        "operationId": "create_advertising_unit",
        "summary": "Create Advertising Unit",
        "parameters": [],
        "responses": {
          "201": {
            "description": "Created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AdvertisingUnit"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AdvertisingUnitInput"
              }
            }
          },
          "required": true
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      }
    },
    "/advertising_units/{id}": {
      "patch": {
        "operationId": "update_advertising_unit",
        "summary": "Update Advertising Unit",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "schema": {
              "title": "Id",
              "type": "string",
              "format": "uuid"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AdvertisingUnit"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AdvertisingUnitUpdateInput"
              }
            }
          },
          "required": true
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      },
      "delete": {
        "operationId": "delete_advertising_unit",
        "summary": "Delete Advertising Unit",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "schema": {
              "title": "Id",
              "type": "string",
              "format": "uuid"
            },
            "required": true
          }
        ],
        "responses": {
          "204": {
            "description": "No Content"
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      }
    },
    "/webhooks": {
      "post": {
        "operationId": "create_webhook",
        "summary": "Create Webhook",
        "parameters": [],
        "responses": {
          "201": {
            "description": "Created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Webhook"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/WebhookInput"
              }
            }
          },
          "required": true
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      },
      "get": {
        "operationId": "list_webhooks",
        "summary": "List Webhooks",
        "parameters": [],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookPage"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      }
    },
    "/webhooks/{id}": {
      "get": {
        "operationId": "retrieve_webhook",
        "summary": "Retrieve Webhook",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "schema": {
              "title": "Id",
              "type": "string",
              "format": "uuid"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Webhook"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      },
      "patch": {
        "operationId": "update_webhook",
        "summary": "Update Webhook",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "schema": {
              "title": "Id",
              "type": "string",
              "format": "uuid"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Webhook"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/WebhookInput"
              }
            }
          },
          "required": true
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      },
      "delete": {
        "operationId": "delete_webhook",
        "summary": "Delete Webhook",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "schema": {
              "title": "Id",
              "type": "string",
              "format": "uuid"
            },
            "required": true
          }
        ],
        "responses": {
          "204": {
            "description": "No Content"
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      }
    },
    "/webhooks/{id}/attempts": {
      "get": {
        "operationId": "retrieve_webhook_attempts",
        "summary": "Retrieve Webhook Attempts",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "schema": {
              "title": "Id",
              "type": "string",
              "format": "uuid"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WebhookAttemptOutputPage"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      }
    },
    "/webhooks/{id}/test": {
      "post": {
        "operationId": "test_webhook",
        "summary": "Test Webhook",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "schema": {
              "title": "Id",
              "type": "string",
              "format": "uuid"
            },
            "required": true
          },
          {
            "in": "query",
            "name": "event_type",
            "schema": {
              "title": "Type",
              "description": "Various types of events that are recorded by Buttondown, both in terms of exogenous systems\nlike Stripe and Memberful, and endogenous ones like email opens and clicks. (In general, if anything\nimportant ever happens that could be relevant to your newsletter, we have an event type for it!)\n\nThese event types power lots of things within Buttondown. They're used to trigger automations, webhooks,\nand analytics.\n\n(Note that Buttondown also has a different thing we call \"events\"; those are `EmailEvents` and are used\nfor tracking aggregate details about an email. Alas, we shouldn't have used the term \"event\" for two different\nthings, but it's too late to go back now!)",
              "enum": [
                "subscriber.created",
                "subscriber.unsubscribed",
                "subscriber.changed_email",
                "subscriber.confirmed",
                "subscriber.trial_started",
                "subscriber.trial_ended",
                "subscriber.type.changed",
                "subscriber.tags.changed",
                "subscriber.clicked",
                "subscriber.opened",
                "subscriber.paid",
                "subscriber.churned",
                "subscriber.updated",
                "subscriber.deleted",
                "subscriber.viewed_checkout_page",
                "subscriber.replied",
                "subscriber.paused",
                "subscriber.resumed",
                "subscriber.responded_to_survey",
                "subscriber.referred",
                "subscriber.referred.paid",
                "subscriber.commented",
                "email.created",
                "email.sent",
                "email.updated",
                "email.deleted",
                "email.status.changed",
                "scheduled_email.converted",
                "mention.created",
                "advertising_slot.purchased",
                "social_mention.created",
                "export.created",
                "export.completed",
                "export.failed",
                "automation.invoked",
                "stripe.checkout.session.completed",
                "stripe.subscription.activated",
                "stripe.subscription.churning",
                "stripe.subscription.deactivated",
                "stripe.customer.updated",
                "memberful.subscription.created",
                "memberful.subscription.deleted",
                "memberful.member.updated"
              ],
              "type": "string"
            },
            "required": false,
            "description": "Various types of events that are recorded by Buttondown, both in terms of exogenous systems\nlike Stripe and Memberful, and endogenous ones like email opens and clicks. (In general, if anything\nimportant ever happens that could be relevant to your newsletter, we have an event type for it!)\n\nThese event types power lots of things within Buttondown. They're used to trigger automations, webhooks,\nand analytics.\n\n(Note that Buttondown also has a different thing we call \"events\"; those are `EmailEvents` and are used\nfor tracking aggregate details about an email. Alas, we shouldn't have used the term \"event\" for two different\nthings, but it's too late to go back now!)"
          }
        ],
        "responses": {
          "204": {
            "description": "No Content"
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      }
    },
    "/comments": {
      "get": {
        "operationId": "list_comments",
        "summary": "List Comments",
        "parameters": [
          {
            "in": "query",
            "name": "email_id",
            "schema": {
              "title": "Email Id",
              "description": "If provided, only return comments for the given email.",
              "type": "string",
              "format": "uuid"
            },
            "required": false,
            "description": "If provided, only return comments for the given email."
          },
          {
            "in": "query",
            "name": "subscriber_id",
            "schema": {
              "title": "Subscriber Id",
              "description": "If provided, only return comments for the given subscriber.",
              "type": "string",
              "format": "uuid"
            },
            "required": false,
            "description": "If provided, only return comments for the given subscriber."
          },
          {
            "in": "query",
            "name": "expand",
            "schema": {
              "title": "Expand",
              "description": "If provided, expand the given field. (Only supported fields: 'subscriber', 'email').",
              "type": "array",
              "items": {
                "enum": [
                  "subscriber",
                  "email"
                ],
                "type": "string"
              }
            },
            "required": false,
            "description": "If provided, expand the given field. (Only supported fields: 'subscriber', 'email')."
          },
          {
            "in": "query",
            "name": "ordering",
            "schema": {
              "default": "-creation_date",
              "allOf": [
                {
                  "title": "Ordering",
                  "description": "An enumeration.",
                  "enum": [
                    "creation_date",
                    "-creation_date",
                    "email",
                    "-email",
                    "subscriber",
                    "-subscriber"
                  ],
                  "type": "string"
                }
              ]
            },
            "required": false
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CommentPage"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      }
    },
    "/survey_responses": {
      "get": {
        "operationId": "retrieve_survey_responses",
        "summary": "Retrieve Survey Responses",
        "parameters": [
          {
            "in": "query",
            "name": "email",
            "schema": {
              "title": "Email",
              "description": "If provided, only return responses made to the given email.",
              "type": "string",
              "format": "uuid"
            },
            "required": false,
            "description": "If provided, only return responses made to the given email."
          },
          {
            "in": "query",
            "name": "subscriber",
            "schema": {
              "title": "Subscriber",
              "description": "If provided, only return responses made by the given subscriber.",
              "type": "string",
              "format": "uuid"
            },
            "required": false,
            "description": "If provided, only return responses made by the given subscriber."
          },
          {
            "in": "query",
            "name": "survey",
            "schema": {
              "title": "Survey",
              "description": "If provided, only return responses made to the given survey(s).",
              "type": "array",
              "items": {
                "type": "string",
                "format": "uuid"
              }
            },
            "required": false,
            "description": "If provided, only return responses made to the given survey(s)."
          },
          {
            "in": "query",
            "name": "creation_date__start",
            "schema": {
              "title": "Creation Date  Start",
              "description": "If provided, only return responses made after the given date.",
              "example": "2024-01-01",
              "type": "string"
            },
            "required": false,
            "description": "If provided, only return responses made after the given date."
          },
          {
            "in": "query",
            "name": "creation_date__end",
            "schema": {
              "title": "Creation Date  End",
              "description": "If provided, only return responses made before the given date.",
              "example": "2024-01-01",
              "type": "string"
            },
            "required": false,
            "description": "If provided, only return responses made before the given date."
          },
          {
            "in": "query",
            "name": "expand",
            "schema": {
              "title": "Expand",
              "description": "If provided, expand the given field.",
              "type": "array",
              "items": {
                "enum": [
                  "email",
                  "subscriber",
                  "survey",
                  "automation"
                ],
                "type": "string"
              }
            },
            "required": false,
            "description": "If provided, expand the given field."
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ResponsePage"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      },
      "post": {
        "operationId": "create_survey_response",
        "summary": "Create Survey Response",
        "parameters": [],
        "responses": {
          "201": {
            "description": "Created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Response"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ResponseInput"
              }
            }
          },
          "required": true
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      }
    },
    "/events": {
      "get": {
        "operationId": "list_events",
        "summary": "List Events",
        "parameters": [
          {
            "in": "query",
            "name": "event_type",
            "schema": {
              "$ref": "#/components/schemas/EmailEventType"
            },
            "required": false
          },
          {
            "in": "query",
            "name": "ordering",
            "schema": {
              "default": "-creation_date",
              "allOf": [
                {
                  "title": "Ordering",
                  "description": "An enumeration.",
                  "enum": [
                    "creation_date",
                    "-creation_date"
                  ],
                  "type": "string"
                }
              ]
            },
            "required": false
          },
          {
            "in": "query",
            "name": "expand",
            "schema": {
              "title": "Expand",
              "description": "If provided, expand the given field. (Only supported field: 'subscriber').",
              "type": "array",
              "items": {
                "enum": [
                  "automation",
                  "subscriber",
                  "email"
                ],
                "type": "string"
              }
            },
            "required": false,
            "description": "If provided, expand the given field. (Only supported field: 'subscriber')."
          },
          {
            "in": "query",
            "name": "email_id",
            "schema": {
              "title": "Email Id",
              "type": "string",
              "format": "uuid"
            },
            "required": false
          },
          {
            "in": "query",
            "name": "automation_id",
            "schema": {
              "title": "Automation Id",
              "type": "string",
              "format": "uuid"
            },
            "required": false
          },
          {
            "in": "query",
            "name": "subscriber_id",
            "schema": {
              "title": "Subscriber Id",
              "type": "string",
              "format": "uuid"
            },
            "required": false
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EmailEventPage"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "409": {
            "description": "Conflict"
          }
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      }
    },
    "/events/{id}": {
      "get": {
        "operationId": "get_event",
        "summary": "Get Event",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "schema": {
              "title": "Id",
              "type": "string",
              "format": "uuid"
            },
            "required": true
          },
          {
            "in": "query",
            "name": "expand",
            "schema": {
              "title": "Expand",
              "description": "If provided, expand the given field. (Only supported field: 'subscriber').",
              "type": "array",
              "items": {
                "enum": [
                  "automation",
                  "subscriber",
                  "email"
                ],
                "type": "string"
              }
            },
            "required": false,
            "description": "If provided, expand the given field. (Only supported field: 'subscriber')."
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EmailEvent"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          }
        },
        "security": [
          {
            "PermissionAuthenticationRequirement": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "ExportCollection": {
        "title": "Collection",
        "description": "A group of data that can be exported in an export.",
        "enum": [
          "subscribers",
          "emails",
          "events",
          "referrals",
          "surveys",
          "comments",
          "requests",
          "mentions",
          "conversations"
        ],
        "type": "string"
      },
      "ExportStatus": {
        "title": "Status",
        "description": "Represents the status of an export.\n\nNo action is required to move from one state or another; Buttondown\ninternally handles the transitions, and exposing the status is for\nobservability purposes only.",
        "enum": [
          "error",
          "in_progress",
          "not_started",
          "ready"
        ],
        "type": "string"
      },
      "Export": {
        "title": "Export",
        "description": "Some software applications may want programmatic access to their newsletter exports.\nThis assists with a few niche use cases, such as regular backups or data ingestion\n(into a data warehouse), or post-publishing processes that hinge on email events.\n\nIn general, you probably won't _need_ to use this endpoint unless you\n_absolutely_ need to use this endpoint.\n\nTo browse the contents of a given export collection, refer to the [Data exports](https://docs.buttondown.com/data-exports-subscriber) section\nof the documentation.",
        "type": "object",
        "properties": {
          "collections": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ExportCollection"
            }
          },
          "parameters": {
            "title": "Parameters",
            "type": "object"
          },
          "columns": {
            "title": "Columns",
            "description": "If provided, the export will only include these columns.",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "id": {
            "title": "Id",
            "description": "A unique UUID associated with the object.",
            "type": "string",
            "format": "uuid"
          },
          "creation_date": {
            "title": "Creation Date",
            "description": "The date and time at which the object was created.",
            "type": "string",
            "format": "date-time"
          },
          "url": {
            "title": "Url",
            "type": "string"
          },
          "completion_date": {
            "title": "Completion Date",
            "type": "string",
            "format": "date-time"
          },
          "status": {
            "$ref": "#/components/schemas/ExportStatus"
          }
        },
        "required": [
          "collections",
          "id",
          "creation_date",
          "status"
        ]
      },
      "ErrorMessage": {
        "title": "ErrorMessage",
        "type": "object",
        "properties": {
          "code": {
            "title": "Code"
          },
          "detail": {
            "title": "Detail",
            "type": "string"
          },
          "metadata": {
            "title": "Metadata",
            "default": {},
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          }
        },
        "required": [
          "detail"
        ]
      },
      "CreateExportErrorCode": {
        "title": "CreateExportErrorCode",
        "description": "An enumeration.",
        "enum": [
          "collection_empty_invalid",
          "columns_empty_invalid",
          "columns_invalid"
        ],
        "type": "string"
      },
      "ErrorMessage_CreateExportErrorCode_": {
        "title": "ErrorMessage[CreateExportErrorCode]",
        "type": "object",
        "properties": {
          "code": {
            "$ref": "#/components/schemas/CreateExportErrorCode"
          },
          "detail": {
            "title": "Detail",
            "type": "string"
          },
          "metadata": {
            "title": "Metadata",
            "default": {},
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          }
        },
        "required": [
          "code",
          "detail"
        ]
      },
      "ExportInput": {
        "title": "ExportInput",
        "type": "object",
        "properties": {
          "collections": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ExportCollection"
            }
          },
          "parameters": {
            "title": "Parameters",
            "type": "object"
          },
          "columns": {
            "title": "Columns",
            "description": "If provided, the export will only include these columns.",
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "collections"
        ]
      },
      "ExportPage": {
        "title": "Page[Export]",
        "type": "object",
        "properties": {
          "results": {
            "title": "Results",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Export"
            }
          },
          "next": {
            "title": "Next",
            "type": "string"
          },
          "previous": {
            "title": "Previous",
            "type": "string"
          },
          "count": {
            "title": "Count",
            "type": "integer"
          }
        },
        "required": [
          "results",
          "count"
        ]
      },
      "Tag": {
        "title": "Tag",
        "description": "Tags are a way to organize your subscribers. You can create, update, and\ndelete tags via the API. You can also list all tags for a given newsletter.\n\nTags don't have any strict functionality on their own, but you can send emails\nto subscribers with a given tag (or to all subscribers _without_ a given tag.)",
        "type": "object",
        "properties": {
          "name": {
            "title": "Name",
            "example": "VIP",
            "type": "string"
          },
          "color": {
            "title": "Color",
            "example": "#FFD700",
            "type": "string"
          },
          "description": {
            "title": "Description",
            "type": "string"
          },
          "id": {
            "title": "Id",
            "type": "string",
            "format": "uuid"
          },
          "secondary_id": {
            "title": "Secondary Id",
            "type": "integer"
          },
          "creation_date": {
            "title": "Creation Date",
            "type": "string",
            "format": "date-time"
          }
        },
        "required": [
          "name",
          "color",
          "id",
          "secondary_id",
          "creation_date"
        ]
      },
      "TagInput": {
        "title": "TagInput",
        "type": "object",
        "properties": {
          "name": {
            "title": "Name",
            "example": "VIP",
            "type": "string"
          },
          "color": {
            "title": "Color",
            "example": "#FFD700",
            "type": "string"
          },
          "description": {
            "title": "Description",
            "type": "string"
          }
        },
        "required": [
          "name",
          "color"
        ]
      },
      "TagPage": {
        "title": "Page[Tag]",
        "type": "object",
        "properties": {
          "results": {
            "title": "Results",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Tag"
            }
          },
          "next": {
            "title": "Next",
            "type": "string"
          },
          "previous": {
            "title": "Previous",
            "type": "string"
          },
          "count": {
            "title": "Count",
            "type": "integer"
          }
        },
        "required": [
          "results",
          "count"
        ]
      },
      "UpdateTagErrorCode": {
        "title": "UpdateTagErrorCode",
        "description": "A potential error code that can be returned when updating a tag.",
        "enum": [
          "name_already_exists",
          "name_too_long"
        ],
        "type": "string"
      },
      "ErrorMessage_UpdateTagErrorCode_": {
        "title": "ErrorMessage[UpdateTagErrorCode]",
        "type": "object",
        "properties": {
          "code": {
            "$ref": "#/components/schemas/UpdateTagErrorCode"
          },
          "detail": {
            "title": "Detail",
            "type": "string"
          },
          "metadata": {
            "title": "Metadata",
            "default": {},
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          }
        },
        "required": [
          "code",
          "detail"
        ]
      },
      "TagUpdateInput": {
        "title": "TagUpdateInput",
        "type": "object",
        "properties": {
          "name": {
            "title": "Name",
            "example": "VIP",
            "type": "string"
          },
          "color": {
            "title": "Color",
            "example": "#FFD700",
            "type": "string"
          },
          "description": {
            "title": "Description",
            "type": "string"
          },
          "secondary_id": {
            "title": "Secondary Id",
            "type": "integer"
          }
        }
      },
      "TagAnalytics": {
        "title": "TagAnalytics",
        "type": "object",
        "properties": {
          "count": {
            "title": "Count",
            "type": "integer"
          },
          "click_rate": {
            "title": "Click Rate",
            "type": "number"
          },
          "open_rate": {
            "title": "Open Rate",
            "type": "number"
          },
          "retention": {
            "title": "Retention",
            "type": "number"
          }
        },
        "required": [
          "count",
          "click_rate",
          "open_rate",
          "retention"
        ]
      },
      "Empty": {
        "title": "Empty",
        "type": "object",
        "properties": {}
      },
      "Account": {
        "title": "Account",
        "type": "object",
        "properties": {
          "username": {
            "title": "Username",
            "type": "string"
          },
          "email_address": {
            "title": "Email Address",
            "type": "string"
          }
        },
        "required": [
          "username",
          "email_address"
        ]
      },
      "Image": {
        "title": "Image",
        "description": "Images are, well, images! Buttondown allows you to upload images to its secure\nS3 bucket and do with them what you will. This is sort of an odd duck of an\nAPI, to be sure, but if you want to be able to do things like draft\nand send emails completely on your iPad you need a surefire way of creating images.",
        "type": "object",
        "properties": {
          "id": {
            "title": "Id",
            "type": "string",
            "format": "uuid"
          },
          "creation_date": {
            "title": "Creation Date",
            "type": "string",
            "format": "date-time"
          },
          "image": {
            "title": "Image",
            "description": "The URL of the image.",
            "example": "https://placekitten.com/408/287",
            "type": "string"
          }
        },
        "required": [
          "id",
          "creation_date",
          "image"
        ]
      },
      "ImagePage": {
        "title": "Page[Image]",
        "type": "object",
        "properties": {
          "results": {
            "title": "Results",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Image"
            }
          },
          "next": {
            "title": "Next",
            "type": "string"
          },
          "previous": {
            "title": "Previous",
            "type": "string"
          },
          "count": {
            "title": "Count",
            "type": "integer"
          }
        },
        "required": [
          "results",
          "count"
        ]
      },
      "EmailSource": {
        "title": "Source",
        "description": "Represents the original provenance of an email. This value is not exposed\nto subscribers, but does determine some behavior of the email (e.g. whether\nor not analytics can be calculated.)",
        "enum": [
          "api",
          "import",
          "app",
          "external_feed"
        ],
        "type": "string"
      },
      "EmailType": {
        "title": "Type",
        "description": "Represents the audience of an email, and to whom it is visible both in the initial\nemail and in online archives.",
        "enum": [
          "public",
          "private",
          "premium",
          "free",
          "churned",
          "archival",
          "hidden"
        ],
        "type": "string"
      },
      "EmailStatus": {
        "title": "Status",
        "description": "Represents the state of an email.\n\nNo action is required to move from one state or another; Buttondown\ninternally handles the transitions, and exposing the status is for\nobservability purposes only.",
        "enum": [
          "draft",
          "managed_by_rss",
          "about_to_send",
          "scheduled",
          "in_flight",
          "paused",
          "deleted",
          "errored",
          "sent",
          "imported"
        ],
        "type": "string"
      },
      "EmailCommentingMode": {
        "title": "CommentingMode",
        "description": "Governs who can comment on this email.\n\nThis enum replaces the `is_comments_disabled` field, which has been deprecated. (Also note that this field may be superseded by newsletter-level settings; for instance, \"enabled\" is an invalid and inert value if the newsletter itself has comments disabled.)",
        "enum": [
          "disabled",
          "enabled",
          "enabled_for_paid_subscribers"
        ],
        "type": "string"
      },
      "Operator": {
        "title": "Operator",
        "description": "An enumeration.",
        "enum": [
          "equals",
          "not_equals",
          "contains",
          "not_contains",
          "is_empty",
          "is_not_empty",
          "greater_than",
          "less_than"
        ],
        "type": "string"
      },
      "Filter": {
        "title": "Filter",
        "type": "object",
        "properties": {
          "field": {
            "title": "Field",
            "type": "string"
          },
          "operator": {
            "$ref": "#/components/schemas/Operator"
          },
          "value": {
            "title": "Value",
            "type": "string"
          }
        },
        "required": [
          "field",
          "operator",
          "value"
        ]
      },
      "FilterGroup": {
        "title": "FilterGroup",
        "description": "Buttondown's filtering schema can be used for multiple things:\n\n- Filtering [the audience of an email](/api-emails-create) to a specific subset\n- Creating [finely-tuned automations](/api-automations-create)",
        "type": "object",
        "properties": {
          "filters": {
            "title": "Filters",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Filter"
            }
          },
          "groups": {
            "title": "Groups",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/FilterGroup"
            }
          },
          "predicate": {
            "title": "Predicate",
            "description": "The logical operator to use when combining filters (either 'and' or 'or').",
            "enum": [
              "and",
              "or"
            ],
            "type": "string"
          }
        },
        "required": [
          "filters",
          "groups",
          "predicate"
        ]
      },
      "Analytics": {
        "title": "Analytics",
        "type": "object",
        "properties": {
          "recipients": {
            "title": "Recipients",
            "default": 0,
            "type": "integer"
          },
          "deliveries": {
            "title": "Deliveries",
            "default": 0,
            "type": "integer"
          },
          "opens": {
            "title": "Opens",
            "default": 0,
            "type": "integer"
          },
          "clicks": {
            "title": "Clicks",
            "default": 0,
            "type": "integer"
          },
          "temporary_failures": {
            "title": "Temporary Failures",
            "default": 0,
            "type": "integer"
          },
          "permanent_failures": {
            "title": "Permanent Failures",
            "default": 0,
            "type": "integer"
          },
          "unsubscriptions": {
            "title": "Unsubscriptions",
            "default": 0,
            "type": "integer"
          },
          "complaints": {
            "title": "Complaints",
            "default": 0,
            "type": "integer"
          },
          "survey_responses": {
            "title": "Survey Responses",
            "default": 0,
            "type": "integer"
          },
          "webmentions": {
            "title": "Webmentions",
            "default": 0,
            "type": "integer"
          },
          "page_views__lifetime": {
            "title": "Page Views  Lifetime",
            "default": 0,
            "type": "integer"
          },
          "page_views__30": {
            "title": "Page Views  30",
            "default": 0,
            "type": "integer"
          },
          "page_views__7": {
            "title": "Page Views  7",
            "default": 0,
            "type": "integer"
          },
          "subscriptions": {
            "title": "Subscriptions",
            "default": 0,
            "type": "integer"
          },
          "paid_subscriptions": {
            "title": "Paid Subscriptions",
            "default": 0,
            "type": "integer"
          },
          "replies": {
            "title": "Replies",
            "default": 0,
            "type": "integer"
          },
          "comments": {
            "title": "Comments",
            "default": 0,
            "type": "integer"
          },
          "social_mentions": {
            "title": "Social Mentions",
            "default": 0,
            "type": "integer"
          }
        }
      },
      "NewsletterEmailTemplate": {
        "title": "EmailTemplate",
        "description": "Represents the template of an email.\n\nEach template has a different layout/style; you can view screenshots and examples [in the docs](https://docs.buttondown.com/customizing-email-design#buttondowns-default-templates).",
        "enum": [
          "classic",
          "modern",
          "modern-german",
          "airy",
          "plaintext",
          "naked"
        ],
        "type": "string"
      },
      "Email": {
        "title": "Email",
        "description": "Emails are why you're here on Buttondown, right?\nCreating an email via the API is just like creating one in the interface;\nit will instantly trigger sending actual emails,\nbased on the tags and email type you provide.\n\nRelevant changes to the schema:\n\n- [2024-08-15](https://docs.buttondown.com/api-changelog-2024-08-15): unshipped the `included_tags` and `excluded_tags` fields.\n- [2024-12-30](https://docs.buttondown.com/api-changelog-2024-12-30): unshipped the `is_comments_disabled` field, and replaced it with a more flexible `commenting_mode` field.",
        "type": "object",
        "properties": {
          "id": {
            "title": "Id",
            "type": "string",
            "format": "uuid"
          },
          "creation_date": {
            "title": "Creation Date",
            "description": "The date and time the object was first created.",
            "type": "string",
            "format": "date-time"
          },
          "modification_date": {
            "title": "Modification Date",
            "description": "The date and time the object was last modified.",
            "type": "string",
            "format": "date-time"
          },
          "publish_date": {
            "title": "Publish Date",
            "type": "string",
            "format": "date-time"
          },
          "attachments": {
            "title": "Attachments",
            "type": "array",
            "items": {
              "type": "string",
              "format": "uuid"
            }
          },
          "subject": {
            "title": "Subject",
            "type": "string"
          },
          "canonical_url": {
            "title": "Canonical Url",
            "type": "string"
          },
          "image": {
            "title": "Image",
            "type": "string"
          },
          "description": {
            "title": "Description",
            "type": "string"
          },
          "source": {
            "$ref": "#/components/schemas/EmailSource"
          },
          "body": {
            "title": "Body",
            "description": "Can be either HTML or markdown.",
            "type": "string"
          },
          "secondary_id": {
            "title": "Secondary Id",
            "type": "integer"
          },
          "email_type": {
            "$ref": "#/components/schemas/EmailType"
          },
          "slug": {
            "title": "Slug",
            "type": "string"
          },
          "status": {
            "$ref": "#/components/schemas/EmailStatus"
          },
          "metadata": {
            "title": "Metadata",
            "description": "A structured key-value blob that you can use to store arbitrary data on the object.",
            "default": {},
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          },
          "should_send_teaser": {
            "title": "Should Send Teaser",
            "type": "boolean"
          },
          "commenting_mode": {
            "$ref": "#/components/schemas/EmailCommentingMode"
          },
          "custom_teaser": {
            "title": "Custom Teaser",
            "type": "string"
          },
          "absolute_url": {
            "title": "Absolute Url",
            "type": "string"
          },
          "filters": {
            "$ref": "#/components/schemas/FilterGroup"
          },
          "analytics": {
            "$ref": "#/components/schemas/Analytics"
          },
          "template": {
            "$ref": "#/components/schemas/NewsletterEmailTemplate"
          },
          "related_email_ids": {
            "title": "Related Email Ids",
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "id",
          "creation_date",
          "modification_date",
          "subject",
          "canonical_url",
          "image",
          "description",
          "source",
          "body",
          "email_type",
          "status",
          "should_send_teaser",
          "commenting_mode",
          "custom_teaser",
          "absolute_url",
          "filters",
          "related_email_ids"
        ]
      },
      "EmailCreationErrorCode": {
        "title": "EmailCreationErrorCode",
        "description": "Represents the type of error that occurred when creating an email.\n\nHuman-readable error messages are provided in the `detail` field of the response;\nthese values are meant to be parseable by code or client logic.",
        "enum": [
          "subject_invalid",
          "email_duplicate",
          "email_invalid",
          "body_invalid",
          "publish_date_invalid",
          "publish_date_missing",
          "status_invalid",
          "slug_invalid",
          "canonical_url_invalid",
          "tag_invalid"
        ],
        "type": "string"
      },
      "ErrorMessage_EmailCreationErrorCode_": {
        "title": "ErrorMessage[EmailCreationErrorCode]",
        "type": "object",
        "properties": {
          "code": {
            "$ref": "#/components/schemas/EmailCreationErrorCode"
          },
          "detail": {
            "title": "Detail",
            "type": "string"
          },
          "metadata": {
            "title": "Metadata",
            "default": {},
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          }
        },
        "required": [
          "code",
          "detail"
        ]
      },
      "EmailInput": {
        "title": "EmailInput",
        "type": "object",
        "properties": {
          "attachments": {
            "title": "Attachments",
            "default": [],
            "type": "array",
            "items": {
              "type": "string",
              "format": "uuid"
            }
          },
          "publish_date": {
            "title": "Publish Date",
            "type": "string",
            "format": "date-time"
          },
          "subject": {
            "title": "Subject",
            "example": "The subject line for the email",
            "type": "string"
          },
          "slug": {
            "title": "Slug",
            "type": "string"
          },
          "description": {
            "title": "Description",
            "default": "",
            "type": "string"
          },
          "canonical_url": {
            "title": "Canonical Url",
            "default": "",
            "type": "string"
          },
          "image": {
            "title": "Image",
            "default": "",
            "type": "string"
          },
          "body": {
            "title": "Body",
            "description": "Can be either HTML or markdown.",
            "default": "",
            "example": "This is an example of the body of an email.",
            "type": "string"
          },
          "email_type": {
            "default": "public",
            "allOf": [
              {
                "$ref": "#/components/schemas/EmailType"
              }
            ]
          },
          "status": {
            "default": "about_to_send",
            "allOf": [
              {
                "$ref": "#/components/schemas/EmailStatus"
              }
            ]
          },
          "metadata": {
            "title": "Metadata",
            "description": "A structured key-value blob that you can use to store arbitrary data on the object.",
            "default": {},
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          },
          "should_send_teaser": {
            "title": "Should Send Teaser",
            "default": false,
            "type": "boolean"
          },
          "custom_teaser": {
            "title": "Custom Teaser",
            "default": "",
            "type": "string"
          },
          "secondary_id": {
            "title": "Secondary Id",
            "type": "integer"
          },
          "filters": {
            "title": "Filters",
            "default": {
              "filters": [],
              "groups": [],
              "predicate": "and"
            },
            "allOf": [
              {
                "$ref": "#/components/schemas/FilterGroup"
              }
            ]
          },
          "commenting_mode": {
            "default": "enabled",
            "allOf": [
              {
                "$ref": "#/components/schemas/EmailCommentingMode"
              }
            ]
          },
          "related_email_ids": {
            "title": "Related Email Ids",
            "default": [],
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "subject"
        ]
      },
      "EmailPage": {
        "title": "Page[Email]",
        "type": "object",
        "properties": {
          "results": {
            "title": "Results",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Email"
            }
          },
          "next": {
            "title": "Next",
            "type": "string"
          },
          "previous": {
            "title": "Previous",
            "type": "string"
          },
          "count": {
            "title": "Count",
            "type": "integer"
          }
        },
        "required": [
          "results",
          "count"
        ]
      },
      "EmailListErrorCode": {
        "title": "EmailListErrorCode",
        "description": "Represents the type of error that occurred when listing emails.\n\nHuman-readable error messages are provided in the `detail` field of the response;\nthese values are meant to be parseable by code or client logic.",
        "enum": [
          "creation_date_invalid",
          "publish_date_invalid"
        ],
        "type": "string"
      },
      "ErrorMessage_EmailListErrorCode_": {
        "title": "ErrorMessage[EmailListErrorCode]",
        "type": "object",
        "properties": {
          "code": {
            "$ref": "#/components/schemas/EmailListErrorCode"
          },
          "detail": {
            "title": "Detail",
            "type": "string"
          },
          "metadata": {
            "title": "Metadata",
            "default": {},
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          }
        },
        "required": [
          "code",
          "detail"
        ]
      },
      "EmailUpdateInput": {
        "title": "EmailUpdateInput",
        "type": "object",
        "properties": {
          "attachments": {
            "title": "Attachments",
            "type": "array",
            "items": {
              "type": "string",
              "format": "uuid"
            }
          },
          "publish_date": {
            "title": "Publish Date",
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "enum": [
                  "none"
                ],
                "type": "string"
              }
            ]
          },
          "subject": {
            "title": "Subject",
            "maxLength": 1000,
            "example": "The subject line for the email",
            "type": "string"
          },
          "description": {
            "title": "Description",
            "type": "string"
          },
          "canonical_url": {
            "title": "Canonical Url",
            "description": "The URL of the original source of the content.",
            "example": "https://sheinhardtwig.com/2025/01/17/our-nbc-partnership",
            "type": "string"
          },
          "body": {
            "title": "Body",
            "description": "Can be either HTML or markdown.",
            "example": "This is an example of the body of an email.",
            "type": "string"
          },
          "email_type": {
            "$ref": "#/components/schemas/EmailType"
          },
          "status": {
            "$ref": "#/components/schemas/EmailStatus"
          },
          "metadata": {
            "title": "Metadata",
            "description": "A structured key-value blob that you can use to store arbitrary data on the object.",
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          },
          "image": {
            "title": "Image",
            "default": "",
            "type": "string"
          },
          "should_send_teaser": {
            "title": "Should Send Teaser",
            "type": "boolean"
          },
          "custom_teaser": {
            "title": "Custom Teaser",
            "type": "string"
          },
          "slug": {
            "title": "Slug",
            "example": "hello-world",
            "type": "string"
          },
          "secondary_id": {
            "title": "Secondary Id",
            "type": "integer"
          },
          "filters": {
            "$ref": "#/components/schemas/FilterGroup"
          },
          "template": {
            "title": "Template",
            "anyOf": [
              {
                "$ref": "#/components/schemas/NewsletterEmailTemplate"
              },
              {
                "enum": [
                  "none"
                ],
                "type": "string"
              }
            ]
          },
          "commenting_mode": {
            "$ref": "#/components/schemas/EmailCommentingMode"
          },
          "related_email_ids": {
            "title": "Related Email Ids",
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "AccessLevel": {
        "title": "AccessLevel",
        "description": "An enumeration.",
        "enum": [
          "none",
          "read",
          "write"
        ],
        "type": "string"
      },
      "Permissions": {
        "title": "Permissions",
        "type": "object",
        "properties": {
          "subscriber": {
            "default": "none",
            "allOf": [
              {
                "$ref": "#/components/schemas/AccessLevel"
              }
            ]
          },
          "email": {
            "default": "none",
            "allOf": [
              {
                "$ref": "#/components/schemas/AccessLevel"
              }
            ]
          },
          "sending": {
            "default": "none",
            "allOf": [
              {
                "$ref": "#/components/schemas/AccessLevel"
              }
            ]
          },
          "styling": {
            "default": "none",
            "allOf": [
              {
                "$ref": "#/components/schemas/AccessLevel"
              }
            ]
          },
          "administrivia": {
            "default": "none",
            "allOf": [
              {
                "$ref": "#/components/schemas/AccessLevel"
              }
            ]
          },
          "automations": {
            "default": "none",
            "allOf": [
              {
                "$ref": "#/components/schemas/AccessLevel"
              }
            ]
          },
          "surveys": {
            "default": "none",
            "allOf": [
              {
                "$ref": "#/components/schemas/AccessLevel"
              }
            ]
          }
        }
      },
      "InvitationStatus": {
        "title": "Status",
        "description": "An enumeration.",
        "enum": [
          "pending",
          "accepted",
          "declined",
          "revoked",
          "owner"
        ],
        "type": "string"
      },
      "User": {
        "title": "User",
        "type": "object",
        "properties": {
          "permissions": {
            "$ref": "#/components/schemas/Permissions"
          },
          "email_address": {
            "title": "Email Address",
            "type": "string"
          },
          "id": {
            "title": "Id",
            "description": "A unique UUID associated with the object.",
            "type": "string",
            "format": "uuid"
          },
          "creation_date": {
            "title": "Creation Date",
            "description": "The date and time at which the object was created.",
            "type": "string",
            "format": "date-time"
          },
          "status": {
            "$ref": "#/components/schemas/InvitationStatus"
          },
          "last_logged_in": {
            "title": "Last Logged In",
            "type": "string",
            "format": "date-time"
          }
        },
        "required": [
          "permissions",
          "email_address",
          "id",
          "creation_date",
          "status"
        ]
      },
      "History": {
        "title": "History",
        "type": "object",
        "properties": {
          "history_id": {
            "title": "History Id",
            "type": "integer"
          },
          "creation_date": {
            "title": "Creation Date",
            "type": "string",
            "format": "date-time"
          },
          "value": {
            "title": "Value",
            "type": "string"
          },
          "user_id": {
            "title": "User Id",
            "type": "string",
            "format": "uuid"
          },
          "user": {
            "$ref": "#/components/schemas/User"
          }
        },
        "required": [
          "history_id",
          "creation_date",
          "value"
        ]
      },
      "HistoryPage": {
        "title": "Page[History]",
        "type": "object",
        "properties": {
          "results": {
            "title": "Results",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/History"
            }
          },
          "next": {
            "title": "Next",
            "type": "string"
          },
          "previous": {
            "title": "Previous",
            "type": "string"
          },
          "count": {
            "title": "Count",
            "type": "integer"
          }
        },
        "required": [
          "results",
          "count"
        ]
      },
      "SendDraftInput": {
        "title": "SendDraftInput",
        "type": "object",
        "properties": {
          "subscribers": {
            "title": "Subscribers",
            "description": "A list of subscriber ids to which to send the email.",
            "example": [
              "bc5601f4-b180-4e02-8501-c18080662376",
              "24ee3338-daaf-42b0-bf7b-0cab38972fe5"
            ],
            "type": "array",
            "items": {
              "type": "string",
              "format": "uuid"
            }
          },
          "recipients": {
            "title": "Recipients",
            "description": "A list of email addresses to send the email to.",
            "example": [
              "telemachus@buttondown.email"
            ],
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "SubscriberType": {
        "title": "Type",
        "description": "Represents the state of a subscriber and what emails they\nshould or should not be receiving. This type is meant to be fully expressive\nso as to consolidate the logic of determining what emails a subscriber should\nreceive into a single place.\n\nNote that the only types that can be set programmatically are REGULAR, UNSUBSCRIBED,\nGIFTED and UNPAID. All other types are meant to be user-visible and cannot\nbe set programmatically.",
        "enum": [
          "regular",
          "premium",
          "churning",
          "past_due",
          "gifted",
          "unpaid",
          "churned",
          "unactivated",
          "unsubscribed",
          "malformed",
          "complained",
          "undeliverable",
          "spammy",
          "removed",
          "trialed",
          "disabled",
          "paused",
          "disposable"
        ],
        "type": "string"
      },
      "SubscriberSource": {
        "title": "Source",
        "description": "Represents the original provenance of a subscriber. This value is not exposed\nto subscribers; it's only used for internal tracking purposes and governs some\nof the behavior of the subscriber (i.e. whether or not to require double\nopt-in.)",
        "enum": [
          "api",
          "import",
          "organic",
          "user",
          "admin"
        ],
        "type": "string"
      },
      "StripeCoupon": {
        "title": "StripeCoupon",
        "type": "object",
        "properties": {
          "coupon_id": {
            "title": "Coupon Id",
            "type": "string"
          },
          "percent_off": {
            "title": "Percent Off",
            "type": "string"
          },
          "amount_off": {
            "title": "Amount Off",
            "type": "integer"
          },
          "name": {
            "title": "Name",
            "type": "string"
          }
        },
        "required": [
          "coupon_id"
        ]
      },
      "Transition": {
        "title": "Transition",
        "type": "object",
        "properties": {
          "date": {
            "title": "Date",
            "type": "string",
            "format": "date-time"
          },
          "type": {
            "$ref": "#/components/schemas/SubscriberType"
          }
        },
        "required": [
          "date",
          "type"
        ]
      },
      "Subscriber": {
        "title": "Subscriber",
        "description": "Subscribers are the main way you collect email addresses and\nrecipients on Buttondown. They're what you see on your\n[subscribers page](https://buttondown.com/subscribers).\n\nRelevant changes to the schema:\n\n- [2024-08-01](https://docs.buttondown.com/api-changelog-2024-08-01): renamed `subscriber_type` and `email` to `type` and `email_address` respectively.\n- [2024-07-13](https://docs.buttondown.com/api-changelog-2024-08-01): removed `external_url` in favor of `absolute_url`.",
        "type": "object",
        "properties": {
          "id": {
            "title": "Id",
            "description": "A unique UUID associated with the object.",
            "type": "string",
            "format": "uuid"
          },
          "creation_date": {
            "title": "Creation Date",
            "description": "The date and time at which the object was created.",
            "type": "string",
            "format": "date-time"
          },
          "email_address": {
            "title": "Email Address",
            "description": "The email address of the subscriber.",
            "example": "telemachus@buttondown.email",
            "type": "string"
          },
          "notes": {
            "title": "Notes",
            "description": "Any notes you want to attach to the subscriber. These are not publicly visible.",
            "default": "",
            "type": "string"
          },
          "metadata": {
            "title": "Metadata",
            "description": "A structured key-value blob that you can use to store arbitrary data on the object.",
            "default": {},
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          },
          "tags": {
            "title": "Tags",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "referrer_url": {
            "title": "Referrer Url",
            "default": "",
            "type": "string"
          },
          "secondary_id": {
            "title": "Secondary Id",
            "type": "integer"
          },
          "type": {
            "$ref": "#/components/schemas/SubscriberType"
          },
          "source": {
            "$ref": "#/components/schemas/SubscriberSource"
          },
          "utm_campaign": {
            "title": "Utm Campaign",
            "type": "string"
          },
          "utm_medium": {
            "title": "Utm Medium",
            "type": "string"
          },
          "utm_source": {
            "title": "Utm Source",
            "type": "string"
          },
          "referral_code": {
            "title": "Referral Code",
            "type": "string"
          },
          "avatar_url": {
            "title": "Avatar Url",
            "type": "string"
          },
          "stripe_coupon": {
            "$ref": "#/components/schemas/StripeCoupon"
          },
          "unsubscription_date": {
            "title": "Unsubscription Date",
            "type": "string",
            "format": "date-time"
          },
          "churn_date": {
            "title": "Churn Date",
            "type": "string",
            "format": "date-time"
          },
          "upgrade_date": {
            "title": "Upgrade Date",
            "type": "string",
            "format": "date-time"
          },
          "unsubscription_reason": {
            "title": "Unsubscription Reason",
            "type": "string"
          },
          "transitions": {
            "title": "Transitions",
            "default": [],
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Transition"
            }
          },
          "ip_address": {
            "title": "Ip Address",
            "type": "string"
          },
          "last_open_date": {
            "title": "Last Open Date",
            "type": "string",
            "format": "date-time"
          },
          "last_click_date": {
            "title": "Last Click Date",
            "type": "string",
            "format": "date-time"
          },
          "stripe_customer_id": {
            "title": "Stripe Customer Id",
            "type": "string"
          },
          "subscriber_import_id": {
            "title": "Subscriber Import Id",
            "type": "string",
            "format": "uuid"
          },
          "stripe_customer": {
            "title": "Stripe Customer",
            "type": "object"
          }
        },
        "required": [
          "id",
          "creation_date",
          "email_address",
          "tags",
          "secondary_id",
          "type",
          "source",
          "utm_campaign",
          "utm_medium",
          "utm_source",
          "referral_code"
        ]
      },
      "SubscriberInputValidationErrorCode": {
        "title": "ValidationErrorCode",
        "description": "Represents the type of error that occurred when validating subscriber input.\n\nHuman-readable error messages are provided in the `detail` field of the response;\nthese values are meant to be parseable by code or client logic.",
        "enum": [
          "email_already_exists",
          "email_invalid",
          "tag_invalid",
          "metadata_invalid"
        ],
        "type": "string"
      },
      "ErrorMessage_ValidationErrorCode_": {
        "title": "ErrorMessage[ValidationErrorCode]",
        "type": "object",
        "properties": {
          "code": {
            "$ref": "#/components/schemas/SubscriberInputValidationErrorCode"
          },
          "detail": {
            "title": "Detail",
            "type": "string"
          },
          "metadata": {
            "title": "Metadata",
            "default": {},
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          }
        },
        "required": [
          "code",
          "detail"
        ]
      },
      "SubscriberInput": {
        "title": "SubscriberInput",
        "type": "object",
        "properties": {
          "email_address": {
            "title": "Email Address",
            "example": "telemachus@buttondown.email",
            "type": "string"
          },
          "notes": {
            "title": "Notes",
            "default": "",
            "type": "string"
          },
          "metadata": {
            "title": "Metadata",
            "default": {},
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          },
          "tags": {
            "title": "Tags",
            "default": [],
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "referrer_url": {
            "title": "Referrer Url",
            "default": "",
            "type": "string"
          },
          "utm_campaign": {
            "title": "Utm Campaign",
            "default": "",
            "type": "string"
          },
          "utm_medium": {
            "title": "Utm Medium",
            "default": "",
            "type": "string"
          },
          "utm_source": {
            "title": "Utm Source",
            "default": "",
            "type": "string"
          },
          "referring_subscriber_id": {
            "title": "Referring Subscriber Id",
            "type": "string",
            "format": "uuid"
          },
          "type": {
            "example": "regular",
            "allOf": [
              {
                "$ref": "#/components/schemas/SubscriberType"
              }
            ]
          }
        },
        "required": [
          "email_address"
        ]
      },
      "SubscriberPage": {
        "title": "Page[Subscriber]",
        "type": "object",
        "properties": {
          "results": {
            "title": "Results",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Subscriber"
            }
          },
          "next": {
            "title": "Next",
            "type": "string"
          },
          "previous": {
            "title": "Previous",
            "type": "string"
          },
          "count": {
            "title": "Count",
            "type": "integer"
          }
        },
        "required": [
          "results",
          "count"
        ]
      },
      "ListSubscribersErrorCode": {
        "title": "ListSubscribersErrorCode",
        "description": "Represents the type of error that occurred when listing subscribers.\n\nHuman-readable error messages are provided in the `detail` field of the response;\nthese values are meant to be parseable by code or client logic.",
        "enum": [
          "invalid_tag",
          "date_invalid"
        ],
        "type": "string"
      },
      "ErrorMessage_ListSubscribersErrorCode_": {
        "title": "ErrorMessage[ListSubscribersErrorCode]",
        "type": "object",
        "properties": {
          "code": {
            "$ref": "#/components/schemas/ListSubscribersErrorCode"
          },
          "detail": {
            "title": "Detail",
            "type": "string"
          },
          "metadata": {
            "title": "Metadata",
            "default": {},
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          }
        },
        "required": [
          "code",
          "detail"
        ]
      },
      "UpdateSubscriberErrorCode": {
        "title": "UpdateSubscriberErrorCode",
        "description": "Represents the type of error that occurred when updating a subscriber.\n\nHuman-readable error messages are provided in the `detail` field of the response;\nthese values are meant to be parseable by code or client logic.",
        "enum": [
          "email_already_exists",
          "email_invalid",
          "email_has_been_changed_too_many_times",
          "subscriber_type_invalid",
          "tag_invalid"
        ],
        "type": "string"
      },
      "ErrorMessage_UpdateSubscriberErrorCode_": {
        "title": "ErrorMessage[UpdateSubscriberErrorCode]",
        "type": "object",
        "properties": {
          "code": {
            "$ref": "#/components/schemas/UpdateSubscriberErrorCode"
          },
          "detail": {
            "title": "Detail",
            "type": "string"
          },
          "metadata": {
            "title": "Metadata",
            "default": {},
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          }
        },
        "required": [
          "code",
          "detail"
        ]
      },
      "SubscriberUpdateInput": {
        "title": "SubscriberUpdateInput",
        "type": "object",
        "properties": {
          "email_address": {
            "title": "Email Address",
            "example": "telemachus@buttondown.email",
            "type": "string"
          },
          "notes": {
            "title": "Notes",
            "example": "One of our first subscribers!",
            "type": "string"
          },
          "metadata": {
            "title": "Metadata",
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          },
          "tags": {
            "title": "Tags",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "referrer_url": {
            "title": "Referrer Url",
            "default": "",
            "type": "string"
          },
          "type": {
            "$ref": "#/components/schemas/SubscriberType"
          },
          "unsubscription_reason": {
            "title": "Unsubscription Reason",
            "type": "string"
          }
        }
      },
      "Client": {
        "title": "Client",
        "type": "object",
        "properties": {
          "region": {
            "title": "Region",
            "type": "string"
          },
          "country": {
            "title": "Country",
            "type": "string"
          },
          "client_os": {
            "title": "Client Os",
            "type": "string"
          },
          "client_type": {
            "title": "Client Type",
            "type": "string"
          },
          "client_name": {
            "title": "Client Name",
            "type": "string"
          },
          "occurrences": {
            "title": "Occurrences",
            "type": "integer"
          }
        },
        "required": [
          "region",
          "country",
          "client_os",
          "client_type",
          "client_name",
          "occurrences"
        ]
      },
      "ClientPage": {
        "title": "Page[Client]",
        "type": "object",
        "properties": {
          "results": {
            "title": "Results",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Client"
            }
          },
          "next": {
            "title": "Next",
            "type": "string"
          },
          "previous": {
            "title": "Previous",
            "type": "string"
          },
          "count": {
            "title": "Count",
            "type": "integer"
          }
        },
        "required": [
          "results",
          "count"
        ]
      },
      "AutomationAttemptStatus": {
        "title": "Status",
        "description": "An enumeration.",
        "enum": [
          "unprocessed",
          "processed",
          "failed",
          "pending",
          "skipped"
        ],
        "type": "string"
      },
      "AutomationForSubscriber": {
        "title": "AutomationForSubscriber",
        "type": "object",
        "properties": {
          "id": {
            "title": "Id",
            "type": "string",
            "format": "uuid"
          },
          "name": {
            "title": "Name",
            "type": "string"
          },
          "status": {
            "$ref": "#/components/schemas/AutomationAttemptStatus"
          },
          "automation_id": {
            "title": "Automation Id",
            "type": "string",
            "format": "uuid"
          },
          "execution_date": {
            "title": "Execution Date",
            "type": "string",
            "format": "date-time"
          },
          "actions": {
            "title": "Actions",
            "type": "array",
            "items": {
              "type": "object"
            }
          }
        },
        "required": [
          "id",
          "name",
          "status",
          "automation_id",
          "execution_date",
          "actions"
        ]
      },
      "AutomationForSubscriberPage": {
        "title": "Page[AutomationForSubscriber]",
        "type": "object",
        "properties": {
          "results": {
            "title": "Results",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AutomationForSubscriber"
            }
          },
          "next": {
            "title": "Next",
            "type": "string"
          },
          "previous": {
            "title": "Previous",
            "type": "string"
          },
          "count": {
            "title": "Count",
            "type": "integer"
          }
        },
        "required": [
          "results",
          "count"
        ]
      },
      "StripeSubscription": {
        "title": "StripeSubscription",
        "type": "object",
        "properties": {
          "subscription_id": {
            "title": "Subscription Id",
            "type": "string"
          },
          "url": {
            "title": "Url",
            "type": "string"
          },
          "creation_date": {
            "title": "Creation Date",
            "type": "string",
            "format": "date-time"
          },
          "ending_date": {
            "title": "Ending Date",
            "type": "string",
            "format": "date-time"
          },
          "amount": {
            "title": "Amount",
            "type": "integer"
          },
          "currency": {
            "title": "Currency",
            "type": "string"
          },
          "cadence": {
            "title": "Cadence",
            "type": "string"
          },
          "status": {
            "title": "Status",
            "type": "string"
          }
        },
        "required": [
          "subscription_id",
          "url",
          "creation_date",
          "amount",
          "currency",
          "cadence",
          "status"
        ]
      },
      "StripeSubscriptionPage": {
        "title": "Page[StripeSubscription]",
        "type": "object",
        "properties": {
          "results": {
            "title": "Results",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StripeSubscription"
            }
          },
          "next": {
            "title": "Next",
            "type": "string"
          },
          "previous": {
            "title": "Previous",
            "type": "string"
          },
          "count": {
            "title": "Count",
            "type": "integer"
          }
        },
        "required": [
          "results",
          "count"
        ]
      },
      "Newsletter": {
        "title": "Newsletter",
        "description": "You will likely not need to interact with your newsletter settings\nprogrammatically, but if you do, this is the endpoint for you. You can\ncreate, update, and list newsletters via the API; this is ideal for\nintegrating with Buttondown as a headless email or newsletter provider\n(e.g. for a SaaS product.)",
        "type": "object",
        "properties": {
          "id": {
            "title": "Id",
            "type": "string",
            "format": "uuid"
          },
          "username": {
            "title": "Username",
            "type": "string"
          },
          "name": {
            "title": "Name",
            "type": "string"
          },
          "description": {
            "title": "Description",
            "type": "string"
          },
          "creation_date": {
            "title": "Creation Date",
            "type": "string",
            "format": "date-time"
          },
          "api_key": {
            "title": "Api Key",
            "type": "string",
            "format": "uuid"
          },
          "tint_color": {
            "title": "Tint Color",
            "default": "#0069FF",
            "type": "string"
          },
          "from_name": {
            "title": "From Name",
            "default": "",
            "type": "string"
          },
          "header": {
            "title": "Header",
            "default": "",
            "type": "string"
          },
          "footer": {
            "title": "Footer",
            "default": "",
            "type": "string"
          },
          "domain": {
            "title": "Domain",
            "default": "",
            "type": "string"
          },
          "email_domain": {
            "title": "Email Domain",
            "default": "",
            "type": "string"
          },
          "enabled_features": {
            "title": "Enabled Features",
            "default": [],
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "custom_email_template": {
            "title": "Custom Email Template",
            "type": "string"
          }
        },
        "required": [
          "id",
          "username",
          "name",
          "description",
          "creation_date",
          "api_key"
        ]
      },
      "NewsletterPage": {
        "title": "Page[Newsletter]",
        "type": "object",
        "properties": {
          "results": {
            "title": "Results",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Newsletter"
            }
          },
          "next": {
            "title": "Next",
            "type": "string"
          },
          "previous": {
            "title": "Previous",
            "type": "string"
          },
          "count": {
            "title": "Count",
            "type": "integer"
          }
        },
        "required": [
          "results",
          "count"
        ]
      },
      "CreateNewsletterErrorCode": {
        "title": "CreateNewsletterErrorCode",
        "description": "Represents the type of error that occurred when creating a newsletter.\n\nHuman-readable error messages are provided in the `detail` field of the response;\nthese values are meant to be parseable by code or client logic.",
        "enum": [
          "username_already_exists",
          "username_invalid"
        ],
        "type": "string"
      },
      "ErrorMessage_CreateNewsletterErrorCode_": {
        "title": "ErrorMessage[CreateNewsletterErrorCode]",
        "type": "object",
        "properties": {
          "code": {
            "$ref": "#/components/schemas/CreateNewsletterErrorCode"
          },
          "detail": {
            "title": "Detail",
            "type": "string"
          },
          "metadata": {
            "title": "Metadata",
            "default": {},
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          }
        },
        "required": [
          "code",
          "detail"
        ]
      },
      "NewsletterInput": {
        "title": "NewsletterInput",
        "type": "object",
        "properties": {
          "username": {
            "title": "Username",
            "example": "sheinhardt",
            "type": "string"
          },
          "name": {
            "title": "Name",
            "example": "Sheinhardt Wig Company",
            "type": "string"
          },
          "description": {
            "title": "Description",
            "example": "Stay up to date with the latest trends in wigs and hairpieces",
            "type": "string"
          },
          "tint_color": {
            "title": "Tint Color",
            "default": "#0069FF",
            "type": "string"
          },
          "from_name": {
            "title": "From Name",
            "default": "",
            "type": "string"
          },
          "header": {
            "title": "Header",
            "default": "",
            "type": "string"
          },
          "footer": {
            "title": "Footer",
            "default": "",
            "type": "string"
          },
          "domain": {
            "title": "Domain",
            "default": "",
            "type": "string"
          },
          "email_domain": {
            "title": "Email Domain",
            "default": "",
            "type": "string"
          },
          "enabled_features": {
            "title": "Enabled Features",
            "default": [],
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "custom_email_template": {
            "title": "Custom Email Template",
            "type": "string"
          }
        },
        "required": [
          "username",
          "name",
          "description"
        ]
      },
      "NewsletterUpdateInput": {
        "title": "NewsletterUpdateInput",
        "type": "object",
        "properties": {
          "username": {
            "title": "Username",
            "example": "sheinhardt",
            "type": "string"
          },
          "name": {
            "title": "Name",
            "example": "Sheinhardt Wig Company",
            "type": "string"
          },
          "description": {
            "title": "Description",
            "example": "Stay up to date with the latest trends in wigs and hairpieces",
            "type": "string"
          },
          "tint_color": {
            "title": "Tint Color",
            "type": "string"
          },
          "from_name": {
            "title": "From Name",
            "type": "string"
          },
          "header": {
            "title": "Header",
            "type": "string"
          },
          "footer": {
            "title": "Footer",
            "type": "string"
          },
          "domain": {
            "title": "Domain",
            "type": "string"
          },
          "email_domain": {
            "title": "Email Domain",
            "type": "string"
          },
          "enabled_features": {
            "title": "Enabled Features",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "custom_email_template": {
            "title": "Custom Email Template",
            "type": "string"
          }
        }
      },
      "BulkActionType": {
        "title": "Type",
        "description": "Represents the action being performed on a bulk of objects.\n\n(Not to be coy, but these names should be self-explanatory.)",
        "enum": [
          "apply_tags",
          "apply_metadata",
          "ban_subscribers",
          "delete_subscribers",
          "gift_subscribers",
          "reactivate_subscribers",
          "mark_subscribers_as_not_spammy",
          "resubscribe_subscribers",
          "send_emails",
          "unsubscribe_subscribers",
          "send_reminders",
          "delete_emails",
          "update_email_types",
          "delete_tags",
          "delete_surveys",
          "replay_events",
          "delete_comments",
          "update_survey_statuses"
        ],
        "type": "string"
      },
      "BulkActionStatus": {
        "title": "Status",
        "description": "Represents the status of a bulk action.\n\nNo action is required to move from one state or another; Buttondown\ninternally handles the transitions, and exposing the status is for\nobservability purposes only.",
        "enum": [
          "not_started",
          "in_progress",
          "processed",
          "failed"
        ],
        "type": "string"
      },
      "BulkAction": {
        "title": "BulkAction",
        "description": "A bulk action represents, well, a bulk action. It is used to perform\nactions on a large number of objects at once. For example, you can\nuse it to delete a large number of emails, or to unsubscribe a large\nnumber of subscribers. The actions within a bulk action are processed\nserially by Buttondown; this should be considered an ergonomic way to\nbatch API calls across the network rather than a net-new piece of functionality\nin of itself.",
        "type": "object",
        "properties": {
          "type": {
            "example": "delete_emails",
            "allOf": [
              {
                "$ref": "#/components/schemas/BulkActionType"
              }
            ]
          },
          "metadata": {
            "title": "Metadata",
            "example": {
              "ids": [
                "611c8825-6f21-4544-bb47-9f50453e9cb0",
                "418c701a-efe3-4e3d-a404-e635a2f28775"
              ]
            },
            "type": "object",
            "additionalProperties": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                {
                  "type": "object"
                }
              ]
            }
          },
          "id": {
            "title": "Id",
            "description": "A unique UUID associated with the object.",
            "type": "string",
            "format": "uuid"
          },
          "creation_date": {
            "title": "Creation Date",
            "description": "The date and time at which the object was created.",
            "type": "string",
            "format": "date-time"
          },
          "status": {
            "$ref": "#/components/schemas/BulkActionStatus"
          },
          "completion_date": {
            "title": "Completion Date",
            "description": "The date and time at which the bulk action was completed.",
            "type": "string",
            "format": "date-time"
          }
        },
        "required": [
          "type",
          "metadata",
          "id",
          "creation_date",
          "status"
        ]
      },
      "BulkActionInput": {
        "title": "BulkActionInput",
        "type": "object",
        "properties": {
          "type": {
            "example": "delete_emails",
            "allOf": [
              {
                "$ref": "#/components/schemas/BulkActionType"
              }
            ]
          },
          "metadata": {
            "title": "Metadata",
            "example": {
              "ids": [
                "611c8825-6f21-4544-bb47-9f50453e9cb0",
                "418c701a-efe3-4e3d-a404-e635a2f28775"
              ]
            },
            "type": "object",
            "additionalProperties": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                {
                  "type": "object"
                }
              ]
            }
          }
        },
        "required": [
          "type",
          "metadata"
        ]
      },
      "ExternalFeedAutomationStatus": {
        "title": "Status",
        "description": "Represents the status of the automation, and whether or not it is active. Inactive automations will not be processed.",
        "enum": [
          "active",
          "failing",
          "inactive"
        ],
        "type": "string"
      },
      "ExternalFeedAutomationBehavior": {
        "title": "Behavior",
        "description": "An enumeration.",
        "enum": [
          "draft",
          "emails"
        ],
        "type": "string"
      },
      "ExternalFeedAutomationCadence": {
        "title": "Cadence",
        "description": "An enumeration.",
        "enum": [
          "every",
          "daily",
          "weekly",
          "monthly"
        ],
        "type": "string"
      },
      "ExternalFeed": {
        "title": "ExternalFeed",
        "description": "An automation is a one-to-one mapping between an external RSS feed and an action\nto be performed when new items are detected in that feed. Right now, Buttondown offers\ntwo actions:\n\n- Send an email\n- Create an email but save it as a draft to be sent out manually\n\nThe automation is configured with a cadence, which is the frequency at which the\nautomation will be run. The cadence can be one of the following:\n\n- Run the automation every time a new item is detected in the feed\n- Run the automation once per week\n- Run the automation once per month",
        "type": "object",
        "properties": {
          "id": {
            "title": "Id",
            "type": "string",
            "format": "uuid"
          },
          "creation_date": {
            "title": "Creation Date",
            "type": "string",
            "format": "date-time"
          },
          "last_checked_date": {
            "title": "Last Checked Date",
            "type": "string",
            "format": "date-time"
          },
          "status": {
            "$ref": "#/components/schemas/ExternalFeedAutomationStatus"
          },
          "behavior": {
            "$ref": "#/components/schemas/ExternalFeedAutomationBehavior"
          },
          "cadence": {
            "$ref": "#/components/schemas/ExternalFeedAutomationCadence"
          },
          "cadence_metadata": {
            "title": "Cadence Metadata",
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          },
          "filters": {
            "$ref": "#/components/schemas/FilterGroup"
          },
          "url": {
            "title": "Url",
            "type": "string"
          },
          "subject": {
            "title": "Subject",
            "type": "string"
          },
          "body": {
            "title": "Body",
            "type": "string"
          },
          "label": {
            "title": "Label",
            "type": "string"
          }
        },
        "required": [
          "id",
          "creation_date",
          "status",
          "behavior",
          "cadence",
          "cadence_metadata",
          "filters",
          "url",
          "subject",
          "body",
          "label"
        ]
      },
      "ExternalFeedInput": {
        "title": "ExternalFeedInput",
        "type": "object",
        "properties": {
          "url": {
            "title": "Url",
            "example": "http://lorem-rss.herokuapp.com/feed",
            "type": "string"
          },
          "behavior": {
            "example": "draft",
            "allOf": [
              {
                "$ref": "#/components/schemas/ExternalFeedAutomationBehavior"
              }
            ]
          },
          "cadence": {
            "example": "daily",
            "allOf": [
              {
                "$ref": "#/components/schemas/ExternalFeedAutomationCadence"
              }
            ]
          },
          "cadence_metadata": {
            "title": "Cadence Metadata",
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          },
          "filters": {
            "$ref": "#/components/schemas/FilterGroup"
          },
          "subject": {
            "title": "Subject",
            "type": "string"
          },
          "body": {
            "title": "Body",
            "type": "string"
          },
          "label": {
            "title": "Label",
            "default": "",
            "type": "string"
          }
        },
        "required": [
          "url",
          "behavior",
          "cadence",
          "cadence_metadata",
          "filters",
          "subject",
          "body"
        ]
      },
      "ExternalFeedPage": {
        "title": "Page[ExternalFeed]",
        "type": "object",
        "properties": {
          "results": {
            "title": "Results",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ExternalFeed"
            }
          },
          "next": {
            "title": "Next",
            "type": "string"
          },
          "previous": {
            "title": "Previous",
            "type": "string"
          },
          "count": {
            "title": "Count",
            "type": "integer"
          }
        },
        "required": [
          "results",
          "count"
        ]
      },
      "ExternalFeedUpdateInput": {
        "title": "ExternalFeedUpdateInput",
        "type": "object",
        "properties": {
          "behavior": {
            "example": "draft",
            "allOf": [
              {
                "$ref": "#/components/schemas/ExternalFeedAutomationBehavior"
              }
            ]
          },
          "cadence": {
            "example": "daily",
            "allOf": [
              {
                "$ref": "#/components/schemas/ExternalFeedAutomationCadence"
              }
            ]
          },
          "cadence_metadata": {
            "title": "Cadence Metadata",
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          },
          "filters": {
            "$ref": "#/components/schemas/FilterGroup"
          },
          "subject": {
            "title": "Subject",
            "type": "string"
          },
          "body": {
            "title": "Body",
            "type": "string"
          },
          "label": {
            "title": "Label",
            "type": "string"
          },
          "status": {
            "$ref": "#/components/schemas/ExternalFeedAutomationStatus"
          }
        }
      },
      "ExternalFeedItemStatus": {
        "title": "Status",
        "description": "The status of a given item (meaning a distinct URL) within an RSS feed.",
        "enum": [
          "unprocessed",
          "irrelevant",
          "errored",
          "skipped",
          "queued",
          "processed"
        ],
        "type": "string"
      },
      "ExternalFeedItem": {
        "title": "ExternalFeedItem",
        "description": "An external feed item is a single item in an external RSS feed. It is created\nautomatically by Buttondown when a new item is detected in an external feed. External feed\nitems are immutable and cannot be modified or deleted.",
        "type": "object",
        "properties": {
          "id": {
            "title": "Id",
            "type": "string",
            "format": "uuid"
          },
          "creation_date": {
            "title": "Creation Date",
            "type": "string",
            "format": "date-time"
          },
          "status": {
            "$ref": "#/components/schemas/ExternalFeedItemStatus"
          },
          "url": {
            "title": "Url",
            "type": "string"
          },
          "publish_date": {
            "title": "Publish Date",
            "type": "string",
            "format": "date-time"
          },
          "title": {
            "title": "Title",
            "type": "string"
          },
          "description": {
            "title": "Description",
            "type": "string"
          },
          "content": {
            "title": "Content",
            "type": "string"
          },
          "author": {
            "title": "Author",
            "type": "string"
          },
          "email_id": {
            "title": "Email Id",
            "type": "string",
            "format": "uuid"
          },
          "email": {
            "$ref": "#/components/schemas/Email"
          }
        },
        "required": [
          "id",
          "creation_date",
          "status",
          "url",
          "publish_date",
          "title",
          "description",
          "content",
          "author"
        ]
      },
      "ExternalFeedItemPage": {
        "title": "Page[ExternalFeedItem]",
        "type": "object",
        "properties": {
          "results": {
            "title": "Results",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ExternalFeedItem"
            }
          },
          "next": {
            "title": "Next",
            "type": "string"
          },
          "previous": {
            "title": "Previous",
            "type": "string"
          },
          "count": {
            "title": "Count",
            "type": "integer"
          }
        },
        "required": [
          "results",
          "count"
        ]
      },
      "AutomationStatus": {
        "title": "Status",
        "description": "An enumeration.",
        "enum": [
          "active",
          "inactive"
        ],
        "type": "string"
      },
      "ExternalEventType": {
        "title": "Type",
        "description": "Various types of events that are recorded by Buttondown, both in terms of exogenous systems\nlike Stripe and Memberful, and endogenous ones like email opens and clicks. (In general, if anything\nimportant ever happens that could be relevant to your newsletter, we have an event type for it!)\n\nThese event types power lots of things within Buttondown. They're used to trigger automations, webhooks,\nand analytics.\n\n(Note that Buttondown also has a different thing we call \"events\"; those are `EmailEvents` and are used\nfor tracking aggregate details about an email. Alas, we shouldn't have used the term \"event\" for two different\nthings, but it's too late to go back now!)",
        "enum": [
          "subscriber.created",
          "subscriber.unsubscribed",
          "subscriber.changed_email",
          "subscriber.confirmed",
          "subscriber.trial_started",
          "subscriber.trial_ended",
          "subscriber.type.changed",
          "subscriber.tags.changed",
          "subscriber.clicked",
          "subscriber.opened",
          "subscriber.paid",
          "subscriber.churned",
          "subscriber.updated",
          "subscriber.deleted",
          "subscriber.viewed_checkout_page",
          "subscriber.replied",
          "subscriber.paused",
          "subscriber.resumed",
          "subscriber.responded_to_survey",
          "subscriber.referred",
          "subscriber.referred.paid",
          "subscriber.commented",
          "email.created",
          "email.sent",
          "email.updated",
          "email.deleted",
          "email.status.changed",
          "scheduled_email.converted",
          "mention.created",
          "advertising_slot.purchased",
          "social_mention.created",
          "export.created",
          "export.completed",
          "export.failed",
          "automation.invoked",
          "stripe.checkout.session.completed",
          "stripe.subscription.activated",
          "stripe.subscription.churning",
          "stripe.subscription.deactivated",
          "stripe.customer.updated",
          "memberful.subscription.created",
          "memberful.subscription.deleted",
          "memberful.member.updated"
        ],
        "type": "string"
      },
      "Delay": {
        "title": "Delay",
        "type": "object",
        "properties": {
          "value": {
            "title": "Value",
            "type": "string"
          },
          "unit": {
            "title": "Unit",
            "enum": [
              "minutes",
              "hours",
              "days",
              "weeks"
            ],
            "type": "string"
          },
          "time_of_day": {
            "title": "Time Of Day",
            "enum": [
              "morning",
              "evening",
              ""
            ],
            "type": "string"
          }
        },
        "required": [
          "value",
          "unit"
        ]
      },
      "Timing": {
        "title": "Timing",
        "type": "object",
        "properties": {
          "time": {
            "title": "Time",
            "enum": [
              "immediate",
              "delay"
            ],
            "type": "string"
          },
          "delay": {
            "$ref": "#/components/schemas/Delay"
          }
        },
        "required": [
          "time"
        ]
      },
      "AutomationActionType": {
        "title": "ActionType",
        "description": "The action that is triggered when the automation is successfully run.",
        "enum": [
          "add_tags",
          "remove_tags",
          "send_email",
          "add_metadata",
          "change_email_address",
          "gift_premium_subscription",
          "ungift_premium_subscription",
          "send_discord_invitation",
          "send_github_invitation",
          "create_subscriber",
          "unsubscribe_subscriber",
          "shopify_unsubscribe",
          "send_notification",
          "forward_reply",
          "create_linkedin_post",
          "create_twitter_post",
          "create_bluesky_post"
        ],
        "type": "string"
      },
      "Action": {
        "title": "Action",
        "type": "object",
        "properties": {
          "type": {
            "$ref": "#/components/schemas/AutomationActionType"
          },
          "metadata": {
            "title": "Metadata",
            "type": "object"
          }
        },
        "required": [
          "type",
          "metadata"
        ]
      },
      "Automation": {
        "title": "Automation",
        "type": "object",
        "properties": {
          "id": {
            "title": "Id",
            "type": "string",
            "format": "uuid"
          },
          "creation_date": {
            "title": "Creation Date",
            "type": "string",
            "format": "date-time"
          },
          "name": {
            "title": "Name",
            "type": "string"
          },
          "status": {
            "$ref": "#/components/schemas/AutomationStatus"
          },
          "trigger": {
            "$ref": "#/components/schemas/ExternalEventType"
          },
          "timing": {
            "$ref": "#/components/schemas/Timing"
          },
          "actions": {
            "title": "Actions",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Action"
            }
          },
          "filters": {
            "$ref": "#/components/schemas/FilterGroup"
          },
          "metadata": {
            "title": "Metadata",
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          }
        },
        "required": [
          "id",
          "creation_date",
          "name",
          "status",
          "trigger",
          "timing",
          "actions",
          "filters",
          "metadata"
        ]
      },
      "AutomationPage": {
        "title": "Page[Automation]",
        "type": "object",
        "properties": {
          "results": {
            "title": "Results",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Automation"
            }
          },
          "next": {
            "title": "Next",
            "type": "string"
          },
          "previous": {
            "title": "Previous",
            "type": "string"
          },
          "count": {
            "title": "Count",
            "type": "integer"
          }
        },
        "required": [
          "results",
          "count"
        ]
      },
      "AutomationCreationErrorCode": {
        "title": "AutomationCreationErrorCode",
        "description": "Represents the type of error that occurred when creating an automation.\n\nHuman-readable error messages are provided in the `detail` field of the response;\nthese values are meant to be parseable by code or client logic.",
        "enum": [
          "delay_invalid",
          "filter_invalid__tag",
          "filter_invalid",
          "action_invalid"
        ],
        "type": "string"
      },
      "ErrorMessage_AutomationCreationErrorCode_": {
        "title": "ErrorMessage[AutomationCreationErrorCode]",
        "type": "object",
        "properties": {
          "code": {
            "$ref": "#/components/schemas/AutomationCreationErrorCode"
          },
          "detail": {
            "title": "Detail",
            "type": "string"
          },
          "metadata": {
            "title": "Metadata",
            "default": {},
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          }
        },
        "required": [
          "code",
          "detail"
        ]
      },
      "AutomationInput": {
        "title": "AutomationInput",
        "type": "object",
        "properties": {
          "name": {
            "title": "Name",
            "type": "string"
          },
          "trigger": {
            "$ref": "#/components/schemas/ExternalEventType"
          },
          "timing": {
            "$ref": "#/components/schemas/Timing"
          },
          "actions": {
            "title": "Actions",
            "type": "array",
            "items": {
              "type": "object"
            }
          },
          "filters": {
            "$ref": "#/components/schemas/FilterGroup"
          },
          "metadata": {
            "title": "Metadata",
            "default": {},
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          }
        },
        "required": [
          "name",
          "trigger",
          "timing",
          "actions",
          "filters"
        ]
      },
      "SubscriberForAutomation": {
        "title": "SubscriberForAutomation",
        "type": "object",
        "properties": {
          "id": {
            "title": "Id",
            "type": "string",
            "format": "uuid"
          },
          "status": {
            "$ref": "#/components/schemas/AutomationAttemptStatus"
          },
          "subscriber_id": {
            "title": "Subscriber Id",
            "type": "string"
          },
          "subscriber": {
            "$ref": "#/components/schemas/Subscriber"
          }
        },
        "required": [
          "id",
          "status"
        ]
      },
      "SubscriberForAutomationPage": {
        "title": "Page[SubscriberForAutomation]",
        "type": "object",
        "properties": {
          "results": {
            "title": "Results",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SubscriberForAutomation"
            }
          },
          "next": {
            "title": "Next",
            "type": "string"
          },
          "previous": {
            "title": "Previous",
            "type": "string"
          },
          "count": {
            "title": "Count",
            "type": "integer"
          }
        },
        "required": [
          "results",
          "count"
        ]
      },
      "AutomationUpdateInput": {
        "title": "AutomationUpdateInput",
        "type": "object",
        "properties": {
          "name": {
            "title": "Name",
            "type": "string"
          },
          "status": {
            "$ref": "#/components/schemas/AutomationStatus"
          },
          "trigger": {
            "$ref": "#/components/schemas/ExternalEventType"
          },
          "timing": {
            "$ref": "#/components/schemas/Timing"
          },
          "actions": {
            "title": "Actions",
            "type": "array",
            "items": {
              "type": "object"
            }
          },
          "filters": {
            "$ref": "#/components/schemas/FilterGroup"
          },
          "metadata": {
            "title": "Metadata",
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          }
        }
      },
      "Failure": {
        "title": "Failure",
        "description": "An enumeration.",
        "enum": [
          "email_already_exists"
        ],
        "type": "string"
      },
      "ErrorMessage_Failure_": {
        "title": "ErrorMessage[Failure]",
        "type": "object",
        "properties": {
          "code": {
            "$ref": "#/components/schemas/Failure"
          },
          "detail": {
            "title": "Detail",
            "type": "string"
          },
          "metadata": {
            "title": "Metadata",
            "default": {},
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          }
        },
        "required": [
          "code",
          "detail"
        ]
      },
      "UserInput": {
        "title": "UserInput",
        "type": "object",
        "properties": {
          "permissions": {
            "$ref": "#/components/schemas/Permissions"
          },
          "email_address": {
            "title": "Email Address",
            "type": "string"
          }
        },
        "required": [
          "permissions",
          "email_address"
        ]
      },
      "UserPage": {
        "title": "Page[User]",
        "type": "object",
        "properties": {
          "results": {
            "title": "Results",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/User"
            }
          },
          "next": {
            "title": "Next",
            "type": "string"
          },
          "previous": {
            "title": "Previous",
            "type": "string"
          },
          "count": {
            "title": "Count",
            "type": "integer"
          }
        },
        "required": [
          "results",
          "count"
        ]
      },
      "UserUpdateInput": {
        "title": "UserUpdateInput",
        "type": "object",
        "properties": {
          "permissions": {
            "title": "Permissions",
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          }
        },
        "required": [
          "permissions"
        ]
      },
      "Cadence": {
        "title": "Cadence",
        "description": "An enumeration.",
        "enum": [
          "year",
          "month",
          "one-time",
          "email"
        ],
        "type": "string"
      },
      "Product": {
        "title": "Product",
        "type": "object",
        "properties": {
          "id": {
            "title": "Id",
            "type": "string",
            "format": "uuid"
          },
          "product_id": {
            "title": "Product Id",
            "type": "string"
          },
          "name": {
            "title": "Name",
            "type": "string"
          },
          "creation_date": {
            "title": "Creation Date",
            "type": "string"
          }
        },
        "required": [
          "id",
          "product_id",
          "name",
          "creation_date"
        ]
      },
      "Price": {
        "title": "Price",
        "type": "object",
        "properties": {
          "id": {
            "title": "Id",
            "type": "string"
          },
          "amount": {
            "title": "Amount",
            "type": "integer"
          },
          "style": {
            "title": "Style",
            "enum": [
              "pay-what-you-want",
              "fixed",
              "usage-based"
            ],
            "type": "string"
          },
          "currency": {
            "title": "Currency",
            "type": "string"
          },
          "cadence": {
            "$ref": "#/components/schemas/Cadence"
          },
          "product_id": {
            "title": "Product Id",
            "type": "string"
          },
          "product": {
            "$ref": "#/components/schemas/Product"
          }
        },
        "required": [
          "id",
          "style",
          "currency",
          "cadence",
          "product_id"
        ]
      },
      "PricePage": {
        "title": "Page[Price]",
        "type": "object",
        "properties": {
          "results": {
            "title": "Results",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Price"
            }
          },
          "next": {
            "title": "Next",
            "type": "string"
          },
          "previous": {
            "title": "Previous",
            "type": "string"
          },
          "count": {
            "title": "Count",
            "type": "integer"
          }
        },
        "required": [
          "results",
          "count"
        ]
      },
      "ListPricesErrorCode": {
        "title": "ListPricesErrorCode",
        "description": "Represents the type of error that occurred when listing a price.\n\nHuman-readable error messages are provided in the `detail` field of the response;\nthese values are meant to be parseable by code or client logic.",
        "enum": [
          "paid_subscriptions_uninitialized"
        ],
        "type": "string"
      },
      "ErrorMessage_ListPricesErrorCode_": {
        "title": "ErrorMessage[ListPricesErrorCode]",
        "type": "object",
        "properties": {
          "code": {
            "$ref": "#/components/schemas/ListPricesErrorCode"
          },
          "detail": {
            "title": "Detail",
            "type": "string"
          },
          "metadata": {
            "title": "Metadata",
            "default": {},
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          }
        },
        "required": [
          "code",
          "detail"
        ]
      },
      "CreatePriceErrorCode": {
        "title": "CreatePriceErrorCode",
        "description": "Represents the type of error that occurred when listing a price.\n\nHuman-readable error messages are provided in the `detail` field of the response;\nthese values are meant to be parseable by code or client logic.",
        "enum": [
          "paid_subscriptions_uninitialized",
          "invalid_amount"
        ],
        "type": "string"
      },
      "ErrorMessage_CreatePriceErrorCode_": {
        "title": "ErrorMessage[CreatePriceErrorCode]",
        "type": "object",
        "properties": {
          "code": {
            "$ref": "#/components/schemas/CreatePriceErrorCode"
          },
          "detail": {
            "title": "Detail",
            "type": "string"
          },
          "metadata": {
            "title": "Metadata",
            "default": {},
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          }
        },
        "required": [
          "code",
          "detail"
        ]
      },
      "PriceInput": {
        "title": "PriceInput",
        "type": "object",
        "properties": {
          "style": {
            "title": "Style",
            "enum": [
              "pay-what-you-want",
              "fixed",
              "usage-based"
            ],
            "type": "string"
          },
          "amount": {
            "title": "Amount",
            "type": "integer"
          },
          "currency": {
            "title": "Currency",
            "type": "string"
          },
          "cadence": {
            "$ref": "#/components/schemas/Cadence"
          }
        },
        "required": [
          "style",
          "currency",
          "cadence"
        ]
      },
      "StripeCouponPage": {
        "title": "Page[StripeCoupon]",
        "type": "object",
        "properties": {
          "results": {
            "title": "Results",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StripeCoupon"
            }
          },
          "next": {
            "title": "Next",
            "type": "string"
          },
          "previous": {
            "title": "Previous",
            "type": "string"
          },
          "count": {
            "title": "Count",
            "type": "integer"
          }
        },
        "required": [
          "results",
          "count"
        ]
      },
      "SurveyResponseCadence": {
        "title": "ResponseCadence",
        "description": "An enumeration.",
        "enum": [
          "once",
          "once_per_email"
        ],
        "type": "string"
      },
      "SurveyStatus": {
        "title": "Status",
        "description": "An enumeration.",
        "enum": [
          "active",
          "inactive"
        ],
        "type": "string"
      },
      "Survey": {
        "title": "Survey",
        "type": "object",
        "properties": {
          "id": {
            "title": "Id",
            "description": "A unique UUID associated with the object.",
            "type": "string",
            "format": "uuid"
          },
          "creation_date": {
            "title": "Creation Date",
            "description": "The date and time at which the object was created.",
            "type": "string",
            "format": "date-time"
          },
          "identifier": {
            "title": "Identifier",
            "type": "string"
          },
          "question": {
            "title": "Question",
            "type": "string"
          },
          "response_count": {
            "title": "Response Count",
            "type": "integer"
          },
          "answers": {
            "title": "Answers",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "notes": {
            "title": "Notes",
            "type": "string"
          },
          "response_cadence": {
            "$ref": "#/components/schemas/SurveyResponseCadence"
          },
          "status": {
            "$ref": "#/components/schemas/SurveyStatus"
          },
          "is_freeform_response_enabled": {
            "title": "Is Freeform Response Enabled",
            "type": "boolean"
          }
        },
        "required": [
          "id",
          "creation_date",
          "identifier",
          "question",
          "response_count",
          "answers",
          "notes",
          "response_cadence",
          "status",
          "is_freeform_response_enabled"
        ]
      },
      "CreateSurveyErrorCode": {
        "title": "CreateSurveyErrorCode",
        "description": "Represents the type of error that occurred when creating a survey.\n\nHuman-readable error messages are provided in the `detail` field of the response;\nthese values are meant to be parseable by code or client logic.",
        "enum": [
          "identifier_already_exists"
        ],
        "type": "string"
      },
      "ErrorMessage_CreateSurveyErrorCode_": {
        "title": "ErrorMessage[CreateSurveyErrorCode]",
        "type": "object",
        "properties": {
          "code": {
            "$ref": "#/components/schemas/CreateSurveyErrorCode"
          },
          "detail": {
            "title": "Detail",
            "type": "string"
          },
          "metadata": {
            "title": "Metadata",
            "default": {},
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          }
        },
        "required": [
          "code",
          "detail"
        ]
      },
      "SurveyInput": {
        "title": "SurveyInput",
        "type": "object",
        "properties": {
          "identifier": {
            "title": "Identifier",
            "example": "color",
            "type": "string"
          },
          "question": {
            "title": "Question",
            "example": "What's your favorite color?",
            "type": "string"
          },
          "answers": {
            "title": "Answers",
            "example": [
              "Red",
              "Green",
              "Blue"
            ],
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "notes": {
            "title": "Notes",
            "default": "",
            "example": "",
            "type": "string"
          },
          "is_freeform_response_enabled": {
            "title": "Is Freeform Response Enabled",
            "default": false,
            "example": false,
            "type": "boolean"
          },
          "response_cadence": {
            "default": "once",
            "example": "once",
            "allOf": [
              {
                "$ref": "#/components/schemas/SurveyResponseCadence"
              }
            ]
          }
        },
        "required": [
          "identifier",
          "question",
          "answers"
        ]
      },
      "SurveyPage": {
        "title": "Page[Survey]",
        "type": "object",
        "properties": {
          "results": {
            "title": "Results",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Survey"
            }
          },
          "next": {
            "title": "Next",
            "type": "string"
          },
          "previous": {
            "title": "Previous",
            "type": "string"
          },
          "count": {
            "title": "Count",
            "type": "integer"
          }
        },
        "required": [
          "results",
          "count"
        ]
      },
      "UpdateSurveyErrorCode": {
        "title": "UpdateSurveyErrorCode",
        "description": "An enumeration.",
        "enum": [
          "answers_empty"
        ],
        "type": "string"
      },
      "ErrorMessage_UpdateSurveyErrorCode_": {
        "title": "ErrorMessage[UpdateSurveyErrorCode]",
        "type": "object",
        "properties": {
          "code": {
            "$ref": "#/components/schemas/UpdateSurveyErrorCode"
          },
          "detail": {
            "title": "Detail",
            "type": "string"
          },
          "metadata": {
            "title": "Metadata",
            "default": {},
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          }
        },
        "required": [
          "code",
          "detail"
        ]
      },
      "SurveyUpdateInput": {
        "title": "SurveyUpdateInput",
        "type": "object",
        "properties": {
          "notes": {
            "title": "Notes",
            "type": "string"
          },
          "answers": {
            "title": "Answers",
            "example": [
              "Red",
              "Green",
              "Blue"
            ],
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "response_cadence": {
            "example": "once",
            "allOf": [
              {
                "$ref": "#/components/schemas/SurveyResponseCadence"
              }
            ]
          },
          "status": {
            "$ref": "#/components/schemas/SurveyStatus"
          },
          "is_freeform_response_enabled": {
            "title": "Is Freeform Response Enabled",
            "default": false,
            "type": "boolean"
          }
        }
      },
      "APIRequestSource": {
        "title": "Source",
        "description": "An enumeration.",
        "enum": [
          "api",
          "app",
          "carrd",
          "zapier",
          "cli"
        ],
        "type": "string"
      },
      "APIRequestDetail": {
        "title": "APIRequestDetail",
        "description": "Represents a request to the API (api.buttondown.com).",
        "type": "object",
        "properties": {
          "id": {
            "title": "Id",
            "description": "A unique UUID associated with the object.",
            "type": "string",
            "format": "uuid"
          },
          "creation_date": {
            "title": "Creation Date",
            "description": "The date and time at which the object was created.",
            "type": "string",
            "format": "date-time"
          },
          "status_code": {
            "title": "Status Code",
            "type": "integer"
          },
          "path": {
            "title": "Path",
            "type": "string"
          },
          "method": {
            "title": "Method",
            "type": "string"
          },
          "source": {
            "$ref": "#/components/schemas/APIRequestSource"
          },
          "version": {
            "title": "Version",
            "enum": [
              "2024-07-01",
              "2024-08-01",
              "2024-08-15",
              "2024-09-30",
              "2024-12-30",
              "2025-01-02"
            ],
            "type": "string"
          },
          "request_data": {
            "title": "Request Data",
            "type": "string"
          },
          "response_data": {
            "title": "Response Data",
            "type": "string"
          },
          "ip_address": {
            "title": "Ip Address",
            "type": "string"
          }
        },
        "required": [
          "id",
          "creation_date",
          "status_code",
          "path",
          "method",
          "source",
          "version",
          "request_data",
          "response_data",
          "ip_address"
        ]
      },
      "APIRequest": {
        "title": "APIRequest",
        "description": "Represents a request to the API (api.buttondown.com).",
        "type": "object",
        "properties": {
          "id": {
            "title": "Id",
            "description": "A unique UUID associated with the object.",
            "type": "string",
            "format": "uuid"
          },
          "creation_date": {
            "title": "Creation Date",
            "description": "The date and time at which the object was created.",
            "type": "string",
            "format": "date-time"
          },
          "status_code": {
            "title": "Status Code",
            "type": "integer"
          },
          "path": {
            "title": "Path",
            "type": "string"
          },
          "method": {
            "title": "Method",
            "type": "string"
          },
          "source": {
            "$ref": "#/components/schemas/APIRequestSource"
          },
          "version": {
            "title": "Version",
            "enum": [
              "2024-07-01",
              "2024-08-01",
              "2024-08-15",
              "2024-09-30",
              "2024-12-30",
              "2025-01-02"
            ],
            "type": "string"
          }
        },
        "required": [
          "id",
          "creation_date",
          "status_code",
          "path",
          "method",
          "source",
          "version"
        ]
      },
      "APIRequestPage": {
        "title": "Page[APIRequest]",
        "type": "object",
        "properties": {
          "results": {
            "title": "Results",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/APIRequest"
            }
          },
          "next": {
            "title": "Next",
            "type": "string"
          },
          "previous": {
            "title": "Previous",
            "type": "string"
          },
          "count": {
            "title": "Count",
            "type": "integer"
          }
        },
        "required": [
          "results",
          "count"
        ]
      },
      "AdvertisingSKUStatus": {
        "title": "Status",
        "description": "An enumeration.",
        "enum": [
          "active",
          "inactive"
        ],
        "type": "string"
      },
      "AdvertisingSlotStatus": {
        "title": "Status",
        "description": "An enumeration.",
        "enum": [
          "open",
          "sold",
          "finalized",
          "executed",
          "expired"
        ],
        "type": "string"
      },
      "AdvertisingSlot": {
        "title": "AdvertisingSlot",
        "type": "object",
        "properties": {
          "id": {
            "title": "Id",
            "type": "string",
            "format": "uuid"
          },
          "date": {
            "title": "Date",
            "type": "string",
            "format": "date"
          },
          "status": {
            "$ref": "#/components/schemas/AdvertisingSlotStatus"
          },
          "invoice_url": {
            "title": "Invoice Url",
            "type": "string"
          }
        },
        "required": [
          "id",
          "date",
          "status"
        ]
      },
      "AdvertisingUnit": {
        "title": "AdvertisingUnit",
        "type": "object",
        "properties": {
          "id": {
            "title": "Id",
            "type": "string",
            "format": "uuid"
          },
          "creation_date": {
            "title": "Creation Date",
            "type": "string",
            "format": "date-time"
          },
          "status": {
            "$ref": "#/components/schemas/AdvertisingSKUStatus"
          },
          "slots": {
            "title": "Slots",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AdvertisingSlot"
            }
          },
          "title": {
            "title": "Title",
            "type": "string"
          },
          "description": {
            "title": "Description",
            "type": "string"
          },
          "behavior": {
            "title": "Behavior",
            "type": "string"
          },
          "url": {
            "title": "Url",
            "type": "string"
          },
          "price": {
            "title": "Price",
            "type": "integer"
          }
        },
        "required": [
          "id",
          "creation_date",
          "status",
          "slots",
          "title",
          "description",
          "behavior",
          "url"
        ]
      },
      "AdvertisingUnitPage": {
        "title": "Page[AdvertisingUnit]",
        "type": "object",
        "properties": {
          "results": {
            "title": "Results",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AdvertisingUnit"
            }
          },
          "next": {
            "title": "Next",
            "type": "string"
          },
          "previous": {
            "title": "Previous",
            "type": "string"
          },
          "count": {
            "title": "Count",
            "type": "integer"
          }
        },
        "required": [
          "results",
          "count"
        ]
      },
      "AdvertisingUnitInput": {
        "title": "AdvertisingUnitInput",
        "type": "object",
        "properties": {
          "title": {
            "title": "Title",
            "type": "string"
          },
          "description": {
            "title": "Description",
            "type": "string"
          },
          "behavior": {
            "title": "Behavior",
            "default": "",
            "type": "string"
          },
          "url": {
            "title": "Url",
            "default": "",
            "type": "string"
          },
          "price": {
            "title": "Price",
            "type": "integer"
          }
        }
      },
      "AdvertisingUnitUpdateInput": {
        "title": "AdvertisingUnitUpdateInput",
        "type": "object",
        "properties": {
          "title": {
            "title": "Title",
            "type": "string"
          },
          "description": {
            "title": "Description",
            "type": "string"
          },
          "dates": {
            "title": "Dates",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "behavior": {
            "title": "Behavior",
            "type": "string"
          },
          "url": {
            "title": "Url",
            "type": "string"
          },
          "price": {
            "title": "Price",
            "type": "integer"
          }
        },
        "required": [
          "dates"
        ]
      },
      "WebhookStatus": {
        "title": "WebhookStatus",
        "description": "The status of a webhook.",
        "enum": [
          "enabled",
          "disabled"
        ],
        "type": "string"
      },
      "Webhook": {
        "title": "Webhook",
        "description": "Webhooks are used to notify external services of events that occur in the\nsystem. For example, when a newsletter is sent, a webhook can be used to\nnotify an external service that the newsletter has been sent.",
        "type": "object",
        "properties": {
          "id": {
            "title": "Id",
            "description": "A unique UUID associated with the object.",
            "type": "string",
            "format": "uuid"
          },
          "creation_date": {
            "title": "Creation Date",
            "description": "The date and time at which the object was created.",
            "type": "string",
            "format": "date-time"
          },
          "status": {
            "description": "Whether the webhook is enabled or not.",
            "default": "enabled",
            "example": "enabled",
            "allOf": [
              {
                "$ref": "#/components/schemas/WebhookStatus"
              }
            ]
          },
          "event_types": {
            "description": "The types of event for which the webhook will be triggered.",
            "example": [
              "email.created",
              "email.sent"
            ],
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ExternalEventType"
            }
          },
          "url": {
            "title": "Url",
            "description": "The URL to which the webhook will send POST requests.",
            "example": "https://my.api/webhook",
            "minLength": 1,
            "maxLength": 65536,
            "format": "uri",
            "type": "string"
          },
          "description": {
            "title": "Description",
            "description": "An optional description of the webhook, for reference.",
            "default": "",
            "example": "Trigger when an email is created to notify in Slack.",
            "type": "string"
          }
        },
        "required": [
          "id",
          "creation_date",
          "event_types",
          "url"
        ]
      },
      "WebhookInput": {
        "title": "WebhookInput",
        "type": "object",
        "properties": {
          "status": {
            "description": "Whether the webhook is enabled or not.",
            "default": "enabled",
            "example": "enabled",
            "allOf": [
              {
                "$ref": "#/components/schemas/WebhookStatus"
              }
            ]
          },
          "event_types": {
            "description": "The types of event for which the webhook will be triggered.",
            "example": [
              "email.created",
              "email.sent"
            ],
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ExternalEventType"
            }
          },
          "url": {
            "title": "Url",
            "description": "The URL to which the webhook will send POST requests.",
            "example": "https://my.api/webhook",
            "minLength": 1,
            "maxLength": 65536,
            "format": "uri",
            "type": "string"
          },
          "description": {
            "title": "Description",
            "description": "An optional description of the webhook, for reference.",
            "default": "",
            "example": "Trigger when an email is created to notify in Slack.",
            "type": "string"
          }
        },
        "required": [
          "event_types",
          "url"
        ]
      },
      "WebhookPage": {
        "title": "Page[Webhook]",
        "type": "object",
        "properties": {
          "results": {
            "title": "Results",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Webhook"
            }
          },
          "next": {
            "title": "Next",
            "type": "string"
          },
          "previous": {
            "title": "Previous",
            "type": "string"
          },
          "count": {
            "title": "Count",
            "type": "integer"
          }
        },
        "required": [
          "results",
          "count"
        ]
      },
      "WebhookAttemptStatus": {
        "title": "Status",
        "description": "An enumeration.",
        "enum": [
          "unattempted",
          "successful",
          "failed"
        ],
        "type": "string"
      },
      "WebhookAttemptOutput": {
        "title": "WebhookAttemptOutput",
        "type": "object",
        "properties": {
          "id": {
            "title": "Id",
            "description": "A unique UUID associated with the object.",
            "type": "string",
            "format": "uuid"
          },
          "creation_date": {
            "title": "Creation Date",
            "description": "The date and time at which the object was created.",
            "type": "string",
            "format": "date-time"
          },
          "status": {
            "description": "The status of the webhook attempt.",
            "example": "successful",
            "allOf": [
              {
                "$ref": "#/components/schemas/WebhookAttemptStatus"
              }
            ]
          }
        },
        "required": [
          "id",
          "creation_date",
          "status"
        ]
      },
      "WebhookAttemptOutputPage": {
        "title": "Page[WebhookAttemptOutput]",
        "type": "object",
        "properties": {
          "results": {
            "title": "Results",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/WebhookAttemptOutput"
            }
          },
          "next": {
            "title": "Next",
            "type": "string"
          },
          "previous": {
            "title": "Previous",
            "type": "string"
          },
          "count": {
            "title": "Count",
            "type": "integer"
          }
        },
        "required": [
          "results",
          "count"
        ]
      },
      "Comment": {
        "title": "Comment",
        "description": "Comments are a way for subscribers to interact with newsletters. They're a way to\nprovide feedback, ask questions, and generally engage with the content of an email.\nComments exist in a tree structure; comments that reply to other comments are\nconsidered \"children\" of the parent comment.",
        "type": "object",
        "properties": {
          "id": {
            "title": "Id",
            "description": "A unique UUID associated with the object.",
            "type": "string",
            "format": "uuid"
          },
          "creation_date": {
            "title": "Creation Date",
            "description": "The date and time at which the object was created.",
            "type": "string",
            "format": "date-time"
          },
          "email_id": {
            "title": "Email Id",
            "type": "string",
            "format": "uuid"
          },
          "subscriber_id": {
            "title": "Subscriber Id",
            "type": "string",
            "format": "uuid"
          },
          "parent_id": {
            "title": "Parent Id",
            "description": "The ID of the parent comment, if this comment is a reply to another comment.",
            "type": "string",
            "format": "uuid"
          },
          "text": {
            "title": "Text",
            "type": "string"
          },
          "subscriber": {
            "$ref": "#/components/schemas/Subscriber"
          },
          "email": {
            "$ref": "#/components/schemas/Email"
          }
        },
        "required": [
          "id",
          "creation_date",
          "email_id",
          "text"
        ]
      },
      "CommentPage": {
        "title": "Page[Comment]",
        "type": "object",
        "properties": {
          "results": {
            "title": "Results",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Comment"
            }
          },
          "next": {
            "title": "Next",
            "type": "string"
          },
          "previous": {
            "title": "Previous",
            "type": "string"
          },
          "count": {
            "title": "Count",
            "type": "integer"
          }
        },
        "required": [
          "results",
          "count"
        ]
      },
      "Response": {
        "title": "Response",
        "type": "object",
        "properties": {
          "id": {
            "title": "Id",
            "description": "A unique UUID associated with the object.",
            "type": "string",
            "format": "uuid"
          },
          "creation_date": {
            "title": "Creation Date",
            "description": "The date and time at which the object was created.",
            "type": "string",
            "format": "date-time"
          },
          "answer": {
            "title": "Answer",
            "description": "The answer given to the survey.",
            "type": "string"
          },
          "text": {
            "title": "Text",
            "description": "Optional text included by the subscriber with the response. Subscribers are only prompted to supply a text response if the `is_freeform_response_enabled` field is set to `true` on the survey.",
            "type": "string"
          },
          "survey_id": {
            "title": "Survey Id",
            "type": "string",
            "format": "uuid"
          },
          "subscriber_id": {
            "title": "Subscriber Id",
            "type": "string",
            "format": "uuid"
          },
          "email_id": {
            "title": "Email Id",
            "type": "string",
            "format": "uuid"
          },
          "automation_id": {
            "title": "Automation Id",
            "type": "string",
            "format": "uuid"
          },
          "subscriber": {
            "$ref": "#/components/schemas/Subscriber"
          },
          "survey": {
            "$ref": "#/components/schemas/Survey"
          },
          "email": {
            "$ref": "#/components/schemas/Email"
          },
          "automation": {
            "$ref": "#/components/schemas/Automation"
          }
        },
        "required": [
          "id",
          "creation_date",
          "answer",
          "text",
          "survey_id",
          "subscriber_id"
        ]
      },
      "ResponsePage": {
        "title": "Page[Response]",
        "type": "object",
        "properties": {
          "results": {
            "title": "Results",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Response"
            }
          },
          "next": {
            "title": "Next",
            "type": "string"
          },
          "previous": {
            "title": "Previous",
            "type": "string"
          },
          "count": {
            "title": "Count",
            "type": "integer"
          }
        },
        "required": [
          "results",
          "count"
        ]
      },
      "ResponseInput": {
        "title": "ResponseInput",
        "type": "object",
        "properties": {
          "subscriber_id": {
            "title": "Subscriber Id",
            "type": "string",
            "format": "uuid"
          },
          "survey_id": {
            "title": "Survey Id",
            "type": "string",
            "format": "uuid"
          },
          "email_id": {
            "title": "Email Id",
            "type": "string"
          },
          "answer": {
            "title": "Answer",
            "type": "integer"
          }
        },
        "required": [
          "subscriber_id",
          "survey_id",
          "email_id",
          "answer"
        ]
      },
      "EmailEventType": {
        "title": "EmailEventType",
        "description": "An enumeration.",
        "enum": [
          "activation_clicked",
          "activation_delivered",
          "activation_opened",
          "bounced",
          "complained",
          "clicked",
          "dropped",
          "delivered",
          "opened",
          "sent",
          "rejected",
          "replied",
          "unsubscribed"
        ],
        "type": "string"
      },
      "EmailEvent": {
        "title": "EmailEvent",
        "type": "object",
        "properties": {
          "id": {
            "title": "Id",
            "type": "string",
            "format": "uuid"
          },
          "subscriber_id": {
            "title": "Subscriber Id",
            "type": "string",
            "format": "uuid"
          },
          "email_id": {
            "title": "Email Id",
            "type": "string",
            "format": "uuid"
          },
          "automation_id": {
            "title": "Automation Id",
            "type": "string",
            "format": "uuid"
          },
          "creation_date": {
            "title": "Creation Date",
            "type": "string",
            "format": "date-time"
          },
          "metadata": {
            "title": "Metadata",
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          },
          "event_type": {
            "$ref": "#/components/schemas/EmailEventType"
          },
          "subscriber": {
            "$ref": "#/components/schemas/Subscriber"
          },
          "email": {
            "$ref": "#/components/schemas/Email"
          },
          "automation": {
            "$ref": "#/components/schemas/Automation"
          }
        },
        "required": [
          "id",
          "creation_date",
          "metadata",
          "event_type"
        ]
      },
      "EmailEventPage": {
        "title": "Page[EmailEvent]",
        "type": "object",
        "properties": {
          "results": {
            "title": "Results",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/EmailEvent"
            }
          },
          "next": {
            "title": "Next",
            "type": "string"
          },
          "previous": {
            "title": "Previous",
            "type": "string"
          },
          "count": {
            "title": "Count",
            "type": "integer"
          }
        },
        "required": [
          "results",
          "count"
        ]
      },
      "EmailExcludableField": {
        "type": "string",
        "enum": [
          "body"
        ]
      }
    },
    "securitySchemes": {
      "PermissionAuthenticationRequirement": {
        "type": "http",
        "scheme": "none"
      },
      "GlobalAuth": {
        "type": "http",
        "scheme": "token"
      },
      "OAuthAuth": {
        "type": "http",
        "scheme": "bearer"
      },
      "FallbackForNoAuth": {
        "type": "http",
        "scheme": "none"
      },
      "BulkActionAuth": {
        "type": "http",
        "scheme": "none"
      }
    }
  },
  "servers": [
    {
      "url": "https://api.buttondown.com/v1"
    }
  ]
}