yc-types
Version:
TypeScript types and interfaces for YellowCard protobuf definitions
170 lines (169 loc) • 5.6 kB
TypeScript
import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
import { Metadata } from "./common";
export declare const protobufPackage = "pb";
export interface Setting {
id: string;
module: string;
organizationId: string;
settings: {
[key: string]: string;
};
isSystem: boolean;
isEncrypted: boolean;
description: string;
createdAt: Date | undefined;
updatedAt: Date | undefined;
}
export interface Setting_SettingsEntry {
key: string;
value: string;
}
export interface PublicSettingsResponse {
vaccinationAmount: string;
showVerificationStatus: string;
maintainanceMode: string;
maxLoginAttempt: string;
}
export interface SettingValue {
key: string;
value: string;
type: string;
}
export interface SettingsModule {
module: string;
values: SettingValue[];
}
export interface Report {
id: string;
reportType: string;
reportName: string;
description: string;
frequency: string;
isActive: boolean;
lastGenerated: Date | undefined;
nextGeneration: Date | undefined;
fileFormat: string;
retentionDays: number;
createdAt: Date | undefined;
updatedAt: Date | undefined;
}
export interface ReportGeneration {
id: string;
reportId: string;
generatedAt: Date | undefined;
status: string;
filePath: string;
fileSize: number;
errorMessage: string;
reportName: string;
reportType: string;
processingTimeMs: number;
}
export interface GetSettingsRequest {
module: string;
}
export interface GetSettingsResponse {
settings: Setting[];
}
export interface UpdateSettingsRequest {
module: string;
settings: {
[key: string]: string;
};
}
export interface UpdateSettingsRequest_SettingsEntry {
key: string;
value: string;
}
export interface UpdateSettingsResponse {
setting: Setting | undefined;
message: string;
}
export interface CreateSettingRequest {
module: string;
organizationId: string;
settings: {
[key: string]: string;
};
isSystem: boolean;
isEncrypted: boolean;
description: string;
}
export interface CreateSettingRequest_SettingsEntry {
key: string;
value: string;
}
export interface GetReportsRequest {
reportType: string;
}
export interface GenerateReportRequest {
reportType: string;
format: string;
parameters: {
[key: string]: string;
};
}
export interface GenerateReportRequest_ParametersEntry {
key: string;
value: string;
}
export interface GenerateReportResponse {
reportId: string;
status: string;
message: string;
}
export interface ListSettingsResponse {
status: number;
settings: Setting[];
meta: Metadata | undefined;
}
export interface ListReportResponse {
status: number;
reports: Report[];
meta: Metadata | undefined;
}
export interface ListReportGenerationsResponse {
status: number;
reportGenerations: ReportGeneration[];
meta: Metadata | undefined;
}
export declare const Setting: MessageFns<Setting>;
export declare const Setting_SettingsEntry: MessageFns<Setting_SettingsEntry>;
export declare const PublicSettingsResponse: MessageFns<PublicSettingsResponse>;
export declare const SettingValue: MessageFns<SettingValue>;
export declare const SettingsModule: MessageFns<SettingsModule>;
export declare const Report: MessageFns<Report>;
export declare const ReportGeneration: MessageFns<ReportGeneration>;
export declare const GetSettingsRequest: MessageFns<GetSettingsRequest>;
export declare const GetSettingsResponse: MessageFns<GetSettingsResponse>;
export declare const UpdateSettingsRequest: MessageFns<UpdateSettingsRequest>;
export declare const UpdateSettingsRequest_SettingsEntry: MessageFns<UpdateSettingsRequest_SettingsEntry>;
export declare const UpdateSettingsResponse: MessageFns<UpdateSettingsResponse>;
export declare const CreateSettingRequest: MessageFns<CreateSettingRequest>;
export declare const CreateSettingRequest_SettingsEntry: MessageFns<CreateSettingRequest_SettingsEntry>;
export declare const GetReportsRequest: MessageFns<GetReportsRequest>;
export declare const GenerateReportRequest: MessageFns<GenerateReportRequest>;
export declare const GenerateReportRequest_ParametersEntry: MessageFns<GenerateReportRequest_ParametersEntry>;
export declare const GenerateReportResponse: MessageFns<GenerateReportResponse>;
export declare const ListSettingsResponse: MessageFns<ListSettingsResponse>;
export declare const ListReportResponse: MessageFns<ListReportResponse>;
export declare const ListReportGenerationsResponse: MessageFns<ListReportGenerationsResponse>;
type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
export type DeepPartial<T> = T extends Builtin ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {
[K in keyof T]?: DeepPartial<T[K]>;
} : Partial<T>;
type KeysOfUnion<T> = T extends T ? keyof T : never;
export type Exact<P, I extends P> = P extends Builtin ? P : P & {
[K in keyof P]: Exact<P[K], I[K]>;
} & {
[K in Exclude<keyof I, KeysOfUnion<P>>]: never;
};
export interface MessageFns<T> {
encode(message: T, writer?: BinaryWriter): BinaryWriter;
decode(input: BinaryReader | Uint8Array, length?: number): T;
fromJSON(object: any): T;
toJSON(message: T): unknown;
create<I extends Exact<DeepPartial<T>, I>>(base?: I): T;
fromPartial<I extends Exact<DeepPartial<T>, I>>(object: I): T;
}
export {};