rotacloud 1.0.2 → 1.0.5

package/.github/workflows/node.js.yml

@@ -5,7 +5,7 @@ name: Node.js CI
 
 on:
   push:
-    branches: [main]
+    branches: [develop]
 
 jobs:
   build:
@@ -23,21 +23,11 @@ jobs:
         with:
           node-version: ${{ matrix.node-version }}
           cache: 'npm'
+          registry-url: https://registry.npmjs.org/
       - run: npm ci
       - run: npm run version:output
       - run: npm run lint
       - run: npm run build --if-present
-
-  publish-npm:
-    needs: build
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 16
-          registry-url: https://registry.npmjs.org/
-      - run: npm ci
       - run: npm publish
         env:
           NODE_AUTH_TOKEN: ${{secrets.NPM_ACCESS_TOKEN}}

package/README.md

@@ -5,7 +5,7 @@
 Configuration is simple, just import the core rotacloud.js SDK and supply your API key as necessary.
 
 ```typescript
-import { Rotacloud } from 'rotacloud';
+import { RotaCloud } from 'rotacloud';
 
 const rc = new Rotacloud({
   apiKey: 'YOUR_API_KEY',

package/dist/interfaces/account-service.interface.d.ts

@@ -0,0 +1,6 @@
+export interface ApiAccountService {
+    active: boolean;
+    billed: boolean;
+    hidden: boolean;
+    trial_expires?: string;
+}

package/dist/interfaces/account-service.interface.js

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/account-services.interface.d.ts

@@ -0,0 +1,6 @@
+import { ApiAccountService } from './index.js';
+export interface ApiAccountServices {
+    time_attendance: ApiAccountService;
+    sms: ApiAccountService;
+    pro: ApiAccountService;
+}

package/dist/interfaces/account-services.interface.js

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/account.interface.d.ts

@@ -0,0 +1,40 @@
+import { ApiAccountServices } from './index.js';
+export interface ApiAccount {
+    id: number;
+    name: string;
+    level: string;
+    created: number;
+    expired: boolean;
+    owner: number;
+    timezone: number;
+    industry: number;
+    phone: string;
+    address_1: string;
+    address_2: string;
+    city: string;
+    county: string;
+    postcode: string;
+    country: number;
+    services: ApiAccountServices[];
+    total_price: number;
+    pricing: object;
+    expires_in: number;
+    features_disabled: string[];
+    first_billed: string;
+    owed: number;
+    trial: boolean;
+    can_restart_trial: boolean;
+    next_billed: string;
+    hide_billing: boolean;
+    total_employees: number;
+    payment_card: string;
+    billing_type: string;
+    billing_term: string;
+    billing_email: string;
+    billing_address: string;
+    grouped_billing_parent: number;
+    grouped_billing_children: number[];
+    vat_number: string;
+    suspended: boolean;
+    suspended_message: string;
+}

package/dist/interfaces/account.interface.js

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/attendance.interface.d.ts

@@ -0,0 +1,31 @@
+import { ApiShift } from './index.js';
+export interface ApiAttendanceLocation {
+    lat: number;
+    lng: number;
+    accuracy: number;
+}
+export interface ApiAttendance {
+    id: number;
+    deleted: boolean;
+    approved: boolean;
+    in_time: number;
+    out_time: number;
+    minutes_break: number;
+    user: number;
+    location: number;
+    role: number;
+    minutes_late: number;
+    hours: number;
+    hours_auto: number;
+    hours_is_auto: boolean;
+    notes: string | null;
+    shift: ApiShift | null;
+    in_method: string;
+    out_method: string;
+    in_location: ApiAttendanceLocation;
+    out_location: ApiAttendanceLocation;
+    in_device: number;
+    out_device: number;
+    in_terminal: null;
+    out_terminal: null;
+}

package/dist/interfaces/attendance.interface.js

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/availability-pattern.interface.d.ts

@@ -0,0 +1,20 @@
+import { ApiAvailabilityPeriod } from './index.js';
+export interface ApiAvailabilityPatternAvailability {
+    available: ApiAvailabilityPeriod[];
+    unavailable: ApiAvailabilityPeriod[];
+}
+export interface ApiAvailabilityPattern {
+    id: number;
+    user: number;
+    name: string;
+    start_date: string;
+    end_date: string;
+    repeat_weeks: number;
+    mon: ApiAvailabilityPatternAvailability;
+    tue: ApiAvailabilityPatternAvailability;
+    wed: ApiAvailabilityPatternAvailability;
+    thu: ApiAvailabilityPatternAvailability;
+    fri: ApiAvailabilityPatternAvailability;
+    sat: ApiAvailabilityPatternAvailability;
+    sun: ApiAvailabilityPatternAvailability;
+}

package/dist/interfaces/availability-pattern.interface.js

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/availability.interface.d.ts

@@ -0,0 +1,13 @@
+export interface ApiAvailabilityPeriod {
+    start_time: string;
+    end_time: string;
+}
+export interface ApiAvailabilityDates {
+    date: string;
+    available: ApiAvailabilityPeriod[];
+    unavailable: ApiAvailabilityPeriod[];
+}
+export interface ApiAvailability {
+    user: number;
+    dates: ApiAvailabilityDates[];
+}

package/dist/interfaces/availability.interface.js

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/daily-budgets.interface.d.ts

@@ -0,0 +1,6 @@
+export interface ApiDailyBudgets {
+    date: string;
+    location: number;
+    hours_budget: number;
+    salary_budget: number;
+}

package/dist/interfaces/daily-budgets.interface.js

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/daily-revenue.interface.d.ts

@@ -0,0 +1,7 @@
+export interface ApiDailyRevenue {
+    date: string;
+    location: number;
+    labour_percentage: number;
+    revenue_target: number;
+    revenue_actual: number;
+}

package/dist/interfaces/daily-revenue.interface.js

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/day-notes.interface.d.ts

@@ -0,0 +1,8 @@
+export interface ApiDayNotes {
+    id: number;
+    start_date: string;
+    end_date: string;
+    locations: number[];
+    title: string;
+    message: string;
+}

package/dist/interfaces/day-notes.interface.js

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/days-off-pattern.interface.d.ts

@@ -0,0 +1,13 @@
+export interface ApiDaysOffPattern {
+    id: number;
+    user: number;
+    start_date: string;
+    end_date: string;
+    mon_day_off: boolean;
+    tue_day_off: boolean;
+    wed_day_off: boolean;
+    thu_day_off: boolean;
+    fri_day_off: boolean;
+    sat_day_off: boolean;
+    sun_day_off: boolean;
+}

package/dist/interfaces/days-off-pattern.interface.js

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/days-off.interface.d.ts

@@ -0,0 +1,8 @@
+export interface ApiDayOff {
+    date: string;
+    day_off: boolean;
+}
+export interface ApiDaysOff {
+    user: number;
+    dates: ApiDayOff[];
+}

package/dist/interfaces/days-off.interface.js

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/group.interface.d.ts

@@ -0,0 +1,7 @@
+export interface ApiGroup {
+    id: number;
+    name: string;
+    users: number[];
+    deleted: boolean;
+    order: number;
+}

package/dist/interfaces/group.interface.js

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/holiday_allowance.interface.d.ts

@@ -0,0 +1,11 @@
+export interface ApiHolidayAllowance {
+    user: number;
+    default_holiday_allowance: number;
+    default_holiday_allowance_unit: string;
+    custom_holiday_allowance: null;
+    custom_holiday_allowance_unit: null;
+    adjusted_start_date: boolean;
+    adjusted_final_working_date: boolean;
+    holiday_allowance: number;
+    holiday_allowance_unit: string;
+}

package/dist/interfaces/holiday_allowance.interface.js

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/index.d.ts

@@ -0,0 +1,29 @@
+export * from './account-service.interface.js';
+export * from './account-services.interface.js';
+export * from './account.interface.js';
+export * from './attendance.interface.js';
+export * from './availability-pattern.interface.js';
+export * from './availability.interface.js';
+export * from './daily-budgets.interface.js';
+export * from './daily-revenue.interface.js';
+export * from './days-off.interface.js';
+export * from './days-off-pattern.interface.js';
+export * from './day-notes.interface.js';
+export * from './group.interface.js';
+export * from './holiday_allowance.interface.js';
+export * from './leave-date.interface.js';
+export * from './leave-embargo.interface.js';
+export * from './leave-rate.interface.js';
+export * from './leave-request.interface.js';
+export * from './leave-type.interface.js';
+export * from './leave.interface.js';
+export * from './location-coordinate.interface.js';
+export * from './location.interface.js';
+export * from './logbook-category.interface.js';
+export * from './logbook-event.interface.js';
+export * from './pay-period.interface.js';
+export * from './role-rate.interface.js';
+export * from './role.interface.js';
+export * from './sdk-config.interface.js';
+export * from './user.interface.js';
+export * from './shift.interface.js';

package/dist/interfaces/index.js

@@ -0,0 +1,29 @@
+export * from './account-service.interface.js';
+export * from './account-services.interface.js';
+export * from './account.interface.js';
+export * from './attendance.interface.js';
+export * from './availability-pattern.interface.js';
+export * from './availability.interface.js';
+export * from './daily-budgets.interface.js';
+export * from './daily-revenue.interface.js';
+export * from './days-off.interface.js';
+export * from './days-off-pattern.interface.js';
+export * from './day-notes.interface.js';
+export * from './group.interface.js';
+export * from './holiday_allowance.interface.js';
+export * from './leave-date.interface.js';
+export * from './leave-embargo.interface.js';
+export * from './leave-rate.interface.js';
+export * from './leave-request.interface.js';
+export * from './leave-type.interface.js';
+export * from './leave.interface.js';
+export * from './location-coordinate.interface.js';
+export * from './location.interface.js';
+export * from './logbook-category.interface.js';
+export * from './logbook-event.interface.js';
+export * from './pay-period.interface.js';
+export * from './role-rate.interface.js';
+export * from './role.interface.js';
+export * from './sdk-config.interface.js';
+export * from './user.interface.js';
+export * from './shift.interface.js';

package/dist/interfaces/leave-date.interface.d.ts

@@ -0,0 +1,8 @@
+export interface ApiLeaveDate {
+    date: string;
+    year: string;
+    days: number;
+    hours: number;
+    day_off: boolean;
+    id?: number;
+}

package/dist/interfaces/leave-date.interface.js

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/leave-embargo.interface.d.ts

@@ -0,0 +1,10 @@
+export interface ApiLeaveEmbargo {
+    id: number;
+    start_date: string;
+    start_am_pm: string;
+    end_date: string;
+    end_am_pm: string;
+    everyone: boolean;
+    users: number[];
+    message: string;
+}

package/dist/interfaces/leave-embargo.interface.js

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/leave-rate.interface.d.ts

@@ -0,0 +1,3 @@
+export interface ApiLeaveRate {
+    [key: string]: number;
+}

package/dist/interfaces/leave-rate.interface.js

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/leave-request.interface.d.ts

@@ -0,0 +1,13 @@
+import { ApiLeaveDate } from './leave-date.interface';
+export interface ApiLeaveRequest {
+    id: number;
+    deleted: boolean;
+    type: number;
+    user: number;
+    user_message: string | null;
+    start_date: string;
+    start_am_pm: null;
+    end_date: string;
+    end_am_pm: null;
+    dates: ApiLeaveDate[];
+}

package/dist/interfaces/leave-request.interface.js

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/leave-type.interface.d.ts

@@ -0,0 +1,8 @@
+export interface ApiLeaveType {
+    id: number;
+    name: string;
+    short_name: string;
+    colour: string;
+    can_request: boolean;
+    time_attendance_only: boolean;
+}

package/dist/interfaces/leave-type.interface.js

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/leave.interface.d.ts

@@ -0,0 +1,28 @@
+import { ApiLeaveDate } from './index.js';
+export interface ApiLeave {
+    id: number;
+    deleted: boolean;
+    deleted_at: number;
+    deleted_by: number;
+    type: number;
+    user: number;
+    admin: number;
+    status: string;
+    requested: boolean;
+    user_message: string;
+    admin_message: string;
+    start_date: string;
+    start_am_pm: string;
+    end_date: string;
+    end_am_pm: string;
+    hours: {
+        [key: string]: number;
+    };
+    hours_method: string;
+    hours_set: boolean;
+    dates: ApiLeaveDate[];
+    requested_at: number;
+    paid: boolean;
+    replied_at: number;
+    users?: number[];
+}

package/dist/interfaces/leave.interface.js

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/location-coordinate.interface.d.ts

@@ -0,0 +1,5 @@
+export interface ApiLocationCoordinate {
+    lat: number;
+    lng: number;
+    radius: number;
+}

package/dist/interfaces/location-coordinate.interface.js

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/location.interface.d.ts

@@ -0,0 +1,13 @@
+import { ApiLocationCoordinate } from './index.js';
+export interface ApiLocation {
+    id: number;
+    name: string;
+    deleted: boolean;
+    address: string;
+    location: ApiLocationCoordinate;
+    timezone: number;
+    users: [];
+    managers: [];
+    metadata: null;
+    clock_in_ips: null;
+}

package/dist/interfaces/location.interface.js

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/logbook-category.interface.d.ts

@@ -0,0 +1,4 @@
+export interface ApiLogbookCategory {
+    id: number;
+    name: string;
+}

package/dist/interfaces/logbook-category.interface.js

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/logbook-event.interface.d.ts

@@ -0,0 +1,16 @@
+export interface ApiLogbookEvent {
+    id: number;
+    created_at: number;
+    created_by: number;
+    updated_at: string;
+    updated_by: string;
+    deleted: boolean;
+    deleted_at: string;
+    deleted_by: string;
+    user: number;
+    category: number;
+    date: string;
+    time: string;
+    name: string;
+    description: string;
+}

package/dist/interfaces/logbook-event.interface.js

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/pay-period.interface.d.ts

@@ -0,0 +1,16 @@
+export interface ApiPayPeriod {
+    id: number;
+    start_date: string;
+    end_date: string;
+    name: string;
+    locked: boolean;
+    locked_at: number;
+    locked_by: number;
+    unlocked_at: null;
+    unlocked_by: null;
+    finalised: boolean;
+    finalised_at: number;
+    finalised_by: number;
+    unfinalised_at: null;
+    unfinalised_by: null;
+}

package/dist/interfaces/pay-period.interface.js

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/query-params/attendance-query-params.interface.d.ts

@@ -0,0 +1,9 @@
+export interface AttendanceQueryParams {
+    start: number;
+    end: number;
+    users?: number[];
+    locations?: number[];
+    roles?: number[];
+    approved?: boolean;
+    include_deleted?: boolean;
+}

package/dist/interfaces/query-params/attendance-query-params.interface.js

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/query-params/availability-patterns-query-params.interface.d.ts

@@ -0,0 +1,5 @@
+export interface AvailabilityPatternsQueryParams {
+    start?: string;
+    end?: string;
+    users?: number[];
+}

package/dist/interfaces/query-params/availability-patterns-query-params.interface.js

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/query-params/availability-query-params.interface.d.ts

@@ -0,0 +1,5 @@
+export interface AvailabilityQueryParams {
+    start?: string;
+    end?: string;
+    users?: number[];
+}

package/dist/interfaces/query-params/availability-query-params.interface.js

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/query-params/common-shift-times-query-params.interface.d.ts

@@ -0,0 +1,3 @@
+export interface CommonShiftTimesQueryParams {
+    users?: number[];
+}

package/dist/interfaces/query-params/common-shift-times-query-params.interface.js

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/query-params/daily-budgets-query-params.interface.d.ts

@@ -0,0 +1,5 @@
+export interface DailyBudgetsQueryParams {
+    start?: string;
+    end?: string;
+    locations?: number[];
+}

package/dist/interfaces/query-params/daily-budgets-query-params.interface.js

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/query-params/daily-revenue-query-params.interface.d.ts

@@ -0,0 +1,5 @@
+export interface DailyRevenueQueryParams {
+    start?: string;
+    end?: string;
+    locations?: number[];
+}

package/dist/interfaces/query-params/daily-revenue-query-params.interface.js

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/query-params/day-notes-query-params.interface.d.ts

@@ -0,0 +1,5 @@
+export interface DayNotesQueryParams {
+    start?: string;
+    end?: string;
+    locations?: number[];
+}

package/dist/interfaces/query-params/day-notes-query-params.interface.js

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/query-params/days-off-patterns-query-params.interface.d.ts

@@ -0,0 +1,5 @@
+export interface DaysOffPatternsQueryParams {
+    start?: string;
+    end?: string;
+    users?: number[];
+}

package/dist/interfaces/query-params/days-off-patterns-query-params.interface.js

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/query-params/days-off-query-params.interface.d.ts

@@ -0,0 +1,5 @@
+export interface DaysOffQueryParams {
+    start?: string;
+    end?: string;
+    users?: number[];
+}

package/dist/interfaces/query-params/days-off-query-params.interface.js

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/query-params/documents-query-params.interface.d.ts

@@ -0,0 +1,4 @@
+export interface DocumentsQueryParams {
+    users?: number[];
+    search?: string;
+}

package/dist/interfaces/query-params/documents-query-params.interface.js

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/query-params/groups-query-params.interface.d.ts

@@ -0,0 +1,3 @@
+export interface GroupsQueryParams {
+    order?: string;
+}

package/dist/interfaces/query-params/groups-query-params.interface.js

@@ -0,0 +1 @@
+export {};

package/dist/interfaces/query-params/internal-query-params.inteface.d.ts

@@ -0,0 +1,5 @@
+export interface InternalQueryParams {
+    expand?: string[];
+    fields?: string[];
+    limit?: number;
+}