@markwharton/eh-payroll 3.2.1 → 3.3.0

package/dist/client.d.ts

@@ -145,6 +145,13 @@ export declare class PayrollClient {
      * @param options - Optional filters
      */
     getRosterShifts(fromDate: string, toDate: string, options?: PayrollRosterShiftOptions): Promise<Result<PayrollRosterShift[]>>;
+    /**
+     * Get a single kiosk by ID
+     *
+     * @param kioskId - Kiosk identifier
+     * @see https://api.keypay.com.au/australia/reference/manager/manager-kiosk--get-api-v2-business-by-business-id-manager-kiosk-by-id.html
+     */
+    getKiosk(kioskId: number): Promise<Result<PayrollKiosk>>;
     /**
      * Get all kiosks for the business
      */

package/dist/client.js

@@ -480,6 +480,21 @@ export class PayrollClient {
     // ============================================================================
     // Time & Attendance (Kiosk)
     // ============================================================================
+    /**
+     * Get a single kiosk by ID
+     *
+     * @param kioskId - Kiosk identifier
+     * @see https://api.keypay.com.au/australia/reference/manager/manager-kiosk--get-api-v2-business-by-business-id-manager-kiosk-by-id.html
+     */
+    async getKiosk(kioskId) {
+        return this.cached(`kiosk:${kioskId}:detail`, this.cacheTtl.kiosksTtl, async () => {
+            // KeyPay serves single kiosk at manager/kiosk/{id}, not kiosk/{id}
+            const url = this.businessUrl(`manager/${ENTITIES.PayrollKiosk.path}/${kioskId}`);
+            return this.fetchAndParse(url, async (r) => {
+                return pickFields(await r.json(), ENTITIES.PayrollKiosk.fields);
+            });
+        });
+    }
     /**
      * Get all kiosks for the business
      */

package/dist/types.js

@@ -116,21 +116,20 @@ export const ENTITIES = {
     PayrollEmployeeLeaveRequest: { fields: PAYROLL_LEAVE_REQUEST_FIELDS, path: 'employee/{employeeId}/leaverequest', apiRef: 'leave-requests/au-hours-leave-request--get-leave-requests' },
     PayrollLocation: { fields: PAYROLL_LOCATION_FIELDS, path: 'location', apiRef: 'location/au-location--get-locations' },
     PayrollRosterShift: { fields: PAYROLL_ROSTER_SHIFT_FIELDS, path: 'rostershift', apiRef: 'roster-shifts/au-roster-shift--get' },
-    PayrollKiosk: { fields: PAYROLL_KIOSK_FIELDS, path: 'kiosk', apiRef: 'time-and-attendance/kiosk--get-all' },
+    PayrollKiosk: { fields: PAYROLL_KIOSK_FIELDS, path: 'kiosk', apiRef: 'time-and-attendance/kiosk--get-all', apiRefById: 'manager/manager-kiosk--get-api-v2-business-by-business-id-manager-kiosk-by-id' },
     PayrollKioskEmployee: { fields: PAYROLL_KIOSK_EMPLOYEE_FIELDS, path: 'kiosk/{kioskId}/staff', apiRef: 'time-and-attendance/generic-time-and-attendance--get-staff' },
     PayrollEmployeeGroup: { fields: PAYROLL_EMPLOYEE_GROUP_FIELDS, path: 'employeegroup', apiRef: 'employee-groups/au-employee-group--get-groups' },
     PayrollStandardHours: { path: 'employee/{employeeId}/standardhours', apiRef: 'employee/au-employee-standard-hours--get' },
+    EHEmployee: { fields: PAYROLL_EMPLOYEE_FIELDS, path: 'employee/unstructured', apiRef: 'employee/au-employee--get-employees', apiRefById: 'employee/au-employee--get-employee-by-id' },
+    EHLeaveRequest: { fields: PAYROLL_LEAVE_REQUEST_FIELDS, path: 'leaverequest', apiRef: 'leave-requests/au-business-hours-leave-request--list-leave-requests' },
+    EHEmployeeLeaveRequest: { fields: PAYROLL_LEAVE_REQUEST_FIELDS, path: 'employee/{employeeId}/leaverequest', apiRef: 'leave-requests/au-hours-leave-request--get-leave-requests' },
+    EHLocation: { fields: PAYROLL_LOCATION_FIELDS, path: 'location', apiRef: 'location/au-location--get-locations' },
+    EHRosterShift: { fields: PAYROLL_ROSTER_SHIFT_FIELDS, path: 'rostershift', apiRef: 'roster-shifts/au-roster-shift--get' },
+    EHKiosk: { fields: PAYROLL_KIOSK_FIELDS, path: 'kiosk', apiRef: 'time-and-attendance/kiosk--get-all', apiRefById: 'manager/manager-kiosk--get-api-v2-business-by-business-id-manager-kiosk-by-id' },
+    EHKioskEmployee: { fields: PAYROLL_KIOSK_EMPLOYEE_FIELDS, path: 'kiosk/{kioskId}/staff', apiRef: 'time-and-attendance/generic-time-and-attendance--get-staff' },
+    EHEmployeeGroup: { fields: PAYROLL_EMPLOYEE_GROUP_FIELDS, path: 'employeegroup', apiRef: 'employee-groups/au-employee-group--get-groups' },
+    EHStandardHours: { path: 'employee/{employeeId}/standardhours', apiRef: 'employee/au-employee-standard-hours--get' },
 };
-// Backward compatibility aliases for ENTITIES keys
-ENTITIES.EHEmployee = ENTITIES.PayrollEmployee;
-ENTITIES.EHLeaveRequest = ENTITIES.PayrollLeaveRequest;
-ENTITIES.EHEmployeeLeaveRequest = ENTITIES.PayrollEmployeeLeaveRequest;
-ENTITIES.EHLocation = ENTITIES.PayrollLocation;
-ENTITIES.EHRosterShift = ENTITIES.PayrollRosterShift;
-ENTITIES.EHKiosk = ENTITIES.PayrollKiosk;
-ENTITIES.EHKioskEmployee = ENTITIES.PayrollKioskEmployee;
-ENTITIES.EHEmployeeGroup = ENTITIES.PayrollEmployeeGroup;
-ENTITIES.EHStandardHours = ENTITIES.PayrollStandardHours;
 /**
  * Access tier for each data method.
  *
@@ -141,6 +140,7 @@ ENTITIES.EHStandardHours = ENTITIES.PayrollStandardHours;
 export const METHOD_TIERS = {
     getLocations: 'standard',
     getEmployeeGroups: 'standard',
+    getKiosk: 'standard',
     getKiosks: 'standard',
     getKioskStaff: 'standard',
     getRosterShifts: 'standard',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@markwharton/eh-payroll",
-  "version": "3.2.1",
+  "version": "3.3.0",
   "description": "Employment Hero Payroll API client",
   "type": "module",
   "main": "dist/index.js",