Zip Bundle

OpenAPI Schema

The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.

{
  "description": "A zip bundle.",
  "properties": {
    "downloadPageUrl": {
      "description": "The URL for the download page where the zip bundle can be\ndownloaded. Is either a URL to a Studio Panel download page, or a\nclient gallery download page if the zip bundle is to be publicly\naccessible.",
      "format": "uri",
      "nullable": true,
      "readOnly": true,
      "type": "string"
    },
    "email": {
      "description": "The email address of an external user to send this zip bundle to.\n\nIf provided, the zip bundle generated will result in an email being\nsent to this address where the zip bundle link points to the client\nGallery's zip bundle download page.  By providing this value, it is\nassumed that the intended recipient is an external user.\n\nIf a value is not provided, the zip bundle generated will be sent to\nthe requester's email address, and the link will be to a Studio\nPanel page where the ZIP file(s) can be downloaded.\n",
      "format": "email",
      "type": "string",
      "writeOnly": true
    },
    "expiration": {
      "description": "Datetime representing the expiration for the given URL. URL will no\nlonger be valid after this time.",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    },
    "numFiles": {
      "description": "The number of files that make up this zip bundle. Null until\nprocessing is complete.",
      "nullable": true,
      "readOnly": true,
      "type": "number"
    },
    "photoIds": {
      "description": "The (optional) IDs of the photos included in this zip bundle. If present, zip bundle will be limited to photo IDs present in this value.\n",
      "items": {
        "type": "number"
      },
      "type": "array",
      "writeOnly": true
    },
    "type": {
      "description": "The type of object represented",
      "enum": [
        "zip-bundle"
      ],
      "type": "string"
    },
    "zipBundleStatus": {
      "description": "A slug string representing the status message describing the state of the zip bundle.\n* `awaiting-processing` - In the queue for processing\n* `processing` - Photos are being processed and zip bundle assembled.\n* `downloadable` - Zip bundle is ready for download.\n* `deleted` - Bundle has been deleted",
      "enum": [
        "awaiting-processing",
        "processing",
        "downloadable",
        "deleted"
      ],
      "readOnly": true,
      "type": "string"
    },
    "zipBundleType": {
      "description": "The digital download type slug:\n* `digital-download-order` - Bundle of all photos belonging to a single paid digitals order\n* `studio-group-photos` - Studio panel user selected group of photos\n* `event-all-photos` - Bundle of all photos belonging to the event\n* `event-all-photos-client` - Client gallery user chose to download all photos in the event\n* `studio-sent-client-link` - Studio panel user generated a zip bundle and corresponding share link, no email address associated with this type of zip bundle == no authentication\n* `album-all-photos` -  Bundle of all photos belonging to the event album, only used by studio panel\n* `client-group-photos` - Client user's arbitrary selection of photos grouped together into a zip bundle for download",
      "enum": [
        "digital-download-order",
        "studio-group-photos",
        "event-all-photos",
        "event-all-photos-client",
        "studio-sent-client-link",
        "album-all-photos",
        "client-group-photos"
      ],
      "readOnly": true,
      "type": "string"
    }
  },
  "title": "Zip Bundle",
  "type": "object"
}