@tomei/sso/dist/src/components/api-key/api-key.d.ts

Tomei SSO Package

import { ObjectBase } from '@tomei/general';
import { APIKeyStatusEnum } from '../../enum/api-key.enum';
import { APIKeyRepository } from './api-key.repository';
import { IAPIKeyAttr } from '../../interfaces/api-key-attr.interface';
import { LoginUser } from '../login-user/login-user';
export declare class APIKey extends ObjectBase {
    ObjectId: string;
    ObjectName: string;
    ObjectType: 'ApiKey';
    TableName: 'sso_APIKey';
    ApiKey: string;
    Name: string;
    SystemCode: string;
    Description: string;
    Status: APIKeyStatusEnum;
    ExpirationDate: Date;
    RevokedReason: string;
    _RevokedById: number;
    _RevokedAt: Date;
    _CreatedAt: Date;
    _CreatedById: number;
    get APIKeyId(): number;
    set APIKeyId(value: number);
    get RevokedById(): number;
    get RevokedAt(): Date;
    get CreatedAt(): Date;
    get CreatedById(): number;
    protected static _Repo: APIKeyRepository;
    protected constructor(apiKeyAttr?: IAPIKeyAttr);
    static init(ApiKeyId?: number, dbTransaction?: any): Promise<APIKey>;
    generate(loginUser: LoginUser, dbTransaction?: any): Promise<{
        ApiKey: string;
        Name: string;
        Status: APIKeyStatusEnum;
        Description: string;
        SystemCode: string;
        ExpirationDate: Date;
        CreatedAt: Date;
        CreatedById: number;
        RevokedAt: Date;
        RevokedById: number;
        RevokedReason: string;
    }>;
    static findAll(pagination: {
        page: number;
        limit: number;
    }, loginUser: LoginUser, dbTransaction: any, whereOptions: {
        SystemCode?: string;
        Status?: APIKeyStatusEnum;
        ExpirationDate?: {
            FromDate: Date;
            ToDate: Date;
        };
        CreatedById?: number;
    }, sortOptions?: {
        SortBy: string;
        SortOrder: 'ASC' | 'DESC';
    }): Promise<{
        total: number;
        ApiKeys: {
            ApiKeyId: number;
            ApiKey: string;
            Name: string;
            SystemCode: string;
            Description: string;
            Status: APIKeyStatusEnum;
            ExpirationDate: Date;
            CreatedAt: Date;
            CreatedById: number;
            RevokedAt: Date;
            RevokedById: number;
            RevokedReason: string;
        }[];
        page: number;
        limit: number;
    }>;
    revoke(apiKey: string, loginUser: LoginUser, dbTransaction: any, reason?: string): Promise<{
        ApiKey: string;
        Status: APIKeyStatusEnum.REVOKED;
        RevokedAt: Date;
        RevokedById: number;
        RevokedReason: string;
    }>;
}