nuvemfiscal_sdk_ruby 0.0.1

data/spec/api/mdfe_api_spec.rb

@@ -0,0 +1,353 @@
+=begin
+#API Nuvem Fiscal
+
+#API para automação comercial e documentos fiscais.
+
+The version of the OpenAPI document: 2.44.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.10.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for NuvemfiscalSdkRuby::MdfeApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'MdfeApi' do
+  before do
+    # run before each test
+    @api_instance = NuvemfiscalSdkRuby::MdfeApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of MdfeApi' do
+    it 'should create an instance of MdfeApi' do
+      expect(@api_instance).to be_instance_of(NuvemfiscalSdkRuby::MdfeApi)
+    end
+  end
+
+  # unit tests for baixar_pdf_cancelamento_mdfe
+  # Baixar PDF do cancelamento
+  # @param id ID único do MDF-e gerado pela Nuvem Fiscal.
+  # @param [Hash] opts the optional parameters
+  # @return [File]
+  describe 'baixar_pdf_cancelamento_mdfe test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for baixar_pdf_encerramento_mdfe
+  # Baixar PDF do encerramento
+  # @param id ID único do MDF-e gerado pela Nuvem Fiscal.
+  # @param [Hash] opts the optional parameters
+  # @return [File]
+  describe 'baixar_pdf_encerramento_mdfe test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for baixar_pdf_evento_mdfe
+  # Baixar PDF do evento
+  # @param id ID único do evento gerado pela Nuvem Fiscal.
+  # @param [Hash] opts the optional parameters
+  # @return [File]
+  describe 'baixar_pdf_evento_mdfe test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for baixar_pdf_mdfe
+  # Baixar PDF do DAMDFE
+  # @param id ID único do MDF-e gerado pela Nuvem Fiscal.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Boolean] :logotipo Imprime o documento com logotipo, desde que esteja cadastrado na empresa.
+  # @return [File]
+  describe 'baixar_pdf_mdfe test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for baixar_xml_cancelamento_mdfe
+  # Baixar XML do cancelamento
+  # @param id ID único do MDF-e gerado pela Nuvem Fiscal.
+  # @param [Hash] opts the optional parameters
+  # @return [File]
+  describe 'baixar_xml_cancelamento_mdfe test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for baixar_xml_encerramento_mdfe
+  # Baixar XML do encerramento
+  # @param id ID único do MDF-e gerado pela Nuvem Fiscal.
+  # @param [Hash] opts the optional parameters
+  # @return [File]
+  describe 'baixar_xml_encerramento_mdfe test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for baixar_xml_evento_mdfe
+  # Baixar XML do evento
+  # @param id ID único do evento gerado pela Nuvem Fiscal.
+  # @param [Hash] opts the optional parameters
+  # @return [File]
+  describe 'baixar_xml_evento_mdfe test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for baixar_xml_mdfe
+  # Baixar XML do MDF-e processado
+  # Utilize esse endpoint para obter o XML do manifesto enviado para a SEFAZ, complementado com a informação do protocolo de autorização ou denegação de uso (TAG raiz `mdfeProc`).    O XML só estará disponível nesse endpoint caso o manifesto tenha sido autorizado ou denegado pela SEFAZ. Para obter o XML nos demais casos, utilize o endpoint `GET /mdfe/{id}/xml/manifesto`.
+  # @param id ID único do MDF-e gerado pela Nuvem Fiscal.
+  # @param [Hash] opts the optional parameters
+  # @return [File]
+  describe 'baixar_xml_mdfe test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for baixar_xml_mdfe_manifesto
+  # Baixar XML do MDF-e
+  # Utilize esse endpoint para obter o XML do manifesto enviado para a SEFAZ.    O XML estará disponível nesse endpoint mesmo em casos que o manifesto tenha sido rejeitado.
+  # @param id ID único da MDF-e gerado pela Nuvem Fiscal.
+  # @param [Hash] opts the optional parameters
+  # @return [File]
+  describe 'baixar_xml_mdfe_manifesto test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for baixar_xml_mdfe_protocolo
+  # Baixar XML do Protocolo da SEFAZ
+  # @param id ID único da MDF-e gerado pela Nuvem Fiscal.
+  # @param [Hash] opts the optional parameters
+  # @return [File]
+  describe 'baixar_xml_mdfe_protocolo test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for cancelar_mdfe
+  # Cancelar um MDF-e autorizado
+  # **Informações adicionais**:  - Cota: <a href=\"/docs/limites#dfe-eventos\">dfe-eventos</a>  - Consumo: 1 unidade por requisição.
+  # @param id ID único do MDF-e gerado pela Nuvem Fiscal.
+  # @param [Hash] opts the optional parameters
+  # @option opts [MdfePedidoCancelamento] :body Dados do cancelamento.
+  # @return [DfeCancelamento]
+  describe 'cancelar_mdfe test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for consultar_cancelamento_mdfe
+  # Consultar o cancelamento do MDF-e
+  # @param id ID único do MDF-e gerado pela Nuvem Fiscal.
+  # @param [Hash] opts the optional parameters
+  # @return [DfeCancelamento]
+  describe 'consultar_cancelamento_mdfe test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for consultar_encerramento_mdfe
+  # Consultar encerramento do MDF-e
+  # @param id ID único do MDF-e gerado pela Nuvem Fiscal.
+  # @param [Hash] opts the optional parameters
+  # @return [MdfeEncerramento]
+  describe 'consultar_encerramento_mdfe test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for consultar_evento_mdfe
+  # Consultar evento do MDF-e
+  # @param id ID único do evento gerado pela Nuvem Fiscal.
+  # @param [Hash] opts the optional parameters
+  # @return [DfeEvento]
+  describe 'consultar_evento_mdfe test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for consultar_lote_mdfe
+  # Consultar lote de MDF-e
+  # Consulta os detalhes de um lote já existente. Forneça o ID único obtido de uma requisição de emissão ou de listagem de lotes e a Nuvem Fiscal irá retornar as informações do lote correspondente.
+  # @param id ID único do lote gerado pela Nuvem Fiscal.
+  # @param [Hash] opts the optional parameters
+  # @return [DfeLote]
+  describe 'consultar_lote_mdfe test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for consultar_mdfe
+  # Consultar manifesto
+  # Consulta os detalhes de um manifesto já existente. Forneça o ID único obtido de uma requisição de emissão ou de listagem de manifestos e a Nuvem Fiscal irá retornar as informações do manifesto correspondente.
+  # @param id ID único do MDF-e gerado pela Nuvem Fiscal.
+  # @param [Hash] opts the optional parameters
+  # @return [Dfe]
+  describe 'consultar_mdfe test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for consultar_mdfe_nao_encerrados
+  # Consulta MDF-e não encerrados
+  # @param cpf_cnpj CPF/CNPJ do emitente.  Utilize o valor sem máscara.
+  # @param [Hash] opts the optional parameters
+  # @return [MdfeNaoEncerrados]
+  describe 'consultar_mdfe_nao_encerrados test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for consultar_status_sefaz_mdfe
+  # Consulta do Status do Serviço na SEFAZ Autorizadora
+  # Consulta do status do serviço prestado pelo Portal da Secretaria de Fazenda Estadual.    A Nuvem Fiscal mantém a última consulta em cache por 5 minutos, evitando sobrecarregar desnecessariamente os servidores da SEFAZ (conforme orientação do MOC - versão 3.0.0a, item 4.6.3). Dessa forma, você poderá chamar esse endpoint quantas vezes quiser, sem preocupar-se em ter o seu CNPJ bloqueado por consumo indevido (Rejeição 656).
+  # @param cpf_cnpj CPF/CNPJ do emitente.  Utilize o valor sem máscara.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :autorizador Ambiente Autorizador.    Autorizadores disponíveis: `SVRS`.    *Caso não seja informado, será utilizado o ambiente autorizador da UF do emitente.*
+  # @return [DfeSefazStatus]
+  describe 'consultar_status_sefaz_mdfe test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for emitir_lote_mdfe
+  # Emitir lote de MDF-e
+  # **Informações adicionais**:  - Cota: <a href=\"/docs/limites#dfe-eventos\">dfe-eventos</a>  - Consumo: 1 unidade por MDF-e.
+  # @param body 
+  # @param [Hash] opts the optional parameters
+  # @return [DfeLote]
+  describe 'emitir_lote_mdfe test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for emitir_mdfe
+  # Emitir MDF-e
+  # **Informações adicionais**:  - Cota: <a href=\"/docs/limites#dfe-eventos\">dfe-eventos</a>  - Consumo: 1 unidade por requisição.
+  # @param body 
+  # @param [Hash] opts the optional parameters
+  # @return [Dfe]
+  describe 'emitir_mdfe test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for encerrar_mdfe
+  # Encerrar um MDF-e autorizado
+  # **Informações adicionais**:  - Cota: <a href=\"/docs/limites#dfe-eventos\">dfe-eventos</a>  - Consumo: 1 unidade por requisição.
+  # @param id ID único do MDF-e gerado pela Nuvem Fiscal.
+  # @param body 
+  # @param [Hash] opts the optional parameters
+  # @return [MdfeEncerramento]
+  describe 'encerrar_mdfe test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for incluir_condutor_mdfe
+  # Incluir um condutor em um MDF-e autorizado
+  # **Informações adicionais**:  - Cota: <a href=\"/docs/limites#dfe-eventos\">dfe-eventos</a>  - Consumo: 1 unidade por requisição.
+  # @param id ID único do MDF-e gerado pela Nuvem Fiscal.
+  # @param body 
+  # @param [Hash] opts the optional parameters
+  # @return [MdfeInclusaoCondutor]
+  describe 'incluir_condutor_mdfe test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for incluir_dfe_mdfe
+  # Incluir um DF-e em um MDF-e autorizado
+  # **Informações adicionais**:  - Cota: <a href=\"/docs/limites#dfe-eventos\">dfe-eventos</a>  - Consumo: 1 unidade por requisição.
+  # @param id ID único do MDF-e gerado pela Nuvem Fiscal.
+  # @param body 
+  # @param [Hash] opts the optional parameters
+  # @return [MdfeInclusaoDfe]
+  describe 'incluir_dfe_mdfe test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for listar_lotes_mdfe
+  # Listar lotes de MDF-e
+  # Retorna a lista dos lotes de acordo com os critérios de busca utilizados. Os lotes são retornados ordenados pela data da criação, com os mais recentes aparecendo primeiro.
+  # @param cpf_cnpj Filtrar pelo CPF ou CNPJ do emitente.  Utilize o valor sem máscara.
+  # @param ambiente Identificação do Ambiente.    Valores aceitos: homologacao, producao
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :top Limite no número de objetos a serem retornados pela API, entre 1 e 100.
+  # @option opts [Integer] :skip Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.
+  # @option opts [Boolean] :inlinecount Inclui no JSON de resposta, na propriedade `@count`, o número total de registros que o filtro retornaria, independente dos filtros de paginação.
+  # @option opts [String] :referencia 
+  # @return [DfeLoteListagem]
+  describe 'listar_lotes_mdfe test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for listar_mdfe
+  # Listar MDF-e
+  # Retorna a lista de manifestos de acordo com os critérios de busca utilizados. Os manifestos são retornados ordenados pela data da criação, com os mais recentes aparecendo primeiro.
+  # @param cpf_cnpj Filtrar pelo CPF ou CNPJ do emitente.    Utilize o valor sem máscara.
+  # @param ambiente Identificação do Ambiente.    Valores aceitos: homologacao, producao
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :top Limite no número de objetos a serem retornados pela API, entre 1 e 100.
+  # @option opts [Integer] :skip Quantidade de objetos que serão ignorados antes da lista começar a ser retornada.
+  # @option opts [Boolean] :inlinecount Inclui no JSON de resposta, na propriedade `@count`, o número total de registros que o filtro retornaria, independente dos filtros de paginação.
+  # @option opts [String] :referencia Seu identificador único para o documento.
+  # @option opts [String] :chave Chave de acesso do DF-e.
+  # @option opts [String] :serie Série do DF-e.
+  # @return [DfeListagem]
+  describe 'listar_mdfe test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for sincronizar_mdfe
+  # Sincroniza dados no MDF-e a partir da SEFAZ
+  # Realiza a sincronização dos dados a partir da consulta da situação atual da MDF-e na Base de Dados do Portal da Secretaria de Fazenda Estadual.    **Cenários de uso**:  * Sincronizar um manifesto que se encontra com o status `erro` na Nuvem Fiscal, mas está autorizado na SEFAZ (útil em casos de erros de transmissão com a SEFAZ, como instabilidades e timeouts).  * Sincronizar um manifesto que se encontra com o status `autorizado`na Nuvem Fiscal, mas está cancelado ou encerrado na SEFAZ.  * Sincronizar todos os eventos de Cancelamento, Encerramento, Inclusão de condutor e Inclusão de DF-e de um manifesto que porventura não tenham sido feitos a partir da Nuvem Fiscal.    **Informações adicionais**:  - Cota: <a href=\"/docs/limites#dfe-eventos\">dfe-eventos</a>  - Consumo: 1 unidade por evento sincronizado ou requisição.
+  # @param id ID único do MDF-e gerado pela Nuvem Fiscal.
+  # @param [Hash] opts the optional parameters
+  # @return [DfeSincronizacao]
+  describe 'sincronizar_mdfe test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end