@citrineos/base
Version:
The base module for OCPP v2.0.1 including all interfaces. This module is not intended to be used directly, but rather as a dependency for other modules.
404 lines (403 loc) • 17.6 kB
TypeScript
import { z } from 'zod';
export declare const PaginatedParamsSchema: z.ZodObject<{
offset: z.ZodOptional<z.ZodNumber>;
limit: z.ZodOptional<z.ZodNumber>;
dateFrom: z.ZodOptional<z.ZodDate>;
dateTo: z.ZodOptional<z.ZodDate>;
}, z.core.$strip>;
export type PaginatedParams = z.infer<typeof PaginatedParamsSchema>;
export declare const AsyncJobSchema: z.ZodObject<{
tenantId: z.ZodOptional<z.ZodNumber>;
tenant: z.ZodOptional<z.ZodObject<{
id: z.ZodOptional<z.ZodNumber>;
name: z.ZodString;
url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
countryCode: z.ZodOptional<z.ZodNullable<z.ZodString>>;
partyId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
serverProfileOCPI: z.ZodOptional<z.ZodNullable<z.ZodObject<{
credentialsRole: z.ZodObject<{
role: z.ZodEnum<{
CPO: "CPO";
EMSP: "EMSP";
HUB: "HUB";
NAP: "NAP";
NSP: "NSP";
SCSP: "SCSP";
}>;
businessDetails: z.ZodObject<{
name: z.ZodString;
website: z.ZodOptional<z.ZodString>;
logo: z.ZodOptional<z.ZodObject<{
url: z.ZodString;
type: z.ZodString;
category: z.ZodString;
width: z.ZodOptional<z.ZodNumber>;
height: z.ZodOptional<z.ZodNumber>;
}, z.core.$strip>>;
}, z.core.$strip>;
}, z.core.$strip>;
versionDetails: z.ZodArray<z.ZodObject<{
version: z.ZodEnum<{
"2.2.1": "2.2.1";
}>;
versionDetailsUrl: z.ZodOptional<z.ZodString>;
}, z.core.$strip>>;
versionEndpoints: z.ZodRecord<z.ZodString, z.ZodArray<z.ZodObject<{
identifier: z.ZodString;
url: z.ZodString;
}, z.core.$strip>>>;
}, z.core.$strip>>>;
isUserTenant: z.ZodDefault<z.ZodBoolean>;
maxChargingStations: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
updatedAt: z.ZodOptional<z.ZodDate>;
createdAt: z.ZodOptional<z.ZodDate>;
}, z.core.$strip>>;
updatedAt: z.ZodOptional<z.ZodDate>;
createdAt: z.ZodOptional<z.ZodDate>;
jobId: z.ZodString;
jobName: z.ZodEnum<{
FETCH_OCPI_TOKENS: "FETCH_OCPI_TOKENS";
}>;
tenantPartnerId: z.ZodNumber;
tenantPartner: z.ZodOptional<z.ZodObject<{
tenantId: z.ZodOptional<z.ZodNumber>;
tenant: z.ZodOptional<z.ZodObject<{
id: z.ZodOptional<z.ZodNumber>;
name: z.ZodString;
url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
countryCode: z.ZodOptional<z.ZodNullable<z.ZodString>>;
partyId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
serverProfileOCPI: z.ZodOptional<z.ZodNullable<z.ZodObject<{
credentialsRole: z.ZodObject<{
role: z.ZodEnum<{
CPO: "CPO";
EMSP: "EMSP";
HUB: "HUB";
NAP: "NAP";
NSP: "NSP";
SCSP: "SCSP";
}>;
businessDetails: z.ZodObject<{
name: z.ZodString;
website: z.ZodOptional<z.ZodString>;
logo: z.ZodOptional<z.ZodObject<{
url: z.ZodString;
type: z.ZodString;
category: z.ZodString;
width: z.ZodOptional<z.ZodNumber>;
height: z.ZodOptional<z.ZodNumber>;
}, z.core.$strip>>;
}, z.core.$strip>;
}, z.core.$strip>;
versionDetails: z.ZodArray<z.ZodObject<{
version: z.ZodEnum<{
"2.2.1": "2.2.1";
}>;
versionDetailsUrl: z.ZodOptional<z.ZodString>;
}, z.core.$strip>>;
versionEndpoints: z.ZodRecord<z.ZodString, z.ZodArray<z.ZodObject<{
identifier: z.ZodString;
url: z.ZodString;
}, z.core.$strip>>>;
}, z.core.$strip>>>;
isUserTenant: z.ZodDefault<z.ZodBoolean>;
maxChargingStations: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
updatedAt: z.ZodOptional<z.ZodDate>;
createdAt: z.ZodOptional<z.ZodDate>;
}, z.core.$strip>>;
updatedAt: z.ZodOptional<z.ZodDate>;
createdAt: z.ZodOptional<z.ZodDate>;
id: z.ZodOptional<z.ZodNumber>;
countryCode: z.ZodOptional<z.ZodNullable<z.ZodString>>;
partyId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
partnerProfileOCPI: z.ZodObject<{
version: z.ZodObject<{
version: z.ZodEnum<{
"2.2.1": "2.2.1";
}>;
versionDetailsUrl: z.ZodOptional<z.ZodString>;
}, z.core.$strip>;
serverCredentials: z.ZodObject<{
versionsUrl: z.ZodString;
token: z.ZodOptional<z.ZodString>;
certificateRef: z.ZodOptional<z.ZodString>;
}, z.core.$strip>;
roles: z.ZodOptional<z.ZodArray<z.ZodObject<{
role: z.ZodEnum<{
CPO: "CPO";
EMSP: "EMSP";
HUB: "HUB";
NAP: "NAP";
NSP: "NSP";
SCSP: "SCSP";
}>;
businessDetails: z.ZodObject<{
name: z.ZodString;
website: z.ZodOptional<z.ZodString>;
logo: z.ZodOptional<z.ZodObject<{
url: z.ZodString;
type: z.ZodString;
category: z.ZodString;
width: z.ZodOptional<z.ZodNumber>;
height: z.ZodOptional<z.ZodNumber>;
}, z.core.$strip>>;
}, z.core.$strip>;
}, z.core.$strip>>>;
credentials: z.ZodOptional<z.ZodObject<{
versionsUrl: z.ZodString;
token: z.ZodOptional<z.ZodString>;
certificateRef: z.ZodOptional<z.ZodString>;
}, z.core.$strip>>;
endpoints: z.ZodOptional<z.ZodArray<z.ZodObject<{
identifier: z.ZodString;
url: z.ZodString;
}, z.core.$strip>>>;
}, z.core.$strip>;
}, z.core.$strip>>;
finishedAt: z.ZodOptional<z.ZodDate>;
stoppedAt: z.ZodOptional<z.ZodNullable<z.ZodDate>>;
stopScheduled: z.ZodDefault<z.ZodBoolean>;
isFailed: z.ZodDefault<z.ZodBoolean>;
paginatedParams: z.ZodObject<{
offset: z.ZodOptional<z.ZodNumber>;
limit: z.ZodOptional<z.ZodNumber>;
dateFrom: z.ZodOptional<z.ZodDate>;
dateTo: z.ZodOptional<z.ZodDate>;
}, z.core.$strip>;
totalObjects: z.ZodOptional<z.ZodNumber>;
}, z.core.$strip>;
export declare const AsyncJobProps: {
tenant: "tenant";
tenantId: "tenantId";
updatedAt: "updatedAt";
createdAt: "createdAt";
tenantPartnerId: "tenantPartnerId";
tenantPartner: "tenantPartner";
jobId: "jobId";
jobName: "jobName";
finishedAt: "finishedAt";
stoppedAt: "stoppedAt";
stopScheduled: "stopScheduled";
isFailed: "isFailed";
paginatedParams: "paginatedParams";
totalObjects: "totalObjects";
};
export type AsyncJobDto = z.infer<typeof AsyncJobSchema>;
export declare const AsyncJobCreateSchema: z.ZodObject<{
tenantId: z.ZodOptional<z.ZodNumber>;
tenantPartnerId: z.ZodNumber;
jobName: z.ZodEnum<{
FETCH_OCPI_TOKENS: "FETCH_OCPI_TOKENS";
}>;
finishedAt: z.ZodOptional<z.ZodDate>;
stoppedAt: z.ZodOptional<z.ZodNullable<z.ZodDate>>;
stopScheduled: z.ZodDefault<z.ZodBoolean>;
isFailed: z.ZodDefault<z.ZodBoolean>;
paginatedParams: z.ZodObject<{
offset: z.ZodOptional<z.ZodNumber>;
limit: z.ZodOptional<z.ZodNumber>;
dateFrom: z.ZodOptional<z.ZodDate>;
dateTo: z.ZodOptional<z.ZodDate>;
}, z.core.$strip>;
totalObjects: z.ZodOptional<z.ZodNumber>;
}, z.core.$strip>;
export type AsyncJobCreate = z.infer<typeof AsyncJobCreateSchema>;
export declare const AsyncJobRequestSchema: z.ZodObject<{
tenantPartnerId: z.ZodNumber;
paginatedParams: z.ZodObject<{
offset: z.ZodOptional<z.ZodNumber>;
limit: z.ZodOptional<z.ZodNumber>;
dateFrom: z.ZodOptional<z.ZodDate>;
dateTo: z.ZodOptional<z.ZodDate>;
}, z.core.$strip>;
}, z.core.$strip>;
export type AsyncJobRequest = z.infer<typeof AsyncJobRequestSchema>;
export declare const asyncJobSchemas: {
AsyncJob: z.ZodObject<{
tenantId: z.ZodOptional<z.ZodNumber>;
tenant: z.ZodOptional<z.ZodObject<{
id: z.ZodOptional<z.ZodNumber>;
name: z.ZodString;
url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
countryCode: z.ZodOptional<z.ZodNullable<z.ZodString>>;
partyId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
serverProfileOCPI: z.ZodOptional<z.ZodNullable<z.ZodObject<{
credentialsRole: z.ZodObject<{
role: z.ZodEnum<{
CPO: "CPO";
EMSP: "EMSP";
HUB: "HUB";
NAP: "NAP";
NSP: "NSP";
SCSP: "SCSP";
}>;
businessDetails: z.ZodObject<{
name: z.ZodString;
website: z.ZodOptional<z.ZodString>;
logo: z.ZodOptional<z.ZodObject<{
url: z.ZodString;
type: z.ZodString;
category: z.ZodString;
width: z.ZodOptional<z.ZodNumber>;
height: z.ZodOptional<z.ZodNumber>;
}, z.core.$strip>>;
}, z.core.$strip>;
}, z.core.$strip>;
versionDetails: z.ZodArray<z.ZodObject<{
version: z.ZodEnum<{
"2.2.1": "2.2.1";
}>;
versionDetailsUrl: z.ZodOptional<z.ZodString>;
}, z.core.$strip>>;
versionEndpoints: z.ZodRecord<z.ZodString, z.ZodArray<z.ZodObject<{
identifier: z.ZodString;
url: z.ZodString;
}, z.core.$strip>>>;
}, z.core.$strip>>>;
isUserTenant: z.ZodDefault<z.ZodBoolean>;
maxChargingStations: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
updatedAt: z.ZodOptional<z.ZodDate>;
createdAt: z.ZodOptional<z.ZodDate>;
}, z.core.$strip>>;
updatedAt: z.ZodOptional<z.ZodDate>;
createdAt: z.ZodOptional<z.ZodDate>;
jobId: z.ZodString;
jobName: z.ZodEnum<{
FETCH_OCPI_TOKENS: "FETCH_OCPI_TOKENS";
}>;
tenantPartnerId: z.ZodNumber;
tenantPartner: z.ZodOptional<z.ZodObject<{
tenantId: z.ZodOptional<z.ZodNumber>;
tenant: z.ZodOptional<z.ZodObject<{
id: z.ZodOptional<z.ZodNumber>;
name: z.ZodString;
url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
countryCode: z.ZodOptional<z.ZodNullable<z.ZodString>>;
partyId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
serverProfileOCPI: z.ZodOptional<z.ZodNullable<z.ZodObject<{
credentialsRole: z.ZodObject<{
role: z.ZodEnum<{
CPO: "CPO";
EMSP: "EMSP";
HUB: "HUB";
NAP: "NAP";
NSP: "NSP";
SCSP: "SCSP";
}>;
businessDetails: z.ZodObject<{
name: z.ZodString;
website: z.ZodOptional<z.ZodString>;
logo: z.ZodOptional<z.ZodObject<{
url: z.ZodString;
type: z.ZodString;
category: z.ZodString;
width: z.ZodOptional<z.ZodNumber>;
height: z.ZodOptional<z.ZodNumber>;
}, z.core.$strip>>;
}, z.core.$strip>;
}, z.core.$strip>;
versionDetails: z.ZodArray<z.ZodObject<{
version: z.ZodEnum<{
"2.2.1": "2.2.1";
}>;
versionDetailsUrl: z.ZodOptional<z.ZodString>;
}, z.core.$strip>>;
versionEndpoints: z.ZodRecord<z.ZodString, z.ZodArray<z.ZodObject<{
identifier: z.ZodString;
url: z.ZodString;
}, z.core.$strip>>>;
}, z.core.$strip>>>;
isUserTenant: z.ZodDefault<z.ZodBoolean>;
maxChargingStations: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
updatedAt: z.ZodOptional<z.ZodDate>;
createdAt: z.ZodOptional<z.ZodDate>;
}, z.core.$strip>>;
updatedAt: z.ZodOptional<z.ZodDate>;
createdAt: z.ZodOptional<z.ZodDate>;
id: z.ZodOptional<z.ZodNumber>;
countryCode: z.ZodOptional<z.ZodNullable<z.ZodString>>;
partyId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
partnerProfileOCPI: z.ZodObject<{
version: z.ZodObject<{
version: z.ZodEnum<{
"2.2.1": "2.2.1";
}>;
versionDetailsUrl: z.ZodOptional<z.ZodString>;
}, z.core.$strip>;
serverCredentials: z.ZodObject<{
versionsUrl: z.ZodString;
token: z.ZodOptional<z.ZodString>;
certificateRef: z.ZodOptional<z.ZodString>;
}, z.core.$strip>;
roles: z.ZodOptional<z.ZodArray<z.ZodObject<{
role: z.ZodEnum<{
CPO: "CPO";
EMSP: "EMSP";
HUB: "HUB";
NAP: "NAP";
NSP: "NSP";
SCSP: "SCSP";
}>;
businessDetails: z.ZodObject<{
name: z.ZodString;
website: z.ZodOptional<z.ZodString>;
logo: z.ZodOptional<z.ZodObject<{
url: z.ZodString;
type: z.ZodString;
category: z.ZodString;
width: z.ZodOptional<z.ZodNumber>;
height: z.ZodOptional<z.ZodNumber>;
}, z.core.$strip>>;
}, z.core.$strip>;
}, z.core.$strip>>>;
credentials: z.ZodOptional<z.ZodObject<{
versionsUrl: z.ZodString;
token: z.ZodOptional<z.ZodString>;
certificateRef: z.ZodOptional<z.ZodString>;
}, z.core.$strip>>;
endpoints: z.ZodOptional<z.ZodArray<z.ZodObject<{
identifier: z.ZodString;
url: z.ZodString;
}, z.core.$strip>>>;
}, z.core.$strip>;
}, z.core.$strip>>;
finishedAt: z.ZodOptional<z.ZodDate>;
stoppedAt: z.ZodOptional<z.ZodNullable<z.ZodDate>>;
stopScheduled: z.ZodDefault<z.ZodBoolean>;
isFailed: z.ZodDefault<z.ZodBoolean>;
paginatedParams: z.ZodObject<{
offset: z.ZodOptional<z.ZodNumber>;
limit: z.ZodOptional<z.ZodNumber>;
dateFrom: z.ZodOptional<z.ZodDate>;
dateTo: z.ZodOptional<z.ZodDate>;
}, z.core.$strip>;
totalObjects: z.ZodOptional<z.ZodNumber>;
}, z.core.$strip>;
AsyncJobCreate: z.ZodObject<{
tenantId: z.ZodOptional<z.ZodNumber>;
tenantPartnerId: z.ZodNumber;
jobName: z.ZodEnum<{
FETCH_OCPI_TOKENS: "FETCH_OCPI_TOKENS";
}>;
finishedAt: z.ZodOptional<z.ZodDate>;
stoppedAt: z.ZodOptional<z.ZodNullable<z.ZodDate>>;
stopScheduled: z.ZodDefault<z.ZodBoolean>;
isFailed: z.ZodDefault<z.ZodBoolean>;
paginatedParams: z.ZodObject<{
offset: z.ZodOptional<z.ZodNumber>;
limit: z.ZodOptional<z.ZodNumber>;
dateFrom: z.ZodOptional<z.ZodDate>;
dateTo: z.ZodOptional<z.ZodDate>;
}, z.core.$strip>;
totalObjects: z.ZodOptional<z.ZodNumber>;
}, z.core.$strip>;
AsyncJobRequest: z.ZodObject<{
tenantPartnerId: z.ZodNumber;
paginatedParams: z.ZodObject<{
offset: z.ZodOptional<z.ZodNumber>;
limit: z.ZodOptional<z.ZodNumber>;
dateFrom: z.ZodOptional<z.ZodDate>;
dateTo: z.ZodOptional<z.ZodDate>;
}, z.core.$strip>;
}, z.core.$strip>;
};