node-paymo-api 0.0.3 → 0.0.5

package/src/resources/estimates/types.ts

@@ -0,0 +1,89 @@
+import { FilterOperator, GenericListConfig, Merge, PaymoCurrency } from "../../types"
+
+
+// PAYMO API DOCS - 2019-12-11    /estimates    /estimates/####
+// =================================================================================================
+
+export interface EstimatesTypeRead {
+  readonly id: number
+  readonly created_on: string
+  readonly updated_on: string
+  readonly subtotal : number
+  readonly total : number
+  readonly tax_amount : number
+  readonly tax2_amount : number
+  readonly permalink : string
+  readonly pdf_link : string
+}
+
+export interface EstimatesTypeUpdate {
+  number?: string
+  client_id?: number
+  template_id?: number
+  status?: 'draft' | 'sent' | 'viewed' |'accepted' | 'invoiced' | 'void'
+  currency?: PaymoCurrency
+  date?: string
+  tax?: number
+  tax2?: number
+  tax_on_tax?: boolean
+  bill_to?: string
+  company_info?: string
+  footer?: string
+  notes?: string
+  tax_text?:string
+  tax2_text?:string
+  title?:string
+  invoice_id?:number
+  estimateitems?: EstimateItemTypeCreate[] // Not sure if this is how you update items or not !
+}
+
+export type EstimatesTypeResponse = Merge<EstimatesTypeUpdate, Merge<EstimatesTypeRead, {
+  estimateitems?: EstimateItemTypeRead[]
+}>>
+
+export interface EstimatesTypeCreate extends EstimatesTypeUpdate {
+  client_id: number
+  currency: PaymoCurrency
+  items?:EstimateItemTypeCreate[]
+}
+
+export interface EstimatesTypeFilter extends EstimatesTypeUpdate {
+  created_on?: string
+  updated_on?: string
+  subtotal?: number
+  total?: number
+  tax_amount?: number
+  tax2_amount?: number
+}
+
+export interface EstimatesFilterCondition extends EstimatesTypeFilter {
+  _custom?: {
+    [k: string]: {
+      key?: Extract<keyof EstimatesTypeFilter, string>
+      operator?:FilterOperator
+      value: string | number | boolean | null | number[]
+    }
+  }
+}
+
+export interface EstimatesListConfig extends GenericListConfig {
+  filter?:EstimatesFilterCondition
+}
+
+export interface EstimateItemTypeCreate {
+  item: string
+  description: string
+  price_unit: number
+  quantity: number
+  apply_tax?: boolean
+  seq?: number | null
+}
+
+export interface EstimateItemTypeRead extends EstimateItemTypeCreate {
+  readonly id: number
+  readonly estimate_id: number
+  apply_tax: boolean
+  seq: number | null
+  readonly created_on: string
+  readonly updated_on: string
+}

package/src/resources/estimatetemplates/index.ts

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

package/src/resources/estimatetemplates/types.ts

@@ -0,0 +1,46 @@
+import { FilterOperator, GenericListConfig, Merge } from "../../types"
+
+// PAYMO API DOCS - 2019-12-11    /estimatetemplates    /estimatetemplates/####
+// =================================================================================================
+
+export interface EstimateTemplatesTypeRead {
+  readonly id: number
+  readonly created_on: string
+  readonly updated_on: string
+}
+
+export interface EstimateTemplatesTypeUpdate {
+  name?:string
+  title?:string
+  html?:string
+  css?:string
+  is_default?:boolean
+}
+
+export type EstimateTemplatesTypeResponse = Merge<EstimateTemplatesTypeUpdate, Merge<EstimateTemplatesTypeRead, {
+
+}>>
+
+export interface EstimateTemplatesTypeCreate extends EstimateTemplatesTypeUpdate {
+  name: string
+}
+
+export interface EstimateTemplatesTypeFilter {
+  id?:number
+  name?: string
+  is_default?: boolean
+}
+
+export interface EstimateTemplatesFilterCondition extends EstimateTemplatesTypeFilter {
+  _custom?: {
+    [k: string]: {
+      key?: Extract<keyof EstimateTemplatesTypeFilter, string>
+      operator?:FilterOperator
+      value: string | number | boolean | null | number[]
+    }
+  }
+}
+
+export interface EstimateTemplatesListConfig extends GenericListConfig {
+  filter?:EstimateTemplatesFilterCondition
+}

package/src/resources/expenses/index.ts

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

package/src/resources/expenses/types.ts

@@ -0,0 +1,58 @@
+import { FilterOperator, GenericListConfig, Merge, PaymoCurrency } from "../../types"
+
+// PAYMO API DOCS - 2019-12-11    /expenses    /expenses/####
+// =================================================================================================
+
+export interface ExpensesTypeRead {
+  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
+}
+
+export interface ExpensesTypeUpdate {
+  client_id?: number
+  project_id?: number
+  user_id?: number
+  amount?: number
+  currency?: PaymoCurrency
+  date?: string
+  notes?: string
+  invoiced?: boolean
+  invoice_item_id?: number
+  tags?: string[]
+  file?: string
+}
+
+export type ExpensesTypeResponse = Merge<ExpensesTypeUpdate, Merge<ExpensesTypeRead, {
+
+}>>
+
+export interface ExpensesTypeCreate extends ExpensesTypeUpdate {
+  client_id: number
+  currency: PaymoCurrency
+  amount: number
+}
+
+export interface ExpensesTypeFilter {
+  client_id?: number
+  project_id?: number
+  user_id?: number
+  invoice_item_id?: number
+}
+
+export interface ExpensesFilterCondition extends ExpensesTypeFilter {
+  _custom?: {
+    [k: string]: {
+      key?: Extract<keyof ExpensesTypeFilter, string>
+      operator?:FilterOperator
+      value: string | number | boolean | null | number[]
+    }
+  }
+}
+
+export interface ExpensesListConfig extends GenericListConfig {
+  filter?:ExpensesFilterCondition
+}

package/src/resources/files/index.ts

@@ -0,0 +1,50 @@
+import { AbstractResource, AbstractResourceInterface } from '../../abstract'
+import { AuthInterface } from "../../types"
+import { FilesListConfig, FilesTypeCreate, FilesTypeResponse, FilesTypeUpdate } from "./types"
+
+export interface FilesHandler extends AbstractResourceInterface {
+  get: (id: number) => Promise<FilesTypeResponse | null>
+  list: (config?: FilesListConfig) => Promise<FilesTypeResponse[]>
+  create: (d: FilesTypeCreate) => Promise<FilesTypeResponse | null>
+  update: (id: number, data: FilesTypeUpdate) => Promise<FilesTypeResponse | null>
+  delete: (id: number) => Promise<boolean>
+}
+
+export class Files extends AbstractResource implements FilesHandler {
+  constructor(auth: AuthInterface) {
+    super(auth, 'files')
+  }
+
+  get = async (id: number) => {
+    return (await this.baseGet(id)) as FilesTypeResponse | null
+  }
+
+  list = async (config: FilesListConfig = {}) => {
+    const validConfig =
+      !!config &&
+      config.filter &&
+      (config.filter.project_id ||
+        config.filter.task_id ||
+        config.filter.discussion_id ||
+        config.filter.comment_id)
+    if (!validConfig) {
+      console.log('File list requires at least one valid filter condition')
+      return []
+    }
+    return (await this.baseList(config)) as FilesTypeResponse[]
+  }
+
+  // Does not work yet, needs multipart upload system
+  create = async (data: FilesTypeCreate) => {
+    return (await this.baseCreate(data)) as FilesTypeResponse | null
+  }
+
+  update = async (id: number, data: FilesTypeUpdate) => {
+    return (await this.baseUpdate(id, data)) as FilesTypeResponse | null
+  }
+
+  delete = async (id: number) => {
+    return await this.baseDelete(id)
+  }
+
+}

package/src/resources/files/types.ts

@@ -0,0 +1,58 @@
+import { FilterOperator, GenericListConfig, Merge } from "../../types"
+
+// PAYMO API DOCS - 2019-12-11    /files    /files/####
+// =================================================================================================
+
+export interface FilesTypeRead {
+  readonly id: number
+  readonly created_on: string
+  readonly updated_on: string
+  readonly user_id: number | null
+  readonly project_id: number | null
+  readonly discussion_id: number | null
+  readonly task_id: number | null
+  readonly comment_id: number | null
+  readonly token: string
+  readonly size: number
+  readonly mime: string
+  readonly file: string
+  readonly image_thumb_large?: string
+  readonly image_thumb_medium?: string
+  readonly image_thumb_small?: string
+}
+
+export interface FilesTypeUpdate {
+  original_filename?: string
+  description?: string
+}
+
+export type FilesTypeResponse = Merge<FilesTypeUpdate, Merge<FilesTypeRead, {
+
+}>>
+
+// This is not the actual CREATE type as it is a multi-part upload
+export interface FilesTypeCreate extends FilesTypeUpdate {
+
+}
+
+export interface FilesTypeFilter {
+  original_filename?: string
+  project_id?: number
+  discussion_id?: number
+  task_id?: number
+  comment_id?: number
+}
+
+export interface FilesFilterCondition extends FilesTypeFilter {
+  _custom?: {
+    [k: string]: {
+      key?: Extract<keyof FilesTypeFilter, string>
+      operator?:FilterOperator
+      value: string | number | boolean | null | number[]
+    }
+  }
+}
+
+export interface FilesListConfig extends GenericListConfig {
+  filter?:FilesFilterCondition
+}

package/src/resources/index.ts

@@ -0,0 +1,289 @@
+import { AuthInterface } from '../types'
+import { Projects, ProjectsHandler } from './projects'
+import { Clients, ClientsHandler } from './clients'
+import { Users, UsersHandler } from "./users"
+import { Bookings, BookingsHandler } from "./bookings"
+import { ClientContacts, ClientContactsHandler } from "./clientcontacts"
+import { Comments, CommentsHandler, Threads, ThreadsHandler } from "./comments"
+import { Company, CompanyHandler } from "./company"
+import { Discussions, DiscussionsHandler } from "./discussions"
+import { EstimateTemplates, EstimateTemplatesHandler } from "./estimatetemplates"
+import { Estimates, EstimatesHandler } from "./estimates"
+import { Expenses, ExpensesHandler } from "./expenses"
+import { Files, FilesHandler } from "./files"
+import { InvoiceTemplates, InvoiceTemplatesHandler } from "./invoicetemplates"
+import { Invoices, InvoicesHandler } from "./invoices"
+import { Milestones, MilestonesHandler } from "./milestones"
+import { ProjectTemplates, ProjectTemplatesHandler } from "./projecttemplates"
+import { ProjectStatuses, ProjectStatusesHandler } from "./projectstatuses"
+import { Reports, ReportsHandler } from "./reports"
+import { Sessions, SessionsHandler } from "./sessions"
+import { TaskLists, TaskListsHandler } from "./tasklists"
+import { Tasks, TasksHandler } from "./tasks"
+import { TimeEntries, TimeEntriesHandler } from "./entries"
+import { UserTasks, UserTasksHandler } from "./usertasks"
+import { Workflows, WorkflowsHandler } from "./workflows"
+import { WorkflowStatuses, WorkflowStatusesHandler } from "./workflowstatuses"
+
+export interface PaymoHandlersContainerInterface {
+  projects?: ProjectsHandler
+  clients?: ClientsHandler
+  users?: UsersHandler
+  bookings?: BookingsHandler
+  clientcontacts?: ClientContacts
+  comments?: Comments
+  threads?: Threads
+  company?: Company
+  discussions?: Discussions
+  estimatetemplates?: EstimateTemplates
+  estimates?: Estimates
+  expenses?: Expenses
+  files?: Files
+  invoicetemplates?: InvoiceTemplates
+  invoices?: Invoices
+  milestones?: Milestones
+  projecttemplates?: ProjectTemplates
+  projectstatuses?: ProjectStatuses
+  reports?: Reports
+  sessions?: Sessions
+  tasklists?: TaskLists
+  tasks?: Tasks
+  entries?: TimeEntries
+  usertasks?: UserTasks
+  workflows?: Workflows
+  workflowstatuses?: WorkflowStatuses
+}
+
+export interface PaymoResourceHandlerInterface {
+  isApiUser: (a: string) => boolean
+  projects: () => ProjectsHandler
+  clients: () => ClientsHandler
+  users: () => UsersHandler
+  bookings: () => BookingsHandler
+  clientcontacts: () => ClientContactsHandler
+  comments: () => CommentsHandler
+  threads: () => ThreadsHandler
+  company: () => CompanyHandler
+  discussions: () => DiscussionsHandler
+  estimatetemplates: () => EstimateTemplatesHandler
+  estimates: () => EstimatesHandler
+  expenses: () => ExpensesHandler
+  files: () => FilesHandler
+  invoicetemplates: () => InvoiceTemplatesHandler
+  invoices: () => InvoicesHandler
+  milestones: () => MilestonesHandler
+  projecttemplates: ()=> ProjectTemplatesHandler
+  projectstatuses: () => ProjectStatusesHandler
+  reports: () => ReportsHandler
+  sessions: () => SessionsHandler
+  tasklists: ()=>TaskListsHandler
+  tasks: ()=>TasksHandler
+  entries: ()=>TimeEntriesHandler
+  usertasks: ()=>UserTasksHandler
+  workflows: ()=>WorkflowsHandler
+  workflowstatuses: ()=>WorkflowStatusesHandler
+}
+
+const PaymoResourceHandler = class implements PaymoResourceHandlerInterface {
+  auth: AuthInterface = {
+    userApi: '',
+    password: '',
+  }
+
+  handlers: PaymoHandlersContainerInterface = {}
+
+  constructor(u: string, p: string | null) {
+    this.auth = {
+      userApi: u,
+      password: p || 'paymoApi',
+    }
+  }
+
+  isApiUser = (apiUser: string) => {
+    return this.auth.userApi === apiUser
+  }
+
+  projects = (): ProjectsHandler => {
+    if (!this.handlers.projects) {
+      this.handlers.projects = new Projects(this.auth)
+    }
+    return this.handlers.projects
+  }
+
+  clients = (): ClientsHandler => {
+    if (!this.handlers.clients) {
+      this.handlers.clients = new Clients(this.auth)
+    }
+    return this.handlers.clients
+  }
+
+  users = (): UsersHandler => {
+    if (!this.handlers.users) {
+      this.handlers.users = new Users(this.auth)
+    }
+    return this.handlers.users
+  }
+
+  bookings = (): BookingsHandler => {
+    if (!this.handlers.bookings) {
+      this.handlers.bookings = new Bookings(this.auth)
+    }
+    return this.handlers.bookings
+  }
+
+  clientcontacts = (): ClientContactsHandler => {
+    if (!this.handlers.clientcontacts) {
+      this.handlers.clientcontacts = new ClientContacts(this.auth)
+    }
+    return this.handlers.clientcontacts
+  }
+
+  comments = (): CommentsHandler => {
+    if (!this.handlers.comments) {
+      this.handlers.comments = new Comments(this.auth)
+    }
+    return this.handlers.comments
+  }
+
+  threads = (): ThreadsHandler => {
+    if (!this.handlers.threads) {
+      this.handlers.threads = new Threads(this.auth)
+    }
+    return this.handlers.threads
+  }
+
+  company = (): CompanyHandler => {
+    if (!this.handlers.company) {
+      this.handlers.company = new Company(this.auth)
+    }
+    return this.handlers.company
+  }
+
+  discussions = (): DiscussionsHandler => {
+    if (!this.handlers.discussions) {
+      this.handlers.discussions = new Discussions(this.auth)
+    }
+    return this.handlers.discussions
+  }
+
+  estimatetemplates = (): EstimateTemplatesHandler => {
+    if (!this.handlers.estimatetemplates) {
+      this.handlers.estimatetemplates = new EstimateTemplates(this.auth)
+    }
+    return this.handlers.estimatetemplates
+  }
+
+  estimates = (): EstimatesHandler => {
+    if (!this.handlers.estimates) {
+      this.handlers.estimates = new Estimates(this.auth)
+    }
+    return this.handlers.estimates
+  }
+
+  expenses = (): ExpensesHandler => {
+    if (!this.handlers.expenses) {
+      this.handlers.expenses = new Expenses(this.auth)
+    }
+    return this.handlers.expenses
+  }
+
+  files = (): FilesHandler => {
+    if (!this.handlers.files) {
+      this.handlers.files = new Files(this.auth)
+    }
+    return this.handlers.files
+  }
+
+  invoicetemplates = (): InvoiceTemplatesHandler => {
+    if (!this.handlers.invoicetemplates) {
+      this.handlers.invoicetemplates = new InvoiceTemplates(this.auth)
+    }
+    return this.handlers.invoicetemplates
+  }
+
+  invoices = (): InvoicesHandler => {
+    if (!this.handlers.invoices) {
+      this.handlers.invoices = new Invoices(this.auth)
+    }
+    return this.handlers.invoices
+  }
+
+  milestones = (): MilestonesHandler => {
+    if (!this.handlers.milestones) {
+      this.handlers.milestones = new Milestones(this.auth)
+    }
+    return this.handlers.milestones
+  }
+
+  projecttemplates = (): ProjectTemplatesHandler => {
+    if (!this.handlers.projecttemplates) {
+      this.handlers.projecttemplates = new ProjectTemplates(this.auth)
+    }
+    return this.handlers.projecttemplates
+  }
+
+  projectstatuses = (): ProjectStatusesHandler => {
+    if (!this.handlers.projectstatuses) {
+      this.handlers.projectstatuses = new ProjectStatuses(this.auth)
+    }
+    return this.handlers.projectstatuses
+  }
+
+  reports = (): ReportsHandler => {
+    if (!this.handlers.reports) {
+      this.handlers.reports = new Reports(this.auth)
+    }
+    return this.handlers.reports
+  }
+
+  sessions = (): SessionsHandler => {
+    if (!this.handlers.sessions) {
+      this.handlers.sessions = new Sessions(this.auth)
+    }
+    return this.handlers.sessions
+  }
+
+  tasklists = (): TaskListsHandler => {
+    if (!this.handlers.tasklists) {
+      this.handlers.tasklists = new TaskLists(this.auth)
+    }
+    return this.handlers.tasklists
+  }
+
+  tasks = (): TasksHandler => {
+    if (!this.handlers.tasks) {
+      this.handlers.tasks = new Tasks(this.auth)
+    }
+    return this.handlers.tasks
+  }
+
+  entries = (): TimeEntriesHandler => {
+    if (!this.handlers.entries) {
+      this.handlers.entries = new TimeEntries(this.auth)
+    }
+    return this.handlers.entries
+  }
+
+  usertasks = (): UserTasksHandler => {
+    if (!this.handlers.usertasks) {
+      this.handlers.usertasks = new UserTasks(this.auth)
+    }
+    return this.handlers.usertasks
+  }
+
+  workflows = (): WorkflowsHandler => {
+    if (!this.handlers.workflows) {
+      this.handlers.workflows = new Workflows(this.auth)
+    }
+    return this.handlers.workflows
+  }
+
+  workflowstatuses = (): WorkflowStatusesHandler => {
+    if (!this.handlers.workflowstatuses) {
+      this.handlers.workflowstatuses = new WorkflowStatuses(this.auth)
+    }
+    return this.handlers.workflowstatuses
+  }
+}
+
+export default PaymoResourceHandler

package/src/resources/invoices/InvoiceItem.ts

@@ -0,0 +1,6 @@
+
+export const InvoiceItem = {
+
+}
+
+export default null