action dodo_get_nh_furniture {
  label: "All New Horizons furniture"
  description: "Get a list of all furniture and their details in *Animal Crossing: New Horizons*."
  provider: dodo
  method: GET
  path: "/nh/furniture"
  encoding: json
  input: {
    type: "object"
    properties: {
      "Accept-Version": {
        type: "string"
      }
      "X-API-KEY": {
        type: "string"
        format: "uuid"
      }
      category: {
        type: "string"
        enum: ["Housewares", "Miscellaneous", "Wall-mounted"]
      }
      color: {
        type: "array"
        items: {
          type: "string"
          enum: ["Aqua", "Beige", "Black", "Blue", "Brown", "Colorful", "Gray", "Green", "Orange", "Pink", "Purple", "Red", "White", "Yellow"]
        }
      }
      excludedetails: {
        type: "string"
      }
    }
    required: ["Accept-Version", "X-API-KEY"]
    additionalProperties: false
  }
  output: {
    type: "array"
    items: {
      type: "object"
      properties: {
        availability: {
          type: "array"
          description: "Where the furniture may be obtained from (could be multiple sources). `from` is a brief description of the source; `note`, when provided, provides additional details."
          items: {
            type: "object"
            properties: {
              from: {
                type: "string"
              }
              note: {
                type: "string"
              }
            }
          }
        }
        buy: {
          type: "array"
          description: "An array of prices, for when the item may be purchased with Bells, Nook Miles, etc.."
          items: {
            type: "object"
            properties: {
              currency: {
                type: "string"
              }
              price: {
                type: "integer"
              }
            }
          }
        }
        category: {
          type: "string"
          description: "The category of item as shown in the player's inventory."
          enum: ["Housewares", "Miscellaneous", "Wall-mounted"]
        }
        custom_body_part: {
          type: "string"
          description: "If the item has variations, this is the name of the furniture part that changes. For example, for many bamboo items, the custom body part is \"Bamboo\" as the bamboo color is able to be customized."
        }
        custom_kit_type: {
          type: "string"
          description: "The item that needs to be consumed to customize this item. The vast majority are \"Customization Kit\", but a small selection of items will require a different item, such as items in the Spooky Series requireing pumpkins."
        }
        custom_kits: {
          type: "integer"
          description: "The number of `custom_kit_type`s (e.g. Customization Kits) that are needed to customize this item. Value is 0 if the item is not customizable."
        }
        custom_pattern_part: {
          type: "string"
          description: "If the item's pattern can be customized, this is the name of the furniture part that can have a pattern applied to it. For example, for the Baby Chair, the custom pattern part is \"Cushion\" as the cushion on the chair may have a pattern applied."
        }
        customizable: {
          type: "boolean"
          description: "Whether or not the item is customizable via a crafting table."
        }
        door_decor: {
          type: "boolean"
          description: "Whether this item may be placed on the exterior door of the player's house."
        }
        functions: {
          type: "array"
          description: "A list of functionalities (if any) that the item has. For example, furniture that items can be placed on topof will have \"Table\" as a function.."
          items: {
            type: "string"
            enum: ["Trash", "Toilet", "Table", "Storage", "Stereo", "Seating", "Lighting", "Instrument", "Dresser", "Bed", "Audio"]
          }
        }
        grid_length: {
          type: "number"
          format: "float"
          description: "The number of lengthwise grid spaces this item takes up."
        }
        grid_width: {
          type: "number"
          format: "float"
          description: "The number of widthwise grid spaces this item takes up."
        }
        height: {
          type: "number"
          format: "float"
          description: "The height of the object. One in-game block is 10 units tall, while the player is 15.1324 units tall."
        }
        hha_base: {
          type: "integer"
          description: "The base value that the item provides to a player's Happy Home Academy score when placed in their home."
        }
        hha_category: {
          type: "string"
          description: "The HHA category the item is a part of, if any. If the item does not have an HHA category, this will be an empty string."
        }
        item_series: {
          type: "string"
          description: "The [furniture series](https://nookipedia.com/wiki/Series_(furniture)) the item is a part of, if any. A series is a collection of furniture and interior items, all with the same theme. If the item is not part of a series, this will be an empty string."
        }
        item_set: {
          type: "string"
          description: "The [furniture set](https://nookipedia.com/wiki/Set) the item is a part of, if any. A set is a smaller collection of related furniture items. If the item is not part of a set, this will be an empty string."
        }
        lucky: {
          type: "boolean"
          description: "Whether or not the item is lucky. Lucky items give a 777-point HHA bonus. Some items are only counted as lucky in certain seasons, as indicated by the `lucky_season` field."
        }
        lucky_season: {
          type: "string"
          description: "The season in which the item is lucky (or \"All year\" if lucky throughout the entire year). Items that are not lucky will have this field as an empty string."
          enum: ["", "All year", "Spring", "Summer", "Autumn", "Winter"]
        }
        name: {
          type: "string"
          description: "The name of the furniture."
        }
        notes: {
          type: "string"
          description: "Any additional miscellaneous information about the item, such as a name change from a past update."
        }
        pattern_total: {
          type: "integer"
          description: "The number of default patterns available to customize the item with, between 0 and 8. For items with customizable patterns, the player may also customize with patterns of their own."
          enum: [0, 1, 2, 3, 4, 5, 6, 7, 8]
        }
        sell: {
          type: "integer"
          description: "The number of Bells the item can be sold to Nook's store for."
        }
        tag: {
          type: "string"
          description: "The tag of an item, if any, which denotes a specific use or relation to an event. Tags are determined by Nintendo. Examples include \"Chair\", \"Musical Instrument\", and \"Mario\". If the item does not have a tag, this will be an empty string."
        }
        themes: {
          type: "array"
          description: "A list of [themes](https://nookipedia.com/wiki/Theme_(furniture)) (if any) that the item belongs to."
          items: {
            type: "string"
          }
        }
        unlocked: {
          type: "boolean"
          description: "Whether the item is available through legitimate gameplay. Some items are added to the game files in an update, but aren't actually made available until a subsequent update unlocks them."
        }
        url: {
          type: "string"
          description: "Link to the respective Nookipedia article."
        }
        variation_total: {
          type: "integer"
          description: "The number of variations, between 0 and 8."
          enum: [0, 1, 2, 3, 4, 5, 6, 7, 8]
        }
        variations: {
          type: "array"
          description: "An array of objects, each object representing a variation of the furniture. Furniture that has no variations (only one version) will have a single variation object with the image URL and colors, but the `variation` or `pattern` fields will be empty strings. Furniture with multiple variations will have the `variation` and/or `pattern` fields defined depending on whether the furniture varies by body variety, pattern, or both."
          items: {
            type: "object"
            properties: {
              colors: {
                type: "array"
                items: {
                  type: "string"
                  enum: ["Aqua", "Beige", "Black", "Blue", "Brown", "Colorful", "Gray", "Green", "Orange", "Pink", "Purple", "Red", "White", "Yellow"]
                }
              }
              image_url: {
                type: "string"
              }
              pattern: {
                type: "string"
              }
              variation: {
                type: "string"
              }
            }
          }
        }
        version_added: {
          type: "string"
          description: "The version of *New Horizons* that the item was added. Items that were included at the game's launch have version \"1.0.0\"."
        }
      }
    }
  }
}