action britbox_check_voucher {
  label: "checkVoucher"
  description: "Validates the coupon/voucher for specified payment platform."
  provider: britbox
  method: POST
  path: "/itv/voucher/{platform}"
  encoding: json
  input: {
    type: "object"
    properties: {
      platform: {
        type: "string"
      }
      voucher: {
        type: "string"
        description: "The voucher."
      }
    }
    required: ["platform", "voucher"]
    additionalProperties: false
  }
  output: {
    type: "object"
    required: ["display", "id", "links", "offerType"]
    properties: {
      display: {
        type: "object"
        required: ["type"]
        properties: {
          currency: {
            type: "string"
            description: "Currency."
          }
          discountPrice: {
            type: "string"
            description: "Discount price."
          }
          duration: {
            type: "string"
            description: "Duration."
          }
          durationInMonths: {
            type: "number"
            format: "integer"
            description: "Duration in months."
          }
          headlineLabel: {
            type: "string"
            description: "Headline label."
          }
          initialCost: {
            type: "number"
            format: "float"
            description: "InitialCost."
          }
          longDescription: {
            type: "string"
            description: "Long description."
          }
          percentOff: {
            type: "number"
            format: "float"
            description: "Percent off."
          }
          savingLabel: {
            type: "string"
            description: "SavingLabel."
          }
          shortDescription: {
            type: "string"
            description: "Short description."
          }
        }
      }
      id: {
        type: "string"
        description: "The coupon/voucher."
      }
      links: {
        type: "object"
        required: ["redeem", "self"]
        properties: {
          redeem: {
            type: "object"
            required: ["href"]
            properties: {
              href: {
                type: "string"
                description: "The voucher link."
              }
            }
          }
          self: {
            type: "object"
            additionalProperties: true
          }
        }
      }
      offerType: {
        type: "string"
        description: "The voucher offer type."
        enum: ["stripe", "talon one"]
      }
    }
    additionalProperties: false
  }
}