@kaaiot/services/dist/shared/clients/ecr/ECRClient.types.d.ts

Type definitions for KaaIoT platform REST API service communication

export interface ECRConfigurationResponse {
    configId: string;
    config: string;
    createdDate: string;
    updatedDate: string;
}
export interface ECRGetConfigurationHeaders {
    'If-None-Match': string;
}
export interface ECRSetConfigurationHeaders {
    'If-Match': string;
}
export interface ECRGetEpConfigurationParams {
    endpointId: string;
    appVersionName: string;
    headers?: ECRGetConfigurationHeaders;
}
export interface ECRSetEpConfigurationParams {
    endpointId: string;
    appVersionName: string;
    data: any;
    headers?: ECRSetConfigurationHeaders;
}
export interface ECRBatchUpdateEpConfigurationParams {
    endpoints: Record<string, string[]>;
    configPayload: any;
}
export interface ECRBatchUpdateEpConfigurationByFilterParams {
    filterId: string;
    data: any;
}
export interface ECRDeleteEpConfigurationParams {
    endpointId: string;
    appVersionName: string;
}
export interface ECRDeleteConfigurationResponse {
    message: string;
}
export interface ECRGetDefaultConfiguration {
    appVersionName: string;
    headers: ECRGetConfigurationHeaders;
}
export interface SystemConfigsResponse {
    content: SystemConfig[];
    totalElements: number;
}
export interface SystemConfigsRequestParams {
    page?: number;
    size?: number;
    sort?: 'updatedAt' | 'createdAt';
    sortOrder?: 'asc' | 'desc';
    name?: string;
}
export interface SystemConfig {
    name: string;
    config: string;
    configId: string;
    updatedAt: string;
    createdAt: string;
    displayName?: string;
}
export interface SystemConfigsItemPayload {
    name: string;
    config: string;
    displayName?: string;
}
export declare enum ConfigLevel {
    tenant = "tenants",
    application = "applications",
    appVersion = "app-versions",
    endpoint = "endpoints"
}
export interface ECRSetDefaultConfiguration {
    appVersionName: string;
    headers: ECRSetConfigurationHeaders;
    data: any;
}
export declare enum ConfigurationStatusType {
    PENDING = "PENDING",
    DISPATCHED = "DISPATCHED",
    APPLIED = "APPLIED",
    FAILED = "FAILED"
}
export interface ConfigurationStatus {
    configId: string;
    endpointId: string;
    appVersionName: string;
    config?: string;
    status: ConfigurationStatusType;
    lastDispatchedDate?: string;
    lastConfirmedDate?: string;
    confirmationStatusCode?: number;
    confirmationReasonPhrase?: string;
}
export interface ConfigurationStatusesParams {
    endpointId: string | string[];
    appVersionName?: string;
    configId?: string;
}
export interface PageableSort {
    sorted: boolean;
    unsorted: boolean;
    empty: boolean;
}
export interface Pageable {
    sort: PageableSort;
    pageNumber: number;
    pageSize: number;
    offset: number;
    paged: boolean;
    unpaged: boolean;
}
export interface ConfigurationStatusesResponse {
    content: ConfigurationStatus[];
    pageable: Pageable;
    totalElements: number;
    totalPages: number;
    last: boolean;
    sort: PageableSort;
    numberOfElements: number;
    first: boolean;
    size: number;
    number: number;
    empty: boolean;
}