action britbox_get_devices {
  label: "getDevices"
  description: "Get all devices registered under this account.\n\nAlso includes information around device registration and deregistration limits.\n"
  provider: britbox
  method: GET
  path: "/account/devices"
  encoding: json
  output: {
    type: "object"
    required: ["devices", "maxRegistered"]
    properties: {
      deregistrationWindow: {
        type: "object"
        required: ["endDate", "limit", "periodDays", "remaining", "startDate"]
        properties: {
          endDate: {
            type: "string"
            format: "date-time"
            description: "The end date of the current period.\n\nThis is based on the value of `startDate` plus the number of days defined by  `periodDays`.\n"
          }
          limit: {
            type: "integer"
            format: "int32"
            description: "The maximum de/registrations that can be made in a period."
          }
          periodDays: {
            type: "integer"
            format: "int32"
            description: "The number of days a de/registration period runs for."
          }
          remaining: {
            type: "integer"
            format: "int32"
            description: "The remaining de/registrations that can be made in the current period."
          }
          startDate: {
            type: "string"
            format: "date-time"
            description: "The start date of the current period.\n\nThis is based on the earliest device de/registrations in the past N days, where\nN is defined by `periodDays`.\n\nIf no device has been de/registered then start date will be from the current date.\n"
          }
        }
        additionalProperties: false
      }
      devices: {
        type: "array"
        description: "The array of registered playack devices."
        items: {
          type: "object"
          required: ["id", "name", "registrationDate", "type"]
          properties: {
            id: {
              type: "string"
              description: "The unique identifier for this device e.g. serial number."
            }
            name: {
              type: "string"
              description: "The human recognisable name for this device."
            }
            registrationDate: {
              type: "string"
              format: "date-time"
              description: "The date this device was registered."
            }
            type: {
              type: "string"
              description: "The device type e.g. web_browser."
            }
          }
          additionalProperties: false
        }
      }
      maxRegistered: {
        type: "integer"
        format: "int32"
        description: "The maximum number of playback devices that can be registered\nunder an account at a single time.\n\nIf there is no maximum defined this value will be `-1`.\n"
      }
      registrationWindow: {
        type: "object"
        additionalProperties: true
      }
    }
    additionalProperties: false
  }
}