action ideal_postcodes_key_details {
  label: "Details"
  description: "Returns private data on the key including remaining lookups, available datasets and usage limits.\n"
  provider: ideal_postcodes
  method: GET
  path: "/keys/{key}/details"
  encoding: json
  input: {
    type: "object"
    properties: {
      key: {
        type: "string"
        description: "Your API Key. Typically beings `ak_`.\n\nAvailable from your dashboard\n"
      }
      user_token: {
        type: "string"
        description: "A secret key used for sensitive operations on your account and API Keys.\n\nYour user token can be retrieved and managed from your [accounts page](https://ideal-postcodes.co.uk/account).\n\nTypically beings `uk_...`\n"
      }
    }
    required: ["key"]
    additionalProperties: false
  }
  output: {
    type: "object"
    required: ["code", "message", "result"]
    properties: {
      code: {
        type: "integer"
        format: "int32"
        enum: [2000]
      }
      message: {
        type: "string"
        enum: ["Success"]
      }
      result: {
        type: "object"
        required: ["allowed_urls", "automated_topups", "current_purchases", "daily_limit", "individual_limit", "lookups_remaining", "notificatinos"]
        properties: {
          allowed_urls: {
            type: "array"
            description: "A list of allowed URLs. An empty list means that allowed URLs are disabled."
            items: {
              type: "string"
            }
          }
          automated_topups: {
            type: "object"
            description: "Automated topup status"
            required: ["enabled"]
            properties: {
              enabled: {
                type: "boolean"
                description: "Indicates whether automated top-ups are enabled"
              }
            }
          }
          current_purchases: {
            type: "array"
            description: "Current balance purchases attached to key."
            items: {
              type: "object"
              required: ["expires", "purchased", "consumed"]
              properties: {
                consumed: {
                  type: "integer"
                  format: "int32"
                  description: "Number of consumed lookups off this purchase."
                }
                expires: {
                  type: "string"
                  description: "`string` or `null` The date when this purchase will expire in simplified \nextended ISO format (ISO 8601). This is typically 365 days from the time \nof first use. This field will be `null` if the purchase has not yet been \nused."
                }
                purchased: {
                  type: "integer"
                  format: "int32"
                  description: "Number of procured lookups from this purchase."
                }
              }
            }
          }
          daily_limit: {
            type: "object"
            required: ["consumed", "limit"]
            properties: {
              consumed: {
                type: "integer"
                format: "int32"
                description: "Number of lookups performed today which count towards your daily limit."
              }
              limit: {
                type: "integer"
                format: "int32"
                description: "`number` or `null`. The daily lookup limit currently set on your key. \n`null` means the limit is currently disabled."
              }
            }
          }
          datasets: {
            type: "object"
            description: "Indicates which datasets are available and added by default to the address responses"
            required: ["ecad", "ecaf", "mr", "nyb", "paf", "pafa", "pafw", "usps"]
            properties: {
              ecad: {
                type: "boolean"
                description: "IE Address File. Eircode Address Database"
              }
              ecaf: {
                type: "boolean"
                description: "IE Base Address File. Eircode Address File"
              }
              herewe: {
                type: "boolean"
                description: "Western Europe Address File"
              }
              mr: {
                type: "boolean"
                description: "UK Multiple Residence Dataset"
              }
              nyb: {
                type: "boolean"
                description: "UK Not Yet Built Dataset"
              }
              paf: {
                type: "boolean"
                description: "UK Main Address File (Postcode Address File)"
              }
              pafa: {
                type: "boolean"
                description: "UK Property Alias dataset"
              }
              pafw: {
                type: "boolean"
                description: "UK Welsh Language Dataset"
              }
              usps: {
                type: "boolean"
                description: "US Address Dataset"
              }
            }
          }
          individual_limit: {
            type: "object"
            required: ["limit"]
            properties: {
              limit: {
                type: "integer"
                format: "int32"
                description: "`number` or `null` Limit set on the number of lookups that can be \nperformed from a single IP address. `null` means the limit is currently \ndisabled."
              }
            }
          }
          lookups_remaining: {
            type: "integer"
            format: "int32"
          }
          notifications: {
            type: "object"
            required: ["emails", "enabled"]
            properties: {
              emails: {
                type: "array"
                description: "A list of email addresses designated by you to receive notifications about this key."
                items: {
                  type: "string"
                }
              }
              enabled: {
                type: "boolean"
                description: "Indicates whether email notifications are enabled."
              }
            }
          }
        }
      }
    }
  }
}