node-paymo-api 0.0.3 → 0.0.5

package/src/resources/clients/types.ts

@@ -0,0 +1,100 @@
+import { FilterOperator, GenericListConfig, Merge } from "../../types"
+
+// PAYMO API DOCS - 2019-11-23 | /clients    /clients/####
+// =================================================================================================
+// id	integer	(read-only) Unique client identifier
+// name	text	Client name
+// address	text	Street address
+// city	text	City name
+// postal_code	text	Postal code
+// country	text	Country name
+// state	text	State or Region name
+// phone	text	Phone number
+// fax	text	Fax number
+// email	email	Email address
+// website	url	Website address
+// active	boolean	(read-only) If true the client is active, otherwise the client is archived.
+// fiscal_information	text	Fiscal information. It is used in invoice headers to display client details.
+// created_on	datetime	(read-only) Date and time when the client was created
+// updated_on	datetime	(read-only) Date and time when the client was last updated
+// image	url	Client logo image URL
+// image_thumb_large	url	(read-only) Client logo image large size thumbnail URL
+// image_thumb_medium	url	(read-only) Client logo image medium size thumbnail URL
+// image_thumb_small	url	(read-only) Client logo image small size thumbnail URL
+
+export interface ClientTypeRead {
+  readonly id: number
+  readonly active: boolean
+  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 ClientTypeUpdate {
+  name?: string
+  address?: string
+  city?: string
+  postal_code?: string
+  country?: string
+  state?: string
+  phone?: string
+  fax?: string
+  email?: string
+  website?: string
+  fiscal_information?: string
+  image?: string
+}
+
+export type ClientTypeResponse = Merge<ClientTypeRead, Merge<ClientTypeUpdate, {
+    additional_privileges: any[]
+    address?: string | null
+    city?: string | null
+    country?: string | null
+    email?: string | null
+    fax?: string | null
+    fiscal_information?: string | null
+    image?: string | null
+    phone?: string | null
+    postal_code?: string | null
+    state?: string | null
+    website?: string | null
+  }>>
+
+export interface ClientTypeCreate extends ClientTypeUpdate {
+  name: string
+}
+
+export interface ClientTypeFilter {
+  id?: number
+  active?: boolean
+  created_on?: string
+  updated_on?: string
+  name?: string
+  address?: string | null
+  city?: string | null
+  country?: string | null
+  email?: string | null
+  fax?: string | null
+  fiscal_information?: string | null
+  image?: string | null
+  phone?: string | null
+  postal_code?: string | null
+  state?: string | null
+  website?: string | null
+}
+
+export interface ClientFilterCondition extends ClientTypeFilter {
+  _custom?: {
+    [k: string]: {
+      key?: Extract<keyof ClientTypeFilter, string>
+      operator?: FilterOperator
+      value: string | number | boolean | null | number[]
+    }
+  }
+}
+
+export interface ClientsListConfig extends GenericListConfig {
+  filter?: ClientFilterCondition
+}

package/src/resources/comments/Comments.ts

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

package/src/resources/comments/Threads.ts

@@ -0,0 +1,28 @@
+import { AbstractResource, AbstractResourceInterface } from '../../abstract'
+import { AuthInterface } from "../../types"
+import { ThreadsListConfig, ThreadsTypeResponse } from "./types"
+
+export interface ThreadsHandler extends AbstractResourceInterface {
+  get: (id: number) => Promise<ThreadsTypeResponse | null>
+  list: (config?: ThreadsListConfig) => Promise<ThreadsTypeResponse[]>
+  //delete: (id: number) => Promise<boolean>
+}
+
+export class Threads extends AbstractResource implements ThreadsHandler {
+  constructor(auth: AuthInterface) {
+    super(auth, 'threads')
+  }
+
+  get = async (id: number) => {
+    return (await this.baseGet(id)) as ThreadsTypeResponse | null
+  }
+
+  list = async (config: ThreadsListConfig = {}) => {
+    return (await this.baseList(config)) as ThreadsTypeResponse[]
+  }
+
+  // delete = async (id: number) => {
+  //   return await this.baseDelete(id)
+  // }
+
+}

package/src/resources/comments/index.ts

@@ -0,0 +1,2 @@
+export { Comments, CommentsHandler } from './Comments';
+export { Threads, ThreadsHandler } from './Threads';

package/src/resources/comments/types.ts

@@ -0,0 +1,105 @@
+import { FilterOperator, GenericListConfig, Merge } from '../../types'
+
+// PAYMO API DOCS - 2019-12-11    /comments    /comments/####
+// =================================================================================================
+
+export interface CommentsTypeRead {
+  readonly id: number
+  readonly created_on: string
+  readonly updated_on: string
+  readonly thread_id: number
+  readonly user_id: number
+}
+
+export interface CommentsTypeUpdate {
+  content: string
+}
+
+export type CommentsTypeResponse = Merge<
+  CommentsTypeUpdate,
+  Merge<CommentsTypeRead, {}>
+>
+
+interface CommentsTypeCreateWithThread extends CommentsTypeUpdate {
+  thread_id: number
+}
+
+interface CommentsTypeCreateWithTask extends CommentsTypeUpdate {
+  task_id: number
+}
+
+interface CommentsTypeCreateWithDiscussion extends CommentsTypeUpdate {
+  discussion_id: number
+}
+
+interface CommentsTypeCreateWithFile extends CommentsTypeUpdate {
+  file_id: number
+}
+
+export type CommentsTypeCreate =
+  | CommentsTypeCreateWithThread
+  | CommentsTypeCreateWithTask
+  | CommentsTypeCreateWithDiscussion
+  | CommentsTypeCreateWithFile
+
+export interface CommentsTypeFilter {
+  id?: number
+  thread_id?: number
+  user_id?: number
+  created_on?: string
+  updated_on?: string
+  content?: string
+}
+
+export interface CommentsFilterCondition extends CommentsTypeFilter {
+  _custom?: {
+    [k: string]: {
+      key?: Extract<keyof CommentsTypeFilter, string>
+      operator?: FilterOperator
+      value: string | number | boolean | null | number[]
+    }
+  }
+}
+
+export interface CommentsListConfig extends GenericListConfig {
+  filter?: CommentsFilterCondition
+}
+
+// PAYMO API DOCS - 2019-12-11    /threads    /threads/####
+// =================================================================================================
+
+export interface ThreadsTypeRead {
+  readonly id: number
+  readonly created_on: string
+  readonly updated_on: string
+  readonly project_id: number
+  readonly discussion_id: number | null
+  readonly task_id: number | null
+  readonly file_id: number | null
+}
+
+export type ThreadsTypeResponse = Merge<ThreadsTypeRead, {}>
+
+export interface ThreadsTypeFilter {
+  id?: number
+  created_on?: string
+  updated_on?: string
+  project_id?: number
+  discussion_id?: number
+  task_id?: number
+  file_id?: number
+}
+
+export interface ThreadsFilterCondition extends ThreadsTypeFilter {
+  _custom?: {
+    [k: string]: {
+      key?: Extract<keyof ThreadsTypeFilter, string>
+      operator?: FilterOperator
+      value: string | number | boolean | null | number[]
+    }
+  }
+}
+
+export interface ThreadsListConfig extends GenericListConfig {
+  filter?: ThreadsFilterCondition
+}

package/src/resources/company/index.ts

@@ -0,0 +1,23 @@
+import { AbstractResource, AbstractResourceInterface } from '../../abstract'
+import { AuthInterface } from "../../types"
+import { CompanyTypeResponse, CompanyTypeUpdate } from "./types"
+
+export interface CompanyHandler extends AbstractResourceInterface {
+  get: () => Promise<CompanyTypeResponse | null>
+  update: (data: CompanyTypeUpdate) => Promise<CompanyTypeResponse | null>
+}
+
+export class Company extends AbstractResource implements CompanyHandler {
+  constructor(auth: AuthInterface) {
+    super(auth, 'company')
+  }
+
+  get = async () => {
+    return (await this.baseGet(null)) as CompanyTypeResponse | null
+  }
+
+  update = async (data: CompanyTypeUpdate) => {
+    return (await this.baseUpdate(null, data)) as CompanyTypeResponse | null
+  }
+
+}

package/src/resources/company/types.ts

@@ -0,0 +1,52 @@
+import { FilterOperator, GenericListConfig, Merge } from "../../types"
+
+// PAYMO API DOCS - 2019-12-11    /company
+// =================================================================================================
+
+export interface CompanyTypeRead {
+  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 account_type: string
+  readonly max_users: number
+  readonly current_users: number
+  readonly max_projects:number|null
+  readonly current_projects:number
+  readonly max_invoices: number
+  readonly current_invoices: number
+}
+
+export interface CompanyTypeUpdate {
+  name?:string
+  address?:string
+  phone?:string
+  email?:string
+  url?:string
+  fiscal_information?:string
+  country?:string
+  image?:string
+  timezone?:string
+  default_currency?:string
+  default_price_per_hour?:string
+  apply_tax_to_expenses?:string
+  tax_on_tax?:string
+  currency_position?:"left"|"right"
+  next_invoice_number?:number
+  next_estimate_number?:number
+  online_payments?:number
+  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"
+  workday_start?:string // HH:SS 24 hour format
+  workday_end?:string // HH:SS 24 hour format
+  working_days?:string // Comma separated list of 0,1,2,3,4,5,6
+}
+
+export type CompanyTypeResponse = Merge<CompanyTypeUpdate, Merge<CompanyTypeRead, {
+
+}>>

package/src/resources/discussions/index.ts

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

package/src/resources/discussions/types.ts

@@ -0,0 +1,53 @@
+import { FilterOperator, GenericListConfig, Merge } from "../../types"
+
+// PAYMO API DOCS - 2019-12-11    /discussions    /discussions/####
+// =================================================================================================
+
+export interface DiscussionsTypeRead {
+  readonly id: number
+  readonly created_on: string
+  readonly updated_on: string
+}
+
+export interface DiscussionsTypeUpdate {
+  name?: string
+  description?: string
+  project_id?:number
+  user_id?:number
+}
+
+export type DiscussionsTypeResponse = Merge<DiscussionsTypeUpdate, Merge<DiscussionsTypeRead, {
+  name:string
+  project_id:number
+  description: string | null
+  user_id: number
+  comments_count: number
+}>>
+
+export interface DiscussionsTypeCreate extends DiscussionsTypeUpdate {
+  name:string
+  project_id: number
+}
+
+export interface DiscussionsTypeFilter {
+  id?: number
+  created_on?:string
+  updated_on?:string
+  name?:string
+  description?:string
+  user_id?:number
+}
+
+export interface DiscussionsFilterCondition extends DiscussionsTypeFilter {
+  _custom?: {
+    [k: string]: {
+      key?: Extract<keyof DiscussionsTypeFilter, string>
+      operator?:FilterOperator
+      value: string | number | boolean | null | number[]
+    }
+  }
+}
+
+export interface DiscussionsListConfig extends GenericListConfig {
+  filter?:DiscussionsFilterCondition
+}

package/src/resources/entries/index.ts

@@ -0,0 +1,52 @@
+import { AbstractResource, AbstractResourceInterface } from '../../abstract'
+import { AuthInterface } from "../../types"
+import { TimeEntriesListConfig, TimeEntriesTypeCreate, TimeEntriesTypeResponse, TimeEntriesTypeUpdate } from "./types"
+
+export interface TimeEntriesHandler extends AbstractResourceInterface {
+  get: (id: number) => Promise<TimeEntriesTypeResponse | null>
+  list: (config?: TimeEntriesListConfig) => Promise<TimeEntriesTypeResponse[]>
+  create: (d: TimeEntriesTypeCreate) => Promise<TimeEntriesTypeResponse | null>
+  update: (id: number, data: TimeEntriesTypeUpdate) => Promise<TimeEntriesTypeResponse | null>
+  delete: (id: number) => Promise<boolean>
+}
+
+export class TimeEntries extends AbstractResource implements TimeEntriesHandler {
+  constructor(auth: AuthInterface) {
+    super(auth, 'entries')
+  }
+
+  get = async (id: number) => {
+    return (await this.baseGet(id)) as TimeEntriesTypeResponse | null
+  }
+
+  list = async (config: TimeEntriesListConfig = {}) => {
+    const validConfig =
+      !!config &&
+      config.filter &&
+      (config.filter.project_id ||
+        config.filter.client_id ||
+        config.filter.task_id ||
+        config.filter.user_id ||
+        (config.filter.time_interval &&
+          Array.isArray(config.filter.time_interval) &&
+          config.filter.time_interval.length === 2))
+    if (!validConfig) {
+      console.log('Entry list requires at least one valid filter condition')
+      return []
+    }
+    return (await this.baseList(config)) as TimeEntriesTypeResponse[]
+  }
+
+  create = async (data: TimeEntriesTypeCreate) => {
+    return (await this.baseCreate(data)) as TimeEntriesTypeResponse | null
+  }
+
+  update = async (id: number, data: TimeEntriesTypeUpdate) => {
+    return (await this.baseUpdate(id, data)) as TimeEntriesTypeResponse | null
+  }
+
+  delete = async (id: number) => {
+    return await this.baseDelete(id)
+  }
+
+}

package/src/resources/entries/types.ts

@@ -0,0 +1,67 @@
+import { FilterOperator, GenericListConfig, Merge } from "../../types"
+
+// PAYMO API DOCS - 2019-12-11    /entries    /entries/####
+// =================================================================================================
+
+export interface TimeEntriesTypeRead {
+  readonly id: number
+  readonly project_id:number
+  readonly created_on: string
+  readonly updated_on: string
+}
+
+export interface TimeEntriesTypeUpdate {
+  task_id?:number
+  user_id?:number
+  is_bulk?: boolean
+  start_time?:string
+  end_time?:string
+  date?:string
+  duration?:number // in seconds
+  description?:string
+  added_manually?:boolean // false means the timer app was used
+  billed?:boolean // time is on an invoice
+}
+
+export type TimeEntriesTypeResponse = Merge<TimeEntriesTypeUpdate, Merge<TimeEntriesTypeRead, {
+
+}>>
+
+interface TimeEntriesTypeCreateCommon extends TimeEntriesTypeUpdate {
+  task_id:number
+}
+
+interface TimeEntriesTypeCreateRange extends TimeEntriesTypeCreateCommon {
+  start_time:string
+  end_time:string
+}
+
+interface TimeEntriesTypeCreateDuration extends TimeEntriesTypeCreateCommon {
+  date:string
+  duration:number
+}
+
+export type TimeEntriesTypeCreate = TimeEntriesTypeCreateRange | TimeEntriesTypeCreateDuration
+
+export interface TimeEntriesTypeFilter {
+  project_id?:number
+  task_id?:number
+  user_id?:number
+  client_id?:number
+  time_interval?:string[]
+  end_time?:string | null
+}
+
+export interface TimeEntriesFilterCondition extends TimeEntriesTypeFilter {
+  _custom?: {
+    [k: string]: {
+      key?: Extract<keyof TimeEntriesTypeFilter, string>
+      operator?:FilterOperator
+      value: string | number | boolean | null | number[]
+    }
+  }
+}
+
+export interface TimeEntriesListConfig extends GenericListConfig {
+  filter?:TimeEntriesFilterCondition
+}

package/src/resources/estimates/EstimateItem.ts

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

package/src/resources/estimates/Estimates.ts

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

package/src/resources/estimates/index.ts

@@ -0,0 +1,2 @@
+export { Estimates, EstimatesHandler } from './Estimates';
+export { EstimateItem } from './EstimateItem';