Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/burnett01/node-moco

A microservice api-client to access Mocoapp.com API
https://github.com/burnett01/node-moco
api client microservice moco mocoapp nodejs
Last synced: 3 months ago
JSON representation
A microservice api-client to access Mocoapp.com API
Host: GitHub
URL: https://github.com/burnett01/node-moco
Owner: Burnett01
License: mit
Created: 2018-02-13T21:59:57.000Z (almost 7 years ago)
Default Branch: master
Last Pushed: 2022-01-16T17:27:21.000Z (about 3 years ago)
Last Synced: 2023-09-19T16:29:14.124Z (over 1 year ago)
Topics: api, client, microservice, moco, mocoapp, nodejs
Language: JavaScript
Size: 54.7 KB
Stars: 4
Watchers: 1
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project

README

        
# node-moco

[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE) [![Build Status](https://travis-ci.com/Burnett01/node-moco.svg?branch=master)](https://travis-ci.com/Burnett01/node-moco) [![npm version](https://badge.fury.io/js/%40burnett01%2Fnode-moco.svg)](https://badge.fury.io/js/%40burnett01%2Fnode-moco)

A microservice api-client to access [Mocoapp.com API](https://github.com/hundertzehn/mocoapp-api-docs/blob/master/README.md).

This module is based on my [Extended-Request](https://github.com/Burnett01/extended-request) package,


in fact it's using that package in order to perform the api requests.

Features:

  * ES8 (Async/Await)

  * ES6 (Promises)

  * ES5 (Callback)

  * Debug Mode

---

# Table of contents

* [API Reference](#api-reference)

* [Property Reference](#property-reference)

* [Method Reference](#method-reference)

  * [Create a Moco instance](#create-a-moco-instance)

  * [Get Activities](#get-activities)

  * [Get Activity](#get-activity)

  * [Get Companies](#get-companies)

  * [Get Company](#get-company)

  * [Get Comments](#get-comments)

  * [Get Comment](#get-comment)

  * [Get Contacts People](#get-contacts-people)

  * [Get Contacts Person](#get-contacts-person)

  * [Get Deals](#get-deals)

  * [Get Deal](#get-deal)

  * [Get Deal Categories](#get-deal-categories)

  * [Get Deal Category](#get-deal-category)

  * [Get Invoices](#get-invoices)

  * [Get Invoice](#get-invoice)

  * [Get Invoice Payments](#get-invoice-payments)

  * [Get Invoice Payment](#get-invoice-payment)

  * [Get Offers](#get-offers)

  * [Get Offer](#get-offer)

  * [Get Projects](#get-projects)

  * [Get Project](#get-project)

  * [Get Projects Assigned](#get-projects-assigned)

  * [Get Projects Expenses](#get-projects-expenses)

  * [Get Purchases](#get-purchases)

  * [Get Purchase](#get-purchase)

  * [Get Purchase Categories](#get-purchase-categories)

  * [Get Purchase Category](#get-purchase-category)

  * [Get Schedules](#get-schedules)

  * [Get Schedule](#get-schedule)

  * [Get Units](#get-units)

  * [Get Unit](#get-unit)

  * [Get Users](#get-users)

  * [Get User](#get-user)

  * [Get User Employments](#get-user-employments)

  * [Get User Employment](#get-user-employment)

  * [Get User Holidays](#get-user-holidays)

  * [Get User Holiday](#get-user-holiday)

* [Sorting](#sorting)

* [Setup / Install](#setup-install)

* [Unit-Tests](#unit-tests)

  * [Make](#make-1)

  * [NPM](#npm-1)

* [Notable Changes](CHANGES.md)

* [Contributing](#contributing)

* [License](#license)

---

## API Reference

```js

Moco(

    [Object {

      domain: String='mycompany'

      debug: Boolean=false

      token: String=''

    } details]

) -> Object {

    /* Constants */

    this: Object=this

    /* Methods */

    getActivities: [Object=options, function(class ErrorClass err, any results) cb] | Promise

    getActivity: [String|Number=id, function(class ErrorClass err, any results) cb] | Promise

    getCompanies: [Object=options, function(class ErrorClass err, any results) cb] | Promise

    getCompany: [String|Number=id, function(class ErrorClass err, any results) cb] | Promise

    getComments: [Object=options, function(class ErrorClass err, any results) cb] | Promise

    getComment: [String|Number=id, function(class ErrorClass err, any results) cb] | Promise

    getContactsPeople: [Object=options, function(class ErrorClass err, any results) cb] | Promise

    getContactsPerson: [String|Number=id, function(class ErrorClass err, any results) cb] | Promise

    getDeals: [Object=options, function(class ErrorClass err, any results) cb] | Promise

    getDeal: [String|Number=id, function(class ErrorClass err, any results) cb] | Promise

    getDealCategories: [Object=options, function(class ErrorClass err, any results) cb] | Promise

    getDealCategory: [String|Number=id, function(class ErrorClass err, any results) cb] | Promise

    getInvoices: [Object=options, function(class ErrorClass err, any results) cb] | Promise

    getInvoice: [String|Number=id, function(class ErrorClass err, any results) cb] | Promise

    getInvoicePayments: [Object=options, function(class ErrorClass err, any results) cb] | Promise

    getInvoicePayment: [String|Number=id, function(class ErrorClass err, any results) cb] | Promise

    getOffers: [Object=options, function(class ErrorClass err, any results) cb] | Promise

    getOffer: [String|Number=id, function(class ErrorClass err, any results) cb] | Promise

    getProjects: [Object=options, function(class ErrorClass err, any results) cb] | Promise

    getProject: [String|Number=id, function(class ErrorClass err, any results) cb] | Promise

    getProjectsAssigned: [Object=options, function(class ErrorClass err, any results) cb] | Promise

    getProjectsExpenses: [Object=options, function(class ErrorClass err, any results) cb] | Promise

    getPurchases: [Object=options, function(class ErrorClass err, any results) cb] | Promise

    getPurchase: [String|Number=id, function(class ErrorClass err, any results) cb] | Promise

    getPurchaseCategories: [Object=options, function(class ErrorClass err, any results) cb] | Promise

    getPurchaseCategory: [String|Number=id, function(class ErrorClass err, any results) cb] | Promise

    getSchedules: [Object=options, function(class ErrorClass err, any results) cb] | Promise

    getSchedule: [String|Number=id, function(class ErrorClass err, any results) cb] | Promise

    getUnits: [Object=options, function(class ErrorClass err, any results) cb] | Promise

    getUnit: [String|Number=id, function(class ErrorClass err, any results) cb] | Promise

    getUsers: [Object=options, function(class ErrorClass err, any results) cb] | Promise

    getUser: [String|Number=id, function(class ErrorClass err, any results) cb] | Promise

    getUserEmployments: [Object=options, function(class ErrorClass err, any results) cb] | Promise

    getUserEmployment: [String|Number=id, function(class ErrorClass err, any results) cb] | Promise

    getUserHolidays: [Object=options, function(class ErrorClass err, any results) cb] | Promise

    getUserHoliday: [String|Number=id, function(class ErrorClass err, any results) cb] | Promise    

}

```

---

## Property reference:

| Property | Description |

| ------ | ----------- |

| details | An object containing configuration details |

| domain | The first part of your MOCO domain (eg. mycompany) |

| apikey | Your MOCO integration API Key |

| debug | Whether to debug requests |

---

## Method reference:

### Create a Moco instance

**Available options:**

| |  | Required | Default |

| ------ | ----------- | ------ | ----- |

| domain | mycompany | Yes | |

| apikey | your key | Yes | |

| debug | enable debugging | No | false |

```javascript

const company = new Moco({

  domain: 'mycompany',

  apikey: ''

})

```

---

### Get Activities

**Available options:**

| |  | Required | Default |

| ------ | ----------- | ------ | ----- |

| options | for example: { from: '2018-02-01' } | No | None |

| cb | optional callback (in case you don't want to use promises) | No | |

Options reference:


[#get-activities](https://github.com/hundertzehn/mocoapp-api-docs/blob/master/sections/activities.md#get-activities)


[Sorting](#sorting)

```javascript

/* Async/Await */

const activities = await mycompany.getActivities()

const activities = await mycompany.getActivities({

  from: '2017-01-02'

  to: '2017-01-02'

})

/* Promise */

mycompany.getActivities()

.then((results) => {

  console.log(results)

})

.catch((err) => {

  console.log(err)

})

mycompany.getActivities({

  from: '2017-01-02'

  to: '2017-01-02'

})

.then((results) => {

  console.log(results)

})

.catch((err) => {

  console.log(err)

})

/* Callback */

mycompany.getActivities((err, response) => {

  console.log(err, response)

})

mycompany.getActivities({

  from: '2017-01-02'

  to: '2017-01-02'

},

(err, response) => {

  console.log(err, response)

})

```

### Get Activity

**Available options:**

| |  | Required | Default |

| ------ | ----------- | ------ | ----- |

| id | for example: 58844  | Yes | None |

| cb | optional callback (in case you don't want to use promises) | No | |

```javascript

/* Async/Await */

const activity = await mycompany.getActivity(58844)

/* Promise */

mycompany.getActivity(58844)

.then((results) => {

  console.log(results)

})

.catch((err) => {

  console.log(err)

})

/* Callback */

mycompany.getActivity(58844, (err, response) => {

  console.log(err, response)

})

```

---

### Get Companies

**Available options:**

| |  | Required | Default |

| ------ | ----------- | ------ | ----- |

| options | for example: { type: 'customer' } | No | None |

| cb | optional callback (in case you don't want to use promises) | No | |

Options reference:


[#get-companies](https://github.com/hundertzehn/mocoapp-api-docs/blob/master/sections/companies.md#get-companies)


[Sorting](#sorting)

```javascript

/* Async/Await */

const companies = await mycompany.getCompanies()

const companies = await mycompany.getCompanies({

  type: 'customer'

})

/* Promise */

mycompany.getCompanies()

.then((results) => {

  console.log(results)

})

.catch((err) => {

  console.log(err)

})

mycompany.getCompanies({

  type: 'customer'

})

.then((results) => {

  console.log(results)

})

.catch((err) => {

  console.log(err)

})

/* Callback */

mycompany.getCompanies((err, response) => {

  console.log(err, response)

})

mycompany.getCompanies({

  type: 'customer'

},

(err, response) => {

  console.log(err, response)

})

```

### Get Company

**Available options:**

| |  | Required | Default |

| ------ | ----------- | ------ | ----- |

| id | for example: 58844  | Yes | None |

| cb | optional callback (in case you don't want to use promises) | No | |

```javascript

/* Async/Await */

const company = await mycompany.getCompany(58844)

/* Promise */

mycompany.getCompany(58844)

.then((results) => {

  console.log(results)

})

.catch((err) => {

  console.log(err)

})

/* Callback */

mycompany.getCompany(58844, (err, response) => {

  console.log(err, response)

})

```

---

### Get Comments

Call as shown above in the [API Reference](#api-reference).

Options reference:


[#get-comments](https://github.com/hundertzehn/mocoapp-api-docs/blob/master/sections/comments.md#get-comments)


[Sorting](#sorting)

### Get Comment

Call as shown above in the [API Reference](#api-reference).

---

### Get Contacts People

Call as shown above in the [API Reference](#api-reference).

Available options: 


[#get-contacts-people](https://github.com/hundertzehn/mocoapp-api-docs/blob/master/sections/contacts.md#get-contactspeople)


[Sorting](#sorting)

### Get Contacts Person

Call as shown above in the [API Reference](#api-reference).

---

### Get Deals

Call as shown above in the [API Reference](#api-reference).

Options reference:


[#get-deals](https://github.com/hundertzehn/mocoapp-api-docs/blob/master/sections/deals.md#get-deals)


[Sorting](#sorting)

### Get Deal

Call as shown above in the [API Reference](#api-reference).

---

### Get Deal Categories

Call as shown above in the [API Reference](#api-reference).

Options reference:


[#get-deal_categories](https://github.com/hundertzehn/mocoapp-api-docs/blob/master/sections/deal_categories.md#get-deal_categories)


[Sorting](#sorting)

### Get Deal Category

Call as shown above in the [API Reference](#api-reference).

---

### Get Invoices

Call as shown above in the [API Reference](#api-reference).

Options reference:


[#get-invoices](https://github.com/hundertzehn/mocoapp-api-docs/blob/master/sections/invoices.md#get-invoices)


[Sorting](#sorting)

### Get Invoice

Call as shown above in the [API Reference](#api-reference).

---

### Get Invoice Payments

Call as shown above in the [API Reference](#api-reference).

Options reference:


[#get-invoice-payments](https://github.com/hundertzehn/mocoapp-api-docs/blob/master/sections/invoice_payments.md#get-invoicespayments)


[Sorting](#sorting)

### Get Invoice Payment

Call as shown above in the [API Reference](#api-reference).

---

### Get Offers

Call as shown above in the [API Reference](#api-reference).

Options reference:


[#get-offers](https://github.com/hundertzehn/mocoapp-api-docs/blob/master/sections/offers.md#get-offers)


[Sorting](#sorting)

### Get Offer

Call as shown above in the [API Reference](#api-reference).

---

### Get Projects

**Available options:**

| |  | Required | Default |

| ------ | ----------- | ------ | ----- |

| options | for example: { include_archived: false } | No | None |

| cb | optional callback (in case you don't want to use promises) | No | |

Options reference:


[#get-projects](https://github.com/hundertzehn/mocoapp-api-docs/blob/master/sections/projects.md#get-projects)


[Sorting](#sorting)

```javascript

/* Async/Await */

const projects = await mycompany.getProjects()

const projects = await mycompany.getProjects({

  include_archived: false

})

/* Promise */

mycompany.getProjects()

.then((results) => {

  console.log(results)

})

.catch((err) => {

  console.log(err)

})

mycompany.getProjects({

  include_archived: false

})

.then((results) => {

  console.log(results)

})

.catch((err) => {

  console.log(err)

})

/* Callback */

mycompany.getProjects((err, response) => {

  console.log(err, response)

})

mycompany.getProjects({

  include_archived: false

},

(err, response) => {

  console.log(err, response)

})

```

### Get Project

**Available options:**

| |  | Required | Default |

| ------ | ----------- | ------ | ----- |

| id | for example: 58844  | Yes | None |

| cb | optional callback (in case you don't want to use promises) | No | |

```javascript

/* Async/Await */

const project = await mycompany.getProject(58844)

/* Promise */

mycompany.getProject(58844)

.then((results) => {

  console.log(results)

})

.catch((err) => {

  console.log(err)

})

/* Callback */

mycompany.getProject(58844, (err, response) => {

  console.log(err, response)

})

```

### Get Projects Assigned

Call as shown above in the [API Reference](#api-reference).

Options reference:


[#get-projects-assigned](https://github.com/hundertzehn/mocoapp-api-docs/blob/master/sections/projects.md#get-projectsassigned)


### Get Projects Expenses

Call as shown above in the [API Reference](#api-reference).

Options reference:


[#get-projects-expenses](https://github.com/hundertzehn/mocoapp-api-docs/blob/master/sections/project_expenses.md)


---

### Get Purchases

Call as shown above in the [API Reference](#api-reference).

Options reference:


[#get-purchases](https://github.com/hundertzehn/mocoapp-api-docs/blob/master/sections/purchases.md#get-purchases)


[Sorting](#sorting)

### Get Purchase

Call as shown above in the [API Reference](#api-reference).

---

### Get Purchase Categories

Call as shown above in the [API Reference](#api-reference).

Options reference:


[#get-purchases-categories](https://github.com/hundertzehn/mocoapp-api-docs/blob/master/sections/purchase_categories.md#get-purchasescategories)


[Sorting](#sorting)

### Get Purchase Category

Call as shown above in the [API Reference](#api-reference).

---

### Get Schedules

**Available options:**

| |  | Required | Default |

| ------ | ----------- | ------ | ----- |

| options | for example: { from: '2018-02-01' } | No | None |

| cb | optional callback (in case you don't want to use promises) | No | |

Options reference:


[#get-schedules](https://github.com/hundertzehn/mocoapp-api-docs/blob/master/sections/schedules.md#get-schedules)


[Sorting](#sorting)

```javascript

/* Async/Await */

const schedules = await mycompany.getSchedules()

const schedules = await mycompany.getSchedules({

  from: '2017-01-02'

  to: '2017-01-02'

})

/* Promise */

mycompany.getSchedules()

.then((results) => {

  console.log(results)

})

.catch((err) => {

  console.log(err)

})

mycompany.getSchedules({

  from: '2017-01-02'

  to: '2017-01-02'

})

.then((results) => {

  console.log(results)

})

.catch((err) => {

  console.log(err)

})

/* Callback */

mycompany.getSchedules((err, response) => {

  console.log(err, response)

})

mycompany.getSchedules({

  from: '2017-01-02'

  to: '2017-01-02'

}, 

(err, response) => {

  console.log(err, response)

})

```

### Get Schedule

**Available options:**

| |  | Required | Default |

| ------ | ----------- | ------ | ----- |

| id | for example: 58844  | Yes | None |

| cb | optional callback (in case you don't want to use promises) | No | |

```javascript

/* Async/Await */

const schedule = await mycompany.getSchedule(58844)

/* Promise */

mycompany.getSchedule(58844)

.then((results) => {

  console.log(results)

})

.catch((err) => {

  console.log(err)

})

/* Callback */

mycompany.getSchedule(58844, (err, response) => {

  console.log(err, response)

})

```

---

### Get Units

Call as shown above in the [API Reference](#api-reference).

Options reference:


[#get-units](https://github.com/hundertzehn/mocoapp-api-docs/blob/master/sections/units.md#get-units)


[Sorting](#sorting)

### Get Unit

Call as shown above in the [API Reference](#api-reference).

---

### Get Users

**Available options:**

| |  | Required | Default |

| ------ | ----------- | ------ | ----- |

| options | | No | None |

| cb | optional callback (in case you don't want to use promises) | No | |

Options reference:


[#get-users](https://github.com/hundertzehn/mocoapp-api-docs/blob/master/sections/users.md#get-users)


[Sorting](#sorting)

```javascript

/* Async/Await */

const users = await mycompany.getUsers()

/* Promise */

mycompany.getUsers()

.then((results) => {

  console.log(results)

})

.catch((err) => {

  console.log(err)

})

/* Callback */

mycompany.getUsers((err, response) => {

  console.log(err, response)

})

```

### Get User

**Available options:**

| |  | Required | Default |

| ------ | ----------- | ------ | ----- |

| id | for example: 58844  | Yes | None |

| cb | optional callback (in case you don't want to use promises) | No | |

```javascript

/* Async/Await */

const user = await mycompany.getUser(58844)

/* Promise */

mycompany.getUser(58844)

.then((results) => {

  console.log(results)

})

.catch((err) => {

  console.log(err)

})

/* Callback */

mycompany.getUser(58844, (err, response) => {

  console.log(err, response)

})

```

---

### Get User Employments

Call as shown above in the [API Reference](#api-reference).

Options reference:


[#get-user-employments](https://github.com/hundertzehn/mocoapp-api-docs/blob/master/sections/employments.md#get-usersemployments)


[Sorting](#sorting)

### Get User Employment

Call as shown above in the [API Reference](#api-reference).

---

### Get User Holidays

Call as shown above in the [API Reference](#api-reference).

Options reference:


[#get-user-holidays](https://github.com/hundertzehn/mocoapp-api-docs/blob/master/sections/holidays.md#get-usersholidays)


[Sorting](#sorting)

### Get User Holiday

Call as shown above in the [API Reference](#api-reference).

---

## Sorting

You can sort your results by adding ``sort_by``

to your options object.

```

sort_by: 'title'

sort_by: 'date desc'

```

Read more: [#sorting](https://github.com/hundertzehn/mocoapp-api-docs/blob/master/README.md#sorting)

---

## Setup / Install

Use `npm install @burnett01/node-moco` 

```javascript

const Moco = require('@burnett01/node-moco')

```

---

## Unit-Tests

The testing-framework used in this module is [Mocha](https://github.com/mochajs/mocha) with the BDD / TDD assertion library [Chai](https://github.com/chaijs/chai).

* test/test.default.js | [Source](../master/test/test.default.js)

Output using [Mocha](https://github.com/mochajs/mocha) `list` reporter:   



Default reporter: `list`

### Make

```make test```

### NPM

```npm test```

---

## Contributing

You're very welcome and free to contribute. Thank you.

---

## License

[MIT](LICENSE)