{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ZipDownload",
  "title": "Zip download",
  "type": "object",
  "x-box-resource-id": "zip_download",
  "x-box-tag": "zip_downloads",
  "x-box-reference-category": "zip_downloads",
  "description": "Represents a successful request to create a `zip` archive of a list of files\nand folders.",
  "example": {
    "download_url": "https://dl.boxcloud.com/2.0/zip_downloads/29l00nfxDyHOt7RphI9zT_w==nDnZEDjY2S8iEWWCHEEiptFxwoWojjlibZjJ6geuE5xnXENDTPxzgbks_yY=/content",
    "status_url": "https://api.box.com/2.0/zip_downloads/29l00nfxDyHOt7RphI9zT_w==nDnZEDjY2S8iEWWCHEEiptFxwoWojjlibZjJ6geuE5xnXENDTPxzgbks_yY=/status",
    "expires_at": "2020-07-22T11:26:08Z",
    "name_conflicts": [
      [
        {
          "id": "12345",
          "type": "file",
          "original_name": "Report.pdf",
          "download_name": "3aa6a7.pdf"
        },
        {
          "id": "34325",
          "type": "file",
          "original_name": "Report.pdf",
          "download_name": "5d53f2.pdf"
        }
      ]
    ]
  },
  "properties": {
    "download_url": {
      "type": "string",
      "description": "The URL that can be used to download the `zip` archive. A `Get` request to\nthis URL will start streaming the items requested. By default, this URL\nis only valid for a few seconds, until the `expires_at` time, unless a\ndownload is started after which it is valid for the duration of the\ndownload.\n\nIt is important to note that the domain and path of this URL might change\nbetween API calls, and therefore it's important to use this URL as-is.",
      "example": "https://dl.boxcloud.com/2.0/zip_downloads/Lu6fA9Ob-jyysp3AAvMF4AkLEwZwAYbL=tgj2zIC=eK9RvJnJbjJl9rNh2qBgHDpyOCAOhpM=vajg2mKq8Mdd/content"
    },
    "status_url": {
      "type": "string",
      "description": "The URL that can be used to get the status of the `zip` archive being\ndownloaded. A `Get` request to this URL will return the number of files\nin the archive as well as the number of items already downloaded or\nskipped. By default, this URL is only valid for a few seconds, until the\n`expires_at` time, unless a download is started after which the URL is\nvalid for 12 hours from the start of the download.\n\nIt is important to note that the domain and path of this URL might change\nbetween API calls, and therefore it's important to use this URL as-is.",
      "example": "https://api.box.com/2.0/zip_downloads/Lu6fA9Ob-jyysp3AAvMF4AkLEwZwAYbL=tgj2zIC=eK9RvJnJbjJl9rNh2qBgHDpyOCAOhpM=vajg2mKq8Mdd/status"
    },
    "expires_at": {
      "type": "string",
      "format": "date-time",
      "description": "The time and date when this archive will expire. After this time the\n`status_url` and `download_url` will return an error.\n\nBy default, these URLs are only valid for a few seconds, unless a download\nis started after which the `download_url` is valid for the duration of the\ndownload, and the `status_url` is valid for 12 hours from the start of the\ndownload.",
      "example": "2019-08-29T23:59:00-07:00"
    },
    "name_conflicts": {
      "type": "array",
      "description": "A list of conflicts that occurred when trying to create the archive. This\nwould occur when multiple items have been requested with the\nsame name.\n\nTo solve these conflicts, the API will automatically rename an item\nand return a mapping between the original item's name and its new\nname.\n\nFor every conflict, both files will be renamed and therefore this list\nwill always be a multiple of 2.",
      "items": {
        "type": "array",
        "description": "An individual conflict that occurred when trying to create the archive.\nThis includes an array of 2 objects, each containing the original name\nand the renamed filename of a file or folder for which the names\nconflicted.",
        "items": {
          "type": "object",
          "description": "A file or folder for which a conflict was encountered, This object provides the type and identifier of the original item, as well as a mapping between its original name and it's new name as it will appear in the archive.",
          "properties": {
            "id": {
              "type": "string",
              "description": "The identifier of the item",
              "example": "12345"
            },
            "type": {
              "type": "string",
              "description": "The type of this item",
              "example": "file",
              "enum": [
                "file",
                "folder"
              ]
            },
            "original_name": {
              "type": "string",
              "description": "The original name of this item",
              "example": "Report.pdf"
            },
            "download_name": {
              "type": "string",
              "description": "The new name of this item as it will appear in the\ndownloaded `zip` archive.",
              "example": "3aa6a7.pdf"
            }
          }
        }
      }
    }
  }
}