nuvemfiscal_sdk_ruby 0.0.1

data/spec/api/nfce_api_spec.rb

@@ -0,0 +1,395 @@
+=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::NfceApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'NfceApi' do
+  before do
+    # run before each test
+    @api_instance = NuvemfiscalSdkRuby::NfceApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of NfceApi' do
+    it 'should create an instance of NfceApi' do
+      expect(@api_instance).to be_instance_of(NuvemfiscalSdkRuby::NfceApi)
+    end
+  end
+
+  # unit tests for baixar_esc_pos_nfce
+  # Comandos ESC/POS para impressão do DANFCE
+  # ESC/POS é um sistema de comando criado pela Epson usado em diversos sistemas de impressoras POS.    Com o formato ESC/POS, você poderá imprimir nativamente em uma vasta quantidade de modelos de impressora térmicas utilizadas no Brasil e no mundo. Com ela, você consegue fazer o envio de comandos em ESC/POS direto para a porta da impressora.
+  # @param id ID único da NFC-e gerado pela Nuvem Fiscal.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :modelo Modelo da impressora:  * `0` - Texto  * `1` - Epson  * `2` - Bematech  * `3` - Daruma  * `4` - Vox  * `5` - Diebold  * `6` - Epson P2  * `7` - CustomPos  * `8` - Star  * `9` - Zjiang  * `10` - GPrinter  * `11` - Datecs  * `12` - Sunmi  * `13` - Externo
+  # @option opts [Integer] :colunas Define o máximo de caracteres, em uma linha, usando a fonte normal.    Ex: 40, 42, 48, 58, 80.
+  # @option opts [Boolean] :qrcode_lateral Imprime o QRCode na lateral do DANFCe.    OBS: não suportado por alguns modelos de impressora.
+  # @return [File]
+  describe 'baixar_esc_pos_nfce 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_cancelamento_nfce
+  # Baixar PDF do cancelamento
+  # @param id ID único da NFC-e gerado pela Nuvem Fiscal.
+  # @param [Hash] opts the optional parameters
+  # @return [File]
+  describe 'baixar_pdf_cancelamento_nfce 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_nfce
+  # 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_nfce 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_inutilizacao_nfce
+  # Baixar PDF da inutilização
+  # @param id ID único do evento gerado pela Nuvem Fiscal.
+  # @param [Hash] opts the optional parameters
+  # @return [File]
+  describe 'baixar_pdf_inutilizacao_nfce 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_nfce
+  # Baixar PDF do DANFCE
+  # @param id ID único da NFC-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.
+  # @option opts [Boolean] :nome_fantasia Exibe o nome fantasia do emitente, desde que esteja presente no XML da nota.
+  # @option opts [String] :mensagem_rodape Imprime mensagem no rodapé do documento.    O caractere `|` (pipe) poderá ser utilizado para definir a quantidade e o alinhamento das mensagens.    **Exemplos de Uso:**  * `\"esquerda\"`  * `\"esquerda|centro\"`  * `\"esquerda|centro|direita\"`  * `\"|centro\"`, `\"|centro|\"`  * `\"|centro|direita\"`  * `\"||direita\"`  * `\"esquerda||direita\"`
+  # @option opts [Boolean] :resumido Poderá ser impresso apenas o DANFE NFC-e resumido ou ecológico, sem o detalhamento dos itens da venda, desde que a Unidade Federada permita esta opção em sua legislação e o consumidor assim o solicite.
+  # @option opts [Boolean] :qrcode_lateral Imprime o QRCode na lateral do DANFE NFC-e.    *Disponível apenas para DANFE com 80 milímetros de largura*.
+  # @option opts [Integer] :largura Largura do DANFE NFC-e (em milímetros).
+  # @option opts [String] :margem Define as margens do DANFE NFC-e (em milímetros).    Essa propriedade pode ser especificada usando um, dois, três ou quatro valores (separados por vírgulas). Cada valor deve ser um número entre `0` e `9`.  * Quando **um** valor é especificado, a mesma margem é aplicada para **todos os quatro lados**.  * Quando **dois** valores são especificados, a primeira margem é aplicada aos **lados esquerdo e direito**, e a segunda aos **lados superior e inferior**.  * Quando **três** valores são especificados, a primeira margem é aplicada ao **lado esquerdo**, a segunda aos **lados superior e inferior**, e a terceira ao **lado direito**.  * Quando **quatro** valores são especificados, as margens são aplicadas aos lados **esquerdo**, **superior**, **direito** e **inferior**, nesta ordem (sentido horário).    **Exemplos de uso**:  * `margem=1`    - Margem esquerda: 1mm    - Margem superior: 1mm    - Margem direita: 1mm    - Margem inferior: 1mm  * `margem=1,2`    - Margem esquerda: 1mm    - Margem superior: 2mm    - Margem direita: 1mm    - Margem inferior: 2mm  * `margem=1,2,3`    - Margem esquerda: 1mm    - Margem superior: 2mm    - Margem direita: 3mm    - Margem inferior: 2mm  * `margem=1,2,3,4`    - Margem esquerda: 1mm    - Margem superior: 2mm    - Margem direita: 3mm    - Margem inferior: 4mm
+  # @return [File]
+  describe 'baixar_pdf_nfce 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_previa_pdf_nfce
+  # Prévia do PDF do DANFCE
+  # Através desse endpoint, é possível enviar os dados de uma NFC-e e gerar uma prévia do DANFCE.    Os dados de entrada são os mesmos do endpoint de emissão de NFC-e (`POST /nfce`).    **Atenção**: O DANFE gerado por este endpoint é apenas para fins de visualização e não possui valor fiscal. Para a emissão de uma NF-e com valor fiscal, utilize o processo de emissão padrão descrito na documentação.    **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
+  # @option opts [Boolean] :logotipo Imprime o documento com logotipo, desde que esteja cadastrado na empresa.
+  # @option opts [Boolean] :nome_fantasia Exibe o nome fantasia do emitente, desde que esteja presente no XML da nota.
+  # @option opts [String] :mensagem_rodape Imprime mensagem no rodapé do documento.    O caractere `|` (pipe) poderá ser utilizado para definir a quantidade e o alinhamento das mensagens.    **Exemplos de Uso:**  * `\"esquerda\"`  * `\"esquerda|centro\"`  * `\"esquerda|centro|direita\"`  * `\"|centro\"`, `\"|centro|\"`  * `\"|centro|direita\"`  * `\"||direita\"`  * `\"esquerda||direita\"`
+  # @option opts [Boolean] :resumido Poderá ser impresso apenas o DANFE NFC-e resumido ou ecológico, sem o detalhamento dos itens da venda, desde que a Unidade Federada permita esta opção em sua legislação e o consumidor assim o solicite.
+  # @option opts [Boolean] :qrcode_lateral Imprime o QRCode na lateral do DANFE NFC-e.    *Disponível apenas para DANFE com 80 milímetros de largura*.
+  # @option opts [Integer] :largura Largura do DANFE NFC-e (em milímetros).
+  # @option opts [String] :margem Define as margens do DANFE NFC-e (em milímetros).    Essa propriedade pode ser especificada usando um, dois, três ou quatro valores (separados por vírgulas). Cada valor deve ser um número entre `0` e `9`.  * Quando **um** valor é especificado, a mesma margem é aplicada para **todos os quatro lados**.  * Quando **dois** valores são especificados, a primeira margem é aplicada aos **lados esquerdo e direito**, e a segunda aos **lados superior e inferior**.  * Quando **três** valores são especificados, a primeira margem é aplicada ao **lado esquerdo**, a segunda aos **lados superior e inferior**, e a terceira ao **lado direito**.  * Quando **quatro** valores são especificados, as margens são aplicadas aos lados **esquerdo**, **superior**, **direito** e **inferior**, nesta ordem (sentido horário).    **Exemplos de uso**:  * `margem=1`    - Margem esquerda: 1mm    - Margem superior: 1mm    - Margem direita: 1mm    - Margem inferior: 1mm  * `margem=1,2`    - Margem esquerda: 1mm    - Margem superior: 2mm    - Margem direita: 1mm    - Margem inferior: 2mm  * `margem=1,2,3`    - Margem esquerda: 1mm    - Margem superior: 2mm    - Margem direita: 3mm    - Margem inferior: 2mm  * `margem=1,2,3,4`    - Margem esquerda: 1mm    - Margem superior: 2mm    - Margem direita: 3mm    - Margem inferior: 4mm
+  # @return [File]
+  describe 'baixar_previa_pdf_nfce 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_previa_xml_nfce
+  # Prévia do XML da NFC-e
+  # Através desse endpoint, é possível enviar os dados de uma NFC-e e gerar uma prévia do XML, sem a assinatura digital.    Os dados de entrada são os mesmos do endpoint de emissão de NFC-e (`POST /nfce`).    **Atenção**: O XML gerado por este endpoint é apenas para fins de visualização e não possui valor fiscal. Para a emissão de uma NF-e com valor fiscal, utilize o processo de emissão padrão descrito na documentação.    **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 [File]
+  describe 'baixar_previa_xml_nfce 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_nfce
+  # Baixar XML do cancelamento
+  # @param id ID único da NFC-e gerado pela Nuvem Fiscal.
+  # @param [Hash] opts the optional parameters
+  # @return [File]
+  describe 'baixar_xml_cancelamento_nfce 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_nfce
+  # 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_nfce 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_inutilizacao_nfce
+  # Baixar XML da inutilização
+  # @param id ID único do evento gerado pela Nuvem Fiscal.
+  # @param [Hash] opts the optional parameters
+  # @return [File]
+  describe 'baixar_xml_inutilizacao_nfce 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_nfce
+  # Baixar XML da NFC-e processada
+  # Utilize esse endpoint para obter o XML da nota enviado para a SEFAZ, complementado com a informação do protocolo de autorização ou denegação de uso (TAG raiz `nfeProc`).    O XML só estará disponível nesse endpoint caso a nota tenha sido autorizada ou denegada pela SEFAZ. Para obter o XML nos demais casos, utilize o endpoint `GET /nfce/{id}/xml/nota`.
+  # @param id ID único da NFC-e gerado pela Nuvem Fiscal.
+  # @param [Hash] opts the optional parameters
+  # @return [File]
+  describe 'baixar_xml_nfce 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_nfce_nota
+  # Baixar XML da NFC-e
+  # Utilize esse endpoint para obter o XML da nota enviado para a SEFAZ.    O XML estará disponível nesse endpoint mesmo em casos que a nota tenha sido rejeitada.
+  # @param id ID único da NFC-e gerado pela Nuvem Fiscal.
+  # @param [Hash] opts the optional parameters
+  # @return [File]
+  describe 'baixar_xml_nfce_nota 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_nfce_protocolo
+  # Baixar XML do Protocolo da SEFAZ
+  # @param id ID único da NFC-e gerado pela Nuvem Fiscal.
+  # @param [Hash] opts the optional parameters
+  # @return [File]
+  describe 'baixar_xml_nfce_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_nfce
+  # Cancelar uma NFC-e autorizada
+  # **Informações adicionais**:  - Cota: <a href=\"/docs/limites#dfe-eventos\">dfe-eventos</a>  - Consumo: 1 unidade por requisição.
+  # @param id ID único da NFC-e gerado pela Nuvem Fiscal.
+  # @param [Hash] opts the optional parameters
+  # @option opts [NfePedidoCancelamento] :body 
+  # @return [DfeCancelamento]
+  describe 'cancelar_nfce 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_nfce
+  # Consultar o cancelamento da NFC-e
+  # @param id ID único da NFC-e gerado pela Nuvem Fiscal.
+  # @param [Hash] opts the optional parameters
+  # @return [DfeCancelamento]
+  describe 'consultar_cancelamento_nfce 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_nfce
+  # Consultar evento
+  # @param id ID único do evento gerado pela Nuvem Fiscal.
+  # @param [Hash] opts the optional parameters
+  # @return [DfeEvento]
+  describe 'consultar_evento_nfce 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_inutilizacao_nfce
+  # Consultar a inutilização de sequência de numeração
+  # @param id ID único do evento gerado pela Nuvem Fiscal.
+  # @param [Hash] opts the optional parameters
+  # @return [DfeInutilizacao]
+  describe 'consultar_inutilizacao_nfce 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_nfce
+  # Consultar lote de NFC-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_nfce 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_nfce
+  # Consultar NFC-e
+  # Consulta os detalhes de uma NFC-e já existente. Forneça o ID único obtido de uma requisição de emissão ou de listagem de notas e a Nuvem Fiscal irá retornar as informações da nota correspondente.
+  # @param id ID único da NFC-e gerado pela Nuvem Fiscal.
+  # @param [Hash] opts the optional parameters
+  # @return [Dfe]
+  describe 'consultar_nfce 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_nfce
+  # 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 7.0, item 5.5.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: `AM`, `BA`, `CE`, `GO`, `MG`, `MS`, `MT`, `PE`, `PR`, `RS`, `SP`, `SVRS`.    *Caso não seja informado, será utilizado o ambiente autorizador da UF do emitente.*
+  # @return [DfeSefazStatus]
+  describe 'consultar_status_sefaz_nfce 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_nfce
+  # Emitir lote de NFC-e
+  # **Informações adicionais**:  - Cota: <a href=\"/docs/limites#dfe-eventos\">dfe-eventos</a>  - Consumo: 1 unidade por NFC-e.
+  # @param body 
+  # @param [Hash] opts the optional parameters
+  # @return [DfeLote]
+  describe 'emitir_lote_nfce 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_nfce
+  # Emitir NFC-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_nfce 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 enviar_email_nfce
+  # Enviar e-mail
+  # Envia o XML e PDF da nota via email.    **Informações adicionais**:  - Cota: <a href=\"/docs/limites#dfe-eventos\">dfe-eventos</a>  - Consumo: 1 unidade por requisição.
+  # @param id ID único da NFC-e gerado pela Nuvem Fiscal.
+  # @param [Hash] opts the optional parameters
+  # @option opts [DfePedidoEnvioEmail] :body 
+  # @return [EmailStatusResponse]
+  describe 'enviar_email_nfce 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 inutilizar_numeracao_nfce
+  # Inutilizar uma sequência de numeração de NFC-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 [DfeInutilizacao]
+  describe 'inutilizar_numeracao_nfce 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_eventos_nfce
+  # Listar eventos
+  # Retorna a lista de eventos vinculados a um documento fiscal de acordo com os critérios de busca utilizados. Os eventos são retornados ordenados pela data da criação, com as mais recentes aparecendo primeiro.
+  # @param dfe_id ID único gerado pela Nuvem Fiscal para o documento fiscal.
+  # @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.
+  # @return [DfeEventoListagem]
+  describe 'listar_eventos_nfce 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_nfce
+  # Listar lotes de NFC-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_nfce 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_nfce
+  # Listar NFC-e
+  # Retorna a lista de notas de acordo com os critérios de busca utilizados. As notas são retornadas ordenadas pela data da criação, com as 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_nfce 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_nfce
+  # Sincroniza dados na NFC-e a partir da SEFAZ
+  # Realiza a sincronização dos dados a partir da consulta da situação atual da NFC-e na Base de Dados do Portal da Secretaria de Fazenda Estadual.    **Cenários de uso**:  * Sincronizar uma nota que se encontra com o status `erro` na Nuvem Fiscal, mas está autorizada na SEFAZ (útil em casos de erros de transmissão com a SEFAZ, como instabilidades e timeouts).  * Sincronizar uma nota que se encontra com o status `autorizado`na Nuvem Fiscal, mas está cancelada na SEFAZ.  * Sincronizar todos os eventos de Cancelamento, Carta de Correção e EPEC de uma nota 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 da NFC-e gerado pela Nuvem Fiscal.
+  # @param [Hash] opts the optional parameters
+  # @return [DfeSincronizacao]
+  describe 'sincronizar_nfce test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/nfcom_api_spec.rb

@@ -0,0 +1,161 @@
+=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::NfcomApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'NfcomApi' do
+  before do
+    # run before each test
+    @api_instance = NuvemfiscalSdkRuby::NfcomApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of NfcomApi' do
+    it 'should create an instance of NfcomApi' do
+      expect(@api_instance).to be_instance_of(NuvemfiscalSdkRuby::NfcomApi)
+    end
+  end
+
+  # unit tests for baixar_xml_cancelamento_nfcom
+  # Baixar XML do cancelamento
+  # @param id ID único da NFCom gerada pela Nuvem Fiscal.
+  # @param [Hash] opts the optional parameters
+  # @return [File]
+  describe 'baixar_xml_cancelamento_nfcom 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_nfcom
+  # Baixar XML da NFCom processada
+  # Utilize esse endpoint para obter o XML da nota enviada para a SEFAZ, complementado com a informação do protocolo de autorização de uso (TAG raiz `nfcomProc`).    O XML só estará disponível nesse endpoint caso a nota tenha sido autorizada pela SEFAZ. Para obter o XML nos demais casos, utilize o endpoint `GET /nfcom/{id}/xml/nota`.
+  # @param id ID único da NFCom gerada pela Nuvem Fiscal.
+  # @param [Hash] opts the optional parameters
+  # @return [File]
+  describe 'baixar_xml_nfcom 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_nfcom_nota
+  # Baixar XML da NFCom
+  # Utilize esse endpoint para obter o XML da nota enviada para a SEFAZ.    O XML estará disponível nesse endpoint mesmo em casos que a nota tenha sido rejeitada.
+  # @param id ID único da NFCom gerada pela Nuvem Fiscal.
+  # @param [Hash] opts the optional parameters
+  # @return [File]
+  describe 'baixar_xml_nfcom_nota 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_nfcom_protocolo
+  # Baixar XML do Protocolo da SEFAZ
+  # @param id ID único da NFCom gerada pela Nuvem Fiscal.
+  # @param [Hash] opts the optional parameters
+  # @return [File]
+  describe 'baixar_xml_nfcom_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_nfcom
+  # Cancelar uma NFCom autorizada
+  # **Informações adicionais**:  - Cota: <a href=\"/docs/limites#dfe-eventos\">dfe-eventos</a>  - Consumo: 1 unidade por requisição.
+  # @param id ID único da NFCom gerada pela Nuvem Fiscal.
+  # @param [Hash] opts the optional parameters
+  # @option opts [NfcomPedidoCancelamento] :body 
+  # @return [DfeCancelamento]
+  describe 'cancelar_nfcom 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_nfcom
+  # Consultar o cancelamento da NFCom
+  # @param id ID único da NFCom gerada pela Nuvem Fiscal.
+  # @param [Hash] opts the optional parameters
+  # @return [DfeCancelamento]
+  describe 'consultar_cancelamento_nfcom 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_nfcom
+  # Consultar NFCom
+  # Consulta os detalhes de uma NFCom já existente. Forneça o ID único obtido de uma requisição de emissão ou de listagem de NFCom e a Nuvem Fiscal irá retornar as informações da NFCom correspondente.
+  # @param id ID único da NFCom gerada pela Nuvem Fiscal.
+  # @param [Hash] opts the optional parameters
+  # @return [Dfe]
+  describe 'consultar_nfcom 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_nfcom
+  # 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.
+  # @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_nfcom 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_nfcom
+  # Emitir NFCom
+  # **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_nfcom 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_nfcom
+  # Listar NFCom
+  # Retorna a lista de NFCom de acordo com os critérios de busca utilizados. As NFCom são retornadas ordenadas pela data da criação, com as 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_nfcom test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end