📝 README completo

Author: lfreneda

README.md

@@ -15,25 +15,26 @@
 
   </p>
   <small>
-    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>
+    Feito com 💙 pela 
+      <a href="https://github.com/FieldControl">FieldControl</a> e
+      <a href="https://github.com/FieldControl/contaazul/graphs/contributors">contribuidores</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>
 
 ---
 
-## Instalação
-
-This client is intended for server side use only.
+### Instalação
 
 ```
 npm install fieldcontrol --save
 ```
 
 <div align="center">💙</div>
 
-## Uso
+### Uso
+
+:exclamation: | Lembre-se de manter em segredo a sua chave de API. Não a compartilhe e tome cuidado para não expô-la publicamente no código do lado do cliente (client-side).
+---: | :---
 
 ```js
 const FieldControl = require('fieldcontrol')
@@ -44,11 +45,13 @@ const client = new FieldControl({
 
 <div align="center">💙</div>
 
-### Resources
+### Recursos
 - [Clientes](#clientes)
 - [Colaboradores](#colaboradores)
 - [Tipos de atividades](#tipos-de-atividade)
-- [Solicitação de serviço](#solicita--o-de-servi-o)
+- [Solicitação de serviço](#solicitação-de-serviço)
+- [Ordens de serviço](#orders-de-serviço)
+- [Atividades](#atividades)
 
 ### Clientes
 
@@ -94,7 +97,7 @@ const response = await client.customers.list({
 })
 ```
 <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>
+  <a href="https://github.com/FieldControl/carchost-node/blob/master/test/resources/customer.spec.js" target="_blank">ver testes</a> - <a href="https://developers.fieldcontrol.com.br/#clientes" target="_blank">ver docs</a>
 </div>
 
 <div align="center">💙</div>
@@ -118,7 +121,7 @@ const response = await client.employees.list({
 })
 ```
 <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>
+  <a href="https://github.com/FieldControl/carchost-node/blob/master/test/resources/employee.spec.js" target="_blank">ver testes</a> - <a href="https://developers.fieldcontrol.com.br/#colaboradores" target="_blank">ver docs</a>
 </div>
 
 <div align="center">💙</div>
@@ -155,7 +158,7 @@ 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>
+  <a href="https://github.com/FieldControl/carchost-node/blob/master/test/resources/service.spec.js" target="_blank">ver testes</a> - <a href="https://developers.fieldcontrol.com.br/#tipos-de-atividades" target="_blank">ver docs</a>
 </div>
 
 <div align="center">💙</div>
@@ -169,7 +172,7 @@ Uma solicitação de serviço é, basicamente, um pedido de atendimento, ele pod
 // 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.',
+  message: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.',
   subject: 'Manutenção preventiva',
   contact: {
     email: '[email protected]',
@@ -182,7 +185,7 @@ const response = await client.tickets.create({
 // 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.',
+  message: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.',
   subject: 'Manutenção preventiva',
   contact: {
     email: '[email protected]',
@@ -205,19 +208,147 @@ const response = await client.tickets.list({
 ```
 
 <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>
+  <a href="https://github.com/FieldControl/carchost-node/blob/master/test/resources/ticket.spec.js" target="_blank">ver testes</a> - <a href="https://developers.fieldcontrol.com.br/#solicita--o-de-servi-o" target="_blank">ver docs</a>
+</div>
+
+<div align="center">💙</div>
+
+### Ordens de serviço
+
+Uma ordem de serviço (orders) é a formalização do serviço a ser prestado.
+
+Na prática, funciona assim: o cliente chega até você com uma demanda, solicita um orçamento, há uma negociação e, assim que ela é concluída, é preciso emitir uma OS para organizar internamente o trabalho a ser realizado.
+
+```js
+// Recuperar ordem de serviço por id
+const response = await client.orders.get('NTVlMzYxMTktZWJiZjE=')
+```
+
+```js
+// Criar uma nova ordem de serviço (sempre é necessário criar com pelo menos UMA atividade)
+const response = await client.orders.create({
+  identifier: '695860',
+  description: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.',
+  customer: {
+    id: 'MTox'
+  },
+  service: {
+    id: 'MTox'
+  },
+  address: {
+    zipCode: '05005900',
+    city: 'Sao Paulo',
+    state: 'SP',
+    street: 'Rua Turiassu',
+    number: '902',
+    complement: null,
+    neighborhood: null,
+    coords: {
+      latitude: -23.52702,
+      longitude: -46.680823
+    }
+  },
+  tasks: [
+    {
+      employee: {
+        id: 'MTAxOjE='
+      },
+      status: 'done',
+      duration: 30,
+      scheduling: {
+        date: '2019-08-20',
+        time: '15:00:00'
+      },
+      coords: {
+        latitude: -23.52702,
+        longitude: -46.680823
+      }
+    }
+  ]
+})
+```
+
+```js
+// Listar ordens de serviço por identificador e com configurações de paginação
+const response = await client.orders.list({
+  filter: {
+    identifier: 'ABC'
+  },
+  pagination: {
+    limit: 50,
+    offset: 50
+  }
+})
+```
+
+```js
+// Listar anexos de uma ordem de serviço
+const response = await client.orders.listAttachments('NTVlMzYxMTktZWJiZjE=')
+```
+
+```js
+// Listar atividades de uma ordem de serviço
+const response = await client.orders.listTasks('NTVlMzYxMTktZWJiZjE=')
+```
+
+```js
+// Listar comentários de uma ordem de serviço
+const response = await client.orders.listComments('NTVlMzYxMTktZWJiZjE=')
+```
+
+```js
+// Listar materiais usados em uma ordem de serviço
+const response = await client.orders.listMaterials('NTVlMzYxMTktZWJiZjE=')
+```
+
+```js
+// Listar formulários respondidos para uma ordem de serviço
+const response = await client.orders.listForms('NTVlMzYxMTktZWJiZjE=')
+```
+
+<div align="right">
+  <a href="https://github.com/FieldControl/carchost-node/blob/master/test/resources/order.spec.js" target="_blank">ver testes</a> - <a href="https://developers.fieldcontrol.com.br/#ordem-de-servi-o--os-" target="_blank">ver docs</a>
+</div>
+
+<div align="center">💙</div>
+
+### Atividades
+
+Atividades (tasks) são os registros das visitas e serviços realizados aos clientes.
+
+Na prática, funciona assim: dado uma ordem de serviço, agora é preciso agendar o atendimento até o local da prestação de serviço (cadastrado na OS).
+
+É necessário atribuir uma data, opcionalmente um horário e um colaborador. As atividades são enviadas para os celulares dos técnicos formando sua agenda de atendimento. Vale ressaltar que é possível criar uma ou mais atividades (visitas) para a mesma ordem de serviço.
+
+```js
+// Recuperar uma atividade por id
+const response = await client.tasks.get('MzUxMzE6MjI5MTU=')
+```
+
+```js
+// Listar atividades por data de criação e com configurações de paginação
+const response = await client.tasks.list({
+  filter: {
+    created_at: '2020-06-20'
+  },
+  pagination: {
+    limit: 10,
+    offset: 20
+  }
+})
+```
+
+<div align="right">
+  <a href="https://github.com/FieldControl/carchost-node/blob/master/test/resources/task.spec.js" target="_blank">ver testes</a> - <a href="https://developers.fieldcontrol.com.br/#atividades" target="_blank">ver docs</a>
 </div>
 
 <div align="center">💙</div>
 
-## Pull Requests
+## Contribuições
 
-- **Add tests!** Your patch won't be accepted if it doesn't have tests.
-- **Document any change in behaviour**. Make sure the README and any other
-  relevant documentation are kept up-to-date.
-- **Create topic branches**. Don't ask us to pull from your master branch.
-- **One pull request per feature**. If you want to do more than one thing, send
-  multiple pull requests.
+- **Testes unitários!** Seu patch não será aceito se seu código não estiver testado :S
+- **Documentação**. Garanta que o README atualizado!
+- **Branch feature**. Se você quer contribuir com mais de uma funcionalidade, envie vários PR.
 
 <div align="center">💙</div>
 
@@ -231,7 +362,7 @@ const response = await client.tickets.list({
 <div align="center">
   <p>
     <sub>
-      Open source, from <a href="https://instagram.com/fieldcontrolapp" target="_blank">Field Control</a> with ❤ - <a href="https://fieldcontrol.com.br/vaga-para-desenvolvedor.html?utm_source=github&utm_medium=opensource&utm_campaign=carchost-node">Estamos contratando!</a>
+      Open source, from <a href="https://instagram.com/fieldcontrolapp" target="_blank">Field Control</a> with ❤ - <a href="https://fieldcontrol.com.br/vaga-para-desenvolvedor.html?utm_source=github&utm_medium=opensource&utm_campaign=carchost-node">We are hiring!</a>
     </sub>
   </p> 
 </div>