@pliancy/timelyapp-sdk 6.1.0

package/README.md

@@ -0,0 +1,53 @@
+# TimelyApp Node SDK
+
+[![Timely Rest API](https://img.shields.io/badge/Timely%20Rest%20API--green.svg)](https://dev.timelyapp.com/)
+[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/pliancy/timelyapp-sdk/CI)](https://github.com/pliancy/timelyapp-sdk)
+[![npm](https://img.shields.io/npm/v/timelyapp.svg)](https://www.npmjs.com/package/timelyapp)
+[![Downloads](https://img.shields.io/npm/dm/timelyapp.svg)](https://npmjs.com/timelyapp)
+[![Dependency Status](https://img.shields.io/david/pliancy/timelyapp-sdk)](https://david-dm.org/pliancy/timelyapp-sdk)
+[![License](https://img.shields.io/github/license/pliancy/timelyapp-sdk)](https://npmjs.com/timelyapp)
+
+A typed node module which provides a wrapper and several convienence functions for the TimelyApp.com API
+
+## Installation
+
+```shell
+npm install timelyapp
+```
+
+## Examples
+```typescript
+import { TimelyApp } from 'timelyapp'
+import dotenv from 'dotenv'
+dotenv.config()
+
+const timely = new TimelyApp({
+    accountId: process.env.TIMELY_ACCOUNT as string,
+    token: process.env.TIMELY_TOKEN as string,
+})
+
+;(async () => {
+    const output = await timely.getClients()
+    // eslint-disable-next-line no-console
+    console.dir(output, { depth: null })
+    // eslint-disable-next-line no-console
+})().catch(console.log)
+```
+
+### Create the client
+
+```typescript
+import { TimelyApp } from 'timelyapp'
+
+const timely = new TimelyApp({
+  clientId: 'xxxxxxxxxxxxx',
+  clientSecret: 'xxxxxxxxxxxxx',
+  accountId: '123456',
+})
+```
+
+### Get all users
+
+```typescript
+const users = await timely.users.getAll()
+```

package/index.d.ts

@@ -0,0 +1,2 @@
+export * from './lib/types';
+export { TimelyApp } from './lib/timely-app';

package/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TimelyApp = void 0;
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./lib/types"), exports);
+var timely_app_1 = require("./lib/timely-app");
+Object.defineProperty(exports, "TimelyApp", { enumerable: true, get: function () { return timely_app_1.TimelyApp; } });
+//# sourceMappingURL=index.js.map

package/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;AAAA,sDAA2B;AAC3B,+CAA4C;AAAnC,uGAAA,SAAS,OAAA"}

package/lib/accounts/accounts.d.ts

@@ -0,0 +1,8 @@
+import { AxiosInstance } from 'axios';
+import { TimelyAccount } from '../types';
+export declare class Accounts {
+    private readonly http;
+    constructor(http: AxiosInstance);
+    getAll(): Promise<TimelyAccount[]>;
+    getById(accountId: number): Promise<TimelyAccount>;
+}

package/lib/accounts/accounts.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Accounts = void 0;
+class Accounts {
+    constructor(http) {
+        this.http = http;
+    }
+    async getAll() {
+        const { data } = await this.http.get('/accounts');
+        return data;
+    }
+    async getById(accountId) {
+        const { data } = await this.http.get(`/accounts/${accountId}`);
+        return data;
+    }
+}
+exports.Accounts = Accounts;
+//# sourceMappingURL=accounts.js.map

package/lib/accounts/accounts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"accounts.js","sourceRoot":"","sources":["../../../src/lib/accounts/accounts.ts"],"names":[],"mappings":";;;AAGA,MAAa,QAAQ;IACjB,YAA6B,IAAmB;QAAnB,SAAI,GAAJ,IAAI,CAAe;IAAG,CAAC;IAEpD,KAAK,CAAC,MAAM;QACR,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,CAAA;QACjD,OAAO,IAAI,CAAA;IACf,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,SAAiB;QAC3B,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,aAAa,SAAS,EAAE,CAAC,CAAA;QAC9D,OAAO,IAAI,CAAA;IACf,CAAC;CACJ;AAZD,4BAYC"}

package/lib/clients/clients.d.ts

@@ -0,0 +1,13 @@
+import { AxiosInstance } from 'axios';
+import { AddTimelyClient, TimelyAppConfig, TimelyClient } from '../types';
+export declare class Clients {
+    private readonly http;
+    private readonly config;
+    constructor(http: AxiosInstance, config: TimelyAppConfig);
+    getAll(): Promise<TimelyClient[]>;
+    getById(clientId: number): Promise<TimelyClient>;
+    getByName(clientName: string): Promise<TimelyClient | undefined>;
+    getByExternalId(customerId: string): Promise<TimelyClient | undefined>;
+    add(client: AddTimelyClient): Promise<TimelyClient>;
+    update(clientId: number, client: Partial<TimelyClient>): Promise<TimelyClient>;
+}

package/lib/clients/clients.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Clients = void 0;
+class Clients {
+    constructor(http, config) {
+        this.http = http;
+        this.config = config;
+    }
+    async getAll() {
+        const { data } = await this.http.get(`/${this.config.accountId}/clients?show=all`);
+        return data;
+    }
+    async getById(clientId) {
+        const { data } = await this.http.get(`/${this.config.accountId}/clients/${clientId}`);
+        return data;
+    }
+    async getByName(clientName) {
+        const clients = await this.getAll();
+        return clients.find((c) => c.name === clientName);
+    }
+    async getByExternalId(customerId) {
+        const clients = await this.getAll();
+        return clients.find((e) => e.external_id === customerId);
+    }
+    async add(client) {
+        const { data } = await this.http.post(`/${this.config.accountId}/clients`, { client });
+        return data;
+    }
+    async update(clientId, client) {
+        const { data } = await this.http.put(`/${this.config.accountId}/clients/${clientId}`, {
+            client,
+        });
+        return data;
+    }
+}
+exports.Clients = Clients;
+//# sourceMappingURL=clients.js.map

package/lib/clients/clients.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"clients.js","sourceRoot":"","sources":["../../../src/lib/clients/clients.ts"],"names":[],"mappings":";;;AAGA,MAAa,OAAO;IAChB,YACqB,IAAmB,EACnB,MAAuB;QADvB,SAAI,GAAJ,IAAI,CAAe;QACnB,WAAM,GAAN,MAAM,CAAiB;IACzC,CAAC;IAEJ,KAAK,CAAC,MAAM;QACR,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,mBAAmB,CAAC,CAAA;QAClF,OAAO,IAAI,CAAA;IACf,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,QAAgB;QAC1B,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,YAAY,QAAQ,EAAE,CAAC,CAAA;QACrF,OAAO,IAAI,CAAA;IACf,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,UAAkB;QAC9B,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,MAAM,EAAE,CAAA;QACnC,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,UAAU,CAAC,CAAA;IACrD,CAAC;IAED,KAAK,CAAC,eAAe,CAAC,UAAkB;QACpC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,MAAM,EAAE,CAAA;QACnC,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,KAAK,UAAU,CAAC,CAAA;IAC5D,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,MAAuB;QAC7B,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,UAAU,EAAE,EAAE,MAAM,EAAE,CAAC,CAAA;QACtF,OAAO,IAAI,CAAA;IACf,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,QAAgB,EAAE,MAA6B;QACxD,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,YAAY,QAAQ,EAAE,EAAE;YAClF,MAAM;SACT,CAAC,CAAA;QACF,OAAO,IAAI,CAAA;IACf,CAAC;CACJ;AArCD,0BAqCC"}

package/lib/events/events.d.ts

@@ -0,0 +1,14 @@
+import { AxiosInstance } from 'axios';
+import { DateString, TimelyAppConfig, TimelyBulkUpdateEventsReturn, TimelyEvent, TimelyEventBulkUpdate } from '../types';
+export declare class Events {
+    private readonly http;
+    private readonly config;
+    constructor(http: AxiosInstance, config: TimelyAppConfig);
+    getAll(start?: DateString, end?: DateString): Promise<TimelyEvent[]>;
+    getByProjectId(projectId: number, start: DateString, end: DateString): Promise<TimelyEvent[]>;
+    bulkUpdate(updateArray: TimelyEventBulkUpdate[]): Promise<TimelyBulkUpdateEventsReturn[]>;
+    bulkDelete(eventIds: number[]): Promise<TimelyBulkUpdateEventsReturn[]>;
+    update(eventId: number, event: Partial<TimelyEvent>): Promise<TimelyEvent>;
+    getById(eventId: number): Promise<TimelyEvent>;
+    ensureISOFormat(date: DateString): string;
+}

package/lib/events/events.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Events = void 0;
+const paginated_request_1 = require("../http/paginated-request");
+class Events {
+    constructor(http, config) {
+        this.http = http;
+        this.config = config;
+    }
+    async getAll(start, end) {
+        const [startDate, endDate] = [start, end].map((s) => (s ? this.ensureISOFormat(s) : null));
+        const params = {};
+        if (startDate && endDate) {
+            params.since = startDate;
+            params.upto = endDate;
+        }
+        const data = await (0, paginated_request_1.paginatedRequest)(this.http, `/${this.config.accountId}/events`, params);
+        return data;
+    }
+    async getByProjectId(projectId, start, end) {
+        const [startDate, endDate] = [start, end].map((s) => this.ensureISOFormat(s));
+        const params = {};
+        if (startDate) {
+            params.since = startDate;
+        }
+        if (endDate) {
+            params.upto = endDate;
+        }
+        const data = await (0, paginated_request_1.paginatedRequest)(this.http, `/${this.config.accountId}/projects/${projectId}/events`, params);
+        return data;
+    }
+    async bulkUpdate(updateArray) {
+        const { data } = await this.http.post(`/${this.config.accountId}/bulk/events`, {
+            update: updateArray,
+        });
+        return data;
+    }
+    async bulkDelete(eventIds) {
+        const { data } = await this.http.post(`/${this.config.accountId}/bulk/events`, {
+            delete: eventIds,
+        });
+        return data;
+    }
+    async update(eventId, event) {
+        const { data } = await this.http.put(`/${this.config.accountId}/events/${eventId}`, event);
+        return data;
+    }
+    async getById(eventId) {
+        const { data } = await this.http.get(`/${this.config.accountId}/events/${eventId}`);
+        return data;
+    }
+    ensureISOFormat(date) {
+        try {
+            return new Date(date).toISOString().slice(0, 10);
+        }
+        catch (e) {
+            throw new Error(`Unable to parse "${date}" as YYYY-MM-DD`);
+        }
+    }
+}
+exports.Events = Events;
+//# sourceMappingURL=events.js.map

package/lib/events/events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.js","sourceRoot":"","sources":["../../../src/lib/events/events.ts"],"names":[],"mappings":";;;AACA,iEAA4D;AAS5D,MAAa,MAAM;IACf,YACqB,IAAmB,EACnB,MAAuB;QADvB,SAAI,GAAJ,IAAI,CAAe;QACnB,WAAM,GAAN,MAAM,CAAiB;IACzC,CAAC;IAEJ,KAAK,CAAC,MAAM,CAAC,KAAkB,EAAE,GAAgB;QAE7C,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAA;QAC1F,MAAM,MAAM,GAAG,EAAqC,CAAA;QACpD,IAAI,SAAS,IAAI,OAAO,EAAE,CAAC;YACvB,MAAM,CAAC,KAAK,GAAG,SAAS,CAAA;YACxB,MAAM,CAAC,IAAI,GAAG,OAAO,CAAA;QACzB,CAAC;QACD,MAAM,IAAI,GAAG,MAAM,IAAA,oCAAgB,EAAC,IAAI,CAAC,IAAI,EAAE,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,SAAS,EAAE,MAAM,CAAC,CAAA;QAC1F,OAAO,IAAI,CAAA;IACf,CAAC;IAED,KAAK,CAAC,cAAc,CAChB,SAAiB,EACjB,KAAiB,EACjB,GAAe;QAGf,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAA;QAC7E,MAAM,MAAM,GAAG,EAAuC,CAAA;QACtD,IAAI,SAAS,EAAE,CAAC;YACZ,MAAM,CAAC,KAAK,GAAG,SAAS,CAAA;QAC5B,CAAC;QACD,IAAI,OAAO,EAAE,CAAC;YACV,MAAM,CAAC,IAAI,GAAG,OAAO,CAAA;QACzB,CAAC;QACD,MAAM,IAAI,GAAG,MAAM,IAAA,oCAAgB,EAC/B,IAAI,CAAC,IAAI,EACT,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,aAAa,SAAS,SAAS,EACxD,MAAM,CACT,CAAA;QACD,OAAO,IAAI,CAAA;IACf,CAAC;IAcD,KAAK,CAAC,UAAU,CACZ,WAAoC;QAEpC,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,cAAc,EAAE;YAC3E,MAAM,EAAE,WAAW;SACtB,CAAC,CAAA;QACF,OAAO,IAAI,CAAA;IACf,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,QAAkB;QAC/B,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,cAAc,EAAE;YAC3E,MAAM,EAAE,QAAQ;SACnB,CAAC,CAAA;QACF,OAAO,IAAI,CAAA;IACf,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,OAAe,EAAE,KAA2B;QACrD,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,WAAW,OAAO,EAAE,EAAE,KAAK,CAAC,CAAA;QAC1F,OAAO,IAAI,CAAA;IACf,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,OAAe;QACzB,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,WAAW,OAAO,EAAE,CAAC,CAAA;QACnF,OAAO,IAAI,CAAA;IACf,CAAC;IAMD,eAAe,CAAC,IAAgB;QAC5B,IAAI,CAAC;YACD,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAA;QACpD,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACT,MAAM,IAAI,KAAK,CAAC,oBAAoB,IAAI,iBAAiB,CAAC,CAAA;QAC9D,CAAC;IACL,CAAC;CACJ;AAzFD,wBAyFC"}

package/lib/http/http.d.ts

@@ -0,0 +1,2 @@
+import { AxiosRequestConfig } from 'axios';
+export declare const createHttpClient: (config: AxiosRequestConfig) => import("axios").AxiosInstance;

package/lib/http/http.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createHttpClient = void 0;
+const tslib_1 = require("tslib");
+const axios_1 = tslib_1.__importDefault(require("axios"));
+const createHttpClient = (config) => axios_1.default.create(config);
+exports.createHttpClient = createHttpClient;
+//# sourceMappingURL=http.js.map

package/lib/http/http.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"http.js","sourceRoot":"","sources":["../../../src/lib/http/http.ts"],"names":[],"mappings":";;;;AAAA,0DAAiD;AAE1C,MAAM,gBAAgB,GAAG,CAAC,MAA0B,EAAE,EAAE,CAAC,eAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;AAAvE,QAAA,gBAAgB,oBAAuD"}

package/lib/http/paginated-request.d.ts

@@ -0,0 +1,4 @@
+import type { AxiosInstance } from 'axios';
+export declare const paginatedRequest: (httpAgent: AxiosInstance, route: string, filter?: {
+    [index: string]: any;
+} | undefined, per_page?: number) => Promise<any[]>;

package/lib/http/paginated-request.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.paginatedRequest = void 0;
+const paginatedRequest = async (httpAgent, route, filter, per_page = 1000) => {
+    const params = {
+        per_page,
+        page: 1,
+    };
+    if (filter)
+        Object.assign(params, { ...filter });
+    const finalData = [];
+    let res = [];
+    do {
+        const { data } = await httpAgent.get(route, { params });
+        finalData.push(...data);
+        res = data;
+        params.page++;
+    } while (res.length === per_page);
+    return finalData;
+};
+exports.paginatedRequest = paginatedRequest;
+//# sourceMappingURL=paginated-request.js.map

package/lib/http/paginated-request.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"paginated-request.js","sourceRoot":"","sources":["../../../src/lib/http/paginated-request.ts"],"names":[],"mappings":";;;AAEO,MAAM,gBAAgB,GAAG,KAAK,EACjC,SAAwB,EACxB,KAAa,EACb,MAAiC,EACjC,QAAQ,GAAG,IAAI,EACD,EAAE;IAChB,MAAM,MAAM,GAAG;QACX,QAAQ;QACR,IAAI,EAAE,CAAC;KACV,CAAA;IAED,IAAI,MAAM;QAAE,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,GAAG,MAAM,EAAE,CAAC,CAAA;IAEhD,MAAM,SAAS,GAAG,EAAE,CAAA;IACpB,IAAI,GAAG,GAAU,EAAE,CAAA;IAEnB,GAAG,CAAC;QACA,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,SAAS,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,MAAM,EAAE,CAAC,CAAA;QACvD,SAAS,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAA;QACvB,GAAG,GAAG,IAAI,CAAA;QACV,MAAM,CAAC,IAAI,EAAE,CAAA;IAEjB,CAAC,QAAQ,GAAG,CAAC,MAAM,KAAK,QAAQ,EAAC;IAEjC,OAAO,SAAS,CAAA;AACpB,CAAC,CAAA;AAzBY,QAAA,gBAAgB,oBAyB5B"}

package/lib/labels/labels.d.ts

@@ -0,0 +1,11 @@
+import { AxiosInstance } from 'axios';
+import { AddTimelyLabel, TimelyAppConfig, TimelyLabel } from '../types';
+export declare class Labels {
+    private readonly http;
+    private readonly config;
+    constructor(http: AxiosInstance, config: TimelyAppConfig);
+    getAll(): Promise<TimelyLabel[]>;
+    getById(labelId: number): Promise<TimelyLabel>;
+    update(labelId: number, label: Partial<TimelyLabel>): Promise<TimelyLabel>;
+    add(label: AddTimelyLabel): Promise<TimelyLabel>;
+}

package/lib/labels/labels.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Labels = void 0;
+class Labels {
+    constructor(http, config) {
+        this.http = http;
+        this.config = config;
+    }
+    async getAll() {
+        const { data } = await this.http.get(`/${this.config.accountId}/labels`);
+        return data;
+    }
+    async getById(labelId) {
+        const { data } = await this.http.get(`/${this.config.accountId}/labels/${labelId}`);
+        return data;
+    }
+    async update(labelId, label) {
+        const { data } = await this.http.put(`/${this.config.accountId}/labels/${labelId}`, {
+            label,
+        });
+        return data;
+    }
+    async add(label) {
+        const { data } = await this.http.post(`/${this.config.accountId}/labels`, {
+            label,
+        });
+        return data;
+    }
+}
+exports.Labels = Labels;
+//# sourceMappingURL=labels.js.map

package/lib/labels/labels.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"labels.js","sourceRoot":"","sources":["../../../src/lib/labels/labels.ts"],"names":[],"mappings":";;;AAGA,MAAa,MAAM;IACf,YACqB,IAAmB,EACnB,MAAuB;QADvB,SAAI,GAAJ,IAAI,CAAe;QACnB,WAAM,GAAN,MAAM,CAAiB;IACzC,CAAC;IAEJ,KAAK,CAAC,MAAM;QACR,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,SAAS,CAAC,CAAA;QACxE,OAAO,IAAI,CAAA;IACf,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,OAAe;QACzB,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,WAAW,OAAO,EAAE,CAAC,CAAA;QACnF,OAAO,IAAI,CAAA;IACf,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,OAAe,EAAE,KAA2B;QACrD,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,WAAW,OAAO,EAAE,EAAE;YAChF,KAAK;SACR,CAAC,CAAA;QACF,OAAO,IAAI,CAAA;IACf,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,KAAqB;QAC3B,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,SAAS,EAAE;YACtE,KAAK;SACR,CAAC,CAAA;QACF,OAAO,IAAI,CAAA;IACf,CAAC;CACJ;AA7BD,wBA6BC"}

package/lib/projects/projects.d.ts

@@ -0,0 +1,14 @@
+import { AxiosInstance } from 'axios';
+import { AddTimelyProject, TimelyAppConfig, TimelyProject } from '../types';
+export declare class Projects {
+    private readonly http;
+    private readonly config;
+    constructor(http: AxiosInstance, config: TimelyAppConfig);
+    getAll(filter?: 'active' | 'all' | 'mine' | 'archived'): Promise<TimelyProject[]>;
+    getArchived(): Promise<TimelyProject[]>;
+    getById(projectId: number): Promise<TimelyProject>;
+    getByExternalId(externalId: string): Promise<TimelyProject[]>;
+    add(project: AddTimelyProject): Promise<TimelyProject>;
+    remove(projectId: number): Promise<{}>;
+    update(projectId: number, project: Partial<TimelyProject>): Promise<TimelyProject>;
+}

package/lib/projects/projects.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Projects = void 0;
+class Projects {
+    constructor(http, config) {
+        this.http = http;
+        this.config = config;
+    }
+    async getAll(filter) {
+        const { data } = await this.http.get(`/${this.config.accountId}/projects?filter=${filter !== null && filter !== void 0 ? filter : 'active'} `);
+        return data;
+    }
+    async getArchived() {
+        const { data } = await this.http.get(`/${this.config.accountId}/projects?filter=archived`);
+        return data;
+    }
+    async getById(projectId) {
+        const { data } = await this.http.get(`/${this.config.accountId}/projects/${projectId}`);
+        return data;
+    }
+    async getByExternalId(externalId) {
+        const projects = await this.getAll();
+        if (!(projects && projects.length))
+            return [];
+        return projects.filter((e) => (e === null || e === void 0 ? void 0 : e.external_id) === externalId);
+    }
+    async add(project) {
+        const { data } = await this.http.post(`/${this.config.accountId}/projects`, { project });
+        return data;
+    }
+    async remove(projectId) {
+        const { data } = await this.http.delete(`/${this.config.accountId}/projects/${projectId}`);
+        return data;
+    }
+    async update(projectId, project) {
+        const { data } = await this.http.put(`/${this.config.accountId}/projects/${projectId}`, {
+            project,
+        });
+        return data;
+    }
+}
+exports.Projects = Projects;
+//# sourceMappingURL=projects.js.map

package/lib/projects/projects.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"projects.js","sourceRoot":"","sources":["../../../src/lib/projects/projects.ts"],"names":[],"mappings":";;;AAGA,MAAa,QAAQ;IACjB,YACqB,IAAmB,EACnB,MAAuB;QADvB,SAAI,GAAJ,IAAI,CAAe;QACnB,WAAM,GAAN,MAAM,CAAiB;IACzC,CAAC;IAEJ,KAAK,CAAC,MAAM,CAAC,MAA+C;QACxD,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAChC,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,oBAAoB,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,QAAQ,GAAG,CACrE,CAAA;QACD,OAAO,IAAI,CAAA;IACf,CAAC;IAED,KAAK,CAAC,WAAW;QACb,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,2BAA2B,CAAC,CAAA;QAC1F,OAAO,IAAI,CAAA;IACf,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,SAAiB;QAC3B,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,aAAa,SAAS,EAAE,CAAC,CAAA;QACvF,OAAO,IAAI,CAAA;IACf,CAAC;IAED,KAAK,CAAC,eAAe,CAAC,UAAkB;QACpC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,EAAE,CAAA;QACpC,IAAI,CAAC,CAAC,QAAQ,IAAI,QAAQ,CAAC,MAAM,CAAC;YAAE,OAAO,EAAE,CAAA;QAC7C,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAA,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,WAAW,MAAK,UAAU,CAAC,CAAA;IAChE,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,OAAyB;QAC/B,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,WAAW,EAAE,EAAE,OAAO,EAAE,CAAC,CAAA;QACxF,OAAO,IAAI,CAAA;IACf,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,SAAiB;QAC1B,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,aAAa,SAAS,EAAE,CAAC,CAAA;QAC1F,OAAO,IAAI,CAAA;IACf,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,SAAiB,EAAE,OAA+B;QAC3D,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,aAAa,SAAS,EAAE,EAAE;YACpF,OAAO;SACV,CAAC,CAAA;QACF,OAAO,IAAI,CAAA;IACf,CAAC;CACJ;AA7CD,4BA6CC"}

package/lib/reports/reports.d.ts

@@ -0,0 +1,13 @@
+import { AxiosInstance } from 'axios';
+import { TimelyAppConfig } from '../types';
+export declare class Reports {
+    private readonly http;
+    private readonly config;
+    constructor(http: AxiosInstance, config: TimelyAppConfig);
+    getByExternalId(externalId: string, filter: {
+        group_by?: string[];
+        project_ids?: number[];
+        since?: string;
+        until?: string;
+    }): Promise<any[]>;
+}

package/lib/reports/reports.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Reports = void 0;
+const paginated_request_1 = require("../http/paginated-request");
+class Reports {
+    constructor(http, config) {
+        this.http = http;
+        this.config = config;
+    }
+    async getByExternalId(externalId, filter) {
+        const data = await (0, paginated_request_1.paginatedRequest)(this.http, `/${this.config.accountId}/reports/filter`, filter);
+        return data;
+    }
+}
+exports.Reports = Reports;
+//# sourceMappingURL=reports.js.map

package/lib/reports/reports.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reports.js","sourceRoot":"","sources":["../../../src/lib/reports/reports.ts"],"names":[],"mappings":";;;AACA,iEAA4D;AAG5D,MAAa,OAAO;IAChB,YACqB,IAAmB,EACnB,MAAuB;QADvB,SAAI,GAAJ,IAAI,CAAe;QACnB,WAAM,GAAN,MAAM,CAAiB;IACzC,CAAC;IAEJ,KAAK,CAAC,eAAe,CACjB,UAAkB,EAClB,MAKC;QAED,MAAM,IAAI,GAAG,MAAM,IAAA,oCAAgB,EAC/B,IAAI,CAAC,IAAI,EACT,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,iBAAiB,EAC1C,MAAM,CACT,CAAA;QACD,OAAO,IAAI,CAAA;IACf,CAAC;CACJ;AAtBD,0BAsBC"}

package/lib/teams/teams.d.ts

@@ -0,0 +1,10 @@
+import { AxiosInstance } from 'axios';
+import { TimelyAppConfig, TimelyTeam, TimelyUser } from '../types';
+export declare class Teams {
+    private readonly http;
+    private readonly config;
+    constructor(http: AxiosInstance, config: TimelyAppConfig);
+    getAll(): Promise<TimelyUser[]>;
+    getByName(name: string): Promise<TimelyTeam>;
+    update(teamId: number, team: Partial<TimelyTeam>): Promise<TimelyTeam>;
+}

package/lib/teams/teams.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Teams = void 0;
+class Teams {
+    constructor(http, config) {
+        this.http = http;
+        this.config = config;
+    }
+    async getAll() {
+        const { data } = await this.http.get(`/${this.config.accountId}/teams`);
+        return data;
+    }
+    async getByName(name) {
+        const { data: response } = await this.http.get(`/${this.config.accountId}/teams`);
+        return response.find((u) => u.name === name);
+    }
+    async update(teamId, team) {
+        const { data } = await this.http.put(`/${this.config.accountId}/teams/${teamId}`, { team });
+        return data;
+    }
+}
+exports.Teams = Teams;
+//# sourceMappingURL=teams.js.map

package/lib/teams/teams.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"teams.js","sourceRoot":"","sources":["../../../src/lib/teams/teams.ts"],"names":[],"mappings":";;;AAGA,MAAa,KAAK;IACd,YACqB,IAAmB,EACnB,MAAuB;QADvB,SAAI,GAAJ,IAAI,CAAe;QACnB,WAAM,GAAN,MAAM,CAAiB;IACzC,CAAC;IAEJ,KAAK,CAAC,MAAM;QACR,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,QAAQ,CAAC,CAAA;QACvE,OAAO,IAAI,CAAA;IACf,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,IAAY;QACxB,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,GAA2B,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAClE,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,QAAQ,CACpC,CAAA;QACD,OAAO,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAe,CAAA;IAC9D,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,MAAc,EAAE,IAAyB;QAClD,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,UAAU,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,CAAA;QAC3F,OAAO,IAAI,CAAA;IACf,CAAC;CACJ;AAtBD,sBAsBC"}

package/lib/timely-app.d.ts

@@ -0,0 +1,24 @@
+import { AxiosInstance } from 'axios';
+import { TimelyAppConfig } from './types';
+import { Accounts } from './accounts/accounts';
+import { Clients } from './clients/clients';
+import { Events } from './events/events';
+import { Labels } from './labels/labels';
+import { Projects } from './projects/projects';
+import { Users } from './users/users';
+import { Teams } from './teams/teams';
+import { Reports } from './reports/reports';
+export declare class TimelyApp {
+    private readonly config;
+    readonly accounts: Accounts;
+    readonly clients: Clients;
+    readonly events: Events;
+    readonly http: AxiosInstance;
+    readonly labels: Labels;
+    readonly projects: Projects;
+    readonly teams: Teams;
+    readonly users: Users;
+    readonly reports: Reports;
+    constructor(config: TimelyAppConfig);
+    private validateConfig;
+}

package/lib/timely-app.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TimelyApp = void 0;
+const accounts_1 = require("./accounts/accounts");
+const clients_1 = require("./clients/clients");
+const events_1 = require("./events/events");
+const labels_1 = require("./labels/labels");
+const projects_1 = require("./projects/projects");
+const users_1 = require("./users/users");
+const http_1 = require("./http/http");
+const teams_1 = require("./teams/teams");
+const reports_1 = require("./reports/reports");
+class TimelyApp {
+    constructor(config) {
+        var _a;
+        this.config = config;
+        this.validateConfig();
+        const httpConfig = {
+            baseURL: 'https://api.timelyapp.com/1.1',
+            timeout: (_a = this.config.timeout) !== null && _a !== void 0 ? _a : 20000,
+            headers: {
+                authorization: `Bearer ${this.config.token}`,
+            },
+        };
+        this.http = (0, http_1.createHttpClient)(httpConfig);
+        this.accounts = new accounts_1.Accounts(this.http);
+        this.clients = new clients_1.Clients(this.http, this.config);
+        this.events = new events_1.Events(this.http, this.config);
+        this.labels = new labels_1.Labels(this.http, this.config);
+        this.projects = new projects_1.Projects(this.http, this.config);
+        this.teams = new teams_1.Teams(this.http, this.config);
+        this.users = new users_1.Users(this.http, this.config);
+        this.reports = new reports_1.Reports(this.http, this.config);
+    }
+    validateConfig() {
+        if (!this.config.accountId || !this.config.token)
+            throw new Error('Missing required inputs for TimelyApp constructor');
+    }
+}
+exports.TimelyApp = TimelyApp;
+//# sourceMappingURL=timely-app.js.map

package/lib/timely-app.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"timely-app.js","sourceRoot":"","sources":["../../src/lib/timely-app.ts"],"names":[],"mappings":";;;AAEA,kDAA8C;AAC9C,+CAA2C;AAC3C,4CAAwC;AACxC,4CAAwC;AACxC,kDAA8C;AAC9C,yCAAqC;AACrC,sCAA8C;AAC9C,yCAAqC;AACrC,+CAA2C;AAE3C,MAAa,SAAS;IAmBlB,YAA6B,MAAuB;;QAAvB,WAAM,GAAN,MAAM,CAAiB;QAChD,IAAI,CAAC,cAAc,EAAE,CAAA;QACrB,MAAM,UAAU,GAAG;YACf,OAAO,EAAE,+BAA+B;YACxC,OAAO,EAAE,MAAA,IAAI,CAAC,MAAM,CAAC,OAAO,mCAAI,KAAK;YACrC,OAAO,EAAE;gBACL,aAAa,EAAE,UAAU,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE;aAC/C;SACJ,CAAA;QAED,IAAI,CAAC,IAAI,GAAG,IAAA,uBAAgB,EAAC,UAAU,CAAC,CAAA;QACxC,IAAI,CAAC,QAAQ,GAAG,IAAI,mBAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACvC,IAAI,CAAC,OAAO,GAAG,IAAI,iBAAO,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,CAAA;QAClD,IAAI,CAAC,MAAM,GAAG,IAAI,eAAM,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,CAAA;QAChD,IAAI,CAAC,MAAM,GAAG,IAAI,eAAM,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,CAAA;QAChD,IAAI,CAAC,QAAQ,GAAG,IAAI,mBAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,CAAA;QACpD,IAAI,CAAC,KAAK,GAAG,IAAI,aAAK,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,CAAA;QAC9C,IAAI,CAAC,KAAK,GAAG,IAAI,aAAK,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,CAAA;QAC9C,IAAI,CAAC,OAAO,GAAG,IAAI,iBAAO,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,CAAA;IACtD,CAAC;IAEO,cAAc;QAClB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK;YAC5C,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAA;IAC5E,CAAC;CACJ;AA5CD,8BA4CC"}

package/lib/timely-app.spec.d.ts

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

package/lib/timely-app.spec.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const timely_app_1 = require("./timely-app");
+const labels_1 = require("./labels/labels");
+const events_1 = require("./events/events");
+const clients_1 = require("./clients/clients");
+const accounts_1 = require("./accounts/accounts");
+const projects_1 = require("./projects/projects");
+describe('TimelyApp', () => {
+    it('fails to create given a bad config', () => {
+        try {
+            new timely_app_1.TimelyApp({});
+        }
+        catch (e) {
+            expect(e.message).toBe('Missing required inputs for TimelyApp constructor');
+        }
+    });
+    it('creates component instances', () => {
+        const t = new timely_app_1.TimelyApp({
+            accountId: 'accountId',
+            timeout: 20000,
+            token: 'token',
+        });
+        expect(t.http).toBeDefined();
+        expect(t.labels).toBeInstanceOf(labels_1.Labels);
+        expect(t.events).toBeInstanceOf(events_1.Events);
+        expect(t.clients).toBeInstanceOf(clients_1.Clients);
+        expect(t.accounts).toBeInstanceOf(accounts_1.Accounts);
+        expect(t.projects).toBeInstanceOf(projects_1.Projects);
+    });
+});
+//# sourceMappingURL=timely-app.spec.js.map

package/lib/timely-app.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"timely-app.spec.js","sourceRoot":"","sources":["../../src/lib/timely-app.spec.ts"],"names":[],"mappings":";;AAAA,6CAAwC;AACxC,4CAAwC;AACxC,4CAAwC;AACxC,+CAA2C;AAC3C,kDAA8C;AAC9C,kDAA8C;AAE9C,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;IACvB,EAAE,CAAC,oCAAoC,EAAE,GAAG,EAAE;QAC1C,IAAI,CAAC;YACD,IAAI,sBAAS,CAAC,EAAW,CAAC,CAAA;QAC9B,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACT,MAAM,CAAE,CAAW,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,mDAAmD,CAAC,CAAA;QAC1F,CAAC;IACL,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;QACnC,MAAM,CAAC,GAAG,IAAI,sBAAS,CAAC;YACpB,SAAS,EAAE,WAAW;YACtB,OAAO,EAAE,KAAK;YACd,KAAK,EAAE,OAAO;SACjB,CAAC,CAAA;QAEF,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,CAAA;QAC5B,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,cAAc,CAAC,eAAM,CAAC,CAAA;QACvC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,cAAc,CAAC,eAAM,CAAC,CAAA;QACvC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,cAAc,CAAC,iBAAO,CAAC,CAAA;QACzC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,cAAc,CAAC,mBAAQ,CAAC,CAAA;QAC3C,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,cAAc,CAAC,mBAAQ,CAAC,CAAA;IAC/C,CAAC,CAAC,CAAA;AACN,CAAC,CAAC,CAAA"}

package/lib/types.d.ts

@@ -0,0 +1,387 @@
+type OptionalExceptFor<T, TRequired extends keyof T> = Partial<T> & Pick<T, TRequired>;
+export interface TimelyAppConfig {
+    token: string;
+    accountId: string;
+    timeout?: number;
+}
+export interface TimelyAccount {
+    id: number;
+    name: string;
+    color: string;
+    currency: {
+        id: string;
+        name: string;
+        iso_code: string;
+        symbol: string;
+        symbol_first: boolean;
+    };
+    logo: {
+        large_retina: string;
+        medium_retina: string;
+        small_retina: string;
+        brand_logo: boolean;
+    };
+    from: string;
+    max_users: number;
+    seats: number;
+    max_projects: number;
+    plan_id: number;
+    plan_name: string;
+    next_charge: string;
+    start_of_week: number;
+    created_at: number;
+    payment_mode: string;
+    paid: boolean;
+    company_size: string;
+    plan_code: string;
+    plan_custom: boolean;
+    appstore_transaction_id: number;
+    owner_id: number;
+    weekly_user_capacity: number;
+    default_hour_rate: number;
+    support_email: string;
+    estimated_company_size: string;
+    industry: string;
+    num_users: number;
+    num_projects: number;
+    active_projects_count: number;
+    total_projects_count: number;
+    capacity: {
+        hours: number;
+        minutes: number;
+        seconds: number;
+        formatted: string;
+        total_hours: number;
+        total_seconds: number;
+        total_minutes: number;
+    };
+    status: string;
+    beta: boolean;
+    expired: boolean;
+    trial: boolean;
+    days_to_end_trial: number;
+    features: Array<{
+        name: string;
+        days: number;
+    }>;
+}
+export interface TimelyClient {
+    id: number;
+    name: string;
+    active: boolean;
+    external_id: string;
+    updated_at: string;
+}
+export interface TimelyTeam {
+    id: number;
+    name: string;
+    users: {
+        user_id: number;
+        lead?: boolean;
+    }[];
+}
+export interface TimelyUser {
+    id: number;
+    email: string;
+    name: string;
+    active: boolean;
+    day_view_onboarded: boolean;
+    memory_onboarded: boolean;
+    created_at: number;
+    updated_at: number;
+    last_received_memories_date: boolean;
+    sign_in_count: boolean;
+    external_id: string;
+    time_zone: string;
+    avatar: {
+        large_retina: string;
+        large: string;
+        medium_retina: string;
+        medium: string;
+        small_retina: string;
+        small: string;
+    };
+    type: string;
+    weekly_capacity: number;
+    user_level: string;
+    admin: boolean;
+    hide_hourly_rate: boolean;
+    deleted: boolean;
+    default_hour_rate: number;
+    internal_hour_rate?: number;
+    role_id: number;
+    role: {
+        id: number;
+        name: string;
+    };
+    projects?: {
+        project_id: number;
+        hour_rate?: number;
+    }[];
+}
+export interface TimelyLabel {
+    id: number;
+    name: string;
+    sequence: number;
+    parent_id: number;
+    emoji: string;
+    active: boolean;
+    children: TimelyLabel[];
+}
+export interface TimelyProject {
+    id: number;
+    active: boolean;
+    account_id: number;
+    name: string;
+    color: string;
+    rate_type: string;
+    billable: boolean;
+    updated_at?: number;
+    external_id: string;
+    budget_scope: any;
+    client: TimelyClient;
+    required_notes: boolean;
+    required_labels: boolean;
+    budget_expired_on?: any;
+    has_recurrence: boolean;
+    enable_labels: 'all' | 'none' | 'custom';
+    budget: number;
+    budget_type: string;
+    hour_rate: number;
+    hour_rate_in_cents: number;
+    budget_progress: number;
+    budget_percent: number;
+    users: TimelyProjectUser[];
+    labels: TimelyProjectLabel[];
+    label_ids: number[];
+    required_label_ids: number[];
+    cost: TimelyProjectCost;
+    estimated_cost: TimelyProjectCost;
+    duration: TimelyProjectDuration;
+    estimated_duration: TimelyProjectDuration;
+    billed_cost: TimelyProjectCost;
+    billed_duration: TimelyProjectDuration;
+    unbilled_cost: TimelyProjectCost;
+    unbilled_duration: TimelyProjectDuration;
+}
+export interface TimelyProjectDuration {
+    hours: number;
+    minutes: number;
+    seconds: number;
+    formatted: string;
+    total_hours: number;
+    total_seconds: number;
+    total_minutes: number;
+}
+export interface TimelyProjectCost {
+    fractional: number;
+    formatted: string;
+    amount: number;
+}
+export interface TimelyProjectUser {
+    user_id: number;
+    hour_rate: number;
+    hour_rate_in_cents: number;
+    updated_at?: string;
+    created_at?: string;
+    deleted: boolean;
+}
+export interface TimelyProjectClient {
+    id: number;
+    name: string;
+    active: boolean;
+    external_id: string;
+    updated_at?: string;
+}
+export interface TimelyProjectLabel {
+    project_id: number;
+    label_id: number;
+    budget: number;
+    required: Boolean;
+    updated_at?: Date | string;
+}
+export interface AddTimelyProject {
+    name: string;
+    color: string;
+    client_id: number;
+    rate_type: 'user' | 'project';
+    active?: boolean;
+    currency_code?: string;
+    budget_type?: string;
+    users?: Array<{
+        user_id: number;
+        hour_rate?: number;
+    }>;
+    hour_rate?: number;
+    budget?: number;
+    billable?: boolean;
+    external_id?: string;
+    send_invite?: boolean;
+    required_notes?: boolean;
+    budget_recurrence?: {
+        recur: string;
+        start_date: Date | string;
+        end_date: Date | string;
+        recur_until: Date | string;
+    };
+    labels?: [Array<{
+        label_id: number;
+        required: boolean;
+    }>];
+    enable_labels?: 'all' | 'none' | 'custom';
+}
+export interface TimelyRole {
+    id: number;
+    name: string;
+    display_name: string;
+    description: string;
+    scopes: [
+        {
+            name: string;
+            display_name: string;
+            description: string;
+            default: string;
+            options: any[];
+        }
+    ];
+    default: boolean;
+}
+export interface TimelyUserCapacity {
+    user_id: number;
+    capacities: TimelyCapacity[];
+}
+export interface TimelyCapacity {
+    id?: number;
+    weekly_capacity: number;
+    daily_capacity: number;
+    weekdays: string;
+    total_working_days?: number;
+    weekly_working_days?: number;
+    current: boolean;
+    start_date?: string;
+    end_date?: string;
+}
+export interface TimelyPermission {
+    resource: string;
+    permissions: Array<'create' | 'read' | 'update' | 'delete'>;
+}
+export interface TimelyEvent {
+    id: number;
+    uid: string;
+    user: {
+        id: number;
+        email: string;
+        name: string;
+        avatar: object;
+        updated_at: string;
+    };
+    project: {
+        id: number;
+        active: boolean;
+        account_id: number;
+        name: string;
+        color: string;
+        rate_type: string;
+        billable: boolean;
+        updated_at: number;
+        external_id: string;
+        budget_scope: any;
+        client: {
+            id: number;
+            name: string;
+            active: boolean;
+            external_id: any;
+            updated_at: string;
+        };
+        required_notes: boolean;
+        required_labels: boolean;
+        budget_expired_on: string;
+        has_recurrence: boolean;
+        enable_labels: string;
+        budget: number;
+        budget_type: string;
+        hour_rate: number;
+        hour_rate_in_cents: number;
+        budget_progress: number;
+        budget_percent: number;
+        invoice_by_budget: boolean;
+        labels: TimelyLabel[];
+        label_ids: [];
+        required_label_ids: [];
+    };
+    duration: {
+        hours: number;
+        minutes: number;
+        seconds: number;
+        formatted: string;
+        total_hours: number;
+        total_seconds: number;
+        total_minutes: number;
+    };
+    estimated_duration: {
+        hours: number;
+        minutes: number;
+        seconds: number;
+        formatted: string;
+        total_hours: number;
+        total_seconds: number;
+        total_minutes: number;
+    };
+    cost: {
+        fractional: number;
+        formatted: string;
+        amount: number;
+    };
+    estimated_cost: {
+        fractional: number;
+        formatted: string;
+        amount: number;
+    };
+    day: string;
+    note: string;
+    sequence: number;
+    estimated: boolean;
+    timer_state: string;
+    timer_started_on: 0;
+    timer_stopped_on: 0;
+    label_ids: number[];
+    user_ids: number[];
+    updated_at: number;
+    created_at: number;
+    created_from: string;
+    updated_from: string;
+    billed: boolean;
+    billable: boolean;
+    to: any;
+    from: any;
+    deleted: boolean;
+    hour_rate: number;
+    hour_rate_in_cents: number;
+    creator_id: number;
+    updater_id: number;
+    external_id: any;
+    entry_ids: [any];
+    suggestion_id: any;
+    draft: boolean;
+    manage: boolean;
+    forecast_id: any;
+    readonly locked_reason: string;
+    readonly locked: boolean;
+    invoice_id: any;
+    timestamps: any[];
+}
+export interface TimelyBulkUpdateEventsReturn {
+    deleted_ids: number[];
+    created_ids: number[];
+    updated_ids: number[];
+}
+export type TimelyEventBulkUpdate = OptionalExceptFor<TimelyEvent, 'id'>;
+export type AddTimelyClient = OptionalExceptFor<TimelyClient, 'name'>;
+export type AddTimelyUser = AddToAllProjects & OptionalExceptFor<TimelyUser, 'name' | 'email' | 'role_id'>;
+export type UpdateTimelyUser = Partial<TimelyUser & AddToAllProjects>;
+export interface AddToAllProjects {
+    add_to_all_projects?: boolean;
+}
+export type AddTimelyLabel = OptionalExceptFor<TimelyLabel, 'name'>;
+export type DateString = string | Date;
+export {};

package/lib/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/lib/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/lib/types.ts"],"names":[],"mappings":""}

package/lib/users/users.d.ts

@@ -0,0 +1,19 @@
+import { AxiosInstance } from 'axios';
+import { AddTimelyUser, TimelyAppConfig, TimelyCapacity, TimelyPermission, TimelyRole, TimelyUser, TimelyUserCapacity, UpdateTimelyUser } from '../types';
+export declare class Users {
+    private readonly http;
+    private readonly config;
+    constructor(http: AxiosInstance, config: TimelyAppConfig);
+    getAll(): Promise<TimelyUser[]>;
+    getById(userId: number): Promise<TimelyUser>;
+    getByEmail(userEmail: string): Promise<TimelyUser>;
+    add(user: AddTimelyUser): Promise<TimelyUser>;
+    update(userId: number, user: UpdateTimelyUser): Promise<TimelyUser>;
+    removeUserById(userId: number): Promise<{}>;
+    removeUserByEmail(userEmail: string): Promise<{}>;
+    getRoles(): Promise<TimelyRole[]>;
+    getUserCapacities(): Promise<TimelyUserCapacity[]>;
+    getUserCapacityById(userId: number): Promise<TimelyCapacity>;
+    getUsersPermissions(): Promise<TimelyPermission[]>;
+    getUsersPermissionsById(userId: number): Promise<TimelyPermission[]>;
+}

package/lib/users/users.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Users = void 0;
+class Users {
+    constructor(http, config) {
+        this.http = http;
+        this.config = config;
+    }
+    async getAll() {
+        const { data } = await this.http.get(`/${this.config.accountId}/users?limit=1000`);
+        return data;
+    }
+    async getById(userId) {
+        const { data } = await this.http.get(`/${this.config.accountId}/users/${userId}`);
+        return data;
+    }
+    async getByEmail(userEmail) {
+        const { data: response } = await this.http.get(`/${this.config.accountId}/users?limit=999`);
+        return response.find((u) => u.email === userEmail);
+    }
+    async add(user) {
+        const { data } = await this.http.post(`/${this.config.accountId}/users`, { user });
+        return data;
+    }
+    async update(userId, user) {
+        const { data } = await this.http.put(`/${this.config.accountId}/users/${userId}`, { user });
+        return data;
+    }
+    async removeUserById(userId) {
+        const { data } = await this.http.delete(`/${this.config.accountId}/users/${userId}`);
+        return data;
+    }
+    async removeUserByEmail(userEmail) {
+        const user = await this.getByEmail(userEmail);
+        if (!user)
+            throw new Error(`failed to find user with email: ${userEmail}`);
+        return await this.removeUserById(user.id);
+    }
+    async getRoles() {
+        const { data } = await this.http.get(`/${this.config.accountId}/roles`);
+        return data;
+    }
+    async getUserCapacities() {
+        const { data } = await this.http.get(`/${this.config.accountId}/users/capacities`);
+        return data;
+    }
+    async getUserCapacityById(userId) {
+        const { data } = await this.http.get(`/${this.config.accountId}/users/${userId}/capacities`);
+        return data;
+    }
+    async getUsersPermissions() {
+        const { data } = await this.http.get(`/${this.config.accountId}/users/current/permissions`);
+        return data;
+    }
+    async getUsersPermissionsById(userId) {
+        const { data } = await this.http.get(`/${this.config.accountId}/users/${userId}/permissions`);
+        return data;
+    }
+}
+exports.Users = Users;
+//# sourceMappingURL=users.js.map

package/lib/users/users.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"users.js","sourceRoot":"","sources":["../../../src/lib/users/users.ts"],"names":[],"mappings":";;;AAYA,MAAa,KAAK;IACd,YACqB,IAAmB,EACnB,MAAuB;QADvB,SAAI,GAAJ,IAAI,CAAe;QACnB,WAAM,GAAN,MAAM,CAAiB;IACzC,CAAC;IAEJ,KAAK,CAAC,MAAM;QACR,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,mBAAmB,CAAC,CAAA;QAClF,OAAO,IAAI,CAAA;IACf,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,MAAc;QACxB,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,UAAU,MAAM,EAAE,CAAC,CAAA;QACjF,OAAO,IAAI,CAAA;IACf,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,SAAiB;QAC9B,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,GAA2B,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAClE,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,kBAAkB,CAC9C,CAAA;QACD,OAAO,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,SAAS,CAAe,CAAA;IACpE,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,IAAmB;QACzB,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,QAAQ,EAAE,EAAE,IAAI,EAAE,CAAC,CAAA;QAClF,OAAO,IAAI,CAAA;IACf,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,MAAc,EAAE,IAAsB;QAC/C,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,UAAU,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,CAAA;QAC3F,OAAO,IAAI,CAAA;IACf,CAAC;IAED,KAAK,CAAC,cAAc,CAAC,MAAc;QAC/B,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,UAAU,MAAM,EAAE,CAAC,CAAA;QACpF,OAAO,IAAI,CAAA;IACf,CAAC;IAED,KAAK,CAAC,iBAAiB,CAAC,SAAiB;QACrC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAA;QAC7C,IAAI,CAAC,IAAI;YAAE,MAAM,IAAI,KAAK,CAAC,mCAAmC,SAAS,EAAE,CAAC,CAAA;QAC1E,OAAO,MAAM,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,EAAY,CAAC,CAAA;IACvD,CAAC;IAED,KAAK,CAAC,QAAQ;QACV,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,QAAQ,CAAC,CAAA;QACvE,OAAO,IAAI,CAAA;IACf,CAAC;IAED,KAAK,CAAC,iBAAiB;QACnB,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,mBAAmB,CAAC,CAAA;QAClF,OAAO,IAAI,CAAA;IACf,CAAC;IAED,KAAK,CAAC,mBAAmB,CAAC,MAAc;QACpC,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,UAAU,MAAM,aAAa,CAAC,CAAA;QAC5F,OAAO,IAAI,CAAA;IACf,CAAC;IAED,KAAK,CAAC,mBAAmB;QACrB,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,4BAA4B,CAAC,CAAA;QAC3F,OAAO,IAAI,CAAA;IACf,CAAC;IAED,KAAK,CAAC,uBAAuB,CAAC,MAAc;QACxC,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAChC,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,UAAU,MAAM,cAAc,CAC1D,CAAA;QACD,OAAO,IAAI,CAAA;IACf,CAAC;CACJ;AAtED,sBAsEC"}

package/package.json

@@ -0,0 +1,62 @@
+{
+    "author": {
+        "name": "Josh Stout",
+        "email": "joshstout@gmail.com"
+    },
+    "config": {
+        "commitizen": {
+            "path": "./node_modules/@digitalroute/cz-conventional-changelog-for-jira",
+            "skipScope": false
+        }
+    },
+    "dependencies": {
+        "axios": "1.17.0"
+    },
+    "description": "SDK for timelyapp.com API",
+    "devDependencies": {
+        "@digitalroute/cz-conventional-changelog-for-jira": "6.8.0",
+        "@pliancy/eslint-config-ts": "1.1.0",
+        "@pliancy/semantic-release-config-npm": "2.5.0",
+        "@types/jest": "29.5.12",
+        "commitizen": "4.3.0",
+        "cpy-cli": "5.0.0",
+        "husky": "9.0.11",
+        "jest": "29.7.0",
+        "npm-run-all2": "5.0.0",
+        "pinst": "3.0.0",
+        "rimraf": "5.0.5",
+        "semantic-release": "23.0.2",
+        "ts-jest": "29.1.2",
+        "ts-node": "10.9.2",
+        "typescript": "5.4.2"
+    },
+    "engines": {
+        "node": ">=12"
+    },
+    "keywords": [],
+    "license": "MIT",
+    "main": "index.js",
+    "name": "@pliancy/timelyapp-sdk",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/pliancy/timelyapp-sdk"
+    },
+    "scripts": {
+        "build": "run-s -l clean test tsc copy",
+        "build:check": "tsc --noEmit",
+        "clean": "rimraf coverage dist tmp",
+        "copy": "pinst --disable && cpy package.json dist && cpy README.md dist && pinst --enable",
+        "lint": "eslint \"src/**/*.ts\" --fix",
+        "_postinstall": "husky install",
+        "qa": "run-s -l lint test clean build:check",
+        "semantic-release": "semantic-release",
+        "test": "jest",
+        "tsc": "tsc -p tsconfig.build.json"
+    },
+    "types": "index.d.ts",
+    "version": "6.1.0",
+    "volta": {
+        "node": "24.16.0",
+        "yarn": "1.22.21"
+    }
+}