types: added itinerary price metrics types

src/amadeus/namespaces/analytics/index.ts

@@ -1,5 +1,5 @@
 import Client from "../../client";
-import ItineraryPriceMetrics from "./itenrary-price-metrics";
+import ItineraryPriceMetrics from "./itinerary-price-metrics";
 
 /**
  * A namespaced client for the

src/amadeus/namespaces/analytics/itenrary-price-metrics.ts → src/amadeus/namespaces/analytics/itinerary-price-metrics.ts

@@ -1,3 +1,8 @@
+import {
+  ItineraryPriceMetricsParams,
+  ItineraryPriceMetricsResult,
+  ItineraryPriceMetricsReturnedResponse,
+} from "../../../types/amadeus/namespaces/analytics/itinerary-price-metrics";
 import Client from "../../client";
 
 /**
@@ -37,7 +42,12 @@ export default class ItineraryPriceMetrics {
    * });
    * ```
    */
-  public get(params = {}) {
-    return this.client.get("/v1/analytics/itinerary-price-metrics", params);
+  public get(
+    params: ItineraryPriceMetricsParams
+  ): Promise<ItineraryPriceMetricsReturnedResponse> {
+    return this.client.get<
+      ItineraryPriceMetricsResult,
+      ItineraryPriceMetricsResult["data"]
+    >("/v1/analytics/itinerary-price-metrics", params);
   }
 }

src/types/amadeus/namespaces/analytics/itinerary-price-metrics.ts

@@ -0,0 +1,40 @@
+import { ReturnedResponseSuccess } from "../../client/response";
+import { CollectionMetaLink, CurrencyCode, Issue } from "../shared";
+
+export interface ItineraryPriceMetric {
+  type?: string;
+  origin?: {
+    iataCode?: string;
+  };
+  destination?: {
+    iataCode?: string;
+  };
+  departureDate?: string;
+  transportType?: "FLIGHT";
+  currencyCode?: CurrencyCode;
+  oneWay?: boolean;
+  priceMetrics?: {
+    amount?: string;
+    quartileRanking?: "MINIMUM" | "FIRST" | "MEDIUM" | "THIRD" | "MAXIMUM";
+  }[];
+}
+
+// Types used in class
+export type ItineraryPriceMetricsParams = {
+  originIataCode: string;
+  destinationIataCode: string;
+  departureDate: string;
+  currencyCode?: CurrencyCode;
+  oneWay?: boolean;
+};
+
+export type ItineraryPriceMetricsResult = {
+  warnings?: Issue[];
+  data: ItineraryPriceMetric[];
+  meta?: CollectionMetaLink;
+};
+
+export type ItineraryPriceMetricsReturnedResponse = ReturnedResponseSuccess<
+  ItineraryPriceMetricsResult,
+  ItineraryPriceMetricsResult["data"]
+>;

src/types/amadeus/namespaces/shared.ts

@@ -94,6 +94,41 @@ export interface OperatingFlight {
   carrierCode?: string;
 }
 
+export type CurrencyCode =
+  | "CAD"
+  | "HKD"
+  | "ISK"
+  | "PHP"
+  | "DKK"
+  | "HUF"
+  | "CZK"
+  | "AUD"
+  | "RON"
+  | "SEK"
+  | "IDR"
+  | "INR"
+  | "BRL"
+  | "RUB"
+  | "HRK"
+  | "JPY"
+  | "THB"
+  | "EUR"
+  | "CHF"
+  | "SGD"
+  | "PLN"
+  | "BGN"
+  | "TRY"
+  | "CNY"
+  | "NOK"
+  | "NZD"
+  | "ZAR"
+  | "USD"
+  | "MXN"
+  | "ILS"
+  | "GBP"
+  | "KRW"
+  | "MYR";
+
 export interface Price {
   currency?: string;
   total?: string;
@@ -346,7 +381,7 @@ export interface BaseName {
 
 export interface ElementaryPrice {
   amount?: string;
-  currencyCode?: string;
+  currencyCode?: CurrencyCode;
 }
 
 export type Traveler = Stakeholder & {

src/types/amadeus/namespaces/shopping/flight-offers-search.ts

@@ -2,6 +2,7 @@ import { ReturnedResponseSuccess } from "../../client/response";
 import {
   CollectionMeta,
   CollectionMetaLink,
+  CurrencyCode,
   Dictionaries,
   FlightOffer,
   FlightOfferSource,
@@ -113,7 +114,7 @@ export type Coverage =
 
 // Types used in class
 export type FlightOffersSearchPostParams = {
-  currencyCode?: string;
+  currencyCode?: CurrencyCode;
   originDestinations: OriginDestination[];
   travelers: ExtendedTravelerInfo[];
   sources: FlightOfferSource[];
@@ -139,7 +140,7 @@ export type FlightOffersSearchGetParams = {
   includedAirlineCodes?: string;
   excludedAirlineCodes?: string;
   nonStop?: boolean;
-  currencyCode?: string;
+  currencyCode?: CurrencyCode;
   maxPrice?: number;
   max?: number;
 };

src/types/amadeus/namespaces/shopping/flight-offers/upselling.ts

@@ -21,6 +21,7 @@ export interface CollectionMetaUpsell {
   }[];
 }
 
+// Types used in class
 export type FlightOffersUpsellingParams = {
   data: FlightOfferUpsellIn;
 };

tests/amadeus/namespaces.test.ts

@@ -328,7 +328,7 @@ describe("Namespaces", () => {
 
     it(".amadeus.analytics.itineraryPriceMetrics.get", () => {
       amadeus["client"].get = vi.fn();
-      amadeus.analytics.itineraryPriceMetrics.get();
+      amadeus.analytics.itineraryPriceMetrics.get({} as any);
       expect(amadeus["client"].get).toHaveBeenCalledWith(
         "/v1/analytics/itinerary-price-metrics",
         {}