node-paymo-api 0.0.3 → 0.0.5

package/src/resources/workflows/index.ts

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

package/src/resources/workflows/types.ts

@@ -0,0 +1,43 @@
+import { FilterOperator, GenericListConfig, Merge } from "../../types"
+
+// PAYMO API DOCS - 2019-12-11    /workflows    /workflows/####
+// =================================================================================================
+
+export interface WorkflowsTypeRead {
+  readonly id: number
+  readonly created_on: string
+  readonly updated_on: string
+}
+
+export interface WorkflowsTypeUpdate {
+  name?:string
+  is_default?:boolean
+}
+
+export type WorkflowsTypeResponse = Merge<WorkflowsTypeUpdate, Merge<WorkflowsTypeRead, {
+
+}>>
+
+export interface WorkflowsTypeCreate extends WorkflowsTypeUpdate {
+  name:string
+}
+
+export interface WorkflowsTypeFilter {
+  id?:number
+  name?:string
+  is_default?:boolean
+}
+
+export interface WorkflowsFilterCondition extends WorkflowsTypeFilter {
+  _custom?: {
+    [k: string]: {
+      key?: Extract<keyof WorkflowsTypeFilter, string>
+      operator?:FilterOperator
+      value: string | number | boolean | null | number[]
+    }
+  }
+}
+
+export interface WorkflowsListConfig extends GenericListConfig {
+  filter?:WorkflowsFilterCondition
+}

package/src/resources/workflowstatuses/index.ts

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

package/src/resources/workflowstatuses/types.ts

@@ -0,0 +1,47 @@
+import { FilterOperator, GenericListConfig, Merge } from "../../types"
+
+// PAYMO API DOCS - 2019-12-11    /workflowstatuses    /workflowstatuses/####
+// =================================================================================================
+
+export interface WorkflowStatusesTypeRead {
+  readonly id: number
+  readonly created_on: string
+  readonly updated_on: string
+  readonly seq: number
+  readonly action: '' | 'complete' |'backlog'
+}
+
+export interface WorkflowStatusesTypeUpdate {
+  name?:string
+  workflow_id?:number
+  color?:string
+}
+
+export type WorkflowStatusesTypeResponse = Merge<WorkflowStatusesTypeUpdate, Merge<WorkflowStatusesTypeRead, {
+
+}>>
+
+export interface WorkflowStatusesTypeCreate extends WorkflowStatusesTypeUpdate {
+  name:string
+  color:string
+  workflow_id:number
+}
+
+export interface WorkflowStatusesTypeFilter {
+  name?:string
+  workflow_id?:number
+}
+
+export interface WorkflowStatusesFilterCondition extends WorkflowStatusesTypeFilter {
+  _custom?: {
+    [k: string]: {
+      key?: Extract<keyof WorkflowStatusesTypeFilter, string>
+      operator?:FilterOperator
+      value: string | number | boolean | null | number[]
+    }
+  }
+}
+
+export interface WorkflowStatusesListConfig extends GenericListConfig {
+  filter?:WorkflowStatusesFilterCondition
+}

package/src/types.ts

@@ -0,0 +1,40 @@
+export interface AuthInterface {
+  userApi: string
+  password: string
+}
+
+export type FilterOperator =
+  | '='
+  | '<='
+  | '>='
+  | '>'
+  | '<'
+  | '!='
+  | 'like'
+  | 'not like'
+  | 'in'
+  | 'not in'
+
+export type GenericCustomFilterType = {
+  [k: string]: {
+    key?: string
+    operator?: FilterOperator
+    value: string | number | boolean | null | number[]
+  }
+}
+
+export type GenericFilterType = {
+  [key: string]: any
+} & {
+  _custom?: GenericCustomFilterType
+}
+
+export interface GenericListConfig {
+  filter?: GenericFilterType
+  include?: string[]
+}
+
+type Omit<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>
+export type Merge<M, N> = Omit<M, Extract<keyof M, keyof N>> & N;
+
+export type PaymoCurrency = 'AED' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'BAM' | 'BDT' | 'BGN' | 'BRL' | 'BWP' | 'CAD' | 'CFP' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CZK' | 'DKK' | 'DOP' | 'DZD' | 'EEK' | 'EGP' | 'EUR' | 'GBP' | 'GTQ' | 'HKD' | 'HRK' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LKR' | 'LTL' | 'LVL' | 'MAD' | 'MDL' | 'MUR' | 'MXN' | 'MYR' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NZD' | 'OMR' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RMB' | 'RON' | 'RSD' | 'RUB' | 'SAR' | 'SEK' | 'SGD' | 'SKK' | 'TBH' | 'TND' | 'TRY' | 'TTD' | 'TWD' | 'U$S' | 'UAH' | 'US$' | 'USD' | 'UYU' | 'VEF' | 'VND' | 'ZAR'

package/tsconfig.json

@@ -0,0 +1,12 @@
+{
+  "compilerOptions": {
+    "outDir": "dist",
+    "target": "es6",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
+    "module": "commonjs",
+    "strict": true,
+    "strictNullChecks": true,
+    "esModuleInterop": true,
+    "declaration": true,
+    "forceConsistentCasingInFileNames": true  /* Disallow inconsistently-cased references to the same file. */
+  }
+}

package/lib/index.ts

@@ -1,6 +0,0 @@
-
-const paymoApp = {
-  x: 1
-}
-
-export default paymoApp