yc-types
Version:
TypeScript types and interfaces for YellowCard protobuf definitions
262 lines (261 loc) • 18.8 kB
TypeScript
import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
import { GetAnalyticsRequest, GetAnalyticsResponse } from "./analytics";
import { ActivateApiLicenseRequest, ApiLicense, CreateApiLicenseRequest, CreateApiLicenseResponse, GetApiLicenseByKeyRequest, GetApiLicenseRequest, ListApiLicensesRequest, ListApiLicensesResponse, RevokeApiLicenseRequest, UpdateApiLicenseRequest } from "./api_license";
import { CreateUserRequest, LinkUserToIssuerRequest, LinkUserToStakeholderRequest, ListActiveSessionResponse, ListUserResponse, LoginRequest, RefreshTokenRequest, RevokeSessionRequest, Session, User } from "./auth_user";
import { GetBroadcastsRequest, GetBroadcastsResponse } from "./broadcasts";
import { APIAddVaccinationRequest, APIAddVaccinationResponse, APIGetCardRequest, APIGetCardResponse, APIGetVaccinationsResponse, APIListCardsResponse, APIListDiseasesResponse, APIListVaccinationBatchesResponse, APIListVaccinesResponse, APIRevokeCardRequest, BulkIssueYellowCardRequest, BulkIssueYellowCardResponse, IssueYellowCardRequest, IssueYellowCardResponse, VerifyChainCardRequest, VerifyChainCardResponse } from "./card";
import { Citizen, CreateCitizenRequest, ListCitizensResponse } from "./citizen";
import { GetIDRequest, GlobalResponse, ListDataRequest, Metadata } from "./common";
import { GetGeoDataRequest, GetGeoDataResponse } from "./geo";
import { HttpBody } from "./google/api/httpbody";
import { Empty } from "./google/protobuf/empty";
import { CreateIssuerRequest, GenerateIssuerKeyRequest, GenerateIssuerKeyResponse, GetIssuerKeyRequest, GetIssuerKeyResponse, Issuer, ListIssuerKeysRequest, ListIssuerKeysResponse, ListIssuersResponse, RevokeIssuerKeyRequest, RevokeIssuerKeyResponse } from "./issuer";
import { GetAllCardsResponse, GetCardHistoryRequest, GetCardHistoryResponse, UpdateCardStatusRequest, UpdateCardStatusResponse, YellowCard } from "./ledger";
import { GenerateOTPBatchRequest, GenerateOTPBatchResponse, GenerateOTPRequest, GenerateOTPResponse, GetCardPDFRequest, ProcessSyncQueueRequest, ProcessSyncQueueResponse, SyncOTPUsageRequest, SyncOTPUsageResponse, SyncQueueStatusRequest, SyncQueueStatusResponse, ValidateOTPRequest, ValidateOTPResponse } from "./otp_sync";
import { InitializePaymentRequest, InitializePaymentResponse, ListPaymentsResponse, Payment, PaymentStats, PaymentWebhookRequest, VerifyPaymentResponse } from "./payment";
import { CreateSettingRequest, GenerateReportRequest, GenerateReportResponse, GetReportsRequest, GetSettingsRequest, ListReportGenerationsResponse, ListReportResponse, ListSettingsResponse, PublicSettingsResponse, Report, ReportGeneration, Setting, UpdateSettingsRequest } from "./settings_report";
import { CreateStakeholderRequest, ListStakeholdersResponse, Stakeholder } from "./stakeholders";
export declare const protobufPackage = "pb";
export interface Lookup {
id: string;
name: string;
category: string;
createdAt: string;
updatedAt: string;
}
export interface CreateLookupRequest {
name: string;
category: string;
}
export interface ListLookupsByCategoryRequest {
category: string;
pageId: number;
pageSize: number;
}
export interface UpdateLookupRequest {
id: string;
name?: string | undefined;
category?: string | undefined;
}
export interface DeleteLookupRequest {
id: string;
}
export interface ListLookupsResponse {
status: number;
message: string;
lookups: Lookup[];
metadata: Metadata | undefined;
}
export declare const Lookup: MessageFns<Lookup>;
export declare const CreateLookupRequest: MessageFns<CreateLookupRequest>;
export declare const ListLookupsByCategoryRequest: MessageFns<ListLookupsByCategoryRequest>;
export declare const UpdateLookupRequest: MessageFns<UpdateLookupRequest>;
export declare const DeleteLookupRequest: MessageFns<DeleteLookupRequest>;
export declare const ListLookupsResponse: MessageFns<ListLookupsResponse>;
export interface YcServiceManagement {
LoginAPI(request: LoginRequest): Promise<Session>;
RefreshTokenAPI(request: RefreshTokenRequest): Promise<Session>;
RevokeSessionAPI(request: RevokeSessionRequest): Promise<GlobalResponse>;
ActivateSessionAPI(request: RevokeSessionRequest): Promise<GlobalResponse>;
LogoutAPI(request: GetIDRequest): Promise<GlobalResponse>;
ListActiveSessionsAPI(request: ListDataRequest): Promise<ListActiveSessionResponse>;
CreateUserAPI(request: CreateUserRequest): Promise<GlobalResponse>;
GetUserAPI(request: GetIDRequest): Promise<User>;
UpdateUserAPI(request: User): Promise<GlobalResponse>;
ListUsersAPI(request: ListDataRequest): Promise<ListUserResponse>;
DeleteUserAPI(request: GetIDRequest): Promise<GlobalResponse>;
LinkUserToIssuerAPI(request: LinkUserToIssuerRequest): Promise<GlobalResponse>;
LinkUserToStakeholderAPI(request: LinkUserToStakeholderRequest): Promise<GlobalResponse>;
CreateIssuerAPI(request: CreateIssuerRequest): Promise<GlobalResponse>;
GetIssuerAPI(request: GetIDRequest): Promise<Issuer>;
UpdateIssuerAPI(request: Issuer): Promise<GlobalResponse>;
ListIssuersAPI(request: ListDataRequest): Promise<ListIssuersResponse>;
DeleteIssuerAPI(request: GetIDRequest): Promise<GlobalResponse>;
CreateStakeholderAPI(request: CreateStakeholderRequest): Promise<GlobalResponse>;
IssueYellowCardAPI(request: IssueYellowCardRequest): Promise<IssueYellowCardResponse>;
BulkIssueYellowCardAPI(request: BulkIssueYellowCardRequest): Promise<BulkIssueYellowCardResponse>;
GetCard(request: APIGetCardRequest): Promise<APIGetCardResponse>;
ListCards(request: ListDataRequest): Promise<APIListCardsResponse>;
GetStakeholderAPI(request: GetIDRequest): Promise<Stakeholder>;
UpdateStakeholderAPI(request: Stakeholder): Promise<GlobalResponse>;
ListStakeholdersAPI(request: ListDataRequest): Promise<ListStakeholdersResponse>;
DeleteStakeholderAPI(request: GetIDRequest): Promise<GlobalResponse>;
CreateCitizenAPI(request: CreateCitizenRequest): Promise<GlobalResponse>;
GetCitizenAPI(request: GetIDRequest): Promise<Citizen>;
UpdateCitizenAPI(request: Citizen): Promise<GlobalResponse>;
ListCitizensAPI(request: ListDataRequest): Promise<ListCitizensResponse>;
DeleteCitizenAPI(request: GetIDRequest): Promise<GlobalResponse>;
VerifyChainCardAPI(request: VerifyChainCardRequest): Promise<VerifyChainCardResponse>;
AddVaccination(request: APIAddVaccinationRequest): Promise<APIAddVaccinationResponse>;
GetVaccinations(request: GetIDRequest): Promise<APIGetVaccinationsResponse>;
RevokeCard(request: APIRevokeCardRequest): Promise<GlobalResponse>;
ListVaccines(request: ListDataRequest): Promise<APIListVaccinesResponse>;
ListDiseases(request: ListDataRequest): Promise<APIListDiseasesResponse>;
ListVaccinationBatches(request: ListDataRequest): Promise<APIListVaccinationBatchesResponse>;
GetAllCards(request: ListDataRequest): Promise<GetAllCardsResponse>;
ReadCard(request: GetIDRequest): Promise<YellowCard>;
UpdateCardStatus(request: UpdateCardStatusRequest): Promise<UpdateCardStatusResponse>;
GetCardHistory(request: GetCardHistoryRequest): Promise<GetCardHistoryResponse>;
CreateIssuerKeyAPI(request: GenerateIssuerKeyRequest): Promise<GlobalResponse>;
GenerateIssuerKey(request: GenerateIssuerKeyRequest): Promise<GenerateIssuerKeyResponse>;
GetIssuerKey(request: GetIssuerKeyRequest): Promise<GetIssuerKeyResponse>;
ListIssuerKeys(request: ListIssuerKeysRequest): Promise<ListIssuerKeysResponse>;
RevokeIssuerKey(request: RevokeIssuerKeyRequest): Promise<RevokeIssuerKeyResponse>;
InitializePaymentAPI(request: InitializePaymentRequest): Promise<InitializePaymentResponse>;
VerifyPaymentAPI(request: GetIDRequest): Promise<VerifyPaymentResponse>;
GetPaymentAPI(request: GetIDRequest): Promise<Payment>;
ListPaymentsAPI(request: ListDataRequest): Promise<ListPaymentsResponse>;
HandlePaymentWebhookAPI(request: PaymentWebhookRequest): Promise<GlobalResponse>;
GetPaymentStatsAPI(request: Empty): Promise<PaymentStats>;
/** API License Management */
CreateApiLicensePayment(request: CreateApiLicenseRequest): Promise<CreateApiLicenseResponse>;
GetApiLicense(request: GetApiLicenseRequest): Promise<ApiLicense>;
GetApiLicenseByKey(request: GetApiLicenseByKeyRequest): Promise<ApiLicense>;
ListApiLicenses(request: ListApiLicensesRequest): Promise<ListApiLicensesResponse>;
UpdateApiLicense(request: UpdateApiLicenseRequest): Promise<ApiLicense>;
RevokeApiLicense(request: RevokeApiLicenseRequest): Promise<GlobalResponse>;
ActivateApiLicense(request: ActivateApiLicenseRequest): Promise<GlobalResponse>;
GetBroadcastsAPI(request: GetBroadcastsRequest): Promise<GetBroadcastsResponse>;
GetAnalytics(request: GetAnalyticsRequest): Promise<GetAnalyticsResponse>;
GetSystemSettings(request: GetSettingsRequest): Promise<ListSettingsResponse>;
GetSettingsByModule(request: GetSettingsRequest): Promise<Setting>;
UpdateSetting(request: UpdateSettingsRequest): Promise<GlobalResponse>;
/** Create a new settings row for an organization/module */
CreateSettingAPI(request: CreateSettingRequest): Promise<GlobalResponse>;
GetReports(request: GetReportsRequest): Promise<ListReportResponse>;
GetReportByType(request: GetReportsRequest): Promise<Report>;
GenerateReport(request: GenerateReportRequest): Promise<GenerateReportResponse>;
GetReportGeneration(request: GetIDRequest): Promise<ReportGeneration>;
GetReportGenerations(request: Empty): Promise<ListReportGenerationsResponse>;
GetPublicSettings(request: Empty): Promise<PublicSettingsResponse>;
GetGeoDataAPI(request: GetGeoDataRequest): Promise<GetGeoDataResponse>;
CreateLookupAPI(request: CreateLookupRequest): Promise<GlobalResponse>;
ListLookupsByCategoryAPI(request: ListLookupsByCategoryRequest): Promise<ListLookupsResponse>;
UpdateLookupAPI(request: UpdateLookupRequest): Promise<GlobalResponse>;
DeleteLookupAPI(request: DeleteLookupRequest): Promise<GlobalResponse>;
/** OTP Management APIs */
GenerateOTPAPI(request: GenerateOTPRequest): Promise<GenerateOTPResponse>;
ValidateOTPAPI(request: ValidateOTPRequest): Promise<ValidateOTPResponse>;
/** Sync Queue Management APIs */
SyncQueueStatusAPI(request: SyncQueueStatusRequest): Promise<SyncQueueStatusResponse>;
ProcessSyncQueueAPI(request: ProcessSyncQueueRequest): Promise<ProcessSyncQueueResponse>;
GetCardPDFAPI(request: GetCardPDFRequest): Promise<HttpBody>;
/** Offline OTP Pool Management */
GenerateOTPBatchAPI(request: GenerateOTPBatchRequest): Promise<GenerateOTPBatchResponse>;
SyncOTPUsageAPI(request: SyncOTPUsageRequest): Promise<SyncOTPUsageResponse>;
}
export declare const YcServiceManagementServiceName = "pb.YcServiceManagement";
export declare class YcServiceManagementClientImpl implements YcServiceManagement {
private readonly rpc;
private readonly service;
constructor(rpc: Rpc, opts?: {
service?: string;
});
LoginAPI(request: LoginRequest): Promise<Session>;
RefreshTokenAPI(request: RefreshTokenRequest): Promise<Session>;
RevokeSessionAPI(request: RevokeSessionRequest): Promise<GlobalResponse>;
ActivateSessionAPI(request: RevokeSessionRequest): Promise<GlobalResponse>;
LogoutAPI(request: GetIDRequest): Promise<GlobalResponse>;
ListActiveSessionsAPI(request: ListDataRequest): Promise<ListActiveSessionResponse>;
CreateUserAPI(request: CreateUserRequest): Promise<GlobalResponse>;
GetUserAPI(request: GetIDRequest): Promise<User>;
UpdateUserAPI(request: User): Promise<GlobalResponse>;
ListUsersAPI(request: ListDataRequest): Promise<ListUserResponse>;
DeleteUserAPI(request: GetIDRequest): Promise<GlobalResponse>;
LinkUserToIssuerAPI(request: LinkUserToIssuerRequest): Promise<GlobalResponse>;
LinkUserToStakeholderAPI(request: LinkUserToStakeholderRequest): Promise<GlobalResponse>;
CreateIssuerAPI(request: CreateIssuerRequest): Promise<GlobalResponse>;
GetIssuerAPI(request: GetIDRequest): Promise<Issuer>;
UpdateIssuerAPI(request: Issuer): Promise<GlobalResponse>;
ListIssuersAPI(request: ListDataRequest): Promise<ListIssuersResponse>;
DeleteIssuerAPI(request: GetIDRequest): Promise<GlobalResponse>;
CreateStakeholderAPI(request: CreateStakeholderRequest): Promise<GlobalResponse>;
IssueYellowCardAPI(request: IssueYellowCardRequest): Promise<IssueYellowCardResponse>;
BulkIssueYellowCardAPI(request: BulkIssueYellowCardRequest): Promise<BulkIssueYellowCardResponse>;
GetCard(request: APIGetCardRequest): Promise<APIGetCardResponse>;
ListCards(request: ListDataRequest): Promise<APIListCardsResponse>;
GetStakeholderAPI(request: GetIDRequest): Promise<Stakeholder>;
UpdateStakeholderAPI(request: Stakeholder): Promise<GlobalResponse>;
ListStakeholdersAPI(request: ListDataRequest): Promise<ListStakeholdersResponse>;
DeleteStakeholderAPI(request: GetIDRequest): Promise<GlobalResponse>;
CreateCitizenAPI(request: CreateCitizenRequest): Promise<GlobalResponse>;
GetCitizenAPI(request: GetIDRequest): Promise<Citizen>;
UpdateCitizenAPI(request: Citizen): Promise<GlobalResponse>;
ListCitizensAPI(request: ListDataRequest): Promise<ListCitizensResponse>;
DeleteCitizenAPI(request: GetIDRequest): Promise<GlobalResponse>;
VerifyChainCardAPI(request: VerifyChainCardRequest): Promise<VerifyChainCardResponse>;
AddVaccination(request: APIAddVaccinationRequest): Promise<APIAddVaccinationResponse>;
GetVaccinations(request: GetIDRequest): Promise<APIGetVaccinationsResponse>;
RevokeCard(request: APIRevokeCardRequest): Promise<GlobalResponse>;
ListVaccines(request: ListDataRequest): Promise<APIListVaccinesResponse>;
ListDiseases(request: ListDataRequest): Promise<APIListDiseasesResponse>;
ListVaccinationBatches(request: ListDataRequest): Promise<APIListVaccinationBatchesResponse>;
GetAllCards(request: ListDataRequest): Promise<GetAllCardsResponse>;
ReadCard(request: GetIDRequest): Promise<YellowCard>;
UpdateCardStatus(request: UpdateCardStatusRequest): Promise<UpdateCardStatusResponse>;
GetCardHistory(request: GetCardHistoryRequest): Promise<GetCardHistoryResponse>;
CreateIssuerKeyAPI(request: GenerateIssuerKeyRequest): Promise<GlobalResponse>;
GenerateIssuerKey(request: GenerateIssuerKeyRequest): Promise<GenerateIssuerKeyResponse>;
GetIssuerKey(request: GetIssuerKeyRequest): Promise<GetIssuerKeyResponse>;
ListIssuerKeys(request: ListIssuerKeysRequest): Promise<ListIssuerKeysResponse>;
RevokeIssuerKey(request: RevokeIssuerKeyRequest): Promise<RevokeIssuerKeyResponse>;
InitializePaymentAPI(request: InitializePaymentRequest): Promise<InitializePaymentResponse>;
VerifyPaymentAPI(request: GetIDRequest): Promise<VerifyPaymentResponse>;
GetPaymentAPI(request: GetIDRequest): Promise<Payment>;
ListPaymentsAPI(request: ListDataRequest): Promise<ListPaymentsResponse>;
HandlePaymentWebhookAPI(request: PaymentWebhookRequest): Promise<GlobalResponse>;
GetPaymentStatsAPI(request: Empty): Promise<PaymentStats>;
CreateApiLicensePayment(request: CreateApiLicenseRequest): Promise<CreateApiLicenseResponse>;
GetApiLicense(request: GetApiLicenseRequest): Promise<ApiLicense>;
GetApiLicenseByKey(request: GetApiLicenseByKeyRequest): Promise<ApiLicense>;
ListApiLicenses(request: ListApiLicensesRequest): Promise<ListApiLicensesResponse>;
UpdateApiLicense(request: UpdateApiLicenseRequest): Promise<ApiLicense>;
RevokeApiLicense(request: RevokeApiLicenseRequest): Promise<GlobalResponse>;
ActivateApiLicense(request: ActivateApiLicenseRequest): Promise<GlobalResponse>;
GetBroadcastsAPI(request: GetBroadcastsRequest): Promise<GetBroadcastsResponse>;
GetAnalytics(request: GetAnalyticsRequest): Promise<GetAnalyticsResponse>;
GetSystemSettings(request: GetSettingsRequest): Promise<ListSettingsResponse>;
GetSettingsByModule(request: GetSettingsRequest): Promise<Setting>;
UpdateSetting(request: UpdateSettingsRequest): Promise<GlobalResponse>;
CreateSettingAPI(request: CreateSettingRequest): Promise<GlobalResponse>;
GetReports(request: GetReportsRequest): Promise<ListReportResponse>;
GetReportByType(request: GetReportsRequest): Promise<Report>;
GenerateReport(request: GenerateReportRequest): Promise<GenerateReportResponse>;
GetReportGeneration(request: GetIDRequest): Promise<ReportGeneration>;
GetReportGenerations(request: Empty): Promise<ListReportGenerationsResponse>;
GetPublicSettings(request: Empty): Promise<PublicSettingsResponse>;
GetGeoDataAPI(request: GetGeoDataRequest): Promise<GetGeoDataResponse>;
CreateLookupAPI(request: CreateLookupRequest): Promise<GlobalResponse>;
ListLookupsByCategoryAPI(request: ListLookupsByCategoryRequest): Promise<ListLookupsResponse>;
UpdateLookupAPI(request: UpdateLookupRequest): Promise<GlobalResponse>;
DeleteLookupAPI(request: DeleteLookupRequest): Promise<GlobalResponse>;
GenerateOTPAPI(request: GenerateOTPRequest): Promise<GenerateOTPResponse>;
ValidateOTPAPI(request: ValidateOTPRequest): Promise<ValidateOTPResponse>;
SyncQueueStatusAPI(request: SyncQueueStatusRequest): Promise<SyncQueueStatusResponse>;
ProcessSyncQueueAPI(request: ProcessSyncQueueRequest): Promise<ProcessSyncQueueResponse>;
GetCardPDFAPI(request: GetCardPDFRequest): Promise<HttpBody>;
GenerateOTPBatchAPI(request: GenerateOTPBatchRequest): Promise<GenerateOTPBatchResponse>;
SyncOTPUsageAPI(request: SyncOTPUsageRequest): Promise<SyncOTPUsageResponse>;
}
interface Rpc {
request(service: string, method: string, data: Uint8Array): Promise<Uint8Array>;
}
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 {};