totalvoice-ruby 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 156b598bd074acb2c3962eb1bfff5cdc990a8e5b
-  data.tar.gz: b8d2fab5772b2144ffbbf5d94fa1745e70dfe74a
+  metadata.gz: 55c3656d49c672a46fa3e122546b4df33f9bb43b
+  data.tar.gz: 67c3ce991c9cbb368e997934cf545bdf8ddcb4c3
 SHA512:
-  metadata.gz: 2c7a03544fa55a3606bc7b30a3aba0eeac51a11dd5946bca6a49caff1d9571814ce7294e7e0cc1c6a9eb840071546e71753c0596396d292aac099bd1d6cfe4e7
-  data.tar.gz: 9caab1b0f59ae449f3dc3b4294f3edf71ef4181b4157824e570b1830d301f39152867b4e7ad3c336aa8c8501f44059d2c42c14106aaa104721e97630527abd0a
+  metadata.gz: 3468fd10aeec31b134fc1dc05e875e8469600c8711ca5101568ff687bd4d18024fa907847aac43b978c5cbf11db2184715f8763241083846e83d918817b9d152
+  data.tar.gz: cd32579e980786e2d85ddb7066fd6a052a13208cf05921f316aa51cc05984cc5bd06d50136e50a0338059af8f0ead246751fa4ba4a9918159bf71fbe96474a37

data/.gitignore

@@ -9,7 +9,7 @@
 /test/tmp/
 /test/version_tmp/
 /tmp/
-
+/testes/
 .idea/
 
 # Used by dotenv library to load environment variables.

data/README.md

@@ -7,10 +7,13 @@ Client em Ruby para a API da TotalVoice
 - [X] Consulta e envio de SMS
 - [X] Consulta e envio de TTS
 - [X] Consulta e envio de Audio
+- [X] Consulta e envio de Composto
 - [X] Gerenciamento da Conta
 - [X] Gerenciamento de Ramais
 - [X] URL do Webphone
 - [X] Gerenciamento de DID
+- [X] Validação de Número
+- [X] Verificação[Two Dactor Authentication]
 
 > ### Requisitos
 
@@ -41,7 +44,7 @@ A seguir exemplos de como utilizar esta biblioteca.
 require 'totalvoice-ruby'
 include TotalVoice
 
-@client = TotalVoice::API.new("{{access-token}}")
+@client = TotalVoice::API.new("access-token")
 puts @client.chamada.ligar("NUMERO-A", "NUMERO-B")
 ```
 
@@ -51,7 +54,7 @@ puts @client.chamada.ligar("NUMERO-A", "NUMERO-B")
 require 'totalvoice-ruby'
 include TotalVoice
 
-@client = TotalVoice::API.new("{{access-token}}")
+@client = TotalVoice::API.new("access-token")
 puts @client.chamada.buscar(123456)
 ```
 
@@ -61,7 +64,7 @@ puts @client.chamada.buscar(123456)
 require 'totalvoice-ruby'
 include TotalVoice
 
-@client = TotalVoice::API.new("{{access-token}}")
+@client = TotalVoice::API.new("access-token")
 puts @client.chamada.encerrar(123456)
 ```
 
@@ -71,7 +74,7 @@ puts @client.chamada.encerrar(123456)
 require 'totalvoice-ruby'
 include TotalVoice
 
-@client = TotalVoice::API.new("{{access-token}}")
+@client = TotalVoice::API.new("access-token")
 puts @client.sms.enviar("NUMERO-DESTINO", "MENSAGEM")
 ```
 
@@ -81,7 +84,7 @@ puts @client.sms.enviar("NUMERO-DESTINO", "MENSAGEM")
 require 'totalvoice-ruby'
 include TotalVoice
 
-@client = TotalVoice::API.new("{{access-token}}")
+@client = TotalVoice::API.new("access-token")
 puts @client.tts.enviar("NUMERO-DESTINO", "MENSAGEM")
 ```
 
@@ -91,7 +94,7 @@ puts @client.tts.enviar("NUMERO-DESTINO", "MENSAGEM")
 require 'totalvoice-ruby'
 include TotalVoice
 
-@client = TotalVoice::API.new("{{access-token}}")
+@client = TotalVoice::API.new("access-token")
 puts @client.audio.enviar("NUMERO-DESTINO", "URL-AUDIO")
 ```
 
@@ -101,7 +104,7 @@ puts @client.audio.enviar("NUMERO-DESTINO", "URL-AUDIO")
 require 'totalvoice-ruby'
 include TotalVoice
 
-@client = TotalVoice::API.new("{{access-token}}")
+@client = TotalVoice::API.new("access-token")
 puts @client.ramal.buscar(123)
 ```
 
@@ -111,7 +114,7 @@ puts @client.ramal.buscar(123)
 require 'totalvoice-ruby'
 include TotalVoice
 
-@client = TotalVoice::API.new("{{access-token}}")
+@client = TotalVoice::API.new("access-token")
 puts @client.conta.buscar(123)
 ```
 
@@ -121,7 +124,7 @@ puts @client.conta.buscar(123)
 require 'totalvoice-ruby'
 include TotalVoice
 
-@client = TotalVoice::API.new("{{access-token}}")
+@client = TotalVoice::API.new("access-token")
 puts @client.perfil.consulta_saldo()
 ```
 
@@ -131,7 +134,7 @@ puts @client.perfil.consulta_saldo()
 require 'totalvoice-ruby'
 include TotalVoice
 
-@client = TotalVoice::API.new("{{access-token}}", "https://meuhost.com.br")
+@client = TotalVoice::API.new("access-token", "https://meuhost.com.br")
 puts @client.perfil.consulta_saldo()
 ```
 
@@ -141,7 +144,7 @@ puts @client.perfil.consulta_saldo()
 require 'totalvoice-ruby'
 include TotalVoice
 
-@client = TotalVoice::API.new("{{access-token}}")
+@client = TotalVoice::API.new("access-token")
 puts @client.did.adquirir()
 ```
 
@@ -151,7 +154,7 @@ puts @client.did.adquirir()
 require 'totalvoice-ruby'
 include TotalVoice
 
-@client = TotalVoice::API.new("{{access-token}}")
+@client = TotalVoice::API.new("access-token")
 puts @client.did.listar()
 ```
 

data/exemplos/envio-audio.rb

@@ -0,0 +1,5 @@
+require_relative '../lib/totalvoice-ruby.rb'
+include TotalVoice
+
+@client = TotalVoice::API.new("seu-token")
+puts @client.audio.enviar("48912341234", "http://seuaudio.com/audio.mp3")

data/lib/api/audio.rb

@@ -21,15 +21,17 @@ module TotalVoice
     # @param [Boolean] resposta_usuario
     # @param [String] bina
     # @param [Boolean] gravar_audio
+    # @param [Boolean] detecta_caixa
     # @return [json]
     #
-    def enviar(numero_destino, url_audio, resposta_usuario = false, bina = nil, gravar_audio = false)
+    def enviar(numero_destino, url_audio, resposta_usuario = false, bina = nil, gravar_audio = false, detecta_caixa = false)
       @client.post(Route.new([ROTA_AUDIO]), {
         numero_destino: numero_destino,
         url_audio: url_audio,
         resposta_usuario: resposta_usuario,
         bina: bina,
-        gravar_audio: gravar_audio
+        gravar_audio: gravar_audio,
+        detecta_caixa: detecta_caixa
       })
     end
 

data/lib/api/composto.rb

@@ -19,15 +19,17 @@ module TotalVoice
     # @param [String] bina
     # @param [String] tags
     # @param [Boolean] gravar_audio
+    # @param [Boolean] detecta_caixa
     # @return [json]
     #
-    def enviar(numero_destino, dados, bina = nil, tags = nil, gravar_audio = false)
+    def enviar(numero_destino, dados, bina = nil, tags = nil, gravar_audio = false, detecta_caixa = false)
       @client.post(Route.new([ROTA_COMPOSTO]), {
         numero_destino: numero_destino,
         bina: bina,
         tags: tags,
         gravar_audio: gravar_audio,
-        dados: dados
+        dados: dados,
+        detecta_caixa: detecta_caixa
       })
     end
 

data/lib/api/conferencia.rb

@@ -55,5 +55,34 @@ module TotalVoice
     def excluir(id)
       @client.delete(Route.new([ROTA_CONFERENCIA, id.to_s]))
     end
+
+    ##
+    # Gera um relatorio de conferencias
+    #
+    # @param [DateTime|String] data_inicio
+    # @param [DateTime|String] data_fim
+    # @return [json]
+    #
+    def relatorio(data_inicio, data_fim)
+      @client.get(
+        Route.new([ROTA_CONFERENCIA, 'relatorio']),
+        Query.new({ 'data_inicio': Time.parse(data_inicio.to_s).utc, 'data_fim': Time.parse(data_fim.to_s).utc })
+      )
+    end
+
+    ##
+    # Gera um relatorio de chamadas de conferencias
+    #
+    # @param [DateTime|String] data_inicio
+    # @param [DateTime|String] data_fim
+    # @return [json]
+    #
+    def relatorio_chamadas_conferencias(data_inicio, data_fim)
+      @client.get(
+        Route.new([ROTA_CONFERENCIA, 'chamadas/relatorio']),
+        Query.new({ 'data_inicio': Time.parse(data_inicio.to_s).utc, 'data_fim': Time.parse(data_fim.to_s).utc })
+      )
+    end
+
   end
 end

data/lib/api/conta.rb

@@ -11,7 +11,7 @@ module TotalVoice
     end
 
     ##
-    # Cria uma conferência
+    # Cria uma conta abaixo da sua - Subconta
     #
     # @param [Hash] data
     # @return [json]
@@ -21,7 +21,7 @@ module TotalVoice
     end
 
     ##
-    # Atualiza os dados da conta
+    # Atualiza os dados da Subconta
     #
     # @param [Integer] id
     # @param [Hash] data
@@ -32,7 +32,7 @@ module TotalVoice
     end
 
     ##
-    # Busca os dados da Conta
+    # Busca os dados da Subconta
     #
     # @param [Integer] id
     # @return [json]
@@ -42,7 +42,7 @@ module TotalVoice
     end
 
     ##
-    # Remove uma Conta
+    # Remove uma Subconta
     #
     # @param [Integer] id
     # @return [json]
@@ -52,7 +52,7 @@ module TotalVoice
     end
 
     ##
-    # Lista contas criadas por mim
+    # Lista todas as subconta criadas por mim
     # @return [json]
     #
     def relatorio()

data/lib/api/did.rb

@@ -76,7 +76,7 @@ module TotalVoice
     end
 
     ##
-    # Gera relatório de chamadas recebidas pelo DID
+    # Gera relatório de chamadas recebidas de todos os DIDs
     #
     # @param [DateTime|String] data_inicio
     # @param [DateTime|String] data_fim
@@ -88,5 +88,21 @@ module TotalVoice
         Query.new({ 'data_inicio': Time.parse(data_inicio.to_s).utc, 'data_fim': Time.parse(data_fim.to_s).utc })
       )
     end
+
+    ##
+    # Gera relatório de chamadas recebidas por um unico DID
+    #
+    # @param [Integer] id
+    # @param [DateTime|String] data_inicio
+    # @param [DateTime|String] data_fim
+    # @return [json]
+    #
+    def relatorio_did(id,data_inicio, data_fim)
+      @client.get(
+        Route.new([ROTA_DID, id.to_s, 'relatorio']),
+        Query.new({ 'data_inicio': Time.parse(data_inicio.to_s).utc, 'data_fim': Time.parse(data_fim.to_s).utc })
+      )
+    end
+
   end
 end

data/lib/api/fila.rb

@@ -19,5 +19,69 @@ module TotalVoice
     def buscar(id)
       @client.get(Route.new([ROTA_FILA, id.to_s]))
     end
+
+    ##
+    # Criar fila
+    #
+    # @param [String] nome
+    # @param [String] estrategia_ring
+    # @param [String] timeout_ring
+    # @return [json]
+    #
+    def criar(nome, estrategia_ring, timeout_ring = nil)
+      data = {
+        nome: nome,
+        estrategia_ring: estrategia_ring,
+        timeout_ring: timeout_ring
+      }
+      @client.post(Route.new([ROTA_FILA]), data)
+    end
+
+    ##
+    # Adiciona um ramal na fila
+    #
+    # @param [String] nome
+    # @param [String] estrategia_ring
+    # @param [String] timeout_ring
+    # @return [json]
+    #
+    def adiciona_ramal(id, ramal_id)
+      data = {
+        ramal_id: ramal_id
+      }
+      @client.post(Route.new([ROTA_FILA, id.to_s]), data)
+    end
+
+    ##
+    # Busca as informações de um ramal da Fila de Atendimento
+    #
+    # @param [Integer] id
+    # @return [json]
+    #
+    def buscar_ramal(id, ramal_id)
+      @client.get(Route.new([ROTA_FILA, id.to_s, ramal_id.to_s]))
+    end
+
+    ##
+    # Atualiza as informações da fila
+    #
+    # @param [Integer] id
+    # @param [Hash] data
+    # @return [json]
+    #
+    def atualizar(id, data)
+      @client.put(Route.new([ROTA_FILA, id.to_s]), data)
+    end
+
+    ##
+    # Remove um ramal da fila
+    #
+    # @param [Integer] id
+    # @param [Integer] ramal_id
+    # @return [json]
+    #
+    def excluir_ramal(id, ramal_id)
+      @client.delete(Route.new([ROTA_RAMAL, id.to_s, ramal_id.to_s]))
+    end
   end
 end

data/lib/api/ramal.rb

@@ -65,5 +65,20 @@ module TotalVoice
         Query.new({ 'data_inicio': Time.parse(data_inicio.to_s).utc, 'data_fim': Time.parse(data_fim.to_s).utc })
       )
     end
+    
+    ##
+    # Gera relatório de pausas de um ramal
+    #
+    # @param [Integer] id
+    # @param [DateTime|String] data_inicio
+    # @param [DateTime|String] data_fim
+    # @return [json]
+    #
+    def relatorio_pausa_ramal(id, data_inicio, data_fim)
+      @client.get(
+        Route.new([ROTA_RAMAL,id.to_s, 'pausas']),
+        Query.new({'data_inicio': Time.parse(data_inicio.to_s).utc, 'data_fim': Time.parse(data_fim.to_s).utc })
+      )
+    end
   end
-end
+end

data/lib/api/sms.rb

@@ -19,15 +19,17 @@ module TotalVoice
     # @param [Boolean] resposta_usuario
     # @param [Boolean] multi_sms
     # @param [DateTime|String] data_criacao
+    # @param [String] tags
     # @return [json]
     #
-    def enviar(numero_destino, mensagem, resposta_usuario = false, multi_sms = false, data_criacao = nil)
+    def enviar(numero_destino, mensagem, resposta_usuario = false, multi_sms = false, data_criacao = nil, tags = nil)
       @client.post(Route.new([ROTA_SMS]), {
         numero_destino: numero_destino,
         mensagem: mensagem,
         resposta_usuario: resposta_usuario,
         multi_sms: multi_sms,
-        data_criacao: data_criacao != nil ? Time.parse(data_criacao.to_s).utc : nil
+        data_criacao: data_criacao != nil ? Time.parse(data_criacao.to_s).utc : nil,
+        tags: tags
       })
     end
 

data/lib/api/ura.rb

@@ -35,6 +35,16 @@ module TotalVoice
       @client.delete(Route.new([ROTA_URA, id.to_s]))
     end
 
+    ##
+    # Busca uam URA pelo seu ID
+    #
+    # @param [Integer] id
+    # @return [json]
+    #
+    def buscar(id)
+      @client.get(Route.new([ROTA_URA, id.to_s]))
+    end
+
     ##
     # Atualiza uma ura
     #
@@ -45,5 +55,20 @@ module TotalVoice
     def atualizar(id, data)
       @client.put(Route.new([ROTA_URA, id.to_s]), data)
     end
+
+    ##
+    # Gera relatório de todas as URAs da conta
+    #
+    # @param [DateTime|String] data_inicio
+    # @param [DateTime|String] data_fim
+    # @return [json]
+    #
+    def relatorio(data_inicio, data_fim)
+      @client.get(
+        Route.new([ROTA_URA, 'relatorio']),
+        Query.new({ 'data_inicio': Time.parse(data_inicio.to_s).utc, 'data_fim': Time.parse(data_fim.to_s).utc })
+      )
+    end
+
   end
 end

data/lib/api/valida_numero.rb

@@ -0,0 +1,52 @@
+require 'date'
+
+require_relative '../route'
+require_relative '../query'
+
+module TotalVoice
+  # Inicializa o HTTP client
+  class ValidaNumero
+    attr_reader :client
+    ROTA_VALIDA_NUMERO = "/valida_numero"
+
+    def initialize(client)
+      @client = client
+    end
+
+    ##
+    # Envia um Numeoro para verificação
+    #
+    # @param [String] numero_destino
+    # @return [json]
+    #
+    def enviar(numero_destino)
+      @client.post(Route.new([ROTA_VALIDA_NUMERO]), {
+        numero_destino: numero_destino
+      })
+    end
+
+    ##
+    # Busca as informações de um número validado
+    #
+    # @param [Integer] id
+    # @return [json]
+    #
+    def buscar(id)
+      @client.get(Route.new([ROTA_VALIDA_NUMERO, id.to_s]))
+    end
+
+    ##
+    # Gera relatório de números validados
+    #
+    # @param [DateTime|String] data_inicio
+    # @param [DateTime|String] data_fim
+    # @return [json]
+    #
+    def relatorio(data_inicio, data_fim)
+      @client.get(
+        Route.new([ROTA_VALIDA_NUMERO, 'relatorio']),
+        Query.new({ 'data_inicio': Time.parse(data_inicio.to_s).utc, 'data_fim': Time.parse(data_fim.to_s).utc })
+      )
+    end
+  end
+end

data/lib/api/verificacao.rb

@@ -0,0 +1,47 @@
+require 'date'
+
+require_relative '../route'
+require_relative '../query'
+
+module TotalVoice
+  # Inicializa o HTTP client
+  class Verificacao
+    attr_reader :client
+    ROTA_VERIFICACAO = "/verificacao"
+
+    def initialize(client)
+      @client = client
+    end
+
+    ##
+    # Envia o código de verificação
+    #
+    # @param [String] numero_destino
+    # @param [String] nome_produto
+    # @param [Hash] opcoes
+    # @return [json]
+    #
+    def enviar(numero_destino, nome_produto, opcoes = {})
+      data = {
+        numero_destino: numero_destino,
+        nome_produto: nome_produto
+      }
+      data.merge!(opcoes)
+      @client.post(Route.new([ROTA_VERIFICACAO]), data)
+    end
+
+   ##
+    # Consulta se o código pin é valido
+    #
+    # @param [Integer] id
+    # @return [json]
+    #
+    def consultar(id, pin)
+        @client.get(
+            Route.new([ROTA_VERIFICACAO]),
+            Query.new({ 'id': id.to_s, 'pin': pin.to_s })
+            )
+    end
+
+  end
+end

data/lib/api/webphone.rb

@@ -1,4 +1,5 @@
 require_relative '../route'
+require_relative '../query'
 
 module TotalVoice
   # Inicializa o HTTP client
@@ -17,7 +18,7 @@ module TotalVoice
     # @return [json]
     #
     def url(data)
-      @client.get(Route.new([ROTA_WEBPHONE]), data)
+      @client.get(Route.new([ROTA_WEBPHONE]), Query.new(data))
     end
   end
 end

data/lib/client.rb

@@ -16,6 +16,8 @@ require_relative 'api/sms'
 require_relative 'api/tts'
 require_relative 'api/ura'
 require_relative 'api/webphone'
+require_relative 'api/valida_numero'
+require_relative 'api/verificacao'
 
 
 module TotalVoice
@@ -52,6 +54,8 @@ module TotalVoice
       @tts = nil
       @ura = nil
       @webphone = nil
+      @valida_numero = nil
+      @verificacao = nil
     end
 
     def audio
@@ -110,6 +114,13 @@ module TotalVoice
         @webphone ||= Webphone.new self
     end
 
+    def valida_numero
+      @valida_numero ||= ValidaNumero.new self
+    end
+
+    def verificacao
+      @verificacao ||= Verificacao.new self
+    end
     #
     # GET HTTP Method
     #

data/lib/totalvoice/version.rb

@@ -1,3 +1,3 @@
 module TotalVoice
-  VERSION = '1.3.0'
+  VERSION = '1.3.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: totalvoice-ruby
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - DiloWagner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-31 00:00:00.000000000 Z
+date: 2019-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -34,6 +34,7 @@ files:
 - Gemfile
 - LICENSE
 - README.md
+- exemplos/envio-audio.rb
 - lib/api/audio.rb
 - lib/api/bina.rb
 - lib/api/chamada.rb
@@ -47,6 +48,8 @@ files:
 - lib/api/sms.rb
 - lib/api/tts.rb
 - lib/api/ura.rb
+- lib/api/valida_numero.rb
+- lib/api/verificacao.rb
 - lib/api/webphone.rb
 - lib/client.rb
 - lib/query.rb