@kquika-inc/s-system 1.0.7 → 1.0.8

package/dist/sdk.gen.d.ts

@@ -1,5 +1,5 @@
 import type { Options as ClientOptions, TDataShape, Client } from '@hey-api/client-fetch';
-import type { ListFlightsData, GetFlightData, GetFlightMetricsData, GetRouteAnalyticsData, SearchFlightsData, RefreshFlightsData, GetAirportOverviewData, GetAirportHeatmapData, GetAirportCongestionData } from './types.gen';
+import type { ListFlightsData, GetFlightData, GetFlightMetricsData, GetRouteAnalyticsData, SearchFlightsData, RefreshFlightsData, GetAirportOverviewData, GetAirportHeatmapData, GetAirportCongestionData, GetUsageData } from './types.gen';
 export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = ClientOptions<TData, ThrowOnError> & {
     /**
      * You can provide a client instance returned by `createClient()` instead of
@@ -96,3 +96,12 @@ export declare const getAirportHeatmap: <ThrowOnError extends boolean = false>(o
  * immigration and customs.
  */
 export declare const getAirportCongestion: <ThrowOnError extends boolean = false>(options: Options<GetAirportCongestionData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").CongestionResponse, import("./types.gen").ErrorResponse, ThrowOnError>;
+/**
+ * Usage against your allowance
+ * Calls made this period, the allowance, and what remains.
+ *
+ * **Requires Standard.**
+ *
+ * Every response already carries the same position in its `quota` block and in the `X-Quota-*` headers, so polling this endpoint to watch consumption wastes the allowance it reports. Call it when you want the breakdown by endpoint, which headers cannot carry.
+ */
+export declare const getUsage: <ThrowOnError extends boolean = false>(options?: Options<GetUsageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").UsageResponse, import("./types.gen").ErrorResponse, ThrowOnError>;

package/dist/sdk.gen.js

@@ -182,3 +182,23 @@ export const getAirportCongestion = (options) => {
         ...options
     });
 };
+/**
+ * Usage against your allowance
+ * Calls made this period, the allowance, and what remains.
+ *
+ * **Requires Standard.**
+ *
+ * Every response already carries the same position in its `quota` block and in the `X-Quota-*` headers, so polling this endpoint to watch consumption wastes the allowance it reports. Call it when you want the breakdown by endpoint, which headers cannot carry.
+ */
+export const getUsage = (options) => {
+    return (options?.client ?? _heyApiClient).get({
+        security: [
+            {
+                name: 'X-API-Key',
+                type: 'apiKey'
+            }
+        ],
+        url: '/api/v1/usage',
+        ...options
+    });
+};

package/dist/types.gen.d.ts

@@ -16,6 +16,20 @@ export type Envelope = {
      * contract; branch on the HTTP status or on `error`.
      */
     message: string;
+    /**
+     * Your consumption after this call, on every response. A client can slow down before it is throttled rather than after: a quota you discover only by being refused is not a quota. Mirrored in the X-Quota-Remaining and X-RateLimit-Remaining headers, so a caller that does not parse the body still sees it.
+     */
+    quota?: {
+        /**
+         * Null on plans metered by rate rather than volume.
+         */
+        calls_remaining?: number | null;
+        percent_used?: number | null;
+        /**
+         * Requests left in the current minute.
+         */
+        rate_limit_remaining?: number | null;
+    };
 };
 export type Flight = {
     flight_number: string;
@@ -56,10 +70,13 @@ export type FlightListResponse = Envelope & {
         flights?: Array<Flight>;
         count?: number;
         /**
-         * Provenance of the returned records. `generated` indicates synthetic sample
-         * data.
+         * Provenance of the returned records. `generated` appears only when it was requested explicitly, since the default excludes it.
          */
         source?: 'live_feed' | 'database' | 'generated' | 'mixed';
+        /**
+         * Records matching the other filters but removed by `confidence`. With no filter this counts the generated rows the default excluded, so a non-zero value here on a default query means the feed is carrying synthetic data.
+         */
+        excluded_by_confidence?: number | null;
     };
 };
 export type FlightResponse = Envelope & {
@@ -179,10 +196,40 @@ export type ErrorResponse = Envelope & {
      */
     retry_after_seconds?: number | null;
 };
+export type UsageResponse = Envelope & {
+    data?: {
+        period_start?: string;
+        period_end?: string;
+        plan?: 'Standard' | 'Professional' | 'Enterprise';
+        calls_made?: number;
+        /**
+         * Monthly allowance. Null on plans metered by rate rather than volume, which is not the same as unlimited: the per-minute limit still applies.
+         */
+        calls_included?: number | null;
+        calls_remaining?: number | null;
+        percent_used?: number | null;
+        /**
+         * Where the calls went. The reason to call this endpoint.
+         */
+        by_endpoint?: Array<{
+            endpoint?: string;
+            calls?: number;
+        }>;
+        rate_limit_per_minute?: number;
+    };
+};
 /**
  * IATA code, three letters. Case insensitive.
  */
 export type AirportCode = string;
+/**
+ * Restrict to records of this provenance. Repeat the parameter for more than one value.
+ *
+ * **Defaults to `live_feed` and `database`.** Generated records must be asked for by name. A generated row filled a gap in the feed and carries a real carrier code on a route that carrier may not fly, so it does not reach a planner who did not ask for it.
+ *
+ * `count` reflects what was returned. `excluded_by_confidence` reports what the filter removed, so a small result can be told apart from a thin feed.
+ */
+export type Confidence = Array<'live_feed' | 'database' | 'generated'>;
 export type ListFlightsData = {
     body?: never;
     path?: never;
@@ -197,6 +244,14 @@ export type ListFlightsData = {
          */
         date?: string;
         limit?: number;
+        /**
+         * Restrict to records of this provenance. Repeat the parameter for more than one value.
+         *
+         * **Defaults to `live_feed` and `database`.** Generated records must be asked for by name. A generated row filled a gap in the feed and carries a real carrier code on a route that carrier may not fly, so it does not reach a planner who did not ask for it.
+         *
+         * `count` reflects what was returned. `excluded_by_confidence` reports what the filter removed, so a small result can be told apart from a thin feed.
+         */
+        confidence?: Array<'live_feed' | 'database' | 'generated'>;
     };
     url: '/api/v1/flights';
 };
@@ -310,6 +365,14 @@ export type SearchFlightsData = {
          */
         q: string;
         limit?: number;
+        /**
+         * Restrict to records of this provenance. Repeat the parameter for more than one value.
+         *
+         * **Defaults to `live_feed` and `database`.** Generated records must be asked for by name. A generated row filled a gap in the feed and carries a real carrier code on a route that carrier may not fly, so it does not reach a planner who did not ask for it.
+         *
+         * `count` reflects what was returned. `excluded_by_confidence` reports what the filter removed, so a small result can be told apart from a thin feed.
+         */
+        confidence?: Array<'live_feed' | 'database' | 'generated'>;
     };
     url: '/api/v1/flights/search';
 };
@@ -446,6 +509,26 @@ export type GetAirportCongestionResponses = {
     200: CongestionResponse;
 };
 export type GetAirportCongestionResponse = GetAirportCongestionResponses[keyof GetAirportCongestionResponses];
+export type GetUsageData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/api/v1/usage';
+};
+export type GetUsageErrors = {
+    /**
+     * Missing or invalid API key.
+     */
+    401: ErrorResponse;
+};
+export type GetUsageError = GetUsageErrors[keyof GetUsageErrors];
+export type GetUsageResponses = {
+    /**
+     * Usage for the current period.
+     */
+    200: UsageResponse;
+};
+export type GetUsageResponse = GetUsageResponses[keyof GetUsageResponses];
 export type ClientOptions = {
     baseUrl: 'https://www.s-system.cloud' | (string & {});
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kquika-inc/s-system",
-  "version": "1.0.7",
+  "version": "1.0.8",
   "description": "Predict flight disruption, price the passenger-rights exposure it carries, and rebook before it costs you.",
   "author": { "name": "Kquika, Inc.", "email": "support@kquika.com" },
   "homepage": "https://www.s-system.cloud/document",