@fenixalliance/abs-api-client 1.0.16 → 1.1.0

package/schemas/forexService/schema.s.ts

@@ -6,142 +6,32 @@
 
 export interface paths {
   "/api/v2/ForexService/Exchange/Latest": {
-    get: {
-      parameters: {
-        query: {
-          amount: number;
-          sourceCurrencyId: string;
-          targetCurrencyId: string;
-        };
-      };
-      responses: {
-        /** @description OK */
-        200: {
-          content: {
-            "application/json": components["schemas"]["MoneyEnvelope"];
-            "application/xml": components["schemas"]["MoneyEnvelope"];
-          };
-        };
-        /** @description Unauthorized */
-        401: {
-          content: {
-            "application/json": components["schemas"]["ErrorEnvelope"];
-            "application/xml": components["schemas"]["ErrorEnvelope"];
-          };
-        };
-        /** @description Forbidden */
-        403: {
-          content: {
-            "application/json": components["schemas"]["ErrorEnvelope"];
-            "application/xml": components["schemas"]["ErrorEnvelope"];
-          };
-        };
-      };
-    };
+    /**
+     * Exchange currency at latest rates
+     * @description Exchange an amount of money from one currency to another using the latest available exchange rates.
+     */
+    get: operations["ExchangeAmountAsync"];
   };
   "/api/v2/ForexService/Exchange/History": {
-    get: {
-      parameters: {
-        query: {
-          amount: number;
-          sourceCurrencyId: string;
-          targetCurrencyId: string;
-          date: string;
-        };
-      };
-      responses: {
-        /** @description OK */
-        200: {
-          content: {
-            "application/json": components["schemas"]["MoneyEnvelope"];
-            "application/xml": components["schemas"]["MoneyEnvelope"];
-          };
-        };
-        /** @description Unauthorized */
-        401: {
-          content: {
-            "application/json": components["schemas"]["ErrorEnvelope"];
-            "application/xml": components["schemas"]["ErrorEnvelope"];
-          };
-        };
-        /** @description Forbidden */
-        403: {
-          content: {
-            "application/json": components["schemas"]["ErrorEnvelope"];
-            "application/xml": components["schemas"]["ErrorEnvelope"];
-          };
-        };
-      };
-    };
+    /**
+     * Exchange currency at historical rates
+     * @description Exchange an amount of money from one currency to another using exchange rates from a specific historical date.
+     */
+    get: operations["ExchangeAmountHistoricalAsync"];
   };
   "/api/v3/ForexService/Exchange/Latest": {
-    get: {
-      parameters: {
-        query: {
-          amount: number;
-          sourceCurrencyId: string;
-          targetCurrencyId: string;
-        };
-      };
-      responses: {
-        /** @description OK */
-        200: {
-          content: {
-            "application/json": components["schemas"]["ExchangeRateEnvelope"];
-            "application/xml": components["schemas"]["ExchangeRateEnvelope"];
-          };
-        };
-        /** @description Unauthorized */
-        401: {
-          content: {
-            "application/json": components["schemas"]["ErrorEnvelope"];
-            "application/xml": components["schemas"]["ErrorEnvelope"];
-          };
-        };
-        /** @description Forbidden */
-        403: {
-          content: {
-            "application/json": components["schemas"]["ErrorEnvelope"];
-            "application/xml": components["schemas"]["ErrorEnvelope"];
-          };
-        };
-      };
-    };
+    /**
+     * Exchange currency at latest rates (v3)
+     * @description Exchange an amount of money from one currency to another using the latest available exchange rates. Returns the full ExchangeRate details.
+     */
+    get: operations["ExchangeAmountV3Async"];
   };
   "/api/v3/ForexService/Exchange/History": {
-    get: {
-      parameters: {
-        query: {
-          amount: number;
-          sourceCurrencyId: string;
-          targetCurrencyId: string;
-          date: string;
-        };
-      };
-      responses: {
-        /** @description OK */
-        200: {
-          content: {
-            "application/json": components["schemas"]["ExchangeRateEnvelope"];
-            "application/xml": components["schemas"]["ExchangeRateEnvelope"];
-          };
-        };
-        /** @description Unauthorized */
-        401: {
-          content: {
-            "application/json": components["schemas"]["ErrorEnvelope"];
-            "application/xml": components["schemas"]["ErrorEnvelope"];
-          };
-        };
-        /** @description Forbidden */
-        403: {
-          content: {
-            "application/json": components["schemas"]["ErrorEnvelope"];
-            "application/xml": components["schemas"]["ErrorEnvelope"];
-          };
-        };
-      };
-    };
+    /**
+     * Exchange currency at historical rates (v3)
+     * @description Exchange an amount of money from one currency to another using exchange rates from a specific historical date. Returns the full ExchangeRate details.
+     */
+    get: operations["ExchangeAmountHistoricalV3Async"];
   };
   "/version": {
     get: {
@@ -369,152 +259,32 @@ export interface paths {
     };
   };
   "/api/v2/ForexService/Rates/Latest": {
-    get: {
-      parameters: {
-        query?: {
-          "api-version"?: string;
-        };
-        header?: {
-          "x-api-version"?: string;
-        };
-      };
-      responses: {
-        /** @description OK */
-        200: {
-          content: {
-            "application/json": components["schemas"]["ForexRatesDtoEnvelope"];
-            "application/xml": components["schemas"]["ForexRatesDtoEnvelope"];
-          };
-        };
-        /** @description Unauthorized */
-        401: {
-          content: {
-            "application/json": components["schemas"]["ErrorEnvelope"];
-            "application/xml": components["schemas"]["ErrorEnvelope"];
-          };
-        };
-        /** @description Forbidden */
-        403: {
-          content: {
-            "application/json": components["schemas"]["ErrorEnvelope"];
-            "application/xml": components["schemas"]["ErrorEnvelope"];
-          };
-        };
-      };
-    };
+    /**
+     * Get latest currency rates
+     * @description Retrieves the latest exchange rates for all supported currencies.
+     */
+    get: operations["GetLatestCurrencyRatesModelAsync"];
   };
   "/api/v2/ForexService/Rates/Latest/{currencyId}": {
-    get: {
-      parameters: {
-        query?: {
-          "api-version"?: string;
-        };
-        header?: {
-          "x-api-version"?: string;
-        };
-        path: {
-          currencyId: string;
-        };
-      };
-      responses: {
-        /** @description OK */
-        200: {
-          content: {
-            "application/json": components["schemas"]["ExchangeRateEnvelope"];
-            "application/xml": components["schemas"]["ExchangeRateEnvelope"];
-          };
-        };
-        /** @description Unauthorized */
-        401: {
-          content: {
-            "application/json": components["schemas"]["ErrorEnvelope"];
-            "application/xml": components["schemas"]["ErrorEnvelope"];
-          };
-        };
-        /** @description Forbidden */
-        403: {
-          content: {
-            "application/json": components["schemas"]["ErrorEnvelope"];
-            "application/xml": components["schemas"]["ErrorEnvelope"];
-          };
-        };
-      };
-    };
+    /**
+     * Get latest rate for a currency
+     * @description Retrieves the latest exchange rate for a specific currency by its identifier.
+     */
+    get: operations["GetLatestCurrencyRateAsync"];
   };
   "/api/v2/ForexService/Rates/History": {
-    get: {
-      parameters: {
-        query?: {
-          date?: string;
-          "api-version"?: string;
-        };
-        header?: {
-          "x-api-version"?: string;
-        };
-      };
-      responses: {
-        /** @description OK */
-        200: {
-          content: {
-            "application/json": components["schemas"]["ForexRatesDtoEnvelope"];
-            "application/xml": components["schemas"]["ForexRatesDtoEnvelope"];
-          };
-        };
-        /** @description Unauthorized */
-        401: {
-          content: {
-            "application/json": components["schemas"]["ErrorEnvelope"];
-            "application/xml": components["schemas"]["ErrorEnvelope"];
-          };
-        };
-        /** @description Forbidden */
-        403: {
-          content: {
-            "application/json": components["schemas"]["ErrorEnvelope"];
-            "application/xml": components["schemas"]["ErrorEnvelope"];
-          };
-        };
-      };
-    };
+    /**
+     * Get historical currency rates
+     * @description Retrieves exchange rates for all supported currencies as of a specific historical date.
+     */
+    get: operations["GetHistoricalCurrencyRatesAsync"];
   };
   "/api/v2/ForexService/Rates/History/{currencyId}": {
-    get: {
-      parameters: {
-        query?: {
-          date?: string;
-          "api-version"?: string;
-        };
-        header?: {
-          "x-api-version"?: string;
-        };
-        path: {
-          currencyId: string;
-        };
-      };
-      responses: {
-        /** @description OK */
-        200: {
-          content: {
-            "application/json": components["schemas"]["ExchangeRateEnvelope"];
-            "application/xml": components["schemas"]["ExchangeRateEnvelope"];
-          };
-        };
-        /** @description Unauthorized */
-        401: {
-          content: {
-            "application/json": components["schemas"]["ErrorEnvelope"];
-            "application/xml": components["schemas"]["ErrorEnvelope"];
-          };
-        };
-        /** @description Forbidden */
-        403: {
-          content: {
-            "application/json": components["schemas"]["ErrorEnvelope"];
-            "application/xml": components["schemas"]["ErrorEnvelope"];
-          };
-        };
-      };
-    };
+    /**
+     * Get historical rate for a currency
+     * @description Retrieves the exchange rate for a specific currency as of a specific historical date.
+     */
+    get: operations["GetHistoricalCurrencyRateAsync"];
   };
 }
 
@@ -530,6 +300,7 @@ export interface components {
       refreshToken: string | null;
     };
     CurrencyId: {
+      value?: string | null;
       code?: string | null;
       country?: string | null;
     };
@@ -664,6 +435,152 @@ export type external = Record<string, never>;
 
 export interface operations {
 
+  /**
+   * Exchange currency at latest rates
+   * @description Exchange an amount of money from one currency to another using the latest available exchange rates.
+   */
+  ExchangeAmountAsync: {
+    parameters: {
+      query: {
+        amount: number;
+        sourceCurrencyId: string;
+        targetCurrencyId: string;
+      };
+    };
+    responses: {
+      /** @description OK */
+      200: {
+        content: {
+          "application/json": components["schemas"]["MoneyEnvelope"];
+          "application/xml": components["schemas"]["MoneyEnvelope"];
+        };
+      };
+      /** @description Unauthorized */
+      401: {
+        content: {
+          "application/json": components["schemas"]["ErrorEnvelope"];
+          "application/xml": components["schemas"]["ErrorEnvelope"];
+        };
+      };
+      /** @description Forbidden */
+      403: {
+        content: {
+          "application/json": components["schemas"]["ErrorEnvelope"];
+          "application/xml": components["schemas"]["ErrorEnvelope"];
+        };
+      };
+    };
+  };
+  /**
+   * Exchange currency at historical rates
+   * @description Exchange an amount of money from one currency to another using exchange rates from a specific historical date.
+   */
+  ExchangeAmountHistoricalAsync: {
+    parameters: {
+      query: {
+        amount: number;
+        sourceCurrencyId: string;
+        targetCurrencyId: string;
+        date: string;
+      };
+    };
+    responses: {
+      /** @description OK */
+      200: {
+        content: {
+          "application/json": components["schemas"]["MoneyEnvelope"];
+          "application/xml": components["schemas"]["MoneyEnvelope"];
+        };
+      };
+      /** @description Unauthorized */
+      401: {
+        content: {
+          "application/json": components["schemas"]["ErrorEnvelope"];
+          "application/xml": components["schemas"]["ErrorEnvelope"];
+        };
+      };
+      /** @description Forbidden */
+      403: {
+        content: {
+          "application/json": components["schemas"]["ErrorEnvelope"];
+          "application/xml": components["schemas"]["ErrorEnvelope"];
+        };
+      };
+    };
+  };
+  /**
+   * Exchange currency at latest rates (v3)
+   * @description Exchange an amount of money from one currency to another using the latest available exchange rates. Returns the full ExchangeRate details.
+   */
+  ExchangeAmountV3Async: {
+    parameters: {
+      query: {
+        amount: number;
+        sourceCurrencyId: string;
+        targetCurrencyId: string;
+      };
+    };
+    responses: {
+      /** @description OK */
+      200: {
+        content: {
+          "application/json": components["schemas"]["ExchangeRateEnvelope"];
+          "application/xml": components["schemas"]["ExchangeRateEnvelope"];
+        };
+      };
+      /** @description Unauthorized */
+      401: {
+        content: {
+          "application/json": components["schemas"]["ErrorEnvelope"];
+          "application/xml": components["schemas"]["ErrorEnvelope"];
+        };
+      };
+      /** @description Forbidden */
+      403: {
+        content: {
+          "application/json": components["schemas"]["ErrorEnvelope"];
+          "application/xml": components["schemas"]["ErrorEnvelope"];
+        };
+      };
+    };
+  };
+  /**
+   * Exchange currency at historical rates (v3)
+   * @description Exchange an amount of money from one currency to another using exchange rates from a specific historical date. Returns the full ExchangeRate details.
+   */
+  ExchangeAmountHistoricalV3Async: {
+    parameters: {
+      query: {
+        amount: number;
+        sourceCurrencyId: string;
+        targetCurrencyId: string;
+        date: string;
+      };
+    };
+    responses: {
+      /** @description OK */
+      200: {
+        content: {
+          "application/json": components["schemas"]["ExchangeRateEnvelope"];
+          "application/xml": components["schemas"]["ExchangeRateEnvelope"];
+        };
+      };
+      /** @description Unauthorized */
+      401: {
+        content: {
+          "application/json": components["schemas"]["ErrorEnvelope"];
+          "application/xml": components["schemas"]["ErrorEnvelope"];
+        };
+      };
+      /** @description Forbidden */
+      403: {
+        content: {
+          "application/json": components["schemas"]["ErrorEnvelope"];
+          "application/xml": components["schemas"]["ErrorEnvelope"];
+        };
+      };
+    };
+  };
   "MapIdentityApi-/confirmEmail": {
     parameters: {
       query: {
@@ -679,4 +596,160 @@ export interface operations {
       };
     };
   };
+  /**
+   * Get latest currency rates
+   * @description Retrieves the latest exchange rates for all supported currencies.
+   */
+  GetLatestCurrencyRatesModelAsync: {
+    parameters: {
+      query?: {
+        "api-version"?: string;
+      };
+      header?: {
+        "x-api-version"?: string;
+      };
+    };
+    responses: {
+      /** @description OK */
+      200: {
+        content: {
+          "application/json": components["schemas"]["ForexRatesDtoEnvelope"];
+          "application/xml": components["schemas"]["ForexRatesDtoEnvelope"];
+        };
+      };
+      /** @description Unauthorized */
+      401: {
+        content: {
+          "application/json": components["schemas"]["ErrorEnvelope"];
+          "application/xml": components["schemas"]["ErrorEnvelope"];
+        };
+      };
+      /** @description Forbidden */
+      403: {
+        content: {
+          "application/json": components["schemas"]["ErrorEnvelope"];
+          "application/xml": components["schemas"]["ErrorEnvelope"];
+        };
+      };
+    };
+  };
+  /**
+   * Get latest rate for a currency
+   * @description Retrieves the latest exchange rate for a specific currency by its identifier.
+   */
+  GetLatestCurrencyRateAsync: {
+    parameters: {
+      query?: {
+        "api-version"?: string;
+      };
+      header?: {
+        "x-api-version"?: string;
+      };
+      path: {
+        currencyId: string;
+      };
+    };
+    responses: {
+      /** @description OK */
+      200: {
+        content: {
+          "application/json": components["schemas"]["ExchangeRateEnvelope"];
+          "application/xml": components["schemas"]["ExchangeRateEnvelope"];
+        };
+      };
+      /** @description Unauthorized */
+      401: {
+        content: {
+          "application/json": components["schemas"]["ErrorEnvelope"];
+          "application/xml": components["schemas"]["ErrorEnvelope"];
+        };
+      };
+      /** @description Forbidden */
+      403: {
+        content: {
+          "application/json": components["schemas"]["ErrorEnvelope"];
+          "application/xml": components["schemas"]["ErrorEnvelope"];
+        };
+      };
+    };
+  };
+  /**
+   * Get historical currency rates
+   * @description Retrieves exchange rates for all supported currencies as of a specific historical date.
+   */
+  GetHistoricalCurrencyRatesAsync: {
+    parameters: {
+      query?: {
+        date?: string;
+        "api-version"?: string;
+      };
+      header?: {
+        "x-api-version"?: string;
+      };
+    };
+    responses: {
+      /** @description OK */
+      200: {
+        content: {
+          "application/json": components["schemas"]["ForexRatesDtoEnvelope"];
+          "application/xml": components["schemas"]["ForexRatesDtoEnvelope"];
+        };
+      };
+      /** @description Unauthorized */
+      401: {
+        content: {
+          "application/json": components["schemas"]["ErrorEnvelope"];
+          "application/xml": components["schemas"]["ErrorEnvelope"];
+        };
+      };
+      /** @description Forbidden */
+      403: {
+        content: {
+          "application/json": components["schemas"]["ErrorEnvelope"];
+          "application/xml": components["schemas"]["ErrorEnvelope"];
+        };
+      };
+    };
+  };
+  /**
+   * Get historical rate for a currency
+   * @description Retrieves the exchange rate for a specific currency as of a specific historical date.
+   */
+  GetHistoricalCurrencyRateAsync: {
+    parameters: {
+      query?: {
+        date?: string;
+        "api-version"?: string;
+      };
+      header?: {
+        "x-api-version"?: string;
+      };
+      path: {
+        currencyId: string;
+      };
+    };
+    responses: {
+      /** @description OK */
+      200: {
+        content: {
+          "application/json": components["schemas"]["ExchangeRateEnvelope"];
+          "application/xml": components["schemas"]["ExchangeRateEnvelope"];
+        };
+      };
+      /** @description Unauthorized */
+      401: {
+        content: {
+          "application/json": components["schemas"]["ErrorEnvelope"];
+          "application/xml": components["schemas"]["ErrorEnvelope"];
+        };
+      };
+      /** @description Forbidden */
+      403: {
+        content: {
+          "application/json": components["schemas"]["ErrorEnvelope"];
+          "application/xml": components["schemas"]["ErrorEnvelope"];
+        };
+      };
+    };
+  };
 }