📝 Rascunho do README

Author: lfreneda

README.md

@@ -1,10 +1,11 @@
 <div align="center">
   <a target="_blank" href="https://fieldcontrol.com.br/"><img src=".github/static/cover.jpg" alt="FieldControl Cover" height="400px"></a>
-  <div><code>npm install FieldControl --save</code></div>
+  <br>
   <br>
   <p>
     :cloud: Node.js bindings for the Field Control API - <a target="_blank" href="https://developers.fieldcontrol.com.br/">https://developers.fieldcontrol.com.br/</a>
   </p>
+  <div><code>npm install fieldcontrol --save</code></div>
   <p>
 
 ![Field Control ♥](https://img.shields.io/badge/Field%20Control-%20%20%20%20%20%20♥-blue.svg)
@@ -14,28 +15,28 @@
 
   </p>
   <small>
-    Built with ❤ by 
+    Built with 💙 by 
       <a href="https://github.com/FieldControl">FieldControl</a> and
       <a href="https://github.com/FieldControl/contaazul/graphs/contributors">contributors</a> - <a href="https://fieldcontrol.com.br/vaga-para-desenvolvedor.html?utm_source=github&utm_medium=opensource&utm_campaign=carchost-node">Estamos contratando!</a>
   </small>
 </div>
 
 ---
 
-## Installation
+## Instalação
 
 This client is intended for server side use only.
 
 ```
-npm install FieldControl --save
+npm install fieldcontrol --save
 ```
 
 <div align="center">💙</div>
 
-## Usage
+## Uso
 
 ```js
-const FieldControl = require('FieldControl')
+const FieldControl = require('fieldcontrol')
 const client = new FieldControl({
   apiKey: 'ssssssssssshhhhhhhhhhhh:x~'
 })
@@ -44,64 +45,171 @@ const client = new FieldControl({
 <div align="center">💙</div>
 
 ### Resources
-- [Employees](#employees)
-- [Services](#services)
-- [Tickets](#tickets)
+- [Clientes](#clientes)
+- [Colaboradores](#colaboradores)
+- [Tipos de atividades](#tipos-de-atividade)
+- [Solicitação de serviço](#solicita--o-de-servi-o)
+
+### Clientes
+
+Clientes (customers) são os consumidores finais dos serviços prestados (tipos de atividades), seja ele uma pessoa física ou jurídica.
+
+```js
+// Criar um novo cliente
+const response = await client.customers.create({
+  name: 'Luiz Freneda',
+  code: '05e67c054594',
+  documentNumber: '27032236881',
+  address: {
+    zipCode: '15085480',
+    street: 'Rua dos Pinheiros',
+    number: '383',
+    neighborhood: 'Pinheiros',
+    complement: 'Edificio Alamac',
+    city: 'São Paulo',
+    state: 'SP',
+    coords: {
+      latitude: -23.565249,
+      longitude: -46.681838
+    }
+  }
+})
+```
 
-### Employees
+```js
+// Recuperar um cliente por id
+const response = await client.customers.get('MTY0MTU6MjI5MTU=')
+```
 
 ```js
-// Get an employee
+// Listar clientes
+const response = await client.customers.list({
+  filter: {
+    name: 'Luiz'
+  },
+  pagination: {
+    limit: 1,
+    offset: 2
+  }
+})
+```
+<div align="right">
+  <a href="https://github.com/FieldControl/carchost-node/blob/master/test/resources/customer.spec.js" target="_blank">see tests</a> - <a href="https://developers.fieldcontrol.com.br/#clientes" target="_blank">see docs</a>
+</div>
+
+<div align="center">💙</div>
+
+### Colaboradores
+
+Colaboradores (employees) são os profissionais que trabalham externamente usando o app Field Control.
+
+```js
+// Recuperar um colaborador por id
 const response = await client.employees.get('MTY1NDk6MjI5MTU=')
-// {
-//   "status": 200,
-//   "data": {
-//      "id": "MTY0MTU6MjI5MTU=",
-//      "name": "Mauro Garcia",
-//      "avatarUrl": null
-//   }
-// }
 ```
 
 ```js
-// List employees
+// Listar colaboradores
 const response = await client.employees.list({
-    pagination: {
-        limit: 10,
-        offset: 0
-    }
+  pagination: {
+      limit: 10,
+      offset: 0
+  }
 })
-// {
-//   "status": 200,
-//   "data": {
-//        "items": [
-//            {
-//            "id": "MTY0MTU6MjI5MTU=",
-//            "name": "Mauro Garcia",
-//            "avatarUrl": null
-//            },
-//            {
-//            "id": "MTY1NDk6MjI5MTU=",
-//            "name": "Renan Valentin",
-//            "avatarUrl": null
-//            },
-//            {
-//            "id": "MTY1NTU6MjI5MTU=",
-//            "name": "Felipe Zini",
-//            "avatarUrl": null
-//            }
-//        ],
-//        "totalCount": 3
-//     }
-//   }
-// }
 ```
 <div align="right">
   <a href="https://github.com/FieldControl/carchost-node/blob/master/test/resources/employee.spec.js" target="_blank">see tests</a> - <a href="https://developers.fieldcontrol.com.br/#colaboradores" target="_blank">see docs</a>
 </div>
 
 <div align="center">💙</div>
 
+### Tipos de atividades
+
+Tipos de atividades (services) são serviços prestados pela empresa. Exemplos: instalação, manutenção, reparo, etc..
+
+```js
+// Recuperar tipo de atividade por id
+const response = await client.services.get('MzUxMzE6MjI5MTU=')
+```
+
+```js
+// Criar um novo tipo de atividade
+const response = await client.services.create({
+  name: 'Instalação',
+  duration: 120
+})
+```
+
+```js
+// Atualizar um tipo de atividade
+const response = await client.services.update('MzA0ODY6MjI5MTU=', {
+  id: 'MzA0ODY6MjI5MTU=',
+  name: 'Manutenção',
+  duration: 60
+})
+```
+
+```js
+// Listar tipos de atividade
+const response = await client.services.list()
+```
+
+<div align="right">
+  <a href="https://github.com/FieldControl/carchost-node/blob/master/test/resources/service.spec.js" target="_blank">see tests</a> - <a href="https://developers.fieldcontrol.com.br/#tipos-de-atividades" target="_blank">see docs</a>
+</div>
+
+<div align="center">💙</div>
+
+
+### Solicitação de serviço
+
+Uma solicitação de serviço é, basicamente, um pedido de atendimento, ele pode ser um novo negócio, um problema de um cliente já existente e entre outras utilizações.
+
+```js
+// Criar uma nova solicitação de serviço
+const response = await client.tickets.create({
+  name: 'Luiz Freneda',
+  message: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Maecenas posuere eget tellus vitae malesuada. Duis consequat pulvinar tincidunt. Aenean in enim tincidunt, auctor mauris a, tincidunt turpis.',
+  subject: 'Manutenção preventiva',
+  contact: {
+    email: '[email protected]',
+    phone: '11963427191'
+  }
+})
+```
+
+```js
+// Atualizar uma solicitação de serviço existente
+const response = await client.tickets.update('M2JlYTAyNDctODAyNC00Mzc5LTkwNWQtYTM5ZWRhYWMzM2NmOjE=', {
+  name: 'Luiz Freneda',
+  message: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Maecenas posuere eget tellus vitae malesuada. Duis consequat pulvinar tincidunt. Aenean in enim tincidunt, auctor mauris a, tincidunt turpis.',
+  subject: 'Manutenção preventiva',
+  contact: {
+    email: '[email protected]',
+    phone: '11963427191'
+  }
+})
+```
+
+```js
+// Listar solicitações de serviço por nome e com configurações de paginação
+const response = await client.tickets.list({
+  filter: {
+    name: 'Freneda'
+  },
+  pagination: {
+    limit: 10,
+    offset: 1
+  }
+})
+```
+
+<div align="right">
+  <a href="https://github.com/FieldControl/carchost-node/blob/master/test/resources/ticket.spec.js" target="_blank">see tests</a> - <a href="https://developers.fieldcontrol.com.br/#solicita--o-de-servi-o" target="_blank">see docs</a>
+</div>
+
+<div align="center">💙</div>
+
 ## Pull Requests
 
 - **Add tests!** Your patch won't be accepted if it doesn't have tests.

bin/playground.js

@@ -0,0 +1,10 @@
+const FieldControl = require('./../src/index')
+const client = new FieldControl({
+  apiKey: 'ssssssssssshhhhhhhhhhhh:x~'
+})
+
+const run = async () => {
+  console.log(client)
+}
+
+run()