@stadar/sdk 0.1.7

package/src/apis/AccountApi.ts

@@ -0,0 +1,474 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Stadar Esports Data API
+ * Read-only, betting-friendly esports data across all major competitive titles. Flat-tier pricing (no per-game gates), Polar- billed subscriptions (Merchant of Record), sandbox keys for evaluation. See https://stadar.net for tier pricing. All endpoints under `/v1/...`. The version in `info.version` matches the URL prefix; non-breaking field additions ship in `/v1`, breaking changes get a `/v2`. We commit to 24 months of `/v1` support after `/v2` ships. Times are UTC end-to-end (RFC 3339). Localization is the client\'s problem. Cursors are opaque base64 strings; treat them as such. 
+ *
+ * The version of the OpenAPI document: v1
+ * Contact: api@stadar.net
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import * as runtime from '../runtime';
+import {
+    type AccountCreateKey201Response,
+    AccountCreateKey201ResponseFromJSON,
+    AccountCreateKey201ResponseToJSON,
+} from '../models/AccountCreateKey201Response';
+import {
+    type AccountCreateKeyRequest,
+    AccountCreateKeyRequestFromJSON,
+    AccountCreateKeyRequestToJSON,
+} from '../models/AccountCreateKeyRequest';
+import {
+    type AccountListKeys200Response,
+    AccountListKeys200ResponseFromJSON,
+    AccountListKeys200ResponseToJSON,
+} from '../models/AccountListKeys200Response';
+import {
+    type AccountMeCapabilities200Response,
+    AccountMeCapabilities200ResponseFromJSON,
+    AccountMeCapabilities200ResponseToJSON,
+} from '../models/AccountMeCapabilities200Response';
+import {
+    type AccountUsageRecent200Response,
+    AccountUsageRecent200ResponseFromJSON,
+    AccountUsageRecent200ResponseToJSON,
+} from '../models/AccountUsageRecent200Response';
+import {
+    type ErrorEnvelope,
+    ErrorEnvelopeFromJSON,
+    ErrorEnvelopeToJSON,
+} from '../models/ErrorEnvelope';
+import {
+    type UsageToday,
+    UsageTodayFromJSON,
+    UsageTodayToJSON,
+} from '../models/UsageToday';
+
+export interface AccountCreateKeyOperationRequest {
+    accountCreateKeyRequest: AccountCreateKeyRequest;
+    mode?: AccountCreateKeyOperationModeEnum;
+}
+
+export interface AccountDeleteKeyRequest {
+    id: number;
+}
+
+/**
+ * AccountApi - interface
+ * 
+ * @export
+ * @interface AccountApiInterface
+ */
+export interface AccountApiInterface {
+    /**
+     * Creates request options for accountCreateKey without sending the request
+     * @param {AccountCreateKeyRequest} accountCreateKeyRequest 
+     * @param {'live' | 'sandbox'} [mode] `live` (default) returns a production `esp_live_<22>` key. `sandbox` returns an `esp_test_<22>` key. Sandbox keys hit the fixture-only schema and never burn production quota. 
+     * @throws {RequiredError}
+     * @memberof AccountApiInterface
+     */
+    accountCreateKeyRequestOpts(requestParameters: AccountCreateKeyOperationRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Generates a new key. The raw key is returned in the response EXACTLY ONCE — save it; subsequent calls only return the non-secret summary. Sandbox keys (`?mode=sandbox`) mint with prefix `esp_test_` and route to the curated fixture set (`esports_sandbox` schema, separate quota counter). 
+     * @summary Mint a new API key
+     * @param {AccountCreateKeyRequest} accountCreateKeyRequest 
+     * @param {'live' | 'sandbox'} [mode] &#x60;live&#x60; (default) returns a production &#x60;esp_live_&lt;22&gt;&#x60; key. &#x60;sandbox&#x60; returns an &#x60;esp_test_&lt;22&gt;&#x60; key. Sandbox keys hit the fixture-only schema and never burn production quota. 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AccountApiInterface
+     */
+    accountCreateKeyRaw(requestParameters: AccountCreateKeyOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AccountCreateKey201Response>>;
+
+    /**
+     * Generates a new key. The raw key is returned in the response EXACTLY ONCE — save it; subsequent calls only return the non-secret summary. Sandbox keys (`?mode=sandbox`) mint with prefix `esp_test_` and route to the curated fixture set (`esports_sandbox` schema, separate quota counter). 
+     * Mint a new API key
+     */
+    accountCreateKey(requestParameters: AccountCreateKeyOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccountCreateKey201Response>;
+
+    /**
+     * Creates request options for accountDeleteKey without sending the request
+     * @param {number} id 
+     * @throws {RequiredError}
+     * @memberof AccountApiInterface
+     */
+    accountDeleteKeyRequestOpts(requestParameters: AccountDeleteKeyRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * 
+     * @summary Revoke an API key
+     * @param {number} id 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AccountApiInterface
+     */
+    accountDeleteKeyRaw(requestParameters: AccountDeleteKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Revoke an API key
+     */
+    accountDeleteKey(requestParameters: AccountDeleteKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+    /**
+     * Creates request options for accountListKeys without sending the request
+     * @throws {RequiredError}
+     * @memberof AccountApiInterface
+     */
+    accountListKeysRequestOpts(): Promise<runtime.RequestOpts>;
+
+    /**
+     * Returns the non-secret summary of every active key (id, name, prefix, created_at, last_used_at). Revoked keys are excluded. 
+     * @summary List API keys
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AccountApiInterface
+     */
+    accountListKeysRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AccountListKeys200Response>>;
+
+    /**
+     * Returns the non-secret summary of every active key (id, name, prefix, created_at, last_used_at). Revoked keys are excluded. 
+     * List API keys
+     */
+    accountListKeys(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccountListKeys200Response>;
+
+    /**
+     * Creates request options for accountMeCapabilities without sending the request
+     * @throws {RequiredError}
+     * @memberof AccountApiInterface
+     */
+    accountMeCapabilitiesRequestOpts(): Promise<runtime.RequestOpts>;
+
+    /**
+     * Returns the calling user\'s current tier and the list of capability tokens unlocked. SDK consumers call this to surface \"why am I getting a 402\" without guessing — the envelope\'s `data.capabilities` is authoritative. 
+     * @summary Effective capabilities for the calling user
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AccountApiInterface
+     */
+    accountMeCapabilitiesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AccountMeCapabilities200Response>>;
+
+    /**
+     * Returns the calling user\'s current tier and the list of capability tokens unlocked. SDK consumers call this to surface \"why am I getting a 402\" without guessing — the envelope\'s `data.capabilities` is authoritative. 
+     * Effective capabilities for the calling user
+     */
+    accountMeCapabilities(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccountMeCapabilities200Response>;
+
+    /**
+     * Creates request options for accountUsageRecent without sending the request
+     * @throws {RequiredError}
+     * @memberof AccountApiInterface
+     */
+    accountUsageRecentRequestOpts(): Promise<runtime.RequestOpts>;
+
+    /**
+     * Returns the last 50 logged requests for the calling user\'s API keys. Content-negotiates: `Accept: text/event-stream` upgrades to SSE; default JSON. 
+     * @summary Recent request log
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AccountApiInterface
+     */
+    accountUsageRecentRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AccountUsageRecent200Response>>;
+
+    /**
+     * Returns the last 50 logged requests for the calling user\'s API keys. Content-negotiates: `Accept: text/event-stream` upgrades to SSE; default JSON. 
+     * Recent request log
+     */
+    accountUsageRecent(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccountUsageRecent200Response>;
+
+    /**
+     * Creates request options for accountUsageToday without sending the request
+     * @throws {RequiredError}
+     * @memberof AccountApiInterface
+     */
+    accountUsageTodayRequestOpts(): Promise<runtime.RequestOpts>;
+
+    /**
+     * Returns `{count, quota, pct, tier, resets_at_utc}` for the current UTC day. Reads the Redis counter the Quota middleware writes — same source of truth as the rate limiter. 
+     * @summary Today\'s quota counter
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AccountApiInterface
+     */
+    accountUsageTodayRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UsageToday>>;
+
+    /**
+     * Returns `{count, quota, pct, tier, resets_at_utc}` for the current UTC day. Reads the Redis counter the Quota middleware writes — same source of truth as the rate limiter. 
+     * Today\'s quota counter
+     */
+    accountUsageToday(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UsageToday>;
+
+}
+
+/**
+ * 
+ */
+export class AccountApi extends runtime.BaseAPI implements AccountApiInterface {
+
+    /**
+     * Creates request options for accountCreateKey without sending the request
+     */
+    async accountCreateKeyRequestOpts(requestParameters: AccountCreateKeyOperationRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['accountCreateKeyRequest'] == null) {
+            throw new runtime.RequiredError(
+                'accountCreateKeyRequest',
+                'Required parameter "accountCreateKeyRequest" was null or undefined when calling accountCreateKey().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['mode'] != null) {
+            queryParameters['mode'] = requestParameters['mode'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/v1/account/keys`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: AccountCreateKeyRequestToJSON(requestParameters['accountCreateKeyRequest']),
+        };
+    }
+
+    /**
+     * Generates a new key. The raw key is returned in the response EXACTLY ONCE — save it; subsequent calls only return the non-secret summary. Sandbox keys (`?mode=sandbox`) mint with prefix `esp_test_` and route to the curated fixture set (`esports_sandbox` schema, separate quota counter). 
+     * Mint a new API key
+     */
+    async accountCreateKeyRaw(requestParameters: AccountCreateKeyOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AccountCreateKey201Response>> {
+        const requestOptions = await this.accountCreateKeyRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => AccountCreateKey201ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Generates a new key. The raw key is returned in the response EXACTLY ONCE — save it; subsequent calls only return the non-secret summary. Sandbox keys (`?mode=sandbox`) mint with prefix `esp_test_` and route to the curated fixture set (`esports_sandbox` schema, separate quota counter). 
+     * Mint a new API key
+     */
+    async accountCreateKey(requestParameters: AccountCreateKeyOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccountCreateKey201Response> {
+        const response = await this.accountCreateKeyRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for accountDeleteKey without sending the request
+     */
+    async accountDeleteKeyRequestOpts(requestParameters: AccountDeleteKeyRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling accountDeleteKey().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/v1/account/keys/{id}`;
+        urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
+
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Revoke an API key
+     */
+    async accountDeleteKeyRaw(requestParameters: AccountDeleteKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.accountDeleteKeyRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Revoke an API key
+     */
+    async accountDeleteKey(requestParameters: AccountDeleteKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.accountDeleteKeyRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Creates request options for accountListKeys without sending the request
+     */
+    async accountListKeysRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/v1/account/keys`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Returns the non-secret summary of every active key (id, name, prefix, created_at, last_used_at). Revoked keys are excluded. 
+     * List API keys
+     */
+    async accountListKeysRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AccountListKeys200Response>> {
+        const requestOptions = await this.accountListKeysRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => AccountListKeys200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Returns the non-secret summary of every active key (id, name, prefix, created_at, last_used_at). Revoked keys are excluded. 
+     * List API keys
+     */
+    async accountListKeys(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccountListKeys200Response> {
+        const response = await this.accountListKeysRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for accountMeCapabilities without sending the request
+     */
+    async accountMeCapabilitiesRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/v1/account/me/capabilities`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Returns the calling user\'s current tier and the list of capability tokens unlocked. SDK consumers call this to surface \"why am I getting a 402\" without guessing — the envelope\'s `data.capabilities` is authoritative. 
+     * Effective capabilities for the calling user
+     */
+    async accountMeCapabilitiesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AccountMeCapabilities200Response>> {
+        const requestOptions = await this.accountMeCapabilitiesRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => AccountMeCapabilities200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Returns the calling user\'s current tier and the list of capability tokens unlocked. SDK consumers call this to surface \"why am I getting a 402\" without guessing — the envelope\'s `data.capabilities` is authoritative. 
+     * Effective capabilities for the calling user
+     */
+    async accountMeCapabilities(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccountMeCapabilities200Response> {
+        const response = await this.accountMeCapabilitiesRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for accountUsageRecent without sending the request
+     */
+    async accountUsageRecentRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/v1/account/usage/recent`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Returns the last 50 logged requests for the calling user\'s API keys. Content-negotiates: `Accept: text/event-stream` upgrades to SSE; default JSON. 
+     * Recent request log
+     */
+    async accountUsageRecentRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AccountUsageRecent200Response>> {
+        const requestOptions = await this.accountUsageRecentRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => AccountUsageRecent200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Returns the last 50 logged requests for the calling user\'s API keys. Content-negotiates: `Accept: text/event-stream` upgrades to SSE; default JSON. 
+     * Recent request log
+     */
+    async accountUsageRecent(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccountUsageRecent200Response> {
+        const response = await this.accountUsageRecentRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for accountUsageToday without sending the request
+     */
+    async accountUsageTodayRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/v1/account/usage/today`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Returns `{count, quota, pct, tier, resets_at_utc}` for the current UTC day. Reads the Redis counter the Quota middleware writes — same source of truth as the rate limiter. 
+     * Today\'s quota counter
+     */
+    async accountUsageTodayRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UsageToday>> {
+        const requestOptions = await this.accountUsageTodayRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => UsageTodayFromJSON(jsonValue));
+    }
+
+    /**
+     * Returns `{count, quota, pct, tier, resets_at_utc}` for the current UTC day. Reads the Redis counter the Quota middleware writes — same source of truth as the rate limiter. 
+     * Today\'s quota counter
+     */
+    async accountUsageToday(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UsageToday> {
+        const response = await this.accountUsageTodayRaw(initOverrides);
+        return await response.value();
+    }
+
+}
+
+/**
+ * @export
+ */
+export const AccountCreateKeyOperationModeEnum = {
+    Live: 'live',
+    Sandbox: 'sandbox'
+} as const;
+export type AccountCreateKeyOperationModeEnum = typeof AccountCreateKeyOperationModeEnum[keyof typeof AccountCreateKeyOperationModeEnum];