node-paymo-api 0.0.3 → 0.0.5

package/src/resources/reports/index.ts

@@ -0,0 +1,38 @@
+import { AbstractResource, AbstractResourceInterface } from '../../abstract'
+import { AuthInterface } from "../../types"
+import { ReportsListConfig, ReportsTypeCreate, ReportsTypeResponse, ReportsTypeUpdate } from "./types"
+
+export interface ReportsHandler extends AbstractResourceInterface {
+  get: (id: number) => Promise<ReportsTypeResponse | null>
+  list: (config?: ReportsListConfig) => Promise<ReportsTypeResponse[]>
+  create: (d: ReportsTypeCreate) => Promise<ReportsTypeResponse | null>
+  update: (id: number, data: ReportsTypeUpdate) => Promise<ReportsTypeResponse | null>
+  delete: (id: number) => Promise<boolean>
+}
+
+export class Reports extends AbstractResource implements ReportsHandler {
+  constructor(auth: AuthInterface) {
+    super(auth, 'reports')
+  }
+
+  get = async (id: number) => {
+    return (await this.baseGet(id)) as ReportsTypeResponse | null
+  }
+
+  list = async (config: ReportsListConfig = {}) => {
+    return (await this.baseList(config)) as ReportsTypeResponse[]
+  }
+
+  create = async (data: ReportsTypeCreate) => {
+    return (await this.baseCreate(data)) as ReportsTypeResponse | null
+  }
+
+  update = async (id: number, data: ReportsTypeUpdate) => {
+    return (await this.baseUpdate(id, data)) as ReportsTypeResponse | null
+  }
+
+  delete = async (id: number) => {
+    return await this.baseDelete(id)
+  }
+
+}

package/src/resources/reports/types.ts

@@ -0,0 +1,104 @@
+import { FilterOperator, GenericListConfig, Merge } from "../../types"
+
+// PAYMO API DOCS - 2019-12-11    /reports    /reports/####
+// =================================================================================================
+
+type ReportsDateIntervals = 'today' | 'yesterday' | 'this_month' | 'last_month' | 'this_week' | 'last_week' | 'this_year' | 'last_year' | 'all_time'
+
+interface ReportsIncludeOptions {
+  days?: boolean
+  clients?: boolean
+  users?: boolean
+  projects?: boolean
+  tasklists?: boolean
+  tasks?: boolean
+  billed?: boolean
+  entries?: boolean
+}
+
+interface ReportsExtraOptions {
+  exclude_billed_entries?: boolean
+  exclude_unbilled_entries?: boolean
+  exclude_billable_tasks?: boolean
+  exclude_nonbillable_tasks?: boolean
+  exclude_flat_rate_tasks?: boolean
+  exclude_flats?: boolean
+  enable_time_rounding?: boolean
+  rounding_step?: number // In minutes
+  display_charts?: boolean
+  display_costs?: boolean
+  display_entries_descriptions?: boolean
+  display_seconds?: boolean
+  display_tasks_codes?: boolean
+  display_tasks_descriptions?: boolean
+  display_tasks_complete_status?: boolean
+  display_tasks_remaining_time_budgets?: boolean
+  display_tasks_time_budget?: boolean
+  display_projects_budgets?: boolean
+  display_projects_codes?: boolean
+  display_projects_descriptions?: boolean
+  display_projects_remaining_budgets?: boolean
+  display_users_positions?: boolean
+  order?: Array<keyof ReportsIncludeOptions>
+}
+
+export interface ReportsTypeRead {
+  readonly id: number
+  readonly created_on: string
+  readonly updated_on: string
+}
+
+export interface ReportsTypeUpdate {
+  name?: string
+  user_id?: number
+  type?: 'static' | 'live' | 'temp'
+  start_date?: string
+  end_date?: string
+  date_interval?: ReportsDateIntervals
+  shared?: boolean
+}
+
+export type ReportsTypeResponse = Merge<ReportsTypeUpdate, Merge<ReportsTypeRead, {
+  info: any       // Parameters used in the creation
+  content?: { items: any[] }   // Mix of response data types, @todo Can be narrowed down later
+  permalink: string
+  shared: boolean
+  share_client_id?: number
+}>>
+
+export type ReportsTypeCreate = ReportsTypeCreateWithInterval | ReportsTypeCreateWithDates
+
+interface ReportsTypeCommon extends ReportsTypeUpdate {
+  projects?: number[] | 'all' | 'all_active' | 'all_archived' | string // string must be status_id=STATUS_ID
+  clients?: number[] | 'all' | 'all_active'
+  users?: number[] | 'all' | 'all_active' | 'all_archived'
+  include?: ReportsIncludeOptions
+  extra?: ReportsExtraOptions
+}
+
+interface ReportsTypeCreateWithInterval extends ReportsTypeCommon {
+  date_interval: ReportsDateIntervals
+}
+
+interface ReportsTypeCreateWithDates extends ReportsTypeCommon {
+  start_date: string
+  end_date: string
+}
+
+export interface ReportsTypeFilter {
+
+}
+
+export interface ReportsFilterCondition extends ReportsTypeFilter {
+  _custom?: {
+    [k: string]: {
+      key?: Extract<keyof ReportsTypeFilter, string>
+      operator?:FilterOperator
+      value: string | number | boolean | null | number[]
+    }
+  }
+}
+
+export interface ReportsListConfig extends GenericListConfig {
+  filter?:ReportsFilterCondition
+}

package/src/resources/sessions/index.ts

@@ -0,0 +1,39 @@
+import { AbstractResource, AbstractResourceInterface } from '../../abstract'
+import { AuthInterface } from "../../types"
+import { SessionsListConfig, SessionsTypeCreate, SessionsTypeResponse, SessionsTypeUpdate } from "./types"
+
+export interface SessionsHandler extends AbstractResourceInterface {
+  get: (id: number) => Promise<SessionsTypeResponse | null>
+  list: (config?: SessionsListConfig) => Promise<SessionsTypeResponse[]>
+  create: (d: SessionsTypeCreate) => Promise<SessionsTypeResponse | null>
+  update: (id: number, data: SessionsTypeUpdate) => Promise<SessionsTypeResponse | null>
+  delete: (id: number) => Promise<boolean>
+}
+
+export class Sessions extends AbstractResource implements SessionsHandler {
+  constructor(auth: AuthInterface) {
+    super(auth, 'sessions')
+  }
+
+  get = async (id: number) => {
+    return (await this.baseGet(id)) as SessionsTypeResponse | null
+  }
+
+  list = async (config: SessionsListConfig = {}) => {
+    return (await this.baseList(config)) as SessionsTypeResponse[]
+  }
+
+  create = async (data: SessionsTypeCreate) => {
+    return (await this.baseCreate(data)) as SessionsTypeResponse | null
+  }
+
+  // There is no update method for sessions. Create, List, Get, or Delete only
+  update = async (id: number, data: SessionsTypeUpdate) => {
+    return null
+  }
+
+  delete = async (id: number) => {
+    return await this.baseDelete(id)
+  }
+
+}

package/src/resources/sessions/types.ts

@@ -0,0 +1,43 @@
+import { FilterOperator, GenericListConfig, Merge } from "../../types"
+
+// PAYMO API DOCS - 2019-12-11    /sessions    /sessions/####
+// =================================================================================================
+
+export interface SessionsTypeRead {
+  readonly id: string
+  readonly ip: string
+  readonly created_on: string
+  readonly updated_on: string
+  readonly expires_on: string
+  readonly user_id: number
+}
+
+export interface SessionsTypeUpdate {
+
+}
+
+export type SessionsTypeResponse = Merge<SessionsTypeUpdate, Merge<SessionsTypeRead, {
+
+}>>
+
+export interface SessionsTypeCreate {
+
+}
+
+export interface SessionsTypeFilter {
+
+}
+
+export interface SessionsFilterCondition extends SessionsTypeFilter {
+  _custom?: {
+    [k: string]: {
+      key?: Extract<keyof SessionsTypeFilter, string>
+      operator?:FilterOperator
+      value: string | number | boolean | null | number[]
+    }
+  }
+}
+
+export interface SessionsListConfig extends GenericListConfig {
+  filter?:SessionsFilterCondition
+}

package/src/resources/tasklists/index.ts

@@ -0,0 +1,38 @@
+import { AbstractResource, AbstractResourceInterface } from '../../abstract'
+import { AuthInterface } from "../../types"
+import { TaskListsListConfig, TaskListsTypeCreate, TaskListsTypeResponse, TaskListsTypeUpdate } from "./types"
+
+export interface TaskListsHandler extends AbstractResourceInterface {
+  get: (id: number) => Promise<TaskListsTypeResponse | null>
+  list: (config?: TaskListsListConfig) => Promise<TaskListsTypeResponse[]>
+  create: (d: TaskListsTypeCreate) => Promise<TaskListsTypeResponse | null>
+  update: (id: number, data: TaskListsTypeUpdate) => Promise<TaskListsTypeResponse | null>
+  delete: (id: number) => Promise<boolean>
+}
+
+export class TaskLists extends AbstractResource implements TaskListsHandler {
+  constructor(auth: AuthInterface) {
+    super(auth, 'tasklists')
+  }
+
+  get = async (id: number) => {
+    return (await this.baseGet(id)) as TaskListsTypeResponse | null
+  }
+
+  list = async (config: TaskListsListConfig = {}) => {
+    return (await this.baseList(config)) as TaskListsTypeResponse[]
+  }
+
+  create = async (data: TaskListsTypeCreate) => {
+    return (await this.baseCreate(data)) as TaskListsTypeResponse | null
+  }
+
+  update = async (id: number, data: TaskListsTypeUpdate) => {
+    return (await this.baseUpdate(id, data)) as TaskListsTypeResponse | null
+  }
+
+  delete = async (id: number) => {
+    return await this.baseDelete(id)
+  }
+
+}

package/src/resources/tasklists/types.ts

@@ -0,0 +1,48 @@
+import { FilterOperator, GenericListConfig, Merge } from '../../types'
+
+// PAYMO API DOCS - 2019-12-11    /tasklists    /tasklists/####
+// =================================================================================================
+
+export interface TaskListsTypeRead {
+  readonly id: number
+  readonly created_on: string
+  readonly updated_on: string
+  readonly project_id: number
+}
+
+export interface TaskListsTypeUpdate {
+  name?: string
+  seq?: number | null
+  milestone_id?: number
+  tasks_order?: number[]
+}
+
+export type TaskListsTypeResponse = Merge<
+  TaskListsTypeUpdate,
+  Merge<TaskListsTypeRead, {}>
+>
+
+export interface TaskListsTypeCreate extends TaskListsTypeUpdate {
+  name: string
+  project_id: number
+}
+
+export interface TaskListsTypeFilter {
+  name?:string
+  project_id?: number
+  milestone_id?: number
+}
+
+export interface TaskListsFilterCondition extends TaskListsTypeFilter {
+  _custom?: {
+    [k: string]: {
+      key?: Extract<keyof TaskListsTypeFilter, string>
+      operator?: FilterOperator
+      value: string | number | boolean | null | number[]
+    }
+  }
+}
+
+export interface TaskListsListConfig extends GenericListConfig {
+  filter?: TaskListsFilterCondition
+}

package/src/resources/tasks/index.ts

@@ -0,0 +1,38 @@
+import { AbstractResource, AbstractResourceInterface } from '../../abstract'
+import { AuthInterface } from "../../types"
+import { TasksListConfig, TasksTypeCreate, TasksTypeResponse, TasksTypeUpdate } from "./types"
+
+export interface TasksHandler extends AbstractResourceInterface {
+  get: (id: number) => Promise<TasksTypeResponse | null>
+  list: (config?: TasksListConfig) => Promise<TasksTypeResponse[]>
+  create: (d: TasksTypeCreate) => Promise<TasksTypeResponse | null>
+  update: (id: number, data: TasksTypeUpdate) => Promise<TasksTypeResponse | null>
+  delete: (id: number) => Promise<boolean>
+}
+
+export class Tasks extends AbstractResource implements TasksHandler {
+  constructor(auth: AuthInterface) {
+    super(auth, 'tasks')
+  }
+
+  get = async (id: number) => {
+    return (await this.baseGet(id)) as TasksTypeResponse | null
+  }
+
+  list = async (config: TasksListConfig = {}) => {
+    return (await this.baseList(config)) as TasksTypeResponse[]
+  }
+
+  create = async (data: TasksTypeCreate) => {
+    return (await this.baseCreate(data)) as TasksTypeResponse | null
+  }
+
+  update = async (id: number, data: TasksTypeUpdate) => {
+    return (await this.baseUpdate(id, data)) as TasksTypeResponse | null
+  }
+
+  delete = async (id: number) => {
+    return await this.baseDelete(id)
+  }
+
+}

package/src/resources/tasks/types.ts

@@ -0,0 +1,76 @@
+import { FilterOperator, GenericListConfig, Merge } from "../../types"
+
+// PAYMO API DOCS - 2019-12-11    /tasks    /tasks/####
+// =================================================================================================
+
+export interface TasksTypeRead {
+  readonly id: number
+  readonly created_on: string
+  readonly updated_on: string
+  readonly project_id: number
+}
+
+export interface TasksTypeUpdate {
+  name?:string
+  code?:string
+  tasklist_id?: number
+  seq?: number | null
+  description?: string
+  complete?: boolean
+  due_date?: string
+  user_id?: number
+  users?: number[] | null
+  billable?: boolean
+  flat_billing?: boolean
+  price_per_hour?: number
+  budget_hours?: number
+  estimated_price?: number
+  invoiced?: boolean
+  invoice_item_id?: number
+  priority?: 25 | 50 | 75 | 100
+  status_id?: number
+}
+
+export type TasksTypeResponse = Merge<TasksTypeUpdate, Merge<TasksTypeRead, {
+  completed_by?:number
+  cover_file_id?: number
+  start_date?:string
+  recurring_profile_id?:number
+  billing_type?:string
+}>>
+
+interface TasksTypeCreateCommon extends TasksTypeUpdate {
+  name: string
+}
+
+interface TasksTypeCreateWithTaskList extends TasksTypeCreateCommon {
+  tasklist_id: number
+}
+
+interface TasksTypeCreateWithProject extends TasksTypeCreateCommon {
+  project_id: number
+}
+
+export type TasksTypeCreate = TasksTypeCreateWithProject | TasksTypeCreateWithTaskList
+
+export interface TasksTypeFilter {
+  project_id?:number
+  tasklist_id?: number
+  complete?: boolean
+  users?: number | (number|string)[] | 'anyone'
+  mytasks?: boolean
+}
+
+export interface TasksFilterCondition extends TasksTypeFilter {
+  _custom?: {
+    [k: string]: {
+      key?: Extract<keyof TasksTypeFilter, string>
+      operator?:FilterOperator
+      value: string | number | boolean | null | number[]
+    }
+  }
+}
+
+export interface TasksListConfig extends GenericListConfig {
+  filter?:TasksFilterCondition
+}

package/src/resources/users/index.ts

@@ -0,0 +1,48 @@
+import { AbstractResource, AbstractResourceInterface } from '../../abstract'
+import { AuthInterface } from "../../types"
+import { UsersListConfig, UserTypeCreate, UserTypeResponse, UserTypeUpdate } from "./types"
+
+export interface UsersHandler extends AbstractResourceInterface {
+  get: (id: number) => Promise<UserTypeResponse | null>
+  list: (config?: UsersListConfig) => Promise<UserTypeResponse[]>
+  create: (d: UserTypeCreate) => Promise<UserTypeResponse | null>
+  update: (id: number, data: UserTypeUpdate) => Promise<UserTypeResponse | null>
+  delete: (id: number) => Promise<boolean>
+  retire: (id: number) => Promise<UserTypeResponse | null>
+  activate: (id: number) => Promise<UserTypeResponse | null>
+}
+
+export class Users extends AbstractResource implements UsersHandler {
+  constructor(auth: AuthInterface) {
+    super(auth, 'users')
+  }
+
+  get = async (id: number) => {
+    return (await this.baseGet(id)) as UserTypeResponse | null
+  }
+
+  list = async (config: UsersListConfig = {}) => {
+    return (await this.baseList(config)) as UserTypeResponse[]
+  }
+
+  create = async (data: UserTypeCreate) => {
+    return (await this.baseCreate(data)) as UserTypeResponse | null
+  }
+
+  update = async (id: number, data: UserTypeUpdate) => {
+    return (await this.baseUpdate(id, data)) as UserTypeResponse | null
+  }
+
+  delete = async (id: number) => {
+    return await this.baseDelete(id)
+  }
+
+  retire = async (id: number) => {
+    return await this.update(id, {active:false})
+  }
+
+  activate = async (id: number) => {
+    return await this.update(id, {active:true})
+  }
+
+}

package/src/resources/users/types.ts

@@ -0,0 +1,124 @@
+import { FilterOperator, GenericListConfig, Merge } from "../../types"
+
+// PAYMO API DOCS - 2019-11-23    /users    /users/####
+// =================================================================================================
+// id	integer	(read-only) Unique user identifier
+// name	text	Full name
+// email	email	Email address. There are no two active users in Paymo with the same email address. Email is used to receive notifications from Paymo as well as to log into Paymo.
+// type	text	Account type. Available options: Admin, Employee.
+// active	boolean	If true the user is active and can use Paymo, otherwise it is retired (archived).
+// timezone	text	User timezone. List of available options
+// phone	text	Phone number
+// skype	text	Skype account name
+// position	text	Job position description
+// workday_hours	decimal	Number of working hours in a day. It is used to compute user performance.
+// price_per_hour	decimal	Price per hour. It is used in invoicing to compute the cost of worked time.
+// created_on	datetime	(read-only) Date and time when the user was created
+// updated_on	datetime	(read-only) Date and time when the user was last updated
+// image	url	User profile image URL
+// image_thumb_large	url	(read-only) User profile image large size thumbnail URL
+// image_thumb_medium	url	(read-only) User profile image medium size thumbnail URL
+// image_thumb_small	url	(read-only) User profile image small size thumbnail URL
+// date_format	text	Format for displaying dates in the application. Available options: Y-m-d, d/m/Y, m/d/Y, d.m.Y.
+// time_format	text	Format for displaying time values. Available options: H:i for 24-hour format, h:i a for 12-hour format.
+// decimal_sep	text	Decimal separator for displaying numeric values
+// thousands_sep	text	Thousands separator for displaying numeric values
+// week_start	text	Numeric value in the range 0-6 representing the day the week starts, 0 being Sunday, 6 being Saturday.
+// language	text	Paymo user interface language
+// theme	text	Paymo user interface theme name
+// assigned_projects	list	List of projects ids to which the user is assigned
+// managed_projects	list	List of projects ids that the user manages. This list is a subset of assigned_projects.
+// is_online	boolean	(read-only) If true the user is logged into Paymo.
+// password	text	(only for create/update requests) User password when creating or updating a user.
+
+export interface UserTypeRead {
+  readonly id: number
+  readonly created_on: string
+  readonly updated_on: string
+  readonly image_thumb_large?: string
+  readonly image_thumb_medium?: string
+  readonly image_thumb_small?: string
+  readonly is_online?: boolean
+}
+
+export interface UserTypeUpdate {
+  name?: string
+  email?: string
+  type?: "Admin" | "Employee"
+  active?: boolean
+  timezone?: string
+  phone?: string
+  skype?: string
+  position?: string
+  workday_hours?: number
+  price_per_hour?:number
+  image?: string
+  date_format?:"Y-m-d"|"d/m/Y"|"m/d/Y"|"d.m.Y"
+  time_format?:"H:i"|"h:i"
+  decimal_sep?:string
+  thousands_sep?:string
+  week_start?:"0"|"1"|"2"|"3"|"4"|"5"|"6"
+  language?:string
+  theme?:string
+  assigned_projects?:number[]
+  managed_projects?:number[]
+  password?:string
+}
+
+export type UserTypeResponse = Merge<UserTypeUpdate, Merge<UserTypeRead, {
+  additional_privileges:any[]
+  annual_leave_days_number:number|null
+  image:string|null
+  phone:string|null
+  position:string|null
+  price_per_hour:string|null
+  skype:string|null
+  user_hash:string
+  workflows:number[]
+}>>
+
+export interface UserTypeCreate extends UserTypeUpdate {
+  email: string
+}
+
+export interface UserTypeFilter {
+  id?: number
+  created_on?: string
+  updated_on?: string
+  is_online?: boolean
+  name?: string
+  email?: string
+  type?: "Admin" | "Employee"
+  active?: boolean
+  timezone?: string
+  phone?: string
+  skype?: string
+  position?: string
+  workday_hours?: number
+  price_per_hour?:number
+  image?: string
+  date_format?:"Y-m-d"|"d/m/Y"|"m/d/Y"|"d.m.Y"
+  time_format?:"H:i"|"h:i"
+  decimal_sep?:string
+  thousands_sep?:string
+  week_start?:0|1|2|3|4|5|6
+  language?:string
+  theme?:string
+  assigned_projects?:number[]
+  managed_projects?:number[]
+  password?:string
+}
+
+export interface UserFilterCondition extends UserTypeFilter {
+  _custom?: {
+    [k: string]: {
+      key?: Extract<keyof UserTypeFilter, string>
+      operator?:FilterOperator
+      value: string | number | boolean | null | number[]
+    }
+  }
+}
+
+export interface UsersListConfig extends GenericListConfig {
+  filter?:UserFilterCondition
+}

package/src/resources/usertasks/index.ts

@@ -0,0 +1,46 @@
+import { AbstractResource, AbstractResourceInterface } from '../../abstract'
+import { AuthInterface } from "../../types"
+import { UserTasksListConfig, UserTasksTypeCreate, UserTasksTypeResponse, UserTasksTypeUpdate } from "./types"
+
+export interface UserTasksHandler extends AbstractResourceInterface {
+  get: (id: number) => Promise<UserTasksTypeResponse | null>
+  list: (config?: UserTasksListConfig) => Promise<UserTasksTypeResponse[]>
+  create: (d: UserTasksTypeCreate) => Promise<UserTasksTypeResponse | null>
+  update: (id: number, data: UserTasksTypeUpdate) => Promise<UserTasksTypeResponse | null>
+  delete: (id: number) => Promise<boolean>
+}
+
+export class UserTasks extends AbstractResource implements UserTasksHandler {
+  constructor(auth: AuthInterface) {
+    super(auth, 'userstasks')
+  }
+
+  get = async (id: number) => {
+    return (await this.baseGet(id)) as UserTasksTypeResponse | null
+  }
+
+  list = async (config: UserTasksListConfig = {}) => {
+    const validConfig =
+      !!config &&
+      config.filter &&
+      (config.filter.user_id || config.filter.task_id)
+    if (!validConfig) {
+      console.log('User task list requires at least a user_id or task_id filter')
+      return []
+    }
+    return (await this.baseList(config)) as UserTasksTypeResponse[]
+  }
+
+  create = async (data: UserTasksTypeCreate) => {
+    return (await this.baseCreate(data)) as UserTasksTypeResponse | null
+  }
+
+  update = async (id: number, data: UserTasksTypeUpdate) => {
+    return (await this.baseUpdate(id, data)) as UserTasksTypeResponse | null
+  }
+
+  delete = async (id: number) => {
+    return await this.baseDelete(id)
+  }
+
+}

package/src/resources/usertasks/types.ts

@@ -0,0 +1,43 @@
+import { FilterOperator, GenericListConfig, Merge } from "../../types"
+
+// PAYMO API DOCS - 2019-12-11    /userstasks    /userstasks/####
+// =================================================================================================
+
+export interface UserTasksTypeRead {
+  readonly id: number
+  readonly created_on: string
+  readonly updated_on: string
+}
+
+export interface UserTasksTypeUpdate {
+  user_id?:number
+  task_id?:number
+}
+
+export type UserTasksTypeResponse = Merge<UserTasksTypeUpdate, Merge<UserTasksTypeRead, {
+
+}>>
+
+export interface UserTasksTypeCreate extends UserTasksTypeUpdate {
+  user_id:number
+  task_id:number
+}
+
+export interface UserTasksTypeFilter {
+  user_id?:number
+  task_id?:number
+}
+
+export interface UserTasksFilterCondition extends UserTasksTypeFilter {
+  _custom?: {
+    [k: string]: {
+      key?: Extract<keyof UserTasksTypeFilter, string>
+      operator?:FilterOperator
+      value: string | number | boolean | null | number[]
+    }
+  }
+}
+
+export interface UserTasksListConfig extends GenericListConfig {
+  filter?:UserTasksFilterCondition
+}