rotacloud 1.0.55 → 1.0.57

package/dist/mjs/services/users-clock-in.service.js

@@ -0,0 +1,57 @@
+import { Service } from './index.js';
+import { UserClockedIn, UserClockedOut } from '../models/index.js';
+class UserBreak {
+    constructor(apiUserBreak) {
+        this.start_time = apiUserBreak.start_time;
+        this.start_location = apiUserBreak.start_location;
+        this.end_time = apiUserBreak.end_time ?? null;
+        this.end_location = apiUserBreak.end_location ?? null;
+    }
+}
+class UsersClockInService extends Service {
+    constructor() {
+        super(...arguments);
+        this.apiPath = '/users_clocked_in';
+    }
+    getClockedInUser(id, options) {
+        return super
+            .fetch({ url: `${this.apiPath}/${id}` }, options)
+            .then((res) => Promise.resolve(options?.rawResponse ? res : new UserClockedIn(res.data)));
+    }
+    async *list(options) {
+        for await (const res of super.iterator({ url: this.apiPath }, options)) {
+            yield new UserClockedIn(res);
+        }
+    }
+    async listAll(options) {
+        const users = [];
+        for await (const user of this.list(options)) {
+            users.push(user);
+        }
+        return users;
+    }
+    listByPage(options) {
+        return super.iterator({ url: this.apiPath }, options).byPage();
+    }
+    clockIn(data, options) {
+        return super
+            .fetch({ url: this.apiPath, data, method: 'POST' })
+            .then((res) => Promise.resolve(options?.rawResponse ? res : new UserClockedIn(res.data)));
+    }
+    clockOut(id, data, options) {
+        return super
+            .fetch({ url: `${this.apiPath}/${id}`, data, method: 'DELETE' })
+            .then((res) => Promise.resolve(options?.rawResponse ? res : new UserClockedOut(res.data)));
+    }
+    startBreak(id, data, options) {
+        return super
+            .fetch({ url: `${this.apiPath}/${id}`, data, method: 'POST' })
+            .then((res) => Promise.resolve(options?.rawResponse ? res : new UserBreak(res.data)));
+    }
+    endBreak(id, data, options) {
+        return super
+            .fetch({ url: `${this.apiPath}/${id}`, data, method: 'POST' })
+            .then((res) => Promise.resolve(options?.rawResponse ? res : new UserBreak(res.data)));
+    }
+}
+export { UsersClockInService };

package/dist/mjs/services/users.service.d.ts

@@ -0,0 +1,33 @@
+import { AxiosResponse } from 'axios';
+import { ApiUser } from '../interfaces/index.js';
+import { Service, Options, RequirementsOf } from './index.js';
+import { User } from '../models/user.model.js';
+import { UsersQueryParams } from '../interfaces/query-params/users-query-params.interface.js';
+type RequiredProps = 'first_name' | 'last_name';
+declare class UsersService extends Service {
+    private apiPath;
+    create(data: RequirementsOf<ApiUser, RequiredProps>): Promise<User>;
+    create(data: RequirementsOf<ApiUser, RequiredProps>, options: {
+        rawResponse: true;
+    } & Options): Promise<AxiosResponse<ApiUser, any>>;
+    create(data: RequirementsOf<ApiUser, RequiredProps>, options: Options): Promise<User>;
+    get(id: number): Promise<User>;
+    get(id: number, options: {
+        rawResponse: true;
+    } & Options): Promise<AxiosResponse<ApiUser, any>>;
+    get(id: number, options: Options): Promise<User>;
+    list(query: UsersQueryParams, options?: Options): AsyncGenerator<User, void, unknown>;
+    listAll(query: UsersQueryParams, options?: Options): Promise<User[]>;
+    listByPage(query: UsersQueryParams, options?: Options): AsyncGenerator<AxiosResponse<ApiUser[], any>, any, unknown>;
+    update(id: number, data: Partial<ApiUser>): Promise<User>;
+    update(id: number, data: Partial<ApiUser>, options: {
+        rawResponse: true;
+    } & Options): Promise<AxiosResponse<ApiUser, any>>;
+    update(id: number, data: Partial<ApiUser>, options: Options): Promise<User>;
+    delete(id: number): Promise<number>;
+    delete(id: number, options: {
+        rawResponse: true;
+    } & Options): Promise<AxiosResponse<any, any>>;
+    delete(id: number, options: Options): Promise<number>;
+}
+export { UsersService };

package/dist/mjs/services/users.service.js

@@ -0,0 +1,48 @@
+import { Service } from './index.js';
+import { User } from '../models/user.model.js';
+class UsersService extends Service {
+    constructor() {
+        super(...arguments);
+        this.apiPath = '/users';
+    }
+    create(data, options) {
+        return super
+            .fetch({ url: this.apiPath, data, method: 'POST' })
+            .then((res) => Promise.resolve(options?.rawResponse ? res : new User(res.data)));
+    }
+    get(id, options) {
+        return super
+            .fetch({ url: `${this.apiPath}/${id}` }, options)
+            .then((res) => Promise.resolve(options?.rawResponse ? res : new User(res.data)));
+    }
+    async *list(query, options) {
+        for await (const res of super.iterator({ url: this.apiPath, params: query }, options)) {
+            yield new User(res);
+        }
+    }
+    async listAll(query, options) {
+        const users = [];
+        for await (const user of this.list(query, options)) {
+            users.push(user);
+        }
+        return users;
+    }
+    listByPage(query, options) {
+        return super.iterator({ url: this.apiPath, params: query }, options).byPage();
+    }
+    update(id, data, options) {
+        return super
+            .fetch({
+            url: `${this.apiPath}/${id}`,
+            data,
+            method: 'POST',
+        })
+            .then((res) => Promise.resolve(options?.rawResponse ? res : new User(res.data)));
+    }
+    delete(id, options) {
+        return super
+            .fetch({ url: `${this.apiPath}/${id}`, method: 'DELETE' })
+            .then((res) => Promise.resolve(options?.rawResponse ? res : res.status));
+    }
+}
+export { UsersService };

package/dist/mjs/version.d.ts

@@ -0,0 +1,3 @@
+export declare const Version: {
+    version: string;
+};

package/dist/mjs/version.js

@@ -0,0 +1 @@
+export const Version = { version: '1.0.57' };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rotacloud",
-  "version": "1.0.55",
+  "version": "1.0.57",
   "description": "The RotaCloud SDK for the RotaCloud API",
   "engines": {
     "node": ">=16.10.0"
@@ -18,7 +18,8 @@
     "watch": "rm -rf dist/* && concurrently \"tsc -p tsconfig.json --watch\" \"tsc -p tsconfig-cjs.json --watch\" && ./fixup",
     "build": "rm -rf dist/* && tsc -p tsconfig.json && tsc -p tsconfig-cjs.json && ./fixup",
     "lint": "eslint src --ext .ts",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "prepublishOnly": "npm run build"
   },
   "repository": {
     "type": "git",

package/src/interfaces/account.interface.ts

@@ -9,33 +9,33 @@ export interface ApiAccount {
   owner: number;
   timezone: number;
   industry: number;
-  phone: string;
-  address_1: string;
-  address_2: string;
-  city: string;
-  county: string;
-  postcode: string;
+  phone: string | null;
+  address_1: string | null;
+  address_2: string | null;
+  city: string | null;
+  county: string | null;
+  postcode: string | null;
   country: number;
   services: ApiAccountServices[];
   total_price: number;
   pricing: object;
   expires_in: number;
   features_disabled: string[];
-  first_billed: string;
+  first_billed: string | null;
   owed: number;
   trial: boolean;
   can_restart_trial: boolean;
   next_billed: string;
   hide_billing: boolean;
   total_employees: number;
-  payment_card: string;
+  payment_card: string | null;
   billing_type: string;
   billing_term: string;
-  billing_email: string;
-  billing_address: string;
-  grouped_billing_parent: number;
-  grouped_billing_children: number[];
-  vat_number: string;
+  billing_email: string | null;
+  billing_address: string | null;
+  grouped_billing_parent: number | null;
+  grouped_billing_children: number[] | null;
+  vat_number: string | null;
   suspended: boolean;
-  suspended_message: string;
+  suspended_message: string | null;
 }

package/src/interfaces/sdk-config.interface.ts

@@ -1,10 +1,21 @@
 import { RetryOptions, RetryStrategy } from '../services/service.js';
 
-export interface SDKConfig {
+export interface SDKBase {
   baseUri?: string;
-  apiKey: string;
   accountId?: number;
   userId?: number;
   retry?: false | `${RetryStrategy}` | RetryOptions;
   [key: string]: unknown;
 }
+
+export interface SDKBearerAuth extends SDKBase {
+  apiKey: string;
+  basicAuth?: never;
+}
+
+export interface SDKBasicAuth extends SDKBase {
+  apiKey?: never;
+  basicAuth: string;
+}
+
+export type SDKConfig = SDKBasicAuth | SDKBearerAuth;

package/src/interfaces/terminal.interface.ts

@@ -12,6 +12,7 @@ export interface ApiTerminal {
   require_photo: boolean;
   require_photo_breaks: boolean;
   debug: boolean;
+  secret: string;
 }
 
 export interface ApiTerminalLocation {

package/src/models/account.model.ts

@@ -1,15 +1,45 @@
 import { ApiAccount } from '../interfaces/index.js';
 
 export class Account {
-  public id: number;
-  public name: string;
-  public level: string;
-  public created: number;
+  id: number;
+  name: string;
+  level: string;
+  created: number;
+  expired: boolean;
+  owner: number;
+  timezone: number;
+  industry: number;
+  phone: string | null;
+  address_1: string | null;
+  address_2: string | null;
+  city: string | null;
+  county: string | null;
+  postcode: string | null;
+  country: number;
+  services: any;
+  total_price: number;
+  pricing: { current: boolean; name: string; max_employees: number; total_price: number };
+  expires_in: number;
+  features_disabled: string[];
+  first_billed: string | null;
+  owed: number;
+  trial: boolean;
+  can_restart_trial: boolean;
+  next_billed: string;
+  hide_billing: boolean;
+  total_employees: number;
+  payment_card: string | null;
+  billing_type: string;
+  billing_term: string;
+  billing_email: string | null;
+  billing_address: string | null;
+  grouped_billing_parent: number | null;
+  grouped_billing_children: number[] | null;
+  vat_number: string | null;
+  suspended: boolean;
+  suspended_message: string | null;
 
   constructor(account: ApiAccount) {
-    this.id = account.id;
-    this.name = account.name;
-    this.level = account.level;
-    this.created = account.created;
+    Object.assign(this, account);
   }
 }

package/src/models/terminal.model.ts

@@ -13,6 +13,7 @@ export class Terminal {
   public timezone: number;
   public require_photo: boolean;
   public require_photo_breaks: boolean;
+  public secret: string | null;
 
   constructor(terminal: ApiTerminal) {
     this.id = terminal.id;
@@ -27,5 +28,6 @@ export class Terminal {
     this.timezone = terminal.timezone;
     this.require_photo = terminal.require_photo;
     this.require_photo_breaks = terminal.require_photo_breaks;
+    this.secret = terminal.secret;
   }
 }

package/src/rotacloud.ts

@@ -24,10 +24,10 @@ import {
   UsersService,
   UsersClockInService,
 } from './services/index.js';
-import { SDKConfig } from './interfaces/index.js';
+import { SDKBase, SDKConfig } from './interfaces/index.js';
 import { PinsService } from './services/pins.service.js';
 
-const DEFAULT_CONFIG: Partial<SDKConfig> = {
+const DEFAULT_CONFIG: Partial<SDKBase> = {
   baseUri: 'https://api.rotacloud.com/v1',
   retry: RetryStrategy.Exponential,
 };

package/src/services/service.ts

@@ -111,7 +111,9 @@ export abstract class Service<ApiResponse = any> {
 
   fetch<T = ApiResponse>(reqConfig: AxiosRequestConfig, options?: Options): Promise<AxiosResponse<T>> {
     const headers: Record<string, string> = {
-      Authorization: `Bearer ${RotaCloud.config.apiKey}`,
+      Authorization: RotaCloud.config.apiKey
+        ? `Bearer ${RotaCloud.config.apiKey}`
+        : `Basic ${RotaCloud.config.basicAuth}`,
       'SDK-Version': Version.version,
     };
 

package/src/version.ts

@@ -1 +1 @@
-export const Version = { version: '1.0.55' };
+export const Version = { version: '1.0.57' };