{
  "components": {
    "responses": {
      "errors": {
        "content": {
          "application/vnd.api+json": {
            "schema": {
              "$ref": "#/components/schemas/errors"
            }
          }
        },
        "description": "General Error"
      }
    },
    "schemas": {
      "file-filter": {
        "additionalProperties": false,
        "description": "Filters the query to results matching the given filter object",
        "example": "",
        "properties": {
          "and": {
            "items": {
              "$ref": "#/components/schemas/file-filter"
            },
            "type": "array",
            "uniqueItems": true
          },
          "checksum_sha256": {
            "$ref": "#/components/schemas/file-filter-checksum_sha256"
          },
          "checksum_verified_at": {
            "$ref": "#/components/schemas/file-filter-checksum_verified_at"
          },
          "content_type": {
            "$ref": "#/components/schemas/file-filter-content_type"
          },
          "etag": {
            "$ref": "#/components/schemas/file-filter-etag"
          },
          "filename": {
            "$ref": "#/components/schemas/file-filter-filename"
          },
          "id": {
            "$ref": "#/components/schemas/file-filter-id"
          },
          "key": {
            "$ref": "#/components/schemas/file-filter-key"
          },
          "not": {
            "$ref": "#/components/schemas/file-filter"
          },
          "or": {
            "items": {
              "$ref": "#/components/schemas/file-filter"
            },
            "type": "array",
            "uniqueItems": true
          },
          "size": {
            "$ref": "#/components/schemas/file-filter-size"
          },
          "status": {
            "$ref": "#/components/schemas/file-filter-status"
          },
          "store_id": {
            "$ref": "#/components/schemas/file-filter-store_id"
          },
          "verified_at": {
            "$ref": "#/components/schemas/file-filter-verified_at"
          },
          "version": {
            "$ref": "#/components/schemas/file-filter-version"
          }
        },
        "type": "object"
      },
      "product-filter": {
        "additionalProperties": false,
        "description": "Filters the query to results matching the given filter object",
        "example": "",
        "properties": {
          "and": {
            "items": {
              "$ref": "#/components/schemas/product-filter"
            },
            "type": "array",
            "uniqueItems": true
          },
          "description": {
            "$ref": "#/components/schemas/product-filter-description"
          },
          "download_limit": {
            "$ref": "#/components/schemas/product-filter-download_limit"
          },
          "expires_after_seconds": {
            "$ref": "#/components/schemas/product-filter-expires_after_seconds"
          },
          "id": {
            "$ref": "#/components/schemas/product-filter-id"
          },
          "issues_keys": {
            "$ref": "#/components/schemas/product-filter-issues_keys"
          },
          "name": {
            "$ref": "#/components/schemas/product-filter-name"
          },
          "not": {
            "$ref": "#/components/schemas/product-filter"
          },
          "or": {
            "items": {
              "$ref": "#/components/schemas/product-filter"
            },
            "type": "array",
            "uniqueItems": true
          },
          "removed_at": {
            "$ref": "#/components/schemas/product-filter-removed_at"
          },
          "sku": {
            "$ref": "#/components/schemas/product-filter-sku"
          },
          "status": {
            "$ref": "#/components/schemas/product-filter-status"
          }
        },
        "type": "object"
      },
      "OrderCreate": {
        "additionalProperties": false,
        "properties": {
          "buyer_email": {
            "description": "One plain address: where the download email goes.",
            "format": "email",
            "maxLength": 254,
            "type": "string"
          },
          "buyer_name": {
            "maxLength": 255,
            "nullable": true,
            "type": "string"
          },
          "download_limit": {
            "description": "Downloads per unit for this order. Only lower than each product's (else your account's) limit; a higher one is refused (422).",
            "maximum": 1000000,
            "minimum": 1,
            "type": "integer"
          },
          "expires_at": {
            "description": "When this order's access ends (at least a minute ahead, at most 3650 days). Only earlier than each product's (else your account's) expiry; a later one is refused (422).",
            "format": "date-time",
            "type": "string"
          },
          "lines": {
            "description": "At most 50; each product once.",
            "items": {
              "$ref": "#/components/schemas/OrderCreateLine"
            },
            "maxItems": 50,
            "minItems": 1,
            "type": "array"
          },
          "reference": {
            "description": "Your own order or payment id (a Stripe Checkout Session id, an invoice number). Makes the call idempotent; shown as the order's name.",
            "maxLength": 100,
            "type": "string"
          },
          "send_email": {
            "default": true,
            "description": "Email the buyer their download link (default true).",
            "type": "boolean"
          }
        },
        "required": [
          "reference",
          "buyer_email",
          "lines"
        ],
        "title": "OrderCreate",
        "type": "object"
      },
      "OrderResent": {
        "properties": {
          "order": {
            "$ref": "#/components/schemas/Order"
          },
          "resent": {
            "type": "boolean"
          }
        },
        "title": "OrderResent",
        "type": "object"
      },
      "upload-filter-id": {
        "additionalProperties": false,
        "properties": {
          "eq": {
            "format": "uuid",
            "type": "string"
          },
          "greater_than": {
            "format": "uuid",
            "type": "string"
          },
          "greater_than_or_equal": {
            "format": "uuid",
            "type": "string"
          },
          "in": {
            "items": {
              "format": "uuid",
              "type": "string"
            },
            "type": "array"
          },
          "is_distinct_from": {
            "format": "uuid",
            "type": "string"
          },
          "is_nil": {
            "type": "boolean"
          },
          "is_not_distinct_from": {
            "format": "uuid",
            "type": "string"
          },
          "less_than": {
            "format": "uuid",
            "type": "string"
          },
          "less_than_or_equal": {
            "format": "uuid",
            "type": "string"
          },
          "not_eq": {
            "format": "uuid",
            "type": "string"
          }
        },
        "type": "object"
      },
      "upload-filter-expires_at": {
        "additionalProperties": false,
        "properties": {
          "eq": {},
          "greater_than": {},
          "greater_than_or_equal": {},
          "in": {
            "items": {},
            "type": "array"
          },
          "is_distinct_from": {},
          "is_nil": {
            "type": "boolean"
          },
          "is_not_distinct_from": {},
          "less_than": {},
          "less_than_or_equal": {},
          "not_eq": {}
        },
        "type": "object"
      },
      "Me": {
        "properties": {
          "api_key": {
            "description": "The key the request was made with.",
            "properties": {
              "expires_at": {
                "format": "date-time",
                "nullable": true,
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "prefix": {
                "description": "The key's first characters: `fa4_…`.",
                "type": "string"
              },
              "scopes": {
                "items": {
                  "type": "string"
                },
                "type": "array"
              }
            },
            "type": "object"
          },
          "plan": {
            "properties": {
              "api_via": {
                "enum": [
                  "plan",
                  "grant"
                ],
                "type": "string"
              },
              "code": {
                "nullable": true,
                "type": "string"
              }
            },
            "type": "object"
          },
          "tenant": {
            "description": "The account.",
            "properties": {
              "name": {
                "type": "string"
              },
              "slug": {
                "type": "string"
              }
            },
            "type": "object"
          }
        },
        "title": "Me",
        "type": "object"
      },
      "Order": {
        "properties": {
          "buyer": {
            "properties": {
              "email": {
                "type": "string"
              },
              "name": {
                "nullable": true,
                "type": "string"
              }
            },
            "type": "object"
          },
          "cancelled_at": {
            "format": "date-time",
            "nullable": true,
            "type": "string"
          },
          "created_at": {
            "format": "date-time",
            "type": "string"
          },
          "download_url": {
            "description": "The buyer's download page. Whoever has it can download the order: share it only with the buyer.",
            "format": "uri",
            "type": "string"
          },
          "email": {
            "$ref": "#/components/schemas/OrderEmail"
          },
          "id": {
            "format": "uuid",
            "type": "string"
          },
          "lines": {
            "items": {
              "$ref": "#/components/schemas/OrderLine"
            },
            "type": "array"
          },
          "placed_at": {
            "format": "date-time",
            "nullable": true,
            "type": "string"
          },
          "reference": {
            "nullable": true,
            "type": "string"
          },
          "source": {
            "description": "`api`, `manual` (admin), `csv_import`, `shopify` or `paypal`.",
            "type": "string"
          },
          "source_id": {
            "description": "The order's id at its store (`shopify`: numeric order id; `paypal`: `txn_id`), or `null` for `api`, `manual` and `csv_import`.",
            "nullable": true,
            "type": "string"
          },
          "status": {
            "description": "The payment status (`paid`, `refunded`, …).",
            "type": "string"
          },
          "test": {
            "type": "boolean"
          }
        },
        "title": "Order",
        "type": "object"
      },
      "file-filter-checksum_sha256": {
        "additionalProperties": false,
        "properties": {
          "contains": {
            "type": "string"
          },
          "eq": {
            "type": "string"
          },
          "greater_than": {
            "type": "string"
          },
          "greater_than_or_equal": {
            "type": "string"
          },
          "ilike": {
            "type": "string"
          },
          "in": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "is_distinct_from": {
            "type": "string"
          },
          "is_nil": {
            "type": "boolean"
          },
          "is_not_distinct_from": {
            "type": "string"
          },
          "less_than": {
            "type": "string"
          },
          "less_than_or_equal": {
            "type": "string"
          },
          "like": {
            "type": "string"
          },
          "not_eq": {
            "type": "string"
          },
          "string_ends_with": {
            "type": "string"
          },
          "string_starts_with": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "links": {
        "additionalProperties": {
          "$ref": "#/components/schemas/link"
        },
        "type": "object"
      },
      "OrderUnit": {
        "properties": {
          "download_count": {
            "type": "integer"
          },
          "download_limit": {
            "description": "null: unlimited.",
            "nullable": true,
            "type": "integer"
          },
          "expired": {
            "type": "boolean"
          },
          "expires_at": {
            "description": "null: never.",
            "format": "date-time",
            "nullable": true,
            "type": "string"
          },
          "revoke_reason": {
            "nullable": true,
            "type": "string"
          },
          "seq": {
            "type": "integer"
          },
          "status": {
            "enum": [
              "active",
              "pending",
              "revoked",
              "suspended"
            ],
            "type": "string"
          }
        },
        "title": "OrderUnit",
        "type": "object"
      },
      "upload-filter-part_count": {
        "additionalProperties": false,
        "properties": {
          "eq": {
            "type": "integer"
          },
          "greater_than": {
            "type": "integer"
          },
          "greater_than_or_equal": {
            "type": "integer"
          },
          "in": {
            "items": {
              "type": "integer"
            },
            "type": "array"
          },
          "is_distinct_from": {
            "type": "integer"
          },
          "is_nil": {
            "type": "boolean"
          },
          "is_not_distinct_from": {
            "type": "integer"
          },
          "less_than": {
            "type": "integer"
          },
          "less_than_or_equal": {
            "type": "integer"
          },
          "not_eq": {
            "type": "integer"
          }
        },
        "type": "object"
      },
      "product-filter-description": {
        "additionalProperties": false,
        "properties": {
          "contains": {
            "type": "string"
          },
          "eq": {
            "type": "string"
          },
          "greater_than": {
            "type": "string"
          },
          "greater_than_or_equal": {
            "type": "string"
          },
          "ilike": {
            "type": "string"
          },
          "in": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "is_distinct_from": {
            "type": "string"
          },
          "is_nil": {
            "type": "boolean"
          },
          "is_not_distinct_from": {
            "type": "string"
          },
          "less_than": {
            "type": "string"
          },
          "less_than_or_equal": {
            "type": "string"
          },
          "like": {
            "type": "string"
          },
          "not_eq": {
            "type": "string"
          },
          "string_ends_with": {
            "type": "string"
          },
          "string_starts_with": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "product-filter-status": {
        "additionalProperties": false,
        "properties": {
          "eq": {
            "enum": [
              "active",
              "archived",
              "removed"
            ],
            "type": "string"
          },
          "greater_than": {
            "enum": [
              "active",
              "archived",
              "removed"
            ],
            "type": "string"
          },
          "greater_than_or_equal": {
            "enum": [
              "active",
              "archived",
              "removed"
            ],
            "type": "string"
          },
          "in": {
            "items": {
              "enum": [
                "active",
                "archived",
                "removed"
              ],
              "type": "string"
            },
            "type": "array"
          },
          "is_distinct_from": {
            "enum": [
              "active",
              "archived",
              "removed"
            ],
            "type": "string"
          },
          "is_nil": {
            "type": "boolean"
          },
          "is_not_distinct_from": {
            "enum": [
              "active",
              "archived",
              "removed"
            ],
            "type": "string"
          },
          "less_than": {
            "enum": [
              "active",
              "archived",
              "removed"
            ],
            "type": "string"
          },
          "less_than_or_equal": {
            "enum": [
              "active",
              "archived",
              "removed"
            ],
            "type": "string"
          },
          "not_eq": {
            "enum": [
              "active",
              "archived",
              "removed"
            ],
            "type": "string"
          }
        },
        "type": "object"
      },
      "product-filter-issues_keys": {
        "additionalProperties": false,
        "properties": {
          "eq": {
            "type": "boolean"
          },
          "greater_than": {
            "type": "boolean"
          },
          "greater_than_or_equal": {
            "type": "boolean"
          },
          "in": {
            "items": {
              "type": "boolean"
            },
            "type": "array"
          },
          "is_distinct_from": {
            "type": "boolean"
          },
          "is_nil": {
            "type": "boolean"
          },
          "is_not_distinct_from": {
            "type": "boolean"
          },
          "less_than": {
            "type": "boolean"
          },
          "less_than_or_equal": {
            "type": "boolean"
          },
          "not_eq": {
            "type": "boolean"
          }
        },
        "type": "object"
      },
      "OrderExpired": {
        "properties": {
          "already_expired": {
            "type": "integer"
          },
          "expired": {
            "description": "Units whose access ended now.",
            "type": "integer"
          },
          "order": {
            "$ref": "#/components/schemas/Order"
          },
          "skipped": {
            "description": "Units not active (left as they are).",
            "type": "integer"
          }
        },
        "title": "OrderExpired",
        "type": "object"
      },
      "OrderOne": {
        "properties": {
          "order": {
            "$ref": "#/components/schemas/Order"
          }
        },
        "title": "OrderOne",
        "type": "object"
      },
      "product-filter-removed_at": {
        "additionalProperties": false,
        "properties": {
          "eq": {},
          "greater_than": {},
          "greater_than_or_equal": {},
          "in": {
            "items": {},
            "type": "array"
          },
          "is_distinct_from": {},
          "is_nil": {
            "type": "boolean"
          },
          "is_not_distinct_from": {},
          "less_than": {},
          "less_than_or_equal": {},
          "not_eq": {}
        },
        "type": "object"
      },
      "link": {
        "description": "A link MUST be represented as either: a string containing the link's URL or a link object.",
        "type": "string"
      },
      "file_rename": {
        "additionalProperties": false,
        "description": "A \"Resource object\" representing a file_rename",
        "properties": {
          "attributes": {
            "additionalProperties": false,
            "description": "An attributes object for a file_rename",
            "properties": {},
            "type": "object"
          },
          "id": {
            "type": "string"
          },
          "relationships": {
            "additionalProperties": false,
            "description": "A relationships object for a file_rename",
            "properties": {},
            "type": "object"
          },
          "type": {
            "type": "string"
          }
        },
        "required": [
          "type",
          "id"
        ],
        "type": "object"
      },
      "file": {
        "additionalProperties": false,
        "description": "A \"Resource object\" representing a file",
        "properties": {
          "attributes": {
            "additionalProperties": false,
            "description": "An attributes object for a file",
            "properties": {
              "checksum_sha256": {
                "description": "Field included by default.",
                "nullable": true,
                "type": "string"
              },
              "checksum_verified_at": {
                "description": "Field included by default.",
                "nullable": true
              },
              "content_type": {
                "description": "Field included by default.",
                "nullable": true,
                "type": "string"
              },
              "etag": {
                "description": "Field included by default.",
                "nullable": true,
                "type": "string"
              },
              "filename": {
                "description": "Field included by default.",
                "type": "string"
              },
              "key": {
                "description": "Field included by default.",
                "type": "string"
              },
              "size": {
                "description": "Field included by default.",
                "nullable": true,
                "type": "integer"
              },
              "status": {
                "description": "Field included by default.",
                "enum": [
                  "pending",
                  "available",
                  "missing",
                  "deleted",
                  "superseded"
                ],
                "type": "string"
              },
              "store_id": {
                "description": "Field included by default.",
                "format": "uuid",
                "nullable": true,
                "type": "string"
              },
              "verified_at": {
                "description": "Field included by default.",
                "nullable": true
              },
              "version": {
                "description": "Field included by default.",
                "type": "integer"
              }
            },
            "required": [
              "key",
              "filename",
              "status",
              "version"
            ],
            "type": "object"
          },
          "id": {
            "type": "string"
          },
          "relationships": {
            "additionalProperties": false,
            "description": "A relationships object for a file",
            "properties": {},
            "type": "object"
          },
          "type": {
            "type": "string"
          }
        },
        "required": [
          "type",
          "id"
        ],
        "type": "object"
      },
      "upload-filter-part_size": {
        "additionalProperties": false,
        "properties": {
          "eq": {
            "type": "integer"
          },
          "greater_than": {
            "type": "integer"
          },
          "greater_than_or_equal": {
            "type": "integer"
          },
          "in": {
            "items": {
              "type": "integer"
            },
            "type": "array"
          },
          "is_distinct_from": {
            "type": "integer"
          },
          "is_nil": {
            "type": "boolean"
          },
          "is_not_distinct_from": {
            "type": "integer"
          },
          "less_than": {
            "type": "integer"
          },
          "less_than_or_equal": {
            "type": "integer"
          },
          "not_eq": {
            "type": "integer"
          }
        },
        "type": "object"
      },
      "file-filter-etag": {
        "additionalProperties": false,
        "properties": {
          "contains": {
            "type": "string"
          },
          "eq": {
            "type": "string"
          },
          "greater_than": {
            "type": "string"
          },
          "greater_than_or_equal": {
            "type": "string"
          },
          "ilike": {
            "type": "string"
          },
          "in": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "is_distinct_from": {
            "type": "string"
          },
          "is_nil": {
            "type": "boolean"
          },
          "is_not_distinct_from": {
            "type": "string"
          },
          "less_than": {
            "type": "string"
          },
          "less_than_or_equal": {
            "type": "string"
          },
          "like": {
            "type": "string"
          },
          "not_eq": {
            "type": "string"
          },
          "string_ends_with": {
            "type": "string"
          },
          "string_starts_with": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "file-filter-store_id": {
        "additionalProperties": false,
        "properties": {
          "eq": {
            "format": "uuid",
            "type": "string"
          },
          "greater_than": {
            "format": "uuid",
            "type": "string"
          },
          "greater_than_or_equal": {
            "format": "uuid",
            "type": "string"
          },
          "in": {
            "items": {
              "format": "uuid",
              "type": "string"
            },
            "type": "array"
          },
          "is_distinct_from": {
            "format": "uuid",
            "type": "string"
          },
          "is_nil": {
            "type": "boolean"
          },
          "is_not_distinct_from": {
            "format": "uuid",
            "type": "string"
          },
          "less_than": {
            "format": "uuid",
            "type": "string"
          },
          "less_than_or_equal": {
            "format": "uuid",
            "type": "string"
          },
          "not_eq": {
            "format": "uuid",
            "type": "string"
          }
        },
        "type": "object"
      },
      "upload-filter": {
        "additionalProperties": false,
        "description": "Filters the query to results matching the given filter object",
        "example": "",
        "properties": {
          "and": {
            "items": {
              "$ref": "#/components/schemas/upload-filter"
            },
            "type": "array",
            "uniqueItems": true
          },
          "content_type": {
            "$ref": "#/components/schemas/upload-filter-content_type"
          },
          "error": {
            "$ref": "#/components/schemas/upload-filter-error"
          },
          "expires_at": {
            "$ref": "#/components/schemas/upload-filter-expires_at"
          },
          "file_id": {
            "$ref": "#/components/schemas/upload-filter-file_id"
          },
          "filename": {
            "$ref": "#/components/schemas/upload-filter-filename"
          },
          "id": {
            "$ref": "#/components/schemas/upload-filter-id"
          },
          "not": {
            "$ref": "#/components/schemas/upload-filter"
          },
          "or": {
            "items": {
              "$ref": "#/components/schemas/upload-filter"
            },
            "type": "array",
            "uniqueItems": true
          },
          "part_count": {
            "$ref": "#/components/schemas/upload-filter-part_count"
          },
          "part_size": {
            "$ref": "#/components/schemas/upload-filter-part_size"
          },
          "size": {
            "$ref": "#/components/schemas/upload-filter-size"
          },
          "status": {
            "$ref": "#/components/schemas/upload-filter-status"
          }
        },
        "type": "object"
      },
      "upload-filter-file_id": {
        "additionalProperties": false,
        "properties": {
          "eq": {
            "format": "uuid",
            "type": "string"
          },
          "greater_than": {
            "format": "uuid",
            "type": "string"
          },
          "greater_than_or_equal": {
            "format": "uuid",
            "type": "string"
          },
          "in": {
            "items": {
              "format": "uuid",
              "type": "string"
            },
            "type": "array"
          },
          "is_distinct_from": {
            "format": "uuid",
            "type": "string"
          },
          "is_nil": {
            "type": "boolean"
          },
          "is_not_distinct_from": {
            "format": "uuid",
            "type": "string"
          },
          "less_than": {
            "format": "uuid",
            "type": "string"
          },
          "less_than_or_equal": {
            "format": "uuid",
            "type": "string"
          },
          "not_eq": {
            "format": "uuid",
            "type": "string"
          }
        },
        "type": "object"
      },
      "OrderLine": {
        "properties": {
          "delivery": {
            "description": "`delivered`: a unit can be downloaded now; `pending`: units wait for payment; `expired`: none can be downloaded any more (expired or downloads used up); `revoked`; `not_delivered`: the product had nothing to deliver when the order arrived (`delivery_reason`); `unmatched`: no product; `none`: no unit issued.",
            "enum": [
              "delivered",
              "pending",
              "expired",
              "revoked",
              "not_delivered",
              "unmatched",
              "none"
            ],
            "type": "string"
          },
          "delivery_reason": {
            "nullable": true,
            "type": "string"
          },
          "id": {
            "format": "uuid",
            "type": "string"
          },
          "product_id": {
            "format": "uuid",
            "nullable": true,
            "type": "string"
          },
          "quantity": {
            "type": "integer"
          },
          "sku": {
            "nullable": true,
            "type": "string"
          },
          "title": {
            "nullable": true,
            "type": "string"
          },
          "units": {
            "items": {
              "$ref": "#/components/schemas/OrderUnit"
            },
            "type": "array"
          }
        },
        "title": "OrderLine",
        "type": "object"
      },
      "error": {
        "additionalProperties": false,
        "properties": {
          "code": {
            "description": "An application-specific error code, expressed as a string value.",
            "type": "string"
          },
          "detail": {
            "description": "A human-readable explanation specific to this occurrence of the problem.",
            "type": "string"
          },
          "id": {
            "description": "A unique identifier for this particular occurrence of the problem.",
            "type": "string"
          },
          "links": {
            "$ref": "#/components/schemas/links"
          },
          "source": {
            "properties": {
              "parameter": {
                "description": "A string indicating which query parameter caused the error.",
                "type": "string"
              },
              "pointer": {
                "description": "A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. \"/data\" for a primary data object, or \"/data/attributes/title\" for a specific attribute].",
                "type": "string"
              }
            },
            "type": "object"
          },
          "status": {
            "description": "The HTTP status code applicable to this problem, expressed as a string value.",
            "type": "string"
          },
          "title": {
            "description": "A short, human-readable summary of the problem. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.",
            "type": "string"
          }
        },
        "type": "object"
      },
      "OrderEmail": {
        "description": "The buyer's download email.",
        "properties": {
          "attempted_at": {
            "format": "date-time",
            "nullable": true,
            "type": "string"
          },
          "attempts": {
            "type": "integer"
          },
          "delivered_at": {
            "format": "date-time",
            "nullable": true,
            "type": "string"
          },
          "message": {
            "description": "What it means, in words.",
            "nullable": true,
            "type": "string"
          },
          "reason": {
            "description": "`daily_cap`, `daily_cap_invalid` (held); `not_active` (waiting); `retrying`, `resend_requested`, `restored` (queued); `suppressed` (bounced); for skipped: `email_disabled`, `account_inactive`, `account_email_off`, `not_enrolled`, `invalid_recipient`, `not_allowlisted`, `cancelled`, `test_order`, `nothing_to_deliver`, `no_access`, `other`.",
            "nullable": true,
            "type": "string"
          },
          "requested": {
            "description": "`send_email` of the order.",
            "type": "boolean"
          },
          "sent_at": {
            "format": "date-time",
            "nullable": true,
            "type": "string"
          },
          "status": {
            "description": "`held`: your account's daily email limit is reached — it goes out after 00:00 UTC by itself, never dropped. `waiting`: the order's units wait for payment. `skipped`: a send check said no (`reason`). `unknown`: the provider's answer was lost; support settles it before any resend.",
            "enum": [
              "not_requested",
              "waiting",
              "queued",
              "held",
              "sending",
              "sent",
              "delivered",
              "bounced",
              "failed",
              "sandboxed",
              "unknown",
              "skipped"
            ],
            "type": "string"
          }
        },
        "title": "OrderEmail",
        "type": "object"
      },
      "product-filter-download_limit": {
        "additionalProperties": false,
        "properties": {
          "eq": {
            "type": "integer"
          },
          "greater_than": {
            "type": "integer"
          },
          "greater_than_or_equal": {
            "type": "integer"
          },
          "in": {
            "items": {
              "type": "integer"
            },
            "type": "array"
          },
          "is_distinct_from": {
            "type": "integer"
          },
          "is_nil": {
            "type": "boolean"
          },
          "is_not_distinct_from": {
            "type": "integer"
          },
          "less_than": {
            "type": "integer"
          },
          "less_than_or_equal": {
            "type": "integer"
          },
          "not_eq": {
            "type": "integer"
          }
        },
        "type": "object"
      },
      "upload-filter-filename": {
        "additionalProperties": false,
        "properties": {
          "contains": {
            "type": "string"
          },
          "eq": {
            "type": "string"
          },
          "greater_than": {
            "type": "string"
          },
          "greater_than_or_equal": {
            "type": "string"
          },
          "ilike": {
            "type": "string"
          },
          "in": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "is_distinct_from": {
            "type": "string"
          },
          "is_nil": {
            "type": "boolean"
          },
          "is_not_distinct_from": {
            "type": "string"
          },
          "less_than": {
            "type": "string"
          },
          "less_than_or_equal": {
            "type": "string"
          },
          "like": {
            "type": "string"
          },
          "not_eq": {
            "type": "string"
          },
          "string_ends_with": {
            "type": "string"
          },
          "string_starts_with": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "file_rename-filter-id": {
        "additionalProperties": false,
        "properties": {
          "eq": {
            "format": "uuid",
            "type": "string"
          },
          "greater_than": {
            "format": "uuid",
            "type": "string"
          },
          "greater_than_or_equal": {
            "format": "uuid",
            "type": "string"
          },
          "in": {
            "items": {
              "format": "uuid",
              "type": "string"
            },
            "type": "array"
          },
          "is_distinct_from": {
            "format": "uuid",
            "type": "string"
          },
          "is_nil": {
            "type": "boolean"
          },
          "is_not_distinct_from": {
            "format": "uuid",
            "type": "string"
          },
          "less_than": {
            "format": "uuid",
            "type": "string"
          },
          "less_than_or_equal": {
            "format": "uuid",
            "type": "string"
          },
          "not_eq": {
            "format": "uuid",
            "type": "string"
          }
        },
        "type": "object"
      },
      "errors": {
        "items": {
          "$ref": "#/components/schemas/error"
        },
        "type": "array",
        "uniqueItems": true
      },
      "product-filter-id": {
        "additionalProperties": false,
        "properties": {
          "eq": {
            "format": "uuid",
            "type": "string"
          },
          "greater_than": {
            "format": "uuid",
            "type": "string"
          },
          "greater_than_or_equal": {
            "format": "uuid",
            "type": "string"
          },
          "in": {
            "items": {
              "format": "uuid",
              "type": "string"
            },
            "type": "array"
          },
          "is_distinct_from": {
            "format": "uuid",
            "type": "string"
          },
          "is_nil": {
            "type": "boolean"
          },
          "is_not_distinct_from": {
            "format": "uuid",
            "type": "string"
          },
          "less_than": {
            "format": "uuid",
            "type": "string"
          },
          "less_than_or_equal": {
            "format": "uuid",
            "type": "string"
          },
          "not_eq": {
            "format": "uuid",
            "type": "string"
          }
        },
        "type": "object"
      },
      "upload-filter-content_type": {
        "additionalProperties": false,
        "properties": {
          "contains": {
            "type": "string"
          },
          "eq": {
            "type": "string"
          },
          "greater_than": {
            "type": "string"
          },
          "greater_than_or_equal": {
            "type": "string"
          },
          "ilike": {
            "type": "string"
          },
          "in": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "is_distinct_from": {
            "type": "string"
          },
          "is_nil": {
            "type": "boolean"
          },
          "is_not_distinct_from": {
            "type": "string"
          },
          "less_than": {
            "type": "string"
          },
          "less_than_or_equal": {
            "type": "string"
          },
          "like": {
            "type": "string"
          },
          "not_eq": {
            "type": "string"
          },
          "string_ends_with": {
            "type": "string"
          },
          "string_starts_with": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "file-filter-content_type": {
        "additionalProperties": false,
        "properties": {
          "contains": {
            "type": "string"
          },
          "eq": {
            "type": "string"
          },
          "greater_than": {
            "type": "string"
          },
          "greater_than_or_equal": {
            "type": "string"
          },
          "ilike": {
            "type": "string"
          },
          "in": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "is_distinct_from": {
            "type": "string"
          },
          "is_nil": {
            "type": "boolean"
          },
          "is_not_distinct_from": {
            "type": "string"
          },
          "less_than": {
            "type": "string"
          },
          "less_than_or_equal": {
            "type": "string"
          },
          "like": {
            "type": "string"
          },
          "not_eq": {
            "type": "string"
          },
          "string_ends_with": {
            "type": "string"
          },
          "string_starts_with": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "OrderError": {
        "description": "Every refusal of the flat JSON routes: `{\"error\": {code, message, …}}`.",
        "properties": {
          "error": {
            "properties": {
              "code": {
                "type": "string"
              },
              "field": {
                "description": "`invalid`: the field.",
                "type": "string"
              },
              "lines": {
                "description": "`invalid_lines`: each bad line.",
                "items": {
                  "properties": {
                    "code": {
                      "enum": [
                        "unknown_sku",
                        "unknown_product",
                        "product_not_active",
                        "duplicate_product",
                        "quantity_too_high",
                        "invalid_quantity",
                        "missing_product",
                        "sku_and_product_id",
                        "invalid_sku",
                        "invalid_line",
                        "unknown_field"
                      ],
                      "type": "string"
                    },
                    "index": {
                      "description": "0-based, in the request.",
                      "type": "integer"
                    },
                    "message": {
                      "type": "string"
                    },
                    "product_id": {
                      "nullable": true,
                      "type": "string"
                    },
                    "sku": {
                      "nullable": true,
                      "type": "string"
                    }
                  },
                  "type": "object"
                },
                "type": "array"
              },
              "max": {
                "description": "`invalid`: the largest value allowed, when there is one."
              },
              "message": {
                "type": "string"
              },
              "order_id": {
                "description": "`reference_taken`: the order.",
                "type": "string"
              },
              "reason": {
                "description": "`resend_refused`, `nothing_to_expire`: why.",
                "type": "string"
              }
            },
            "required": [
              "code",
              "message"
            ],
            "type": "object"
          }
        },
        "title": "OrderError",
        "type": "object"
      },
      "file-filter-status": {
        "additionalProperties": false,
        "properties": {
          "eq": {
            "enum": [
              "pending",
              "available",
              "missing",
              "deleted",
              "superseded"
            ],
            "type": "string"
          },
          "greater_than": {
            "enum": [
              "pending",
              "available",
              "missing",
              "deleted",
              "superseded"
            ],
            "type": "string"
          },
          "greater_than_or_equal": {
            "enum": [
              "pending",
              "available",
              "missing",
              "deleted",
              "superseded"
            ],
            "type": "string"
          },
          "in": {
            "items": {
              "enum": [
                "pending",
                "available",
                "missing",
                "deleted",
                "superseded"
              ],
              "type": "string"
            },
            "type": "array"
          },
          "is_distinct_from": {
            "enum": [
              "pending",
              "available",
              "missing",
              "deleted",
              "superseded"
            ],
            "type": "string"
          },
          "is_nil": {
            "type": "boolean"
          },
          "is_not_distinct_from": {
            "enum": [
              "pending",
              "available",
              "missing",
              "deleted",
              "superseded"
            ],
            "type": "string"
          },
          "less_than": {
            "enum": [
              "pending",
              "available",
              "missing",
              "deleted",
              "superseded"
            ],
            "type": "string"
          },
          "less_than_or_equal": {
            "enum": [
              "pending",
              "available",
              "missing",
              "deleted",
              "superseded"
            ],
            "type": "string"
          },
          "not_eq": {
            "enum": [
              "pending",
              "available",
              "missing",
              "deleted",
              "superseded"
            ],
            "type": "string"
          }
        },
        "type": "object"
      },
      "product-filter-expires_after_seconds": {
        "additionalProperties": false,
        "properties": {
          "eq": {
            "type": "integer"
          },
          "greater_than": {
            "type": "integer"
          },
          "greater_than_or_equal": {
            "type": "integer"
          },
          "in": {
            "items": {
              "type": "integer"
            },
            "type": "array"
          },
          "is_distinct_from": {
            "type": "integer"
          },
          "is_nil": {
            "type": "boolean"
          },
          "is_not_distinct_from": {
            "type": "integer"
          },
          "less_than": {
            "type": "integer"
          },
          "less_than_or_equal": {
            "type": "integer"
          },
          "not_eq": {
            "type": "integer"
          }
        },
        "type": "object"
      },
      "upload": {
        "additionalProperties": false,
        "description": "A \"Resource object\" representing a upload",
        "properties": {
          "attributes": {
            "additionalProperties": false,
            "description": "An attributes object for a upload",
            "properties": {
              "content_type": {
                "description": "Field included by default.",
                "nullable": true,
                "type": "string"
              },
              "error": {
                "description": "Field included by default.",
                "nullable": true,
                "type": "string"
              },
              "expires_at": {
                "description": "Field included by default."
              },
              "file_id": {
                "description": "Field included by default.",
                "format": "uuid",
                "type": "string"
              },
              "filename": {
                "description": "Field included by default.",
                "type": "string"
              },
              "part_count": {
                "description": "Field included by default.",
                "nullable": true,
                "type": "integer"
              },
              "part_size": {
                "description": "Field included by default.",
                "nullable": true,
                "type": "integer"
              },
              "size": {
                "description": "Field included by default.",
                "nullable": true,
                "type": "integer"
              },
              "status": {
                "description": "Field included by default.",
                "enum": [
                  "open",
                  "completing",
                  "committed",
                  "failed",
                  "aborted",
                  "expired"
                ],
                "type": "string"
              }
            },
            "required": [
              "file_id",
              "filename",
              "status",
              "expires_at"
            ],
            "type": "object"
          },
          "id": {
            "type": "string"
          },
          "relationships": {
            "additionalProperties": false,
            "description": "A relationships object for a upload",
            "properties": {},
            "type": "object"
          },
          "type": {
            "type": "string"
          }
        },
        "required": [
          "type",
          "id"
        ],
        "type": "object"
      },
      "product-filter-name": {
        "additionalProperties": false,
        "properties": {
          "contains": {
            "type": "string"
          },
          "eq": {
            "type": "string"
          },
          "greater_than": {
            "type": "string"
          },
          "greater_than_or_equal": {
            "type": "string"
          },
          "ilike": {
            "type": "string"
          },
          "in": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "is_distinct_from": {
            "type": "string"
          },
          "is_nil": {
            "type": "boolean"
          },
          "is_not_distinct_from": {
            "type": "string"
          },
          "less_than": {
            "type": "string"
          },
          "less_than_or_equal": {
            "type": "string"
          },
          "like": {
            "type": "string"
          },
          "not_eq": {
            "type": "string"
          },
          "string_ends_with": {
            "type": "string"
          },
          "string_starts_with": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "OrderCreateLine": {
        "additionalProperties": false,
        "description": "A product of your account by `sku` (exact, case included) or `product_id`.",
        "properties": {
          "product_id": {
            "format": "uuid",
            "type": "string"
          },
          "quantity": {
            "default": 1,
            "description": "Units: each is one buyer access (its own downloads and license key). At most your account's units per line (100 unless lowered).",
            "minimum": 1,
            "type": "integer"
          },
          "sku": {
            "maxLength": 255,
            "type": "string"
          }
        },
        "title": "OrderCreateLine",
        "type": "object"
      },
      "product-filter-sku": {
        "additionalProperties": false,
        "properties": {
          "contains": {
            "type": "string"
          },
          "eq": {
            "type": "string"
          },
          "greater_than": {
            "type": "string"
          },
          "greater_than_or_equal": {
            "type": "string"
          },
          "ilike": {
            "type": "string"
          },
          "in": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "is_distinct_from": {
            "type": "string"
          },
          "is_nil": {
            "type": "boolean"
          },
          "is_not_distinct_from": {
            "type": "string"
          },
          "less_than": {
            "type": "string"
          },
          "less_than_or_equal": {
            "type": "string"
          },
          "like": {
            "type": "string"
          },
          "not_eq": {
            "type": "string"
          },
          "string_ends_with": {
            "type": "string"
          },
          "string_starts_with": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "file-filter-verified_at": {
        "additionalProperties": false,
        "properties": {
          "eq": {},
          "greater_than": {},
          "greater_than_or_equal": {},
          "in": {
            "items": {},
            "type": "array"
          },
          "is_distinct_from": {},
          "is_nil": {
            "type": "boolean"
          },
          "is_not_distinct_from": {},
          "less_than": {},
          "less_than_or_equal": {},
          "not_eq": {}
        },
        "type": "object"
      },
      "file_rename-filter": {
        "additionalProperties": false,
        "description": "Filters the query to results matching the given filter object",
        "example": "",
        "properties": {
          "and": {
            "items": {
              "$ref": "#/components/schemas/file_rename-filter"
            },
            "type": "array",
            "uniqueItems": true
          },
          "id": {
            "$ref": "#/components/schemas/file_rename-filter-id"
          },
          "not": {
            "$ref": "#/components/schemas/file_rename-filter"
          },
          "or": {
            "items": {
              "$ref": "#/components/schemas/file_rename-filter"
            },
            "type": "array",
            "uniqueItems": true
          }
        },
        "type": "object"
      },
      "upload-filter-error": {
        "additionalProperties": false,
        "properties": {
          "contains": {
            "type": "string"
          },
          "eq": {
            "type": "string"
          },
          "greater_than": {
            "type": "string"
          },
          "greater_than_or_equal": {
            "type": "string"
          },
          "ilike": {
            "type": "string"
          },
          "in": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "is_distinct_from": {
            "type": "string"
          },
          "is_nil": {
            "type": "boolean"
          },
          "is_not_distinct_from": {
            "type": "string"
          },
          "less_than": {
            "type": "string"
          },
          "less_than_or_equal": {
            "type": "string"
          },
          "like": {
            "type": "string"
          },
          "not_eq": {
            "type": "string"
          },
          "string_ends_with": {
            "type": "string"
          },
          "string_starts_with": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "upload-filter-status": {
        "additionalProperties": false,
        "properties": {
          "eq": {
            "enum": [
              "open",
              "completing",
              "committed",
              "failed",
              "aborted",
              "expired"
            ],
            "type": "string"
          },
          "greater_than": {
            "enum": [
              "open",
              "completing",
              "committed",
              "failed",
              "aborted",
              "expired"
            ],
            "type": "string"
          },
          "greater_than_or_equal": {
            "enum": [
              "open",
              "completing",
              "committed",
              "failed",
              "aborted",
              "expired"
            ],
            "type": "string"
          },
          "in": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "is_distinct_from": {
            "type": "string"
          },
          "is_nil": {
            "type": "boolean"
          },
          "is_not_distinct_from": {
            "type": "string"
          },
          "less_than": {
            "enum": [
              "open",
              "completing",
              "committed",
              "failed",
              "aborted",
              "expired"
            ],
            "type": "string"
          },
          "less_than_or_equal": {
            "enum": [
              "open",
              "completing",
              "committed",
              "failed",
              "aborted",
              "expired"
            ],
            "type": "string"
          },
          "not_eq": {
            "enum": [
              "open",
              "completing",
              "committed",
              "failed",
              "aborted",
              "expired"
            ],
            "type": "string"
          }
        },
        "type": "object"
      },
      "file-filter-id": {
        "additionalProperties": false,
        "properties": {
          "eq": {
            "format": "uuid",
            "type": "string"
          },
          "greater_than": {
            "format": "uuid",
            "type": "string"
          },
          "greater_than_or_equal": {
            "format": "uuid",
            "type": "string"
          },
          "in": {
            "items": {
              "format": "uuid",
              "type": "string"
            },
            "type": "array"
          },
          "is_distinct_from": {
            "format": "uuid",
            "type": "string"
          },
          "is_nil": {
            "type": "boolean"
          },
          "is_not_distinct_from": {
            "format": "uuid",
            "type": "string"
          },
          "less_than": {
            "format": "uuid",
            "type": "string"
          },
          "less_than_or_equal": {
            "format": "uuid",
            "type": "string"
          },
          "not_eq": {
            "format": "uuid",
            "type": "string"
          }
        },
        "type": "object"
      },
      "upload-filter-size": {
        "additionalProperties": false,
        "properties": {
          "eq": {
            "type": "integer"
          },
          "greater_than": {
            "type": "integer"
          },
          "greater_than_or_equal": {
            "type": "integer"
          },
          "in": {
            "items": {
              "type": "integer"
            },
            "type": "array"
          },
          "is_distinct_from": {
            "type": "integer"
          },
          "is_nil": {
            "type": "boolean"
          },
          "is_not_distinct_from": {
            "type": "integer"
          },
          "less_than": {
            "type": "integer"
          },
          "less_than_or_equal": {
            "type": "integer"
          },
          "not_eq": {
            "type": "integer"
          }
        },
        "type": "object"
      },
      "OrderList": {
        "properties": {
          "next_cursor": {
            "nullable": true,
            "type": "string"
          },
          "orders": {
            "items": {
              "$ref": "#/components/schemas/Order"
            },
            "type": "array"
          }
        },
        "title": "OrderList",
        "type": "object"
      },
      "file-filter-version": {
        "additionalProperties": false,
        "properties": {
          "eq": {
            "type": "integer"
          },
          "greater_than": {
            "type": "integer"
          },
          "greater_than_or_equal": {
            "type": "integer"
          },
          "in": {
            "items": {
              "type": "integer"
            },
            "type": "array"
          },
          "is_distinct_from": {
            "type": "integer"
          },
          "is_nil": {
            "type": "boolean"
          },
          "is_not_distinct_from": {
            "type": "integer"
          },
          "less_than": {
            "type": "integer"
          },
          "less_than_or_equal": {
            "type": "integer"
          },
          "not_eq": {
            "type": "integer"
          }
        },
        "type": "object"
      },
      "file-filter-size": {
        "additionalProperties": false,
        "properties": {
          "eq": {
            "type": "integer"
          },
          "greater_than": {
            "type": "integer"
          },
          "greater_than_or_equal": {
            "type": "integer"
          },
          "in": {
            "items": {
              "type": "integer"
            },
            "type": "array"
          },
          "is_distinct_from": {
            "type": "integer"
          },
          "is_nil": {
            "type": "boolean"
          },
          "is_not_distinct_from": {
            "type": "integer"
          },
          "less_than": {
            "type": "integer"
          },
          "less_than_or_equal": {
            "type": "integer"
          },
          "not_eq": {
            "type": "integer"
          }
        },
        "type": "object"
      },
      "product": {
        "additionalProperties": false,
        "description": "A \"Resource object\" representing a product",
        "properties": {
          "attributes": {
            "additionalProperties": false,
            "description": "An attributes object for a product",
            "properties": {
              "description": {
                "description": "Field included by default.",
                "nullable": true,
                "type": "string"
              },
              "download_limit": {
                "description": "Field included by default.",
                "nullable": true,
                "type": "integer"
              },
              "expires_after_seconds": {
                "description": "Field included by default.",
                "nullable": true,
                "type": "integer"
              },
              "issues_keys": {
                "description": "Field included by default.",
                "type": "boolean"
              },
              "name": {
                "description": "Field included by default.",
                "type": "string"
              },
              "removed_at": {
                "description": "Field included by default.",
                "nullable": true
              },
              "sku": {
                "description": "Field included by default.",
                "nullable": true,
                "type": "string"
              },
              "status": {
                "description": "Field included by default.",
                "enum": [
                  "active",
                  "archived",
                  "removed"
                ],
                "type": "string"
              }
            },
            "required": [
              "name",
              "status",
              "issues_keys"
            ],
            "type": "object"
          },
          "id": {
            "type": "string"
          },
          "relationships": {
            "additionalProperties": false,
            "description": "A relationships object for a product",
            "properties": {},
            "type": "object"
          },
          "type": {
            "type": "string"
          }
        },
        "required": [
          "type",
          "id"
        ],
        "type": "object"
      },
      "OrderCreated": {
        "properties": {
          "created": {
            "description": "false: a repeat of a reference already created (nothing new).",
            "type": "boolean"
          },
          "order": {
            "$ref": "#/components/schemas/Order"
          }
        },
        "title": "OrderCreated",
        "type": "object"
      },
      "file-filter-checksum_verified_at": {
        "additionalProperties": false,
        "properties": {
          "eq": {},
          "greater_than": {},
          "greater_than_or_equal": {},
          "in": {
            "items": {},
            "type": "array"
          },
          "is_distinct_from": {},
          "is_nil": {
            "type": "boolean"
          },
          "is_not_distinct_from": {},
          "less_than": {},
          "less_than_or_equal": {},
          "not_eq": {}
        },
        "type": "object"
      },
      "file-filter-filename": {
        "additionalProperties": false,
        "properties": {
          "contains": {
            "type": "string"
          },
          "eq": {
            "type": "string"
          },
          "greater_than": {
            "type": "string"
          },
          "greater_than_or_equal": {
            "type": "string"
          },
          "ilike": {
            "type": "string"
          },
          "in": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "is_distinct_from": {
            "type": "string"
          },
          "is_nil": {
            "type": "boolean"
          },
          "is_not_distinct_from": {
            "type": "string"
          },
          "less_than": {
            "type": "string"
          },
          "less_than_or_equal": {
            "type": "string"
          },
          "like": {
            "type": "string"
          },
          "not_eq": {
            "type": "string"
          },
          "string_ends_with": {
            "type": "string"
          },
          "string_starts_with": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "file-filter-key": {
        "additionalProperties": false,
        "properties": {
          "contains": {
            "type": "string"
          },
          "eq": {
            "type": "string"
          },
          "greater_than": {
            "type": "string"
          },
          "greater_than_or_equal": {
            "type": "string"
          },
          "ilike": {
            "type": "string"
          },
          "in": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "is_distinct_from": {
            "type": "string"
          },
          "is_nil": {
            "type": "boolean"
          },
          "is_not_distinct_from": {
            "type": "string"
          },
          "less_than": {
            "type": "string"
          },
          "less_than_or_equal": {
            "type": "string"
          },
          "like": {
            "type": "string"
          },
          "not_eq": {
            "type": "string"
          },
          "string_ends_with": {
            "type": "string"
          },
          "string_starts_with": {
            "type": "string"
          }
        },
        "type": "object"
      }
    },
    "securitySchemes": {
      "bearerAuth": {
        "bearerFormat": "FetchApp API key",
        "description": "A FetchApp API key (`fa4_…`), sent as `Authorization: Bearer <key>` — never in a query parameter or a cookie. Keys are made on the admin's API page with scopes files:read, files:write, products:read, products:write, orders:read and orders:write (the orders scopes only when ticked: a key made without them cannot create orders); each operation says which one it needs. The API is a plan feature: a key of an account without it is refused with 403 plan_required.\n",
        "scheme": "bearer",
        "type": "http"
      }
    }
  },
  "info": {
    "description": "The FetchApp merchant API. Every operation needs an API key (`fa4_…`) made on your admin's **API keys** page, sent as `Authorization: Bearer <key>`; each operation says which scope the key needs. The API is a plan feature.\n\n**Orders** and **account** are plain JSON. **Products**, **files**, **uploads** and **renames** are shown in their JSON:API form (`application/vnd.api+json`); the same paths also answer the plain JSON of the earlier v4 API.\n\nRefusals: `401` no valid key; `403` `plan_required` (your plan does not include the API), `tenant_inactive` or `insufficient_scope`; `429` `rate_limited` (`retry-after` says when). Plain-JSON routes answer `{\"error\": {\"code\", \"message\", …}}`, JSON:API routes a JSON:API error document with the same `code`.\n",
    "title": "FetchApp API v4",
    "version": "4.0.0"
  },
  "openapi": "3.0.0",
  "paths": {
    "/api/v4/files": {
      "get": {
        "callbacks": {},
        "deprecated": false,
        "description": "Scope **files:read**. Your account's files, a page at a time: `page[limit]` (1–200, default 100) and `page[offset]`; `filter[filename]=…`. JSON:API: *Try it out* sends `Accept: application/vnd.api+json`; without it the same path answers the plain JSON of the earlier v4 API.",
        "parameters": [
          {
            "description": "Filters the query to results with attributes matching the given filter object",
            "in": "query",
            "name": "filter",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/file-filter"
            },
            "style": "deepObject"
          },
          {
            "description": "Sort order to apply to the results",
            "explode": false,
            "in": "query",
            "name": "sort",
            "required": false,
            "schema": {
              "pattern": "^(id|-id|\\+\\+id|--id|key|-key|\\+\\+key|--key|filename|-filename|\\+\\+filename|--filename|content_type|-content_type|\\+\\+content_type|--content_type|size|-size|\\+\\+size|--size|checksum_sha256|-checksum_sha256|\\+\\+checksum_sha256|--checksum_sha256|checksum_verified_at|-checksum_verified_at|\\+\\+checksum_verified_at|--checksum_verified_at|etag|-etag|\\+\\+etag|--etag|status|-status|\\+\\+status|--status|verified_at|-verified_at|\\+\\+verified_at|--verified_at|version|-version|\\+\\+version|--version|store_id|-store_id|\\+\\+store_id|--store_id)(,(id|-id|\\+\\+id|--id|key|-key|\\+\\+key|--key|filename|-filename|\\+\\+filename|--filename|content_type|-content_type|\\+\\+content_type|--content_type|size|-size|\\+\\+size|--size|checksum_sha256|-checksum_sha256|\\+\\+checksum_sha256|--checksum_sha256|checksum_verified_at|-checksum_verified_at|\\+\\+checksum_verified_at|--checksum_verified_at|etag|-etag|\\+\\+etag|--etag|status|-status|\\+\\+status|--status|verified_at|-verified_at|\\+\\+verified_at|--verified_at|version|-version|\\+\\+version|--version|store_id|-store_id|\\+\\+store_id|--store_id))*$",
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Paginates the response with the limit and offset or keyset pagination.",
            "in": "query",
            "name": "page",
            "required": false,
            "schema": {
              "example": {
                "limit": 100
              },
              "properties": {
                "after": {
                  "type": "string"
                },
                "before": {
                  "type": "string"
                },
                "count": {
                  "default": false,
                  "type": "boolean"
                },
                "limit": {
                  "minimum": 1,
                  "type": "integer"
                },
                "offset": {
                  "minimum": 0,
                  "type": "integer"
                }
              },
              "type": "object"
            },
            "style": "deepObject"
          },
          {
            "description": "Relationship paths to include in the response",
            "explode": false,
            "in": "query",
            "name": "include",
            "required": false,
            "schema": {
              "pattern": "^()(,())*$",
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Limits the response fields to only those listed for each type",
            "in": "query",
            "name": "fields",
            "required": false,
            "schema": {
              "additionalProperties": true,
              "example": {
                "file": "id,key,filename,content_type,size,checksum_sha256,checksum_verified_at,etag,status,verified_at,version,store_id"
              },
              "properties": {
                "file": {
                  "description": "Comma separated field names for file",
                  "example": "id,key,filename,content_type,size,checksum_sha256,checksum_verified_at,etag,status,verified_at,version,store_id",
                  "type": "string"
                }
              },
              "type": "object"
            },
            "style": "deepObject"
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/vnd.api+json": {
                "schema": {
                  "additionalProperties": false,
                  "properties": {
                    "data": {
                      "description": "An array of resource objects representing a file",
                      "items": {
                        "$ref": "#/components/schemas/file"
                      },
                      "type": "array",
                      "uniqueItems": true
                    },
                    "included": {
                      "items": {},
                      "type": "array",
                      "uniqueItems": true
                    },
                    "meta": {
                      "additionalProperties": true,
                      "type": "object"
                    }
                  },
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "$ref": "#/components/responses/errors"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "summary": "List files",
        "tags": [
          "files"
        ]
      }
    },
    "/api/v4/files/{id}": {
      "get": {
        "callbacks": {},
        "deprecated": false,
        "description": "Scope **files:read**. One of your account's files, by id — also a file kept in one of your own buckets. JSON:API: *Try it out* sends `Accept: application/vnd.api+json`; without it the same path answers the plain JSON of the earlier v4 API.",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Relationship paths to include in the response",
            "explode": false,
            "in": "query",
            "name": "include",
            "required": false,
            "schema": {
              "pattern": "^()(,())*$",
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Limits the response fields to only those listed for each type",
            "in": "query",
            "name": "fields",
            "required": false,
            "schema": {
              "additionalProperties": true,
              "example": {
                "file": "id,key,filename,content_type,size,checksum_sha256,checksum_verified_at,etag,status,verified_at,version,store_id"
              },
              "properties": {
                "file": {
                  "description": "Comma separated field names for file",
                  "example": "id,key,filename,content_type,size,checksum_sha256,checksum_verified_at,etag,status,verified_at,version,store_id",
                  "type": "string"
                }
              },
              "type": "object"
            },
            "style": "deepObject"
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/vnd.api+json": {
                "schema": {
                  "additionalProperties": false,
                  "properties": {
                    "data": {
                      "$ref": "#/components/schemas/file"
                    },
                    "included": {
                      "items": {},
                      "type": "array",
                      "uniqueItems": true
                    },
                    "meta": {
                      "additionalProperties": true,
                      "type": "object"
                    }
                  }
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "$ref": "#/components/responses/errors"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "summary": "Get a file",
        "tags": [
          "files"
        ]
      }
    },
    "/api/v4/files/{id}/rename": {
      "post": {
        "callbacks": {},
        "deprecated": false,
        "description": "Rename a file (scope files:write): the file is the path's id, the new name is `to`. A file's name is its storage key, so a rename is a server-side copy that runs after this call answers: the result is a rename with status `requested`. Poll GET /renames/{id} (the rename's id) every 2 seconds or so until the status is `switched` or `done` (the file has the new name), `failed` (nothing changed; `error` says why) or `needs_attention` (the file has the new name; support is checking the copy). Products keep the file throughout, and buyers' download links keep working. Asking again for the same rename is safe: it answers the rename already made (or `unchanged`, with a null id, when the file always had that name). Refusals (code, HTTP status; the ids of what is in the way are in the error's `meta`): `invalid_name` 422 (`to` is not a valid name), `file_not_found` 404 (no current file with that id in this account), a missing or null `to` 400 (AshJsonApi's `required` / `invalid_body`), `file_not_available` 409 (only an available file can be renamed; `meta.status`), `rename_in_progress` 409 (renaming to another name already; `meta.rename_id`), `rename_needs_attention` 409, `upload_in_progress` 409 (a new version of the file, or a file named `to`, is uploading; `meta.upload_id`), `name_taken` 409 (another file, or an older version of one, has that name; `meta.file_id`), `name_reserved` 409 (a rename holds the name for a minute or two; `meta.rename_id`), `name_occupied` 409 (a stored object nothing uses sits on the name; ask support), `source_missing` 409 (the file's stored object is gone; ask support), `file_changed` 409 (the file changed meanwhile; try again), `too_many_renames` 429 (at most `meta.max_in_flight` renames in progress per account; wait for some to finish), `storage_unavailable` 503 (try again).\n",
        "parameters": [
          {
            "description": "The file to rename, by id (a uuid). An unknown id, or another account's, is file_not_found.",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "description": "The file to rename, by id (a uuid). An unknown id, or another account's, is file_not_found.",
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/vnd.api+json": {
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "data": {
                    "additionalProperties": false,
                    "properties": {
                      "to": {
                        "description": "The new name: UTF-8, at most 255 bytes, no / \\ ? # or control characters, case-sensitive. It replaces the whole name, extension included.",
                        "type": "string"
                      }
                    },
                    "required": [
                      "to"
                    ],
                    "type": "object"
                  }
                },
                "required": [
                  "data"
                ],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/vnd.api+json": {
                "schema": {
                  "additionalProperties": false,
                  "properties": {
                    "error": {
                      "description": "Why a failed rename failed (only then): file_changed, destination_taken, destination_not_listed, destination_changed, source_changed, source_missing, copy_mismatch, storage_unavailable, worker_lost or unknown.",
                      "nullable": true,
                      "type": "string"
                    },
                    "file": {
                      "additionalProperties": false,
                      "description": "The file under its new name, once it has it (switched, done, needs_attention, unchanged); null before.",
                      "nullable": true,
                      "properties": {
                        "filename": {
                          "description": "The file's name: the new one.",
                          "type": "string"
                        },
                        "id": {
                          "description": "The file's id.",
                          "format": "uuid",
                          "type": "string"
                        },
                        "sha256": {
                          "description": "The sha256 of the bytes, hex (a rename keeps the bytes).",
                          "nullable": true,
                          "type": "string"
                        },
                        "sha256_verified": {
                          "description": "True once the server has hashed the stored bytes itself; a rename that cannot prove the copy byte-identical by its ETag re-hashes it, false until then.",
                          "type": "boolean"
                        },
                        "size": {
                          "description": "Bytes.",
                          "nullable": true,
                          "type": "integer"
                        },
                        "version": {
                          "description": "The file's version (a rename keeps it).",
                          "nullable": true,
                          "type": "integer"
                        }
                      },
                      "required": [
                        "id",
                        "filename",
                        "sha256_verified"
                      ],
                      "type": "object"
                    },
                    "file_id": {
                      "description": "The file being renamed (null if it was deleted since).",
                      "format": "uuid",
                      "nullable": true,
                      "type": "string"
                    },
                    "from": {
                      "description": "The file's name when the rename was asked for.",
                      "nullable": true,
                      "type": "string"
                    },
                    "id": {
                      "description": "The rename's id: poll GET /renames/{id}. null only for status unchanged.",
                      "format": "uuid",
                      "nullable": true,
                      "type": "string"
                    },
                    "requested_at": {
                      "description": "When the rename was asked for.",
                      "format": "date-time",
                      "nullable": true,
                      "type": "string"
                    },
                    "status": {
                      "description": "requested: the copy is running and the file still has its old name — poll again. switched: the file has the new name; the old copy is kept a short while for download links issued before the switch, then deleted. done: finished, the old copy deleted. failed: nothing changed, the file keeps its old name; error says why. needs_attention: the file has the new name, but the new copy could not be confirmed, so support is checking it; the file cannot be renamed or replaced until then. unchanged: the file already had that name; nothing to do.",
                      "enum": [
                        "requested",
                        "switched",
                        "done",
                        "failed",
                        "needs_attention",
                        "unchanged"
                      ],
                      "type": "string"
                    },
                    "switched_at": {
                      "description": "When the file took the new name.",
                      "format": "date-time",
                      "nullable": true,
                      "type": "string"
                    },
                    "to": {
                      "description": "The new name.",
                      "type": "string"
                    }
                  },
                  "required": [
                    "to",
                    "status"
                  ],
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "$ref": "#/components/responses/errors"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "summary": "Rename a file",
        "tags": [
          "renames"
        ]
      }
    },
    "/api/v4/me": {
      "get": {
        "callbacks": {},
        "deprecated": false,
        "description": "Any valid key, no scope needed: the account (`slug`, `name`), the key (`name`, its `prefix` — how the admin and our support name it —, `scopes`, `expires_at`) and the plan (`code`; `api_via`: `plan` when the plan includes the API, `grant` when FetchApp gave the account time-limited access). Call it first to check a key works.",
        "operationId": "getMe",
        "parameters": [],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Me"
                }
              }
            },
            "description": "The key's account, the key and the plan."
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderError"
                }
              }
            },
            "description": "No valid API key (`unauthorized`)."
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderError"
                }
              }
            },
            "description": "`plan_required` or `tenant_inactive`."
          },
          "429": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderError"
                }
              }
            },
            "description": "`rate_limited` — the per-key limit; `retry-after` says when."
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "summary": "Who this key is",
        "tags": [
          "account"
        ]
      }
    },
    "/api/v4/orders": {
      "get": {
        "callbacks": {},
        "deprecated": false,
        "description": "Scope **orders:read**. Your account's orders from every source (API, admin, CSV import, Shopify, PayPal), newest first, a page at a time: pass `next_cursor` back as `cursor` until it is null.",
        "operationId": "listOrders",
        "parameters": [
          {
            "description": "Orders per page, 1–100 (default 50).",
            "in": "query",
            "name": "limit",
            "schema": {
              "maximum": 100,
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "description": "`next_cursor` of the previous page.",
            "in": "query",
            "name": "cursor",
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Only orders for this buyer email address (case-insensitive).",
            "in": "query",
            "name": "buyer_email",
            "schema": {
              "format": "email",
              "maxLength": 254,
              "type": "string"
            }
          },
          {
            "description": "Only orders with exactly this reference (e.g. `INV-1042`, or `%231001` for Shopify order `#1001`).",
            "in": "query",
            "name": "reference",
            "schema": {
              "maxLength": 400,
              "type": "string"
            }
          },
          {
            "description": "Only store orders with this external order id: Shopify's numeric order id (or `gid://shopify/Order/…`) or PayPal's `txn_id`.",
            "in": "query",
            "name": "source_id",
            "schema": {
              "maxLength": 200,
              "type": "string"
            }
          },
          {
            "description": "Only orders with this payment status.",
            "in": "query",
            "name": "status",
            "schema": {
              "enum": [
                "pending",
                "authorized",
                "partially_paid",
                "paid",
                "partially_refunded",
                "refunded",
                "voided",
                "expired",
                "unknown"
              ],
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderList"
                }
              }
            },
            "description": "A page of orders."
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderError"
                }
              }
            },
            "description": "No valid API key (`unauthorized`)."
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderError"
                }
              }
            },
            "description": "`plan_required` (the account's plan does not include the API), `tenant_inactive`, or `insufficient_scope` (the key lacks the operation's scope)."
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderError"
                }
              }
            },
            "description": "`invalid` — an unknown parameter, or a bad `limit`, `cursor`, `buyer_email`, `reference`, `source_id` or `status` (`field`)."
          },
          "429": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderError"
                }
              }
            },
            "description": "`rate_limited` — the per-key limit; `retry-after` says when."
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "summary": "List orders",
        "tags": [
          "orders"
        ]
      },
      "post": {
        "callbacks": {},
        "deprecated": false,
        "description": "Scope **orders:write**. Creates an order for products of your account and delivers it exactly as an order created by hand on the admin's New order page: paid, each unit's download limit and expiry from the product (else your account default), license keys from the pools, and — unless `send_email` is false — the buyer's download email, through every send check and your account's daily email limit (over the limit the email is held until the next UTC day, never dropped; `order.email.status` says `held`).\n\n**Idempotent on `reference`** (your own order or payment id, e.g. a Stripe Checkout Session id): sending the same reference again with the same buyer email and lines returns the first order with **200** and `created: false` — nothing is created or emailed twice. The same reference with a different buyer email or lines is **409** `reference_taken`.\n\n**Every line must resolve**, or nothing is created: **422** `invalid_lines` lists each bad line (`unknown_sku`, `unknown_product`, `product_not_active`, `quantity_too_high`, …); fix them and send again with the same reference.\n",
        "operationId": "createOrder",
        "parameters": [],
        "requestBody": {
          "content": {
            "application/json": {
              "examples": {
                "stripe_checkout": {
                  "description": "On `checkout.session.completed`, the Session's id as `reference` and the buyer's email from `customer_details.email`. Stripe sends a webhook again when it is not sure you got it: sending the same order again returns the first one (200, `created: false`) — nothing is created or emailed twice.",
                  "summary": "From a Stripe Checkout webhook: the Session id as the reference",
                  "value": {
                    "buyer_email": "buyer@example.com",
                    "buyer_name": "Ada Lovelace",
                    "lines": [
                      {
                        "quantity": 1,
                        "sku": "EBOOK-01"
                      }
                    ],
                    "reference": "cs_live_a1B2c3D4e5F6g7H8i9J0kLmNoPqRsTuVwXyZ"
                  }
                },
                "with_product_ids": {
                  "description": "Products by their FetchApp id; `send_email: false` creates the order without emailing the buyer (resend it later, or share `download_url` yourself); `download_limit` lower than the product's own.",
                  "summary": "Lines by product id, no email, fewer downloads",
                  "value": {
                    "buyer_email": "buyer@example.com",
                    "download_limit": 3,
                    "lines": [
                      {
                        "product_id": "0193a1b2-c3d4-7e5f-8a9b-0c1d2e3f4a5b",
                        "quantity": 2
                      }
                    ],
                    "reference": "INV-2026-0042",
                    "send_email": false
                  }
                }
              },
              "schema": {
                "$ref": "#/components/schemas/OrderCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderCreated"
                }
              }
            },
            "description": "A repeat of a reference already created with the same buyer email and lines: that order, `created: false`; nothing new was created or emailed."
          },
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderCreated"
                }
              }
            },
            "description": "Created now."
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderError"
                }
              }
            },
            "description": "No valid API key (`unauthorized`)."
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderError"
                }
              }
            },
            "description": "`plan_required` (the account's plan does not include the API), `tenant_inactive`, or `insufficient_scope` (the key lacks the operation's scope)."
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderError"
                }
              }
            },
            "description": "`reference_taken`: another order (with a different buyer email or lines) already uses this reference; `order_id` is that order. Nothing was created."
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderError"
                }
              }
            },
            "description": "`invalid` (`field`: the first bad field; unknown fields are refused) or `invalid_lines` (`lines`: every bad line). Nothing was created."
          },
          "429": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderError"
                }
              }
            },
            "description": "`rate_limited` — the per-key limit; `retry-after` says when."
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "summary": "Create an order",
        "tags": [
          "orders"
        ]
      }
    },
    "/api/v4/orders/{id}": {
      "get": {
        "callbacks": {},
        "deprecated": false,
        "description": "Scope **orders:read**. One order by id or by reference: its lines, each line's delivery, each unit's access, the buyer email's status and the buyer's download page URL.",
        "operationId": "getOrder",
        "parameters": [
          {
            "description": "The order's id, the `reference` you created it with (`POST /orders`, admin or CSV import), or — when only one order of your account matches — a store order's `source_id` (Shopify's numeric order id or GID, PayPal's `txn_id`) or `reference` (`%231001` for `#1001`). Percent-encode `/` and `#` (`INV%2F42`, `%231001`). Another account's order is never found (404).",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderOne"
                }
              }
            },
            "description": "The order."
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderError"
                }
              }
            },
            "description": "No valid API key (`unauthorized`)."
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderError"
                }
              }
            },
            "description": "`plan_required` (the account's plan does not include the API), `tenant_inactive`, or `insufficient_scope` (the key lacks the operation's scope)."
          },
          "404": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderError"
                }
              }
            },
            "description": "`order_not_found`."
          },
          "429": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderError"
                }
              }
            },
            "description": "`rate_limited` — the per-key limit; `retry-after` says when."
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "summary": "Get an order",
        "tags": [
          "orders"
        ]
      }
    },
    "/api/v4/orders/{id}/expire": {
      "post": {
        "callbacks": {},
        "deprecated": false,
        "description": "Scope **orders:write**. Every active unit's access ends now — the admin order page's *Expire access now*. No email is sent. Idempotent: units already expired are counted in `already_expired`. The admin's *Reopen access* gives it back.",
        "operationId": "expireOrder",
        "parameters": [
          {
            "description": "The order's id, the `reference` you created it with (`POST /orders`, admin or CSV import), or — when only one order of your account matches — a store order's `source_id` (Shopify's numeric order id or GID, PayPal's `txn_id`) or `reference` (`%231001` for `#1001`). Percent-encode `/` and `#` (`INV%2F42`, `%231001`). Another account's order is never found (404).",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderExpired"
                }
              }
            },
            "description": "Done."
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderError"
                }
              }
            },
            "description": "No valid API key (`unauthorized`)."
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderError"
                }
              }
            },
            "description": "`plan_required` (the account's plan does not include the API), `tenant_inactive`, or `insufficient_scope` (the key lacks the operation's scope)."
          },
          "404": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderError"
                }
              }
            },
            "description": "`order_not_found`."
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderError"
                }
              }
            },
            "description": "`nothing_to_expire`, `reason`: `no_units`, `not_paid` (units pending) or `no_active_units` (revoked or suspended)."
          },
          "429": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderError"
                }
              }
            },
            "description": "`rate_limited` — the per-key limit; `retry-after` says when."
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "summary": "Expire the order's access now",
        "tags": [
          "orders"
        ]
      }
    },
    "/api/v4/orders/{id}/resend": {
      "post": {
        "callbacks": {},
        "deprecated": false,
        "description": "Scope **orders:write**. Queues the buyer's download email again — the admin order page's *Resend email*, with its rules: every send check and the daily email limit apply again. Also sends the email of an order created with `send_email: false`.",
        "operationId": "resendOrderEmail",
        "parameters": [
          {
            "description": "The order's id, the `reference` you created it with (`POST /orders`, admin or CSV import), or — when only one order of your account matches — a store order's `source_id` (Shopify's numeric order id or GID, PayPal's `txn_id`) or `reference` (`%231001` for `#1001`). Percent-encode `/` and `#` (`INV%2F42`, `%231001`). Another account's order is never found (404).",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "202": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderResent"
                }
              }
            },
            "description": "Queued."
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderError"
                }
              }
            },
            "description": "No valid API key (`unauthorized`)."
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderError"
                }
              }
            },
            "description": "`plan_required` (the account's plan does not include the API), `tenant_inactive`, or `insufficient_scope` (the key lacks the operation's scope)."
          },
          "404": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderError"
                }
              }
            },
            "description": "`order_not_found`."
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderError"
                }
              }
            },
            "description": "`resend_refused`, `reason`: `bounced` (the address refused it: send the download_url another way), `already_queued`, `sending`, or `delivery_outcome_unknown` (support settles the last attempt first)."
          },
          "429": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderError"
                }
              }
            },
            "description": "`rate_limited` — the per-key limit; `retry-after` says when."
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "summary": "Resend the buyer email",
        "tags": [
          "orders"
        ]
      }
    },
    "/api/v4/products": {
      "get": {
        "callbacks": {},
        "deprecated": false,
        "description": "Scope **products:read**. Your account's products, a page at a time: `page[limit]` (1–200, default 100) and `page[offset]`; `filter[sku]=…`, `sort=name`. JSON:API: *Try it out* sends `Accept: application/vnd.api+json`; without it the same path answers the plain JSON of the earlier v4 API.",
        "parameters": [
          {
            "description": "Filters the query to results with attributes matching the given filter object",
            "in": "query",
            "name": "filter",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/product-filter"
            },
            "style": "deepObject"
          },
          {
            "description": "Sort order to apply to the results",
            "explode": false,
            "in": "query",
            "name": "sort",
            "required": false,
            "schema": {
              "pattern": "^(id|-id|\\+\\+id|--id|name|-name|\\+\\+name|--name|sku|-sku|\\+\\+sku|--sku|description|-description|\\+\\+description|--description|status|-status|\\+\\+status|--status|removed_at|-removed_at|\\+\\+removed_at|--removed_at|download_limit|-download_limit|\\+\\+download_limit|--download_limit|expires_after_seconds|-expires_after_seconds|\\+\\+expires_after_seconds|--expires_after_seconds|issues_keys|-issues_keys|\\+\\+issues_keys|--issues_keys)(,(id|-id|\\+\\+id|--id|name|-name|\\+\\+name|--name|sku|-sku|\\+\\+sku|--sku|description|-description|\\+\\+description|--description|status|-status|\\+\\+status|--status|removed_at|-removed_at|\\+\\+removed_at|--removed_at|download_limit|-download_limit|\\+\\+download_limit|--download_limit|expires_after_seconds|-expires_after_seconds|\\+\\+expires_after_seconds|--expires_after_seconds|issues_keys|-issues_keys|\\+\\+issues_keys|--issues_keys))*$",
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Paginates the response with the limit and offset or keyset pagination.",
            "in": "query",
            "name": "page",
            "required": false,
            "schema": {
              "example": {
                "limit": 100
              },
              "properties": {
                "after": {
                  "type": "string"
                },
                "before": {
                  "type": "string"
                },
                "count": {
                  "default": false,
                  "type": "boolean"
                },
                "limit": {
                  "minimum": 1,
                  "type": "integer"
                },
                "offset": {
                  "minimum": 0,
                  "type": "integer"
                }
              },
              "type": "object"
            },
            "style": "deepObject"
          },
          {
            "description": "Relationship paths to include in the response",
            "explode": false,
            "in": "query",
            "name": "include",
            "required": false,
            "schema": {
              "pattern": "^()(,())*$",
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Limits the response fields to only those listed for each type",
            "in": "query",
            "name": "fields",
            "required": false,
            "schema": {
              "additionalProperties": true,
              "example": {
                "product": "id,name,sku,description,status,removed_at,download_limit,expires_after_seconds,issues_keys"
              },
              "properties": {
                "product": {
                  "description": "Comma separated field names for product",
                  "example": "id,name,sku,description,status,removed_at,download_limit,expires_after_seconds,issues_keys",
                  "type": "string"
                }
              },
              "type": "object"
            },
            "style": "deepObject"
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/vnd.api+json": {
                "schema": {
                  "additionalProperties": false,
                  "properties": {
                    "data": {
                      "description": "An array of resource objects representing a product",
                      "items": {
                        "$ref": "#/components/schemas/product"
                      },
                      "type": "array",
                      "uniqueItems": true
                    },
                    "included": {
                      "items": {},
                      "type": "array",
                      "uniqueItems": true
                    },
                    "meta": {
                      "additionalProperties": true,
                      "type": "object"
                    }
                  },
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "$ref": "#/components/responses/errors"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "summary": "List products",
        "tags": [
          "products"
        ]
      }
    },
    "/api/v4/products/{id}": {
      "get": {
        "callbacks": {},
        "deprecated": false,
        "description": "Scope **products:read**. One of your account's products, by id. JSON:API: *Try it out* sends `Accept: application/vnd.api+json`; without it the same path answers the plain JSON of the earlier v4 API.",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Relationship paths to include in the response",
            "explode": false,
            "in": "query",
            "name": "include",
            "required": false,
            "schema": {
              "pattern": "^()(,())*$",
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Limits the response fields to only those listed for each type",
            "in": "query",
            "name": "fields",
            "required": false,
            "schema": {
              "additionalProperties": true,
              "example": {
                "product": "id,name,sku,description,status,removed_at,download_limit,expires_after_seconds,issues_keys"
              },
              "properties": {
                "product": {
                  "description": "Comma separated field names for product",
                  "example": "id,name,sku,description,status,removed_at,download_limit,expires_after_seconds,issues_keys",
                  "type": "string"
                }
              },
              "type": "object"
            },
            "style": "deepObject"
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/vnd.api+json": {
                "schema": {
                  "additionalProperties": false,
                  "properties": {
                    "data": {
                      "$ref": "#/components/schemas/product"
                    },
                    "included": {
                      "items": {},
                      "type": "array",
                      "uniqueItems": true
                    },
                    "meta": {
                      "additionalProperties": true,
                      "type": "object"
                    }
                  }
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "$ref": "#/components/responses/errors"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "summary": "Get a product",
        "tags": [
          "products"
        ]
      }
    },
    "/api/v4/products/{id}/files": {
      "patch": {
        "callbacks": {},
        "deprecated": false,
        "description": "Scope **products:write**. Attaches one of your account's available files (`file_id`) to the product; a file already attached stays as it is. Body: `{\"data\": {\"type\": \"product\", \"id\": \"<product id>\", \"attributes\": {\"file_id\": \"<file id>\"}}}`.",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Relationship paths to include in the response",
            "explode": false,
            "in": "query",
            "name": "include",
            "required": false,
            "schema": {
              "pattern": "^()(,())*$",
              "type": "string"
            },
            "style": "form"
          },
          {
            "description": "Limits the response fields to only those listed for each type",
            "in": "query",
            "name": "fields",
            "required": false,
            "schema": {
              "additionalProperties": true,
              "example": {
                "product": "id,name,sku,description,status,removed_at,download_limit,expires_after_seconds,issues_keys"
              },
              "properties": {
                "product": {
                  "description": "Comma separated field names for product",
                  "example": "id,name,sku,description,status,removed_at,download_limit,expires_after_seconds,issues_keys",
                  "type": "string"
                }
              },
              "type": "object"
            },
            "style": "deepObject"
          }
        ],
        "requestBody": {
          "content": {
            "application/vnd.api+json": {
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "data": {
                    "additionalProperties": false,
                    "properties": {
                      "attributes": {
                        "additionalProperties": false,
                        "properties": {
                          "file_id": {
                            "format": "uuid",
                            "type": "string"
                          }
                        },
                        "required": [
                          "file_id"
                        ],
                        "type": "object"
                      },
                      "id": {
                        "type": "string"
                      },
                      "relationships": {
                        "additionalProperties": false,
                        "properties": {},
                        "type": "object"
                      },
                      "type": {
                        "enum": [
                          "product"
                        ]
                      }
                    },
                    "required": [
                      "id"
                    ],
                    "type": "object"
                  }
                },
                "required": [
                  "data"
                ],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/vnd.api+json": {
                "schema": {
                  "additionalProperties": false,
                  "properties": {
                    "data": {
                      "$ref": "#/components/schemas/product"
                    },
                    "included": {
                      "items": {},
                      "type": "array",
                      "uniqueItems": true
                    },
                    "meta": {
                      "additionalProperties": true,
                      "type": "object"
                    }
                  }
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "$ref": "#/components/responses/errors"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "summary": "Attach a file to a product",
        "tags": [
          "products"
        ]
      }
    },
    "/api/v4/renames/{id}": {
      "get": {
        "callbacks": {},
        "deprecated": false,
        "description": "A rename and where it is (scope files:read): poll this after POST /files/{id}/rename until the status is no longer `requested` (`requested` → `switched` → `done`, or `failed`, or `needs_attention`). Once the file has the new name, `file` shows it. A rename's id keeps working after the file's old name stops finding it.\n",
        "parameters": [
          {
            "description": "The rename's id (a uuid); unknown → rename_not_found.",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "description": "The rename's id (a uuid); unknown → rename_not_found.",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/vnd.api+json": {
                "schema": {
                  "additionalProperties": false,
                  "properties": {
                    "error": {
                      "description": "Why a failed rename failed (only then): file_changed, destination_taken, destination_not_listed, destination_changed, source_changed, source_missing, copy_mismatch, storage_unavailable, worker_lost or unknown.",
                      "nullable": true,
                      "type": "string"
                    },
                    "file": {
                      "additionalProperties": false,
                      "description": "The file under its new name, once it has it (switched, done, needs_attention, unchanged); null before.",
                      "nullable": true,
                      "properties": {
                        "filename": {
                          "description": "The file's name: the new one.",
                          "type": "string"
                        },
                        "id": {
                          "description": "The file's id.",
                          "format": "uuid",
                          "type": "string"
                        },
                        "sha256": {
                          "description": "The sha256 of the bytes, hex (a rename keeps the bytes).",
                          "nullable": true,
                          "type": "string"
                        },
                        "sha256_verified": {
                          "description": "True once the server has hashed the stored bytes itself; a rename that cannot prove the copy byte-identical by its ETag re-hashes it, false until then.",
                          "type": "boolean"
                        },
                        "size": {
                          "description": "Bytes.",
                          "nullable": true,
                          "type": "integer"
                        },
                        "version": {
                          "description": "The file's version (a rename keeps it).",
                          "nullable": true,
                          "type": "integer"
                        }
                      },
                      "required": [
                        "id",
                        "filename",
                        "sha256_verified"
                      ],
                      "type": "object"
                    },
                    "file_id": {
                      "description": "The file being renamed (null if it was deleted since).",
                      "format": "uuid",
                      "nullable": true,
                      "type": "string"
                    },
                    "from": {
                      "description": "The file's name when the rename was asked for.",
                      "nullable": true,
                      "type": "string"
                    },
                    "id": {
                      "description": "The rename's id: poll GET /renames/{id}. null only for status unchanged.",
                      "format": "uuid",
                      "nullable": true,
                      "type": "string"
                    },
                    "requested_at": {
                      "description": "When the rename was asked for.",
                      "format": "date-time",
                      "nullable": true,
                      "type": "string"
                    },
                    "status": {
                      "description": "requested: the copy is running and the file still has its old name — poll again. switched: the file has the new name; the old copy is kept a short while for download links issued before the switch, then deleted. done: finished, the old copy deleted. failed: nothing changed, the file keeps its old name; error says why. needs_attention: the file has the new name, but the new copy could not be confirmed, so support is checking it; the file cannot be renamed or replaced until then. unchanged: the file already had that name; nothing to do.",
                      "enum": [
                        "requested",
                        "switched",
                        "done",
                        "failed",
                        "needs_attention",
                        "unchanged"
                      ],
                      "type": "string"
                    },
                    "switched_at": {
                      "description": "When the file took the new name.",
                      "format": "date-time",
                      "nullable": true,
                      "type": "string"
                    },
                    "to": {
                      "description": "The new name.",
                      "type": "string"
                    }
                  },
                  "required": [
                    "to",
                    "status"
                  ],
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "$ref": "#/components/responses/errors"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "summary": "Follow a rename",
        "tags": [
          "renames"
        ]
      }
    },
    "/api/v4/uploads": {
      "post": {
        "callbacks": {},
        "deprecated": false,
        "description": "Scope **files:write**. Starts a multipart upload of `filename` (`size` in bytes; optional `content_type`, `sha256` to have it checked, `replace` to make it a new version of the file of that name, `attach_product_id` to attach it to a product once stored). The answer carries the upload and a URL for each part: `PUT` each part's bytes to its URL, then **Complete** the upload. `idempotency_key` makes a retry return the same upload.",
        "parameters": [],
        "requestBody": {
          "content": {
            "application/vnd.api+json": {
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "data": {
                    "additionalProperties": false,
                    "properties": {
                      "attach_product_id": {
                        "format": "uuid",
                        "nullable": true,
                        "type": "string"
                      },
                      "content_type": {
                        "nullable": true,
                        "type": "string"
                      },
                      "filename": {
                        "type": "string"
                      },
                      "idempotency_key": {
                        "nullable": true,
                        "type": "string"
                      },
                      "replace": {
                        "nullable": true,
                        "type": "boolean"
                      },
                      "sha256": {
                        "nullable": true,
                        "type": "string"
                      },
                      "size": {
                        "type": "integer"
                      },
                      "swap_file_id": {
                        "format": "uuid",
                        "nullable": true,
                        "type": "string"
                      }
                    },
                    "required": [
                      "filename",
                      "size"
                    ],
                    "type": "object"
                  }
                },
                "required": [
                  "data"
                ],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/vnd.api+json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "$ref": "#/components/responses/errors"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "summary": "Start an upload",
        "tags": [
          "uploads"
        ]
      }
    },
    "/api/v4/uploads/{id}": {
      "get": {
        "callbacks": {},
        "deprecated": false,
        "description": "Scope **files:read**. The upload: its status, the parts received so far, and the file once it is stored.",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "format": "uuid",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/vnd.api+json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "$ref": "#/components/responses/errors"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "summary": "Get an upload",
        "tags": [
          "uploads"
        ]
      }
    },
    "/api/v4/uploads/{id}/abort": {
      "post": {
        "callbacks": {},
        "deprecated": false,
        "description": "Scope **files:write**. Gives the upload up; its parts are deleted. Asking again answers the same.",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "format": "uuid",
              "type": "string"
            }
          }
        ],
        "responses": {
          "201": {
            "content": {
              "application/vnd.api+json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "$ref": "#/components/responses/errors"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "summary": "Abort an upload",
        "tags": [
          "uploads"
        ]
      }
    },
    "/api/v4/uploads/{id}/complete": {
      "post": {
        "callbacks": {},
        "deprecated": false,
        "description": "Scope **files:write**. Every part is in: FetchApp checks the parts (and the `sha256` when you gave one) and stores the file. `parts` (`part_number`, `etag`) is optional. Follow it with **Get an upload** until the status is `committed`.",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "format": "uuid",
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/vnd.api+json": {
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "data": {
                    "additionalProperties": false,
                    "properties": {
                      "parts": {
                        "items": {
                          "type": "object"
                        },
                        "nullable": true,
                        "type": "array"
                      }
                    },
                    "type": "object"
                  }
                },
                "required": [
                  "data"
                ],
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "201": {
            "content": {
              "application/vnd.api+json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "$ref": "#/components/responses/errors"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "summary": "Complete an upload",
        "tags": [
          "uploads"
        ]
      }
    },
    "/api/v4/uploads/{id}/parts": {
      "post": {
        "callbacks": {},
        "deprecated": false,
        "description": "Scope **files:write**. Fresh URLs for the given `part_numbers` — when the first ones expired, or to resume an upload.",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "format": "uuid",
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/vnd.api+json": {
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "data": {
                    "additionalProperties": false,
                    "properties": {
                      "part_numbers": {
                        "items": {
                          "type": "integer"
                        },
                        "type": "array"
                      }
                    },
                    "required": [
                      "part_numbers"
                    ],
                    "type": "object"
                  }
                },
                "required": [
                  "data"
                ],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/vnd.api+json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "default": {
            "$ref": "#/components/responses/errors"
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "summary": "Get part URLs again",
        "tags": [
          "uploads"
        ]
      }
    }
  },
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "servers": [
    {
      "description": "This FetchApp host",
      "url": "https://app.fetchapp.app",
      "variables": {}
    }
  ],
  "tags": [
    {
      "description": "Create orders from your own checkout (a Stripe webhook, a custom cart) and FetchApp delivers them: the buyer's download email, access per your products' terms. List and read orders from every source, resend the buyer email, expire access. Plain JSON.",
      "name": "orders"
    },
    {
      "description": "Who your API key is: the account, the key's name and scopes, the plan. The call to make first. Plain JSON.",
      "name": "account"
    },
    {
      "description": "Your products and the files attached to them. JSON:API (`application/vnd.api+json`).",
      "name": "products"
    },
    {
      "description": "Your stored files: list them, read one. JSON:API.",
      "name": "files"
    },
    {
      "description": "Upload a file in parts: start an upload, `PUT` each part to the URL it gives you, then complete it. JSON:API.",
      "name": "uploads"
    },
    {
      "description": "Rename a file (a copy that runs after the call answers) and follow the rename. JSON:API.",
      "name": "renames"
    }
  ]
}