voltra-hub-api-client
Version:
A Voltra Hub API Client
306 lines (304 loc) • 9.4 kB
TypeScript
/**
* This file was auto-generated by openapi-typescript.
* Do not make direct changes to the file.
*/
export interface paths {
"/health-check": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Health check endpoint */
get: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Correct response indicating that the server is alive */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["response.model"] & {
data: number;
};
};
};
};
};
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/pvpc": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get a PVPC price for a given date */
get: {
parameters: {
query: {
date: string;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Correct response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["response.model"] & {
data: components["schemas"]["pvpc.model"];
};
};
};
/** @description Internal server error */
500: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["internal-server-error-response.model"];
};
};
};
};
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/indicator/pvpc": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get a indicator for a given date */
get: {
parameters: {
query: {
date: string;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Correct response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["response.model"] & {
data: components["schemas"]["indicator.model"];
};
};
};
/** @description Internal server error */
500: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["internal-server-error-response.model"];
};
};
};
};
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/indicator/spot": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get a indicator for a given date */
get: {
parameters: {
query: {
date: string;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Correct response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["response.model"] & {
data: components["schemas"]["indicator.model"];
};
};
};
/** @description Internal server error */
500: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["internal-server-error-response.model"];
};
};
};
};
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
}
export type webhooks = Record<string, never>;
export interface components {
schemas: {
"id-request.model": {
/** @example f0a6f400-be55-42ae-9545-1bcba9b69b99 */
uuid: string;
};
"response.model": {
/** @example 200 */
code: number;
/** @example 1707947871721 */
timestamp: number;
};
"pvpc.model": {
/** @example c0a8433f-d6b1-4f38-a94a-2c9a0d0c1c4d */
uuid: string;
/** @example 1679022000000 */
createdAt: number;
/** @example 1679022000000 */
updatedAt: number;
/** @example 2025-09-22 */
date: string;
general: {
hours: {
/** @example 2025-09-21T22:00:00.000Z */
date: string;
/** @example 0 */
hour: number;
/** @example 99.81 */
price: number;
}[];
min: {
/** @example 2025-09-21T22:00:00.000Z */
date: string;
/** @example 14 */
hour: number;
/** @example 77.58 */
price: number;
};
max: {
/** @example 2025-09-21T22:00:00.000Z */
date: string;
/** @example 20 */
hour: number;
/** @example 273.31 */
price: number;
};
/** @example 136.17625 */
average: number;
};
special: {
hours: {
/** @example 2025-09-21T22:00:00.000Z */
date: string;
/** @example 0 */
hour: number;
/** @example 99.81 */
price: number;
}[];
min: {
/** @example 2025-09-21T22:00:00.000Z */
date: string;
/** @example 15 */
hour: number;
/** @example 77.91 */
price: number;
};
max: {
/** @example 2025-09-21T22:00:00.000Z */
date: string;
/** @example 20 */
hour: number;
/** @example 273.31 */
price: number;
};
/** @example 136.187916666667 */
average: number;
};
};
"internal-server-error-response.model": components["schemas"]["response.model"] & {
/** @example Internal server error */
response: string;
/** @example 500 */
code?: number;
};
"indicator.model": {
/** Format: uuid */
uuid: string;
/** Format: int64 */
createdAt: number;
/** Format: int64 */
updatedAt: number;
geos: number[];
values: {
value: number;
dates: {
/** Format: date-time */
utc: string;
/** Format: date-time */
local: string;
};
geo: number;
}[];
};
};
responses: never;
parameters: never;
requestBodies: never;
headers: never;
pathItems: never;
}
export type $defs = Record<string, never>;
export type operations = Record<string, never>;