Caixa postal e EDI
As caixas postais que recebem e distribuem arquivos, os canais de saída e as caixas EDI.
Caixa postal
Caixas postais, arquivos e os canais de e-mail, WhatsApp, S3, SFTP e Syncthing.
| Comando | HTTP | Descrição |
|---|---|---|
mailbox entries list | GET /v2/mailbox/entries | Listar Caixas Postais |
mailbox entries create | POST /v2/mailbox/entries | Criar Caixa Postal |
mailbox entries files | POST /v2/mailbox/entries/{entry_uid}/files | Criar Arquivo de Mailbox |
mailbox entries get | GET /v2/mailbox/entries/{uid} | Visualizar Caixa Postal |
mailbox entries update | PATCH /v2/mailbox/entries/{uid} | Atualizar Caixa Postal |
mailbox entries delete | DELETE /v2/mailbox/entries/{uid} | Deletar Caixa Postal |
mailbox entries email get | GET /v2/mailbox/entries/{entry_id}/email | Exibir Canal de E-mail |
mailbox entries email create | POST /v2/mailbox/entries/{entry_id}/email | Criar Canal de E-mail |
mailbox entries email update | PATCH /v2/mailbox/entries/{entry_id}/email | Atualizar Canal de E-mail |
mailbox entries email delete | DELETE /v2/mailbox/entries/{entry_id}/email | Excluir Canal de E-mail |
mailbox entries email activate update | PUT /v2/mailbox/entries/{entry_id}/email/activate | Ativar Canal de E-mail |
mailbox entries email deactivate update | PUT /v2/mailbox/entries/{entry_id}/email/deactivate | Desativar Canal de E-mail |
mailbox entries s3 get | GET /v2/mailbox/entries/{entry_id}/s3 | Exibir Canal S3 |
mailbox entries s3 create | POST /v2/mailbox/entries/{entry_id}/s3 | Criar Canal S3 |
mailbox entries s3 delete | DELETE /v2/mailbox/entries/{entry_id}/s3 | Excluir Canal S3 |
mailbox entries s3 activate update | PUT /v2/mailbox/entries/{entry_id}/s3/activate | Ativar Canal S3 |
mailbox entries s3 deactivate update | PUT /v2/mailbox/entries/{entry_id}/s3/deactivate | Desativar Canal S3 |
mailbox entries s3 fetch update | PUT /v2/mailbox/entries/{entry_id}/s3/fetch | Buscar arquivos do Canal S3 |
mailbox entries s3 update-password update | PUT /v2/mailbox/entries/{entry_id}/s3/update_password | Atualizar credenciais AWS do Canal S3 |
mailbox entries sftp get | GET /v2/mailbox/entries/{entry_id}/sftp | Exibir Canal SFTP |
mailbox entries sftp create | POST /v2/mailbox/entries/{entry_id}/sftp | Criar Canal SFTP |
mailbox entries sftp update | PATCH /v2/mailbox/entries/{entry_id}/sftp | Atualizar Canal SFTP |
mailbox entries sftp delete | DELETE /v2/mailbox/entries/{entry_id}/sftp | Excluir Canal SFTP |
mailbox entries sftp activate update | PUT /v2/mailbox/entries/{entry_id}/sftp/activate | Ativar Canal SFTP |
mailbox entries sftp deactivate update | PUT /v2/mailbox/entries/{entry_id}/sftp/deactivate | Desativar Canal SFTP |
mailbox entries sftp fetch update | PUT /v2/mailbox/entries/{entry_id}/sftp/fetch | Buscar arquivos do Canal SFTP |
mailbox entries sftp update-password update | PUT /v2/mailbox/entries/{entry_id}/sftp/update_password | Atualizar credenciais SSH do Canal SFTP |
mailbox entries syncthing get | GET /v2/mailbox/entries/{entry_id}/syncthing | Exibir Canal Syncthing |
mailbox entries syncthing create | POST /v2/mailbox/entries/{entry_id}/syncthing | Criar Canal Syncthing |
mailbox entries syncthing update | PATCH /v2/mailbox/entries/{entry_id}/syncthing | Atualizar Canal Syncthing |
mailbox entries syncthing delete | DELETE /v2/mailbox/entries/{entry_id}/syncthing | Excluir Canal Syncthing |
mailbox entries syncthing activate update | PUT /v2/mailbox/entries/{entry_id}/syncthing/activate | Ativar Canal Syncthing |
mailbox entries syncthing deactivate update | PUT /v2/mailbox/entries/{entry_id}/syncthing/deactivate | Desativar Canal Syncthing |
mailbox entries syncthing resend-invites update | PUT /v2/mailbox/entries/{entry_id}/syncthing/resend_invites | Reenviar Convites Syncthing |
mailbox entries syncthing update-status update | PUT /v2/mailbox/entries/{entry_id}/syncthing/update_status | Atualizar Status do Servidor Syncthing |
mailbox entries whatsapp get | GET /v2/mailbox/entries/{entry_id}/whatsapp | Exibir Canal WhatsApp |
mailbox entries whatsapp create | POST /v2/mailbox/entries/{entry_id}/whatsapp | Criar Canal WhatsApp |
mailbox entries whatsapp update | PATCH /v2/mailbox/entries/{entry_id}/whatsapp | Atualizar Canal WhatsApp |
mailbox entries whatsapp delete | DELETE /v2/mailbox/entries/{entry_id}/whatsapp | Excluir Canal WhatsApp |
mailbox entries whatsapp activate update | PUT /v2/mailbox/entries/{entry_id}/whatsapp/activate | Ativar Canal WhatsApp |
mailbox entries whatsapp deactivate update | PUT /v2/mailbox/entries/{entry_id}/whatsapp/deactivate | Desativar Canal WhatsApp |
mailbox files list | GET /v2/mailbox/files | Listar Arquivos de Mailbox |
mailbox files get | GET /v2/mailbox/files/{uid} | Visualizar Arquivo de Mailbox |
mailbox files update | PATCH /v2/mailbox/files/{uid} | Atualizar Arquivo de Mailbox |
mailbox files delete | DELETE /v2/mailbox/files/{uid} | Deletar Arquivo de Mailbox |
# Listar Caixas Postais
kobana banking mailbox entries list
# Visualizar Caixa Postal
kobana banking mailbox entries get --params '{"uid":"ENTRY_UID"}'
# Deletar Caixa Postal
kobana banking mailbox entries delete --params '{"uid":"ENTRY_UID"}' --dry-run
Caixas EDI
As caixas EDI que recebem os arquivos do banco.
| Comando | HTTP | Descrição |
|---|---|---|
edi edi-boxes list | GET /v2/edi/edi_boxes | Listar Caixas Postais |
edi edi-boxes create | POST /v2/edi/edi_boxes | Criar Caixa Postal |
edi edi-boxes get | GET /v2/edi/edi_boxes/{uid} | Visualizar Caixa Postal |
edi edi-boxes update | PUT /v2/edi/edi_boxes/{uid} | Atualizar Caixa Postal |
# Listar Caixas Postais
kobana banking edi edi-boxes list
# Visualizar Caixa Postal
kobana banking edi edi-boxes get --params '{"uid":"EDI_BOX_UID"}'
Próximos passos
- Introspecção de schema: os parâmetros e o corpo que cada comando aceita.
- Flags globais:
--params,--json,--fields,--dry-rune as demais.