perfume-api 2.4.0 → 2.5.0

package/dist/types.d.ts

@@ -56,35 +56,35 @@ export interface SearchPerfumesResponse {
     source: string;
 }
 export interface SearchPerfumesParams {
-    /** Free text: a perfume name, house, notes or mood. Examples: "fresh citrus summer for men", "Tom Ford tobacco", "vanilla gourmand for winter" */
+    /** Free text: a perfume name, house, notes or mood. Examples: "fresh citrus summer for men", "Tom Ford oud", "vanilla gourmand for winter" */
     q?: string;
     /** Only perfumes from this house. Examples: "Dior", "Maison Francis Kurkdjian", "MFK", "YSL" */
     house?: string;
-    /** Every listed note must be present. Examples: ["oud","rose"], ["vanilla"] Comma-separated list. */
+    /** Every listed note must be present. Examples: ["oud","sandalwood"], ["vanilla"] Comma-separated list. */
     notes_include?: string | string[];
     /** None of these notes may be present. Example: ["patchouli"] Comma-separated list. */
     notes_exclude?: string | string[];
     /** Accords that must be present. Examples: ["woody","sweet"], ["fresh","aquatic"] Comma-separated list. */
     accords?: string | string[];
-    /** Fragrance family: fougere, chypre, oriental-amber, gourmand, aquatic, aromatic, woody, floral, white-floral, fruity, citrus, green, leather, oud, musky, powdery, spicy, tobacco-boozy, smoky-incense, aldehydic-floral, mineral, fresh-spicy-woody, tea-zen. Also accepts words like "amber" or "citrus". */
+    /** Fragrance family. Examples: "chypre", "fougere", "gourmand", "amber", "citrus". Leave term empty in explain_perfume_term to list every family. */
     family?: string;
     /** Audience the perfume is marketed to. men and women also include unisex perfumes. */
     gender?: "men" | "women" | "unisex";
     /** Season the perfume suits (fall is accepted in text queries as autumn). */
     season?: "spring" | "summer" | "autumn" | "winter";
-    /** Occasion the perfume suits: daytime, office, casual, evening, date night or special occasion. */
+    /** Occasion the perfume suits. */
     occasion?: "daytime" | "office" | "casual" | "evening" | "date night" | "special occasion";
-    /** A style word: aquatic, boozy, clean, creamy, dark, floral, fresh, citrusy, fruity, gourmand, green, leathery, musky, powdery, sensual, smoky, spicy, sweet, woody. */
+    /** A style word the scent should have. */
     style?: "aquatic" | "boozy" | "clean" | "creamy" | "dark" | "floral" | "fresh" | "citrusy" | "fruity" | "gourmand" | "green" | "leathery" | "musky" | "powdery" | "sensual" | "smoky" | "spicy" | "sweet" | "woody";
     /** true = only the editors' iconic, era-defining classics (works with every other filter, and without a query) */
     iconic?: boolean;
-    /** How many results per page (1-20, default 8). */
+    /** Results per page. */
     limit?: number;
-    /** next_cursor from the previous page; omit for the first page. */
+    /** next_cursor from the previous page. */
     cursor?: string;
-    /** concise (default) or detailed (adds note pyramid, seasons, occasions, longevity, projection). */
+    /** concise (default) or detailed (adds pyramid, seasons, occasions, longevity). */
     format?: "concise" | "detailed";
-    /** Language of the 10ml.com links and labels. Perfume, house and note names stay as they are. */
+    /** Language of the 10ml.com links and labels. */
     locale?: "en" | "de" | "fr" | "es" | "it" | "ro" | "el" | "hu" | "cs" | "pl";
 }
 export interface GetPerfumeResponse {
@@ -121,9 +121,9 @@ export interface GetPerfumeResponse {
 export interface GetPerfumeParams {
     /** House, when the name alone is ambiguous. Example: "Creed" */
     house?: string;
-    /** concise (default) or detailed (adds note pyramid, seasons, occasions, longevity, projection). */
+    /** concise (default) or detailed (adds pyramid, seasons, occasions, longevity). */
     format?: "concise" | "detailed";
-    /** Language of the 10ml.com links and labels. Perfume, house and note names stay as they are. */
+    /** Language of the 10ml.com links and labels. */
     locale?: "en" | "de" | "fr" | "es" | "it" | "ro" | "el" | "hu" | "cs" | "pl";
 }
 export interface FindSimilarPerfumesResponse {
@@ -167,13 +167,13 @@ export interface FindSimilarPerfumesParams {
     gender?: "men" | "women" | "unisex";
     /** True to leave out perfumes from the same house as the starting perfume */
     other_houses_only?: boolean;
-    /** How many results per page (1-15, default 8). */
+    /** Results per page. */
     limit?: number;
-    /** next_cursor from the previous page; omit for the first page. */
+    /** next_cursor from the previous page. */
     cursor?: string;
-    /** concise (default) or detailed (adds note pyramid, seasons, occasions, longevity, projection). */
+    /** concise (default) or detailed (adds pyramid, seasons, occasions, longevity). */
     format?: "concise" | "detailed";
-    /** Language of the 10ml.com links and labels. Perfume, house and note names stay as they are. */
+    /** Language of the 10ml.com links and labels. */
     locale?: "en" | "de" | "fr" | "es" | "it" | "ro" | "el" | "hu" | "cs" | "pl";
 }
 export interface FindPerfumeAlternativesResponse {
@@ -211,11 +211,11 @@ export interface FindPerfumeAlternativesParams {
     house?: string;
     /** Only alternatives at this closeness */
     closeness?: "very close" | "similar vibe" | "same spirit";
-    /** How many results per page (1-10, default 6). */
+    /** Results per page. */
     limit?: number;
-    /** next_cursor from the previous page; omit for the first page. */
+    /** next_cursor from the previous page. */
     cursor?: string;
-    /** Language of the 10ml.com links and labels. Perfume, house and note names stay as they are. */
+    /** Language of the 10ml.com links and labels. */
     locale?: "en" | "de" | "fr" | "es" | "it" | "ro" | "el" | "hu" | "cs" | "pl";
 }
 export interface ExplainNoteResponse {
@@ -239,9 +239,9 @@ export interface ExplainNoteResponse {
     source: string;
 }
 export interface ExplainNoteParams {
-    /** concise (default) or detailed (adds note pyramid, seasons, occasions, longevity, projection). */
+    /** concise (default) or detailed (adds pyramid, seasons, occasions, longevity). */
     format?: "concise" | "detailed";
-    /** Language of the 10ml.com links and labels. Perfume, house and note names stay as they are. */
+    /** Language of the 10ml.com links and labels. */
     locale?: "en" | "de" | "fr" | "es" | "it" | "ro" | "el" | "hu" | "cs" | "pl";
 }
 export interface ListHousesResponse {
@@ -269,11 +269,11 @@ export interface ListHousesParams {
     country?: string;
     /** Part of a house name, e.g. "tom" or "maison" */
     query?: string;
-    /** How many results per page (1-50, default 20). */
+    /** Results per page. */
     limit?: number;
-    /** next_cursor from the previous page; omit for the first page. */
+    /** next_cursor from the previous page. */
     cursor?: string;
-    /** Language of the 10ml.com links and labels. Perfume, house and note names stay as they are. */
+    /** Language of the 10ml.com links and labels. */
     locale?: "en" | "de" | "fr" | "es" | "it" | "ro" | "el" | "hu" | "cs" | "pl";
 }
 export interface GetHouseResponse {
@@ -296,9 +296,9 @@ export interface GetHouseResponse {
     source: string;
 }
 export interface GetHouseParams {
-    /** concise (default) or detailed (adds note pyramid, seasons, occasions, longevity, projection). */
+    /** concise (default) or detailed (adds pyramid, seasons, occasions, longevity). */
     format?: "concise" | "detailed";
-    /** Language of the 10ml.com links and labels. Perfume, house and note names stay as they are. */
+    /** Language of the 10ml.com links and labels. */
     locale?: "en" | "de" | "fr" | "es" | "it" | "ro" | "el" | "hu" | "cs" | "pl";
 }
 export interface SearchGuidesResponse {
@@ -312,7 +312,7 @@ export interface SearchGuidesResponse {
         title: string;
         type: string;
         topics: string[];
-        url: string;
+        url?: string;
         /** False when the guide is only available in English (the url is then the English page) */
         translated: boolean;
     }>;
@@ -323,11 +323,11 @@ export interface SearchGuidesParams {
     q?: string;
     /** how-to, list (rankings/comparisons), alternatives (dupes guides), note (a note explained), house (a house mapped) */
     type?: "how-to" | "list" | "alternatives" | "note" | "house";
-    /** How many results per page (1-20, default 8). */
+    /** Results per page. */
     limit?: number;
-    /** next_cursor from the previous page; omit for the first page. */
+    /** next_cursor from the previous page. */
     cursor?: string;
-    /** Language of the 10ml.com links and labels. Perfume, house and note names stay as they are. */
+    /** Language of the 10ml.com links and labels. */
     locale?: "en" | "de" | "fr" | "es" | "it" | "ro" | "el" | "hu" | "cs" | "pl";
 }
 export type Locale = "en" | "de" | "fr" | "es" | "it" | "ro" | "el" | "hu" | "cs" | "pl";

package/dist/types.js

@@ -1,2 +1,2 @@
-// Generated by scripts/gen-types.mjs from spec/openapi.json (10ML Fragrance Index API 2.3.4). Do not edit by hand.
+// Generated by scripts/gen-types.mjs from spec/openapi.json (10ML Fragrance Index API 2.5.0). Do not edit by hand.
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "perfume-api",
-  "version": "2.4.0",
+  "version": "2.5.0",
   "description": "Free perfume API client: perfumes, note pyramids, accords, similar scents, notes and houses from the 10ML Fragrance Index. No API key, JSON over HTTPS.",
   "keywords": [
     "perfume",