@smartsides/oracle-ebs-sdk 1.0.0

package/dist/OracleEBSClient-C7P6gYW3.d.mts

@@ -0,0 +1,420 @@
+import { KyInstance, Options } from 'ky';
+
+interface OracleEBSConfig {
+    baseUrl: string;
+    token?: string;
+    timeout?: number;
+    retries?: number;
+    retryDelay?: number;
+    cache?: {
+        enabled?: boolean;
+        ttl?: number;
+    };
+    logging?: {
+        enabled?: boolean;
+        level?: 'debug' | 'info' | 'warn' | 'error';
+    };
+    onError?: (error: Error) => void;
+    onRequest?: (request: Request) => Request | Promise<Request>;
+    onResponse?: (response: Response) => Response | Promise<Response>;
+}
+
+interface APIResponse<T = any> {
+    success: boolean;
+    data?: T;
+    error?: {
+        code: string;
+        message: string;
+        details?: any;
+    };
+    meta?: {
+        timestamp: string;
+        requestId: string;
+        version: string;
+    };
+}
+interface CacheOptions {
+    enabled?: boolean;
+    ttl?: number;
+    key?: string;
+}
+interface RetryOptions {
+    enabled?: boolean;
+    maxRetries?: number;
+    retryDelay?: number;
+    retryOn?: number[];
+}
+
+declare class BaseClient {
+    protected client: KyInstance;
+    protected config: OracleEBSConfig;
+    protected token?: string;
+    constructor(config: OracleEBSConfig);
+    setToken(token: string): void;
+    clearToken(): void;
+    protected get<T>(url: string, options?: Options): Promise<APIResponse<T>>;
+    protected post<T>(url: string, data?: any, options?: Options): Promise<APIResponse<T>>;
+    protected put<T>(url: string, data?: any, options?: Options): Promise<APIResponse<T>>;
+    protected delete<T>(url: string, options?: Options): Promise<APIResponse<T>>;
+    protected handleError(error: any): Error;
+    protected log(level: 'debug' | 'info' | 'warn' | 'error', ...args: any[]): void;
+}
+
+interface LoginCredentials {
+    username: string;
+    password: string;
+}
+interface LoginResponse {
+    access_token: string;
+    token_type: string;
+    user: {
+        userName: string;
+        ebsVersion: string;
+        USER_ID?: string;
+        PERSON_ID?: string;
+        EMPLOYEE_NUMBER?: string;
+        responsibilities?: Responsibility[];
+    };
+}
+interface Responsibility {
+    responsibilityId: string;
+    responsibilityKey: string;
+    responsibilityName: string;
+    applicationShortName: string;
+}
+interface UserContext {
+    userId: string;
+    employeeNumber: string;
+    personId: string;
+    fullName: string;
+    assignmentId: string;
+    assignmentNumber: string;
+}
+
+declare class AuthModule extends BaseClient {
+    login(credentials: LoginCredentials): Promise<LoginResponse>;
+    logout(): Promise<void>;
+    getUserContext(): Promise<UserContext>;
+}
+
+interface AbsenceType {
+    absenceAttendanceTypeId: string;
+    name: string;
+    absenceCategory: string;
+    enabled?: boolean;
+}
+interface GetAbsenceTypesParams {
+    effectiveDate?: string;
+}
+interface GetAbsenceTypesResponse {
+    absenceTypes: AbsenceType[];
+}
+interface LeaveHistoryRecord {
+    sortKeyDate: string;
+    requestDate: string;
+    leaveTypeName: string;
+    startDate: string;
+    endDate: string;
+    days: number;
+    hours: number | null;
+    requestStatus: string;
+    currentApprover: string | null;
+    notificationSentDate: string | null;
+    transactionId: string | null;
+}
+interface GetLeaveHistoryResponse {
+    leaveHistory: LeaveHistoryRecord[];
+    employeeNumber: string;
+}
+interface CreateLeaveRequestInput {
+    absenceTypeId: string;
+    absenceReasonId?: string;
+    startDate: string;
+    endDate: string;
+    days: number;
+    comments?: string;
+    activityId?: string;
+    dffFields?: Record<string, string>;
+}
+interface CreateLeaveRequestResponse {
+    message: string;
+    transactionId: string;
+    itemKey: string;
+}
+
+declare class LeavesModule extends BaseClient {
+    getRestrictedTypes(params?: GetAbsenceTypesParams): Promise<GetAbsenceTypesResponse>;
+    getHistory(): Promise<GetLeaveHistoryResponse>;
+    createRequest(input: CreateLeaveRequestInput): Promise<CreateLeaveRequestResponse>;
+}
+
+interface SitSegment {
+    segmentName: string;
+    segmentValue: string;
+    displayValue?: string;
+}
+interface GetSitSegmentsParams {
+    idFlexNum: string;
+}
+interface GetSitSegmentsResponse {
+    segments: SitSegment[];
+}
+interface SaveAndPreviewSitRequestInput {
+    itemType: string;
+    responsibilityName: string;
+    calledFrom: string;
+    process: string;
+    sitName: string;
+    activityId: string;
+    ameTranType: string;
+    segments: Record<string, string>;
+}
+interface SaveAndPreviewSitRequestResponse {
+    status: string;
+    message: string;
+    activityId: string;
+    transactionId?: string;
+    itemKey?: string;
+}
+interface SubmitSitRequestInput {
+    itemType: string;
+    itemKey: string;
+    transactionId: string;
+    activityId: string;
+    nid?: string | null;
+    aname?: string | null;
+}
+interface SubmitSitRequestResponse {
+    status: string;
+    message: string;
+    transactionId: string;
+    itemKey: string;
+}
+interface GetSitHistoryParams {
+    startDate?: string;
+    endDate?: string;
+}
+interface SitHistoryRecord {
+    transactionId: string;
+    sitName: string;
+    requestDate: string;
+    status: string;
+    approver?: string;
+}
+interface GetSitHistoryResponse {
+    history: SitHistoryRecord[];
+}
+
+declare class SitRequestsModule extends BaseClient {
+    getSegments(params: GetSitSegmentsParams): Promise<GetSitSegmentsResponse>;
+    saveAndPreview(input: SaveAndPreviewSitRequestInput): Promise<SaveAndPreviewSitRequestResponse>;
+    submit(input: SubmitSitRequestInput): Promise<SubmitSitRequestResponse>;
+    getHistory(params?: GetSitHistoryParams): Promise<GetSitHistoryResponse>;
+}
+
+interface Notification {
+    notificationId: string;
+    subject: string;
+    status: string;
+    createdDate: string;
+    itemKey?: string;
+    analysisCriteriaId?: string;
+}
+interface GetNotificationsResponse {
+    notifications: Notification[];
+}
+interface NotificationDetails {
+    notificationId: string;
+    title: string;
+    description: string;
+    status: string;
+    createdDate: string;
+    dueDate?: string;
+    priority?: string;
+}
+interface GetNotificationDetailsParams {
+    notificationId: string;
+}
+interface ProcessApprovalInput {
+    notificationId: string;
+    action: 'APPROVE' | 'REJECT';
+    comments?: string;
+}
+interface ProcessApprovalResponse {
+    status: string;
+    message: string;
+}
+interface CloseFyiParams {
+    notificationId: string;
+}
+interface CloseFyiResponse {
+    status: string;
+    message: string;
+}
+
+declare class NotificationsModule extends BaseClient {
+    getList(): Promise<GetNotificationsResponse>;
+    getDetails(params: GetNotificationDetailsParams): Promise<NotificationDetails>;
+    processApproval(input: ProcessApprovalInput): Promise<ProcessApprovalResponse>;
+    closeFyi(params: CloseFyiParams): Promise<CloseFyiResponse>;
+}
+
+interface GetPayslipHeaderParams {
+    periodName: string;
+}
+interface PayslipHeader {
+    employeeNumber: string;
+    periodName: string;
+    employeeName: string;
+    jobName: string;
+    organizationName: string;
+    locationName: string;
+    periodStartDate: string;
+    periodEndDate: string;
+    payDate: string;
+    basicSalary: string;
+    allowances: string;
+    deductions: string;
+    netSalary: string;
+    currencyCode: string;
+}
+interface GetPayslipDetailsParams {
+    periodName: string;
+}
+interface PayslipDetail {
+    employeeNumber: string;
+    periodName: string;
+    elementName: string;
+    amount: string;
+    elementType: string;
+    currencyCode: string;
+}
+interface GetPayslipDetailsResponse {
+    details: PayslipDetail[];
+}
+
+declare class PayslipModule extends BaseClient {
+    getHeader(params: GetPayslipHeaderParams): Promise<PayslipHeader>;
+    getDetails(params: GetPayslipDetailsParams): Promise<GetPayslipDetailsResponse>;
+}
+
+interface PersonalInformation {
+    userId: string;
+    employeeNumber: string;
+    employeeName: string;
+    emailAddress: string;
+    jobName: string;
+    departmentName: string;
+    locationName: string;
+}
+interface EmployeeHierarchyNode {
+    personId: string;
+    employeeNumber: string;
+    fullName: string;
+    jobName: string;
+    level: number;
+}
+interface GetEmployeeHierarchyResponse {
+    hierarchy: EmployeeHierarchyNode[];
+}
+
+declare class EmployeeModule extends BaseClient {
+    getPersonalInfo(): Promise<PersonalInformation>;
+    getHierarchy(): Promise<GetEmployeeHierarchyResponse>;
+}
+
+interface AccrualBalance {
+    assignmentId: string;
+    calculationDate: string;
+    accrualPlanName: string;
+    balance: string;
+    unit: string;
+    asOfDate: string;
+}
+interface GetAccrualBalancesParams {
+    calculationDate: string;
+}
+interface GetAccrualBalancesResponse {
+    balances: AccrualBalance[];
+}
+
+declare class AccrualBalancesModule extends BaseClient {
+    getBalances(params: GetAccrualBalancesParams): Promise<GetAccrualBalancesResponse>;
+}
+
+interface TableColumn {
+    columnName: string;
+    dataType: string;
+    displayName: string;
+    required: boolean;
+    maxLength?: number;
+}
+interface GetTableColumnsParams {
+    tableName: string;
+}
+interface GetTableColumnsResponse {
+    columns: TableColumn[];
+}
+interface DffSegment {
+    segmentName: string;
+    displayName: string;
+    dataType: string;
+    required: boolean;
+    enabled: boolean;
+    valueSet?: string;
+    maxLength?: number;
+}
+interface GetDffSegmentsParams {
+    applicationId: string;
+    flexfieldName: string;
+}
+interface GetDffSegmentsResponse {
+    segments: DffSegment[];
+}
+
+declare class FormsModule extends BaseClient {
+    getTableColumns(params: GetTableColumnsParams): Promise<GetTableColumnsResponse>;
+    getDffSegments(params: GetDffSegmentsParams): Promise<GetDffSegmentsResponse>;
+}
+
+interface HealthCheckResponse {
+    status: 'healthy' | 'degraded' | 'unhealthy';
+    timestamp: string;
+    uptime: number;
+    version: string;
+    services: {
+        nestjs: {
+            status: 'up';
+            message: string;
+        };
+        oracleEbs: {
+            status: 'up' | 'down' | 'unreachable';
+            message: string;
+            url?: string;
+            responseTime?: number;
+            error?: string;
+        };
+    };
+}
+
+declare class HealthModule extends BaseClient {
+    check(): Promise<HealthCheckResponse>;
+    ping(): Promise<string>;
+}
+
+declare class OracleEBSClient {
+    readonly auth: AuthModule;
+    readonly leaves: LeavesModule;
+    readonly sitRequests: SitRequestsModule;
+    readonly notifications: NotificationsModule;
+    readonly payslip: PayslipModule;
+    readonly employee: EmployeeModule;
+    readonly accrualBalances: AccrualBalancesModule;
+    readonly forms: FormsModule;
+    readonly health: HealthModule;
+    constructor(config: OracleEBSConfig);
+    setToken(token: string): void;
+    clearToken(): void;
+}
+
+export { type APIResponse as A, type GetPayslipDetailsParams as B, type CacheOptions as C, type PayslipDetail as D, type GetPayslipDetailsResponse as E, type PersonalInformation as F, type GetAbsenceTypesParams as G, type EmployeeHierarchyNode as H, type GetEmployeeHierarchyResponse as I, type GetTableColumnsParams as J, type GetTableColumnsResponse as K, type LoginCredentials as L, type DffSegment as M, type Notification as N, OracleEBSClient as O, type ProcessApprovalInput as P, type GetDffSegmentsParams as Q, type RetryOptions as R, type SitSegment as S, type TableColumn as T, type UserContext as U, type GetDffSegmentsResponse as V, type HealthCheckResponse as W, type AccrualBalance as X, type GetAccrualBalancesParams as Y, type GetAccrualBalancesResponse as Z, type OracleEBSConfig as a, type LoginResponse as b, type Responsibility as c, type AbsenceType as d, type GetAbsenceTypesResponse as e, type LeaveHistoryRecord as f, type GetLeaveHistoryResponse as g, type CreateLeaveRequestInput as h, type CreateLeaveRequestResponse as i, type GetSitSegmentsParams as j, type GetSitSegmentsResponse as k, type SaveAndPreviewSitRequestInput as l, type SaveAndPreviewSitRequestResponse as m, type SubmitSitRequestInput as n, type SubmitSitRequestResponse as o, type GetSitHistoryParams as p, type SitHistoryRecord as q, type GetSitHistoryResponse as r, type GetNotificationsResponse as s, type NotificationDetails as t, type GetNotificationDetailsParams as u, type ProcessApprovalResponse as v, type CloseFyiParams as w, type CloseFyiResponse as x, type GetPayslipHeaderParams as y, type PayslipHeader as z };