zei 0.2.8 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 9e2c99bc04f1c5d238e46448b34471a5382965faf5cdfec0fd9db2caa6bbf354
4
- data.tar.gz: 5f6dd3b809157309add4d38d49b74f14af6aa9ace21545d419ad02018b8581a4
3
+ metadata.gz: cdbe16c5c9a1a3e27f36005539bcb8c1ba69b1a075ed8cf526d8bf7511739119
4
+ data.tar.gz: 1b070c06b4a7dbe6b33dbab503bc87afabfc5c26039daf74fbc2f798e449e002
5
5
  SHA512:
6
- metadata.gz: ac0536efa882f77aaadec39a33586a515b421b6e1db70f8eec54ccaba732cfa259f6c9d7d468610f962ca86dfdcac2ba7602cfb69f0ef88e00a2393663bed5c6
7
- data.tar.gz: a27ea8ed97367757017e5f7d751b68fd4f82e64423249b0dc3508e83c2aa94b73779415e1fc9fa1dbda2460fbf7bb77b8f77cf52d9986d6b0008de3ce4f6a44e
6
+ metadata.gz: 5ac1dacfcd4d5fe0ec81bad0f29efbf1c9fe0a30e123ca9f945df0bbfee9d6576f3032f6f3feca5f6e4a39b8cc23416fe2a96947dad85265d03967856e443360
7
+ data.tar.gz: f4d7f7e84b311a29f759a129b9b173bf01b4fb56afc3964975010123769b3bbab3e36ff6ad04a612a5eef539104a26d5c12035c760790d0a859db8dc2983550b
@@ -0,0 +1,26 @@
1
+ module Sei
2
+
3
+ module Estruturas
4
+
5
+ # Item de RetornoListHipotesesLegais (estrutura +HipoteseLegal+): +id_hipotese_legal+,
6
+ # +nome+, +base_legal+, +nivel_acesso+ (1 restrito, 2 sigiloso).
7
+ class RetornoHipoteseLegal < ::Valuable
8
+
9
+ has_value :id_hipotese_legal
10
+ has_value :nome
11
+ has_value :base_legal
12
+ has_value :nivel_acesso
13
+
14
+ # [params] Hash +parametros+ da resposta (chaves snake_case do Savon). Campos ausentes na resposta ficam nil.
15
+ def initialize(params)
16
+ self.id_hipotese_legal = params[:id_hipotese_legal]
17
+ self.nome = params[:nome]
18
+ self.base_legal = params[:base_legal]
19
+ self.nivel_acesso = params[:nivel_acesso]
20
+ initialize_attributes
21
+ end
22
+ end
23
+
24
+ end
25
+
26
+ end
@@ -0,0 +1,30 @@
1
+ module Sei
2
+
3
+ module Estruturas
4
+
5
+ # Retorno de Sei::Servico.listar_hipoteses_legais:
6
+ # +retorno_list_hipoteses_legais+ (Array de RetornoHipoteseLegal).
7
+ class RetornoListHipotesesLegais < ::Valuable
8
+
9
+ has_collection :retorno_list_hipoteses_legais, klass: RetornoHipoteseLegal
10
+
11
+ # [params] Hash +parametros+ da resposta. +item+ Hash vira colecao de 1 elemento,
12
+ # Array vira N elementos; sem +item+ (ou +parametros+ vazio) a colecao fica vazia.
13
+ def initialize(params)
14
+ self.retorno_list_hipoteses_legais = []
15
+ item = params[:item] if params.is_a?(Hash)
16
+ if item.is_a?(Hash)
17
+ self.retorno_list_hipoteses_legais << Sei::Estruturas::RetornoHipoteseLegal.new(item)
18
+ elsif item.is_a?(Array)
19
+ item.each do |retorno|
20
+ self.retorno_list_hipoteses_legais << Sei::Estruturas::RetornoHipoteseLegal.new(retorno)
21
+ end
22
+ end
23
+ initialize_attributes
24
+ end
25
+
26
+ end
27
+
28
+ end
29
+
30
+ end
@@ -0,0 +1,29 @@
1
+ module Sei
2
+
3
+ module Estruturas
4
+
5
+ # Retorno de Sei::Servico.listar_series: +retorno_list_series+ (Array de RetornoSerie).
6
+ class RetornoListSeries < ::Valuable
7
+
8
+ has_collection :retorno_list_series, klass: RetornoSerie
9
+
10
+ # [params] Hash +parametros+ da resposta. +item+ Hash vira colecao de 1 elemento,
11
+ # Array vira N elementos; sem +item+ (ou +parametros+ vazio) a colecao fica vazia.
12
+ def initialize(params)
13
+ self.retorno_list_series = []
14
+ item = params[:item] if params.is_a?(Hash)
15
+ if item.is_a?(Hash)
16
+ self.retorno_list_series << Sei::Estruturas::RetornoSerie.new(item)
17
+ elsif item.is_a?(Array)
18
+ item.each do |retorno|
19
+ self.retorno_list_series << Sei::Estruturas::RetornoSerie.new(retorno)
20
+ end
21
+ end
22
+ initialize_attributes
23
+ end
24
+
25
+ end
26
+
27
+ end
28
+
29
+ end
@@ -0,0 +1,30 @@
1
+ module Sei
2
+
3
+ module Estruturas
4
+
5
+ # Retorno de Sei::Servico.listar_tipos_procedimento:
6
+ # +retorno_list_tipos_procedimento+ (Array de RetornoTipoProcedimento).
7
+ class RetornoListTiposProcedimento < ::Valuable
8
+
9
+ has_collection :retorno_list_tipos_procedimento, klass: RetornoTipoProcedimento
10
+
11
+ # [params] Hash +parametros+ da resposta. +item+ Hash vira colecao de 1 elemento,
12
+ # Array vira N elementos; sem +item+ (ou +parametros+ vazio) a colecao fica vazia.
13
+ def initialize(params)
14
+ self.retorno_list_tipos_procedimento = []
15
+ item = params[:item] if params.is_a?(Hash)
16
+ if item.is_a?(Hash)
17
+ self.retorno_list_tipos_procedimento << Sei::Estruturas::RetornoTipoProcedimento.new(item)
18
+ elsif item.is_a?(Array)
19
+ item.each do |retorno|
20
+ self.retorno_list_tipos_procedimento << Sei::Estruturas::RetornoTipoProcedimento.new(retorno)
21
+ end
22
+ end
23
+ initialize_attributes
24
+ end
25
+
26
+ end
27
+
28
+ end
29
+
30
+ end
@@ -0,0 +1,24 @@
1
+ module Sei
2
+
3
+ module Estruturas
4
+
5
+ # Item de RetornoListSeries (estrutura +Serie+): +id_serie+, +nome+, +aplicabilidade+
6
+ # (T internos e externos, I internos, E externos, F formularios).
7
+ class RetornoSerie < ::Valuable
8
+
9
+ has_value :id_serie
10
+ has_value :nome
11
+ has_value :aplicabilidade
12
+
13
+ # [params] Hash +parametros+ da resposta (chaves snake_case do Savon). Campos ausentes na resposta ficam nil.
14
+ def initialize(params)
15
+ self.id_serie = params[:id_serie]
16
+ self.nome = params[:nome]
17
+ self.aplicabilidade = params[:aplicabilidade]
18
+ initialize_attributes
19
+ end
20
+ end
21
+
22
+ end
23
+
24
+ end
@@ -0,0 +1,24 @@
1
+ module Sei
2
+
3
+ module Estruturas
4
+
5
+ # Item de RetornoListTiposProcedimento (estrutura +TipoProcedimento+): +id_tipo_procedimento+, +nome+,
6
+ # +sin_ouvidoria_anonimo+ (S/N; consta do WSDL do SEI 5.0.5, nil quando o SEI nao envia).
7
+ class RetornoTipoProcedimento < ::Valuable
8
+
9
+ has_value :id_tipo_procedimento
10
+ has_value :nome
11
+ has_value :sin_ouvidoria_anonimo
12
+
13
+ # [params] Hash +parametros+ da resposta (chaves snake_case do Savon). Campos ausentes na resposta ficam nil.
14
+ def initialize(params)
15
+ self.id_tipo_procedimento = params[:id_tipo_procedimento]
16
+ self.nome = params[:nome]
17
+ self.sin_ouvidoria_anonimo = params[:sin_ouvidoria_anonimo]
18
+ initialize_attributes
19
+ end
20
+ end
21
+
22
+ end
23
+
24
+ end
data/lib/sei/servico.rb CHANGED
@@ -1,43 +1,199 @@
1
1
  module Sei
2
+ # Chamadas ao Web Service SOAP do SEI. Cada metodo monta o +message+ com
3
+ # +SiglaSistema+ e +IdentificacaoServico+ de Sei.configuration, chama a operacao
4
+ # via Sei::Connection e devolve uma classe de Sei::Estruturas.
5
+ #
6
+ # Referencia: manual oficial "Web Services - Versao 4.0" do SEI e WSDL do SEI 5.0.5.
7
+ # Levantam Savon::SOAPFault quando o SEI recusa a operacao e Savon::HTTPError em falha HTTP.
2
8
  module Servico
3
- # def self.adicionar_arquivo
4
- # end
9
+ # Gera um processo no SEI (+gerarProcedimento+), opcionalmente ja com documentos, processos
10
+ # relacionados e envio para outras unidades.
11
+ #
12
+ # [id_unidade] String/Integer. +IdUnidade+: identificador da unidade no SEI.
13
+ # [procedimento] Sei::Estruturas::Procedimento. Dados do processo.
14
+ # [documentos] Array de Sei::Estruturas::Documento (padrao []). Documentos incluidos na geracao.
15
+ # [procedimentos_relacionados] Array de objetos que respondem a +to_h+ (padrao []). +ProcedimentosRelacionados+.
16
+ # [unidades_envio] Array de objetos que respondem a +to_message+ (padrao []). +UnidadesEnvio+.
17
+ # [manter_aberto_unidade] "S"/"N" (padrao "N"; o manual 4.0 indica S como padrao do SEI). +SinManterAbertoUnidade+.
18
+ # [enviar_email_notificacao] "S"/"N" (padrao "N"). +SinEnviarEmailNotificacao+.
19
+ # [data_retorno_programado] String dd/mm/aaaa ou nil (padrao nil). +DataRetornoProgramado+.
20
+ # [dias_retorno_programado] Integer ou nil (padrao nil). +DiasRetornoProgramado+.
21
+ # [dias_uteis_retorno_programado] "S"/"N" (padrao "N"). +SinDiasUteisRetornoProgramado+.
22
+ #
23
+ # Retorno: Sei::Estruturas::RetornoGeracaoProcedimento (id, numero visivel, link e documentos incluidos).
24
+ #
25
+ # Levanta Savon::SOAPFault quando o SEI recusa a operacao (regra de negocio,
26
+ # permissao, dado inexistente) e Savon::HTTPError em falha HTTP de transporte.
27
+ def self.gerar_procedimento(id_unidade, procedimento, documentos = [], procedimentos_relacionados = [], unidades_envio = [], manter_aberto_unidade = "N",
28
+ enviar_email_notificacao = "N", data_retorno_programado = nil, dias_retorno_programado = nil, dias_uteis_retorno_programado = "N")
29
+ message = {
30
+ SiglaSistema: Sei.configuration.sigla,
31
+ IdentificacaoServico: Sei.configuration.identificacao,
32
+ IdUnidade: id_unidade,
33
+ Procedimento: procedimento.to_h,
34
+ Documentos: documentos.empty? ? {} : {documento: documentos.map { |documento| documento.to_h }},
35
+ ProcedimentosRelacionados: procedimentos_relacionados.empty? ? {} : {procedimento_relacionado: procedimentos_relacionados.map { |procedimentos_relacionado| procedimentos_relacionado.to_h }},
36
+ UnidadesEnvio: unidades_envio.empty? ? {} : {unidade_envio: unidades_envio.map { |unidade_envio| unidade_envio.to_message }},
37
+ SinManterAbertoUnidade: manter_aberto_unidade,
38
+ SinEnviarEmailNotificacao: enviar_email_notificacao,
39
+ DataRetornoProgramado: data_retorno_programado,
40
+ DiasRetornoProgramado: dias_retorno_programado,
41
+ SinDiasUteisRetornoProgramado: dias_uteis_retorno_programado
42
+ }
43
+ response = Sei::Connection.instance.call :gerar_procedimento, message: message
44
+ body = response.body[:gerar_procedimento_response][:parametros]
45
+ Sei::Estruturas::RetornoGeracaoProcedimento.new body
46
+ end
5
47
 
6
- # def self.adicionar_conteudo_arquivo
7
- # end
48
+ # Inclui um documento gerado (G) ou recebido/externo (R) em um processo existente
49
+ # (+incluirDocumento+).
50
+ #
51
+ # [id_unidade] String/Integer. +IdUnidade+: identificador da unidade no SEI.
52
+ # [documento] Sei::Estruturas::Documento. Dados do documento (conteudo em Base64 via +conteudo+).
53
+ #
54
+ # Retorno: Sei::Estruturas::RetornoInclusaoDocumento (id, numero visivel e link do documento).
55
+ #
56
+ # Levanta Savon::SOAPFault quando o SEI recusa a operacao (regra de negocio,
57
+ # permissao, dado inexistente) e Savon::HTTPError em falha HTTP de transporte.
58
+ def self.incluir_documento(id_unidade, documento)
59
+ message = {
60
+ SiglaSistema: Sei.configuration.sigla,
61
+ IdentificacaoServico: Sei.configuration.identificacao,
62
+ IdUnidade: id_unidade,
63
+ Documento: documento.to_h
64
+ }
65
+ response = Sei::Connection.instance.call :incluir_documento, message: message
66
+ body = response.body[:incluir_documento_response][:parametros]
67
+ Sei::Estruturas::RetornoInclusaoDocumento.new body
68
+ end
8
69
 
9
- def self.agendar_publicacao(id_unidade, protocolo_documento, sta_motivo, id_veiculo_publicacao, data_disponibilizacao, resumo)
70
+ # Inclui um documento em um bloco, ex.: bloco de assinatura (+incluirDocumentoBloco+).
71
+ #
72
+ # [id_unidade] String/Integer. +IdUnidade+: identificador da unidade no SEI.
73
+ # [id_bloco] String/Integer. +IdBloco+: numero do bloco.
74
+ # [protocolo_documento] String. +ProtocoloDocumento+: numero visivel do documento (ex.: 0003934).
75
+ #
76
+ # Retorno: Sei::Estruturas::RetornoInclusaoDocumentoBloco (+status+).
77
+ #
78
+ # Levanta Savon::SOAPFault quando o SEI recusa a operacao (regra de negocio,
79
+ # permissao, dado inexistente) e Savon::HTTPError em falha HTTP de transporte.
80
+ def self.incluir_documento_bloco(id_unidade, id_bloco, protocolo_documento)
10
81
  message = {
11
82
  SiglaSistema: Sei.configuration.sigla,
12
83
  IdentificacaoServico: Sei.configuration.identificacao,
13
84
  IdUnidade: id_unidade,
14
- ProtocoloDocumento: protocolo_documento,
15
- StaMotivo: sta_motivo,
16
- IdVeiculoPublicacao: id_veiculo_publicacao,
17
- DataDisponibilizacao: data_disponibilizacao,
18
- Resumo: resumo
85
+ IdBloco: id_bloco,
86
+ ProtocoloDocumento: protocolo_documento
19
87
  }
20
- response = Sei::Connection.instance.call :agendar_publicacao, message: message
21
- body = response.body[:agendar_publicacao_response][:parametros]
22
- body.as_json
88
+
89
+ response = Sei::Connection.instance.call :incluir_documento_bloco, message: message
90
+ body = response.body[:incluir_documento_bloco_response][:parametros]
91
+ Sei::Estruturas::RetornoInclusaoDocumentoBloco.new body
23
92
  end
24
93
 
25
- def self.alterar_publicacao(id_unidade, protocolo_documento, sta_motivo, id_veiculo_publicacao, data_disponibilizacao, resumo)
94
+ # Inclui um processo em um bloco (+incluirProcessoBloco+).
95
+ #
96
+ # [id_unidade] String/Integer. +IdUnidade+: identificador da unidade no SEI.
97
+ # [id_bloco] String/Integer. +IdBloco+: numero do bloco.
98
+ # [protocolo_procedimento] String. +ProtocoloProcedimento+: numero visivel do processo (ex.: 12.1.000000077-4).
99
+ #
100
+ # Retorno: Sei::Estruturas::RetornoInclusaoProcessoBloco (+status+).
101
+ #
102
+ # Levanta Savon::SOAPFault quando o SEI recusa a operacao (regra de negocio,
103
+ # permissao, dado inexistente) e Savon::HTTPError em falha HTTP de transporte.
104
+ def self.incluir_processo_bloco(id_unidade, id_bloco, protocolo_procedimento)
26
105
  message = {
27
106
  SiglaSistema: Sei.configuration.sigla,
28
107
  IdentificacaoServico: Sei.configuration.identificacao,
29
108
  IdUnidade: id_unidade,
30
- ProtocoloDocumento: protocolo_documento,
31
- StaMotivo: sta_motivo,
32
- IdVeiculoPublicacao: id_veiculo_publicacao,
33
- DataDisponibilizacao: data_disponibilizacao,
34
- Resumo: resumo
109
+ IdBloco: id_bloco,
110
+ ProtocoloProcedimento: protocolo_procedimento
35
111
  }
36
- response = Sei::Connection.instance.call :alterar_publicacao, message: message
37
- body = response.body[:alterar_publicacao_response][:parametros]
38
- body.as_json
112
+
113
+ response = Sei::Connection.instance.call :incluir_processo_bloco, message: message
114
+ body = response.body[:incluir_processo_bloco_response][:parametros]
115
+ Sei::Estruturas::RetornoInclusaoProcessoBloco.new body
39
116
  end
40
117
 
118
+ # Conclui o processo na unidade, encerrando o tramite nela (+concluirProcesso+).
119
+ #
120
+ # [id_unidade] String/Integer. +IdUnidade+: identificador da unidade no SEI.
121
+ # [protocolo_procedimento] String. +ProtocoloProcedimento+: numero visivel do processo (ex.: 12.1.000000077-4).
122
+ #
123
+ # Retorno: Sei::Estruturas::RetornoConclusaoProcesso (+status+).
124
+ #
125
+ # Levanta Savon::SOAPFault quando o SEI recusa a operacao (regra de negocio,
126
+ # permissao, dado inexistente) e Savon::HTTPError em falha HTTP de transporte.
127
+ def self.concluir_processo(id_unidade, protocolo_procedimento)
128
+ message = {
129
+ SiglaSistema: Sei.configuration.sigla,
130
+ IdentificacaoServico: Sei.configuration.identificacao,
131
+ IdUnidade: id_unidade,
132
+ ProtocoloProcedimento: protocolo_procedimento
133
+ }
134
+
135
+ response = Sei::Connection.instance.call :concluir_processo, message: message
136
+ body = response.body[:concluir_processo_response][:parametros]
137
+ Sei::Estruturas::RetornoConclusaoProcesso.new body
138
+ end
139
+
140
+ # Reabre na unidade um processo concluido (+reabrirProcesso+).
141
+ #
142
+ # [id_unidade] String/Integer. +IdUnidade+: identificador da unidade no SEI.
143
+ # [protocolo_procedimento] String. +ProtocoloProcedimento+: numero visivel do processo (ex.: 12.1.000000077-4).
144
+ #
145
+ # Retorno: Sei::Estruturas::RetornoBoolean (+status+ com o valor devolvido pelo SEI).
146
+ #
147
+ # Levanta Savon::SOAPFault quando o SEI recusa a operacao (regra de negocio,
148
+ # permissao, dado inexistente) e Savon::HTTPError em falha HTTP de transporte.
149
+ def self.reabrir_processo(id_unidade, protocolo_procedimento)
150
+ message = {
151
+ SiglaSistema: Sei.configuration.sigla,
152
+ IdentificacaoServico: Sei.configuration.identificacao,
153
+ IdUnidade: id_unidade,
154
+ ProtocoloProcedimento: protocolo_procedimento
155
+ }
156
+
157
+ response = Sei::Connection.instance.call :reabrir_processo, message: message
158
+ body = response.body[:reabrir_processo_response][:parametros]
159
+ Sei::Estruturas::RetornoBoolean.new body
160
+ end
161
+
162
+ # Retira um processo de um bloco (+retirarProcessoBloco+).
163
+ #
164
+ # [id_unidade] String/Integer. +IdUnidade+: identificador da unidade no SEI.
165
+ # [id_bloco] String/Integer. +IdBloco+: numero do bloco.
166
+ # [protocolo_procedimento] String. +ProtocoloProcedimento+: numero visivel do processo (ex.: 12.1.000000077-4).
167
+ #
168
+ # Retorno: Sei::Estruturas::RetornoBoolean (+status+ com o valor devolvido pelo SEI).
169
+ #
170
+ # Levanta Savon::SOAPFault quando o SEI recusa a operacao (regra de negocio,
171
+ # permissao, dado inexistente) e Savon::HTTPError em falha HTTP de transporte.
172
+ def self.retirar_processo_bloco(id_unidade, id_bloco, protocolo_procedimento)
173
+ message = {
174
+ SiglaSistema: Sei.configuration.sigla,
175
+ IdentificacaoServico: Sei.configuration.identificacao,
176
+ IdUnidade: id_unidade,
177
+ IdBloco: id_bloco,
178
+ ProtocoloProcedimento: protocolo_procedimento
179
+ }
180
+
181
+ response = Sei::Connection.instance.call :retirar_processo_bloco, message: message
182
+ body = response.body[:retirar_processo_bloco_response][:parametros]
183
+ Sei::Estruturas::RetornoBoolean.new body
184
+ end
185
+
186
+ # Atribui o processo a um usuario da unidade (+atribuirProcesso+).
187
+ #
188
+ # [id_unidade] String/Integer. +IdUnidade+: identificador da unidade no SEI.
189
+ # [protocolo_procedimento] String. +ProtocoloProcedimento+: numero visivel do processo (ex.: 12.1.000000077-4).
190
+ # [id_usuario] String/Integer. +IdUsuario+: usuario que recebe a atribuicao.
191
+ # [sin_reabrir] "S"/"N" (padrao "N"). +SinReabrir+: reabre o processo se estiver concluido.
192
+ #
193
+ # Retorno: Sei::Estruturas::RetornoBoolean (+status+ com o valor devolvido pelo SEI).
194
+ #
195
+ # Levanta Savon::SOAPFault quando o SEI recusa a operacao (regra de negocio,
196
+ # permissao, dado inexistente) e Savon::HTTPError em falha HTTP de transporte.
41
197
  def self.atribuir_processo(id_unidade, protocolo_procedimento, id_usuario, sin_reabrir = "N")
42
198
  message = {
43
199
  SiglaSistema: Sei.configuration.sigla,
@@ -52,39 +208,83 @@ module Sei
52
208
  Sei::Estruturas::RetornoBoolean.new body
53
209
  end
54
210
 
55
- # def self.anexar_processo
56
- # end
57
-
58
- # def self.atualizar_contatos
59
- # end
60
-
61
- # def self.bloquear_processo
62
- # end
63
-
64
- def self.cancelar_agendamento_publicacao(id_unidade, protocolo_documento)
211
+ # Retira um documento de um bloco (+retirarDocumentoBloco+).
212
+ #
213
+ # [id_unidade] String/Integer. +IdUnidade+: identificador da unidade no SEI.
214
+ # [id_bloco] String/Integer. +IdBloco+: numero do bloco.
215
+ # [protocolo_documento] String. +ProtocoloDocumento+: numero visivel do documento (ex.: 0003934).
216
+ #
217
+ # Retorno: Sei::Estruturas::RetornoBoolean (+status+ com o valor devolvido pelo SEI).
218
+ #
219
+ # Levanta Savon::SOAPFault quando o SEI recusa a operacao (regra de negocio,
220
+ # permissao, dado inexistente) e Savon::HTTPError em falha HTTP de transporte.
221
+ def self.retirar_documento_bloco(id_unidade, id_bloco, protocolo_documento)
65
222
  message = {
66
223
  SiglaSistema: Sei.configuration.sigla,
67
224
  IdentificacaoServico: Sei.configuration.identificacao,
68
225
  IdUnidade: id_unidade,
226
+ IdBloco: id_bloco,
69
227
  ProtocoloDocumento: protocolo_documento
70
228
  }
71
- response = Sei::Connection.instance.call :cancelar_agendamento_publicacao, message: message
72
- body = response.body[:cancelar_agendamento_publicacao_response][:parametros]
229
+ response = Sei::Connection.instance.call :retirar_documento_bloco, message: message
230
+ body = response.body[:retirar_documento_bloco_response][:parametros]
73
231
  Sei::Estruturas::RetornoBoolean.new body
74
232
  end
75
233
 
76
- def self.cancelar_disponibilizacao_bloco(id_unidade, id_bloco)
234
+ # Disponibiliza o bloco para as unidades configuradas nele (+disponibilizarBloco+).
235
+ #
236
+ # [id_unidade] String/Integer. +IdUnidade+: identificador da unidade no SEI.
237
+ # [id_bloco] String/Integer. +IdBloco+: numero do bloco.
238
+ #
239
+ # Retorno: Sei::Estruturas::RetornoBoolean (+status+ com o valor devolvido pelo SEI).
240
+ #
241
+ # Levanta Savon::SOAPFault quando o SEI recusa a operacao (regra de negocio,
242
+ # permissao, dado inexistente) e Savon::HTTPError em falha HTTP de transporte.
243
+ def self.disponibilizar_bloco(id_unidade, id_bloco)
77
244
  message = {
78
245
  SiglaSistema: Sei.configuration.sigla,
79
246
  IdentificacaoServico: Sei.configuration.identificacao,
80
247
  IdUnidade: id_unidade,
81
248
  IdBloco: id_bloco
82
249
  }
83
- response = Sei::Connection.instance.call :cancelar_disponibilizacao_bloco, message: message
84
- body = response.body[:cancelar_disponibilizacao_bloco_response][:parametros]
250
+
251
+ response = Sei::Connection.instance.call :disponibilizar_bloco, message: message
252
+ body = response.body[:disponibilizar_bloco_response][:parametros]
85
253
  Sei::Estruturas::RetornoBoolean.new body
86
254
  end
87
255
 
256
+ # Exclui um bloco (+excluirBloco+).
257
+ #
258
+ # [id_unidade] String/Integer. +IdUnidade+: identificador da unidade no SEI.
259
+ # [id_bloco] String/Integer. +IdBloco+: numero do bloco.
260
+ #
261
+ # Retorno: Sei::Estruturas::RetornoBoolean (+status+ com o valor devolvido pelo SEI).
262
+ #
263
+ # Levanta Savon::SOAPFault quando o SEI recusa a operacao (regra de negocio,
264
+ # permissao, dado inexistente) e Savon::HTTPError em falha HTTP de transporte.
265
+ def self.excluir_bloco(id_unidade, id_bloco)
266
+ message = {
267
+ SiglaSistema: Sei.configuration.sigla,
268
+ IdentificacaoServico: Sei.configuration.identificacao,
269
+ IdUnidade: id_unidade,
270
+ IdBloco: id_bloco
271
+ }
272
+ response = Sei::Connection.instance.call :excluir_bloco, message: message
273
+ body = response.body[:excluir_bloco_response][:parametros]
274
+ Sei::Estruturas::RetornoBoolean.new body
275
+ end
276
+
277
+ # Cancela um documento, registrando o motivo (+cancelarDocumento+). Diferente de
278
+ # excluir_documento, que apaga uma minuta.
279
+ #
280
+ # [id_unidade] String/Integer. +IdUnidade+: identificador da unidade no SEI.
281
+ # [protocolo_documento] String. +ProtocoloDocumento+: numero visivel do documento (ex.: 0003934).
282
+ # [motivo] String. +Motivo+ do cancelamento.
283
+ #
284
+ # Retorno: Sei::Estruturas::RetornoBoolean (+status+ com o valor devolvido pelo SEI).
285
+ #
286
+ # Levanta Savon::SOAPFault quando o SEI recusa a operacao (regra de negocio,
287
+ # permissao, dado inexistente) e Savon::HTTPError em falha HTTP de transporte.
88
288
  def self.cancelar_documento(id_unidade, protocolo_documento, motivo)
89
289
  message = {
90
290
  SiglaSistema: Sei.configuration.sigla,
@@ -98,50 +298,168 @@ module Sei
98
298
  Sei::Estruturas::RetornoBoolean.new body
99
299
  end
100
300
 
101
- def self.concluir_processo(id_unidade, protocolo_procedimento)
301
+ # Agenda a publicacao de um documento no veiculo de publicacao informado (+agendarPublicacao+).
302
+ #
303
+ # [id_unidade] String/Integer. +IdUnidade+: identificador da unidade no SEI.
304
+ # [protocolo_documento] String. +ProtocoloDocumento+: numero visivel do documento (ex.: 0003934).
305
+ # [sta_motivo] String. +StaMotivo+: motivo da publicacao.
306
+ # [id_veiculo_publicacao] String/Integer. +IdVeiculoPublicacao+: veiculo de publicacao.
307
+ # [data_disponibilizacao] String dd/mm/aaaa. +DataDisponibilizacao+: data da disponibilizacao.
308
+ # [resumo] String. +Resumo+ da publicacao.
309
+ #
310
+ # Retorno: Hash retornado pelo SEI (resposta +agendar_publicacao_response+/+parametros+).
311
+ #
312
+ # Levanta Savon::SOAPFault quando o SEI recusa a operacao (regra de negocio,
313
+ # permissao, dado inexistente) e Savon::HTTPError em falha HTTP de transporte.
314
+ def self.agendar_publicacao(id_unidade, protocolo_documento, sta_motivo, id_veiculo_publicacao, data_disponibilizacao, resumo)
102
315
  message = {
103
316
  SiglaSistema: Sei.configuration.sigla,
104
317
  IdentificacaoServico: Sei.configuration.identificacao,
105
318
  IdUnidade: id_unidade,
106
- ProtocoloProcedimento: protocolo_procedimento
319
+ ProtocoloDocumento: protocolo_documento,
320
+ StaMotivo: sta_motivo,
321
+ IdVeiculoPublicacao: id_veiculo_publicacao,
322
+ DataDisponibilizacao: data_disponibilizacao,
323
+ Resumo: resumo
107
324
  }
325
+ response = Sei::Connection.instance.call :agendar_publicacao, message: message
326
+ body = response.body[:agendar_publicacao_response][:parametros]
327
+ body.as_json
328
+ end
108
329
 
109
- response = Sei::Connection.instance.call :concluir_processo, message: message
110
- body = response.body[:concluir_processo_response][:parametros]
111
- Sei::Estruturas::RetornoConclusaoProcesso.new body
330
+ # Altera uma publicacao ja agendada (+alterarPublicacao+).
331
+ #
332
+ # [id_unidade] String/Integer. +IdUnidade+: identificador da unidade no SEI.
333
+ # [protocolo_documento] String. +ProtocoloDocumento+: numero visivel do documento (ex.: 0003934).
334
+ # [sta_motivo] String. +StaMotivo+: motivo da publicacao.
335
+ # [id_veiculo_publicacao] String/Integer. +IdVeiculoPublicacao+: veiculo de publicacao.
336
+ # [data_disponibilizacao] String dd/mm/aaaa. +DataDisponibilizacao+: data da disponibilizacao.
337
+ # [resumo] String. +Resumo+ da publicacao.
338
+ #
339
+ # Retorno: Hash retornado pelo SEI (resposta +alterar_publicacao_response+/+parametros+).
340
+ #
341
+ # Levanta Savon::SOAPFault quando o SEI recusa a operacao (regra de negocio,
342
+ # permissao, dado inexistente) e Savon::HTTPError em falha HTTP de transporte.
343
+ def self.alterar_publicacao(id_unidade, protocolo_documento, sta_motivo, id_veiculo_publicacao, data_disponibilizacao, resumo)
344
+ message = {
345
+ SiglaSistema: Sei.configuration.sigla,
346
+ IdentificacaoServico: Sei.configuration.identificacao,
347
+ IdUnidade: id_unidade,
348
+ ProtocoloDocumento: protocolo_documento,
349
+ StaMotivo: sta_motivo,
350
+ IdVeiculoPublicacao: id_veiculo_publicacao,
351
+ DataDisponibilizacao: data_disponibilizacao,
352
+ Resumo: resumo
353
+ }
354
+ response = Sei::Connection.instance.call :alterar_publicacao, message: message
355
+ body = response.body[:alterar_publicacao_response][:parametros]
356
+ body.as_json
112
357
  end
113
358
 
114
- # def self.confirmar_disponibilizacao_publicacao
115
- # end
359
+ # Cancela o agendamento de publicacao de um documento (+cancelarAgendamentoPublicacao+).
360
+ #
361
+ # [id_unidade] String/Integer. +IdUnidade+: identificador da unidade no SEI.
362
+ # [protocolo_documento] String. +ProtocoloDocumento+: numero visivel do documento (ex.: 0003934).
363
+ #
364
+ # Retorno: Sei::Estruturas::RetornoBoolean (+status+ com o valor devolvido pelo SEI).
365
+ #
366
+ # Levanta Savon::SOAPFault quando o SEI recusa a operacao (regra de negocio,
367
+ # permissao, dado inexistente) e Savon::HTTPError em falha HTTP de transporte.
368
+ def self.cancelar_agendamento_publicacao(id_unidade, protocolo_documento)
369
+ message = {
370
+ SiglaSistema: Sei.configuration.sigla,
371
+ IdentificacaoServico: Sei.configuration.identificacao,
372
+ IdUnidade: id_unidade,
373
+ ProtocoloDocumento: protocolo_documento
374
+ }
375
+ response = Sei::Connection.instance.call :cancelar_agendamento_publicacao, message: message
376
+ body = response.body[:cancelar_agendamento_publicacao_response][:parametros]
377
+ Sei::Estruturas::RetornoBoolean.new body
378
+ end
116
379
 
117
- def self.consultar_bloco(id_unidade, id_bloco, sin_retornar_protocolos = "S")
380
+ # Cancela a disponibilizacao de um bloco (+cancelarDisponibilizacaoBloco+).
381
+ #
382
+ # [id_unidade] String/Integer. +IdUnidade+: identificador da unidade no SEI.
383
+ # [id_bloco] String/Integer. +IdBloco+: numero do bloco.
384
+ #
385
+ # Retorno: Sei::Estruturas::RetornoBoolean (+status+ com o valor devolvido pelo SEI).
386
+ #
387
+ # Levanta Savon::SOAPFault quando o SEI recusa a operacao (regra de negocio,
388
+ # permissao, dado inexistente) e Savon::HTTPError em falha HTTP de transporte.
389
+ def self.cancelar_disponibilizacao_bloco(id_unidade, id_bloco)
118
390
  message = {
119
391
  SiglaSistema: Sei.configuration.sigla,
120
392
  IdentificacaoServico: Sei.configuration.identificacao,
121
393
  IdUnidade: id_unidade,
122
- IdBloco: id_bloco,
123
- SinRetornarProtocolos: sin_retornar_protocolos
394
+ IdBloco: id_bloco
124
395
  }
125
- response = Sei::Connection.instance.call :consultar_bloco, message: message
126
- body = response.body[:consultar_bloco_response][:parametros]
127
- Sei::Estruturas::RetornoConsultarBloco.new body
396
+ response = Sei::Connection.instance.call :cancelar_disponibilizacao_bloco, message: message
397
+ body = response.body[:cancelar_disponibilizacao_bloco_response][:parametros]
398
+ Sei::Estruturas::RetornoBoolean.new body
128
399
  end
129
400
 
130
- def self.consultar_documento(id_unidade, protocolo_documento, sin_retornar_andamento_geracao = "N", sin_retornar_assinaturas = "N", sin_retornar_publicacao = "N")
401
+ # Exclui um documento gerado ainda nao assinado (minuta) (+excluirDocumento+). Consta do
402
+ # WSDL do SEI 5.0.5 e do manual 4.0.
403
+ #
404
+ # [id_unidade] String/Integer. +IdUnidade+: identificador da unidade no SEI.
405
+ # [protocolo_documento] String. +ProtocoloDocumento+: numero visivel do documento (ex.: 0003934).
406
+ #
407
+ # Retorno: Sei::Estruturas::RetornoBoolean (+status+ com o valor devolvido pelo SEI).
408
+ #
409
+ # Levanta Savon::SOAPFault quando o SEI recusa a operacao (regra de negocio,
410
+ # permissao, dado inexistente) e Savon::HTTPError em falha HTTP de transporte.
411
+ def self.excluir_documento(id_unidade, protocolo_documento)
131
412
  message = {
132
413
  SiglaSistema: Sei.configuration.sigla,
133
414
  IdentificacaoServico: Sei.configuration.identificacao,
134
415
  IdUnidade: id_unidade,
135
- ProtocoloDocumento: protocolo_documento,
136
- SinRetornarAndamentoGeracao: sin_retornar_andamento_geracao,
137
- SinRetornarAssinaturas: sin_retornar_assinaturas,
138
- SinRetornarPublicacao: sin_retornar_publicacao
416
+ ProtocoloDocumento: protocolo_documento
139
417
  }
140
- response = Sei::Connection.instance.call :consultar_documento, message: message
141
- body = response.body[:consultar_documento_response][:parametros]
142
- Sei::Estruturas::RetornoConsultarDocumento.new body
418
+ response = Sei::Connection.instance.call :excluir_documento, message: message
419
+ body = response.body[:excluir_documento_response][:parametros]
420
+ Sei::Estruturas::RetornoBoolean.new body
421
+ end
422
+
423
+ # Lista os usuarios da unidade (+listarUsuarios+).
424
+ #
425
+ # [id_unidade] String/Integer. +IdUnidade+: identificador da unidade no SEI.
426
+ # [id_usuario] String/Integer ou nil (padrao nil). +IdUsuario+: filtro; enviado nulo quando nil.
427
+ #
428
+ # Retorno: Sei::Estruturas::RetornoListUsuarios (+retorno_list_usuarios+ com Sei::Estruturas::RetornoUsuario).
429
+ #
430
+ # Levanta Savon::SOAPFault quando o SEI recusa a operacao (regra de negocio,
431
+ # permissao, dado inexistente) e Savon::HTTPError em falha HTTP de transporte.
432
+ def self.listar_usuarios(id_unidade, id_usuario = nil)
433
+ message = {
434
+ SiglaSistema: Sei.configuration.sigla,
435
+ IdentificacaoServico: Sei.configuration.identificacao,
436
+ IdUnidade: id_unidade,
437
+ IdUsuario: id_usuario
438
+ }
439
+ response = Sei::Connection.instance.call :listar_usuarios, message: message
440
+ body = response.body[:listar_usuarios_response][:parametros]
441
+ Sei::Estruturas::RetornoListUsuarios.new body
143
442
  end
144
443
 
444
+ # Consulta os dados de um processo (+consultarProcedimento+). Cada flag "S" pede um bloco
445
+ # opcional de dados no retorno.
446
+ #
447
+ # [id_unidade] String/Integer. +IdUnidade+: identificador da unidade no SEI.
448
+ # [protocolo_procedimento] String. +ProtocoloProcedimento+: numero visivel do processo (ex.: 12.1.000000077-4).
449
+ # [sin_retornar_assuntos] "S"/"N" (padrao "N"). +SinRetornarAssuntos+.
450
+ # [sin_retornar_interessados] "S"/"N" (padrao "N"). +SinRetornarInteressados+.
451
+ # [sin_retornar_observacoes] "S"/"N" (padrao "N"). +SinRetornarObservacoes+.
452
+ # [sin_retornar_andamento_geracao] "S"/"N" (padrao "N"). +SinRetornarAndamentoGeracao+.
453
+ # [sin_retornar_andamento_conclusao] "S"/"N" (padrao "N"). +SinRetornarAndamentoConclusao+.
454
+ # [sin_retornar_ultimo_andamento] "S"/"N" (padrao "N"). +SinRetornarUltimoAndamento+.
455
+ # [sin_retornar_unidades_procedimento_aberto] "S"/"N" (padrao "S"). +SinRetornarUnidadesProcedimentoAberto+.
456
+ # [sin_retornar_procedimentos_relacionados] "S"/"N" (padrao "N"). +SinRetornarProcedimentosRelacionados+.
457
+ # [sin_retornar_procedimentos_anexados] "S"/"N" (padrao "N"). +SinRetornarProcedimentosAnexados+.
458
+ #
459
+ # Retorno: Sei::Estruturas::RetornoConsultarProcedimento.
460
+ #
461
+ # Levanta Savon::SOAPFault quando o SEI recusa a operacao (regra de negocio,
462
+ # permissao, dado inexistente) e Savon::HTTPError em falha HTTP de transporte.
145
463
  def self.consultar_procedimento(
146
464
  id_unidade, protocolo_procedimento,
147
465
  sin_retornar_assuntos = "N",
@@ -174,71 +492,42 @@ module Sei
174
492
  Sei::Estruturas::RetornoConsultarProcedimento.new body
175
493
  end
176
494
 
177
- # def self.consultar_procedimento_individual
178
- # end
179
-
180
- # def self.consultar_publicacao
181
- # end
182
-
183
- # def self.definir_marcador
184
- # end
185
-
186
- # def self.desanexar_processo
187
- # end
188
-
189
- # def self.desbloquear_processo
190
- # end
191
-
192
- def self.disponibilizar_bloco(id_unidade, id_bloco)
193
- message = {
194
- SiglaSistema: Sei.configuration.sigla,
195
- IdentificacaoServico: Sei.configuration.identificacao,
196
- IdUnidade: id_unidade,
197
- IdBloco: id_bloco
198
- }
199
-
200
- response = Sei::Connection.instance.call :disponibilizar_bloco, message: message
201
- body = response.body[:disponibilizar_bloco_response][:parametros]
202
- Sei::Estruturas::RetornoBoolean.new body
203
- end
204
-
205
- def self.enviar_processo(id_unidade, procedimento_formatado, unidades_destino = [], data_retorno_programado = nil, dias_retorno_programado = nil, sin_dias_uteis_retorno_programado = "N")
206
- message = {
207
- SiglaSistema: Sei.configuration.sigla,
208
- IdentificacaoServico: Sei.configuration.identificacao,
209
- IdUnidade: id_unidade,
210
- ProtocoloProcedimento: procedimento_formatado,
211
- UnidadesDestino: unidades_destino,
212
- SinManterAbertoUnidade: "N",
213
- SinRemoverAnotacao: "N",
214
- SinEnviarEmailNotificacao: "N",
215
- DataRetornoProgramado: data_retorno_programado,
216
- DiasRetornoProgramado: dias_retorno_programado,
217
- SinDiasUteisRetornoProgramado: sin_dias_uteis_retorno_programado
218
- }
219
- response = Sei::Connection.instance.call :enviar_processo, message: message
220
- body = response.body[:enviar_processo_response][:parametros]
221
- Sei::Estruturas::EnviarProcesso.new body
222
- end
223
-
224
- def self.excluir_bloco(id_unidade, id_bloco)
495
+ # Lista as unidades em que o servico pode atuar (+listarUnidades+). Nao envia IdUnidade.
496
+ #
497
+ # [id_tipo_procedimento] String/Integer ou nil (padrao nil). +IdTipoProcedimento+: filtro; enviado nulo quando nil.
498
+ # [id_serie] String/Integer ou nil (padrao nil). +IdSerie+: filtro; enviado nulo quando nil.
499
+ #
500
+ # Retorno: Sei::Estruturas::RetornoListUnidades (+retorno_list_unidades+ com Sei::Estruturas::RetornoUnidade).
501
+ #
502
+ # Levanta Savon::SOAPFault quando o SEI recusa a operacao (regra de negocio,
503
+ # permissao, dado inexistente) e Savon::HTTPError em falha HTTP de transporte.
504
+ def self.listar_unidades(id_tipo_procedimento = nil, id_serie = nil)
225
505
  message = {
226
506
  SiglaSistema: Sei.configuration.sigla,
227
507
  IdentificacaoServico: Sei.configuration.identificacao,
228
- IdUnidade: id_unidade,
229
- IdBloco: id_bloco
508
+ IdTipoProcedimento: id_tipo_procedimento,
509
+ IdSerie: id_serie
230
510
  }
231
- response = Sei::Connection.instance.call :excluir_bloco, message: message
232
- body = response.body[:excluir_bloco_response][:parametros]
233
- Sei::Estruturas::RetornoBoolean.new body
511
+ response = Sei::Connection.instance.call :listar_unidades, message: message
512
+ body = response.body[:listar_unidades_response][:parametros]
513
+ Sei::Estruturas::RetornoListUnidades.new body
234
514
  end
235
515
 
236
- # def self.excluir_documento
237
- # end
238
-
239
- # def self.excluir_processo
240
- # end
241
-
516
+ # Gera um bloco de assinatura, reuniao ou interno (+gerarBloco+).
517
+ #
518
+ # [id_unidade] String/Integer. +IdUnidade+: identificador da unidade no SEI.
519
+ # [tipo] String. +Tipo+: A (assinatura), R (reuniao) ou I (interno).
520
+ # [descricao] String. +Descricao+ do bloco.
521
+ # [unidades_disponibilizacao] Unidades (padrao []). +UnidadesDisponibilizacao+ e enviado como recebido:
522
+ # use <tt>{ id_unidade: ['100000001'] }</tt>; IDs soltos nao sao lidos como lista.
523
+ # [documentos] Protocolos de documento (padrao []). +Documentos+ e enviado como recebido:
524
+ # use <tt>{ documento_formatado: ['0003934'] }</tt>.
525
+ # [sin_disponibilizar] "S"/"N" (padrao "N"). +SinDisponibilizar+.
526
+ #
527
+ # Retorno: Sei::Estruturas::RetornoGeracaoBloco (+bloco_gerado+ com o numero do bloco).
528
+ #
529
+ # Levanta Savon::SOAPFault quando o SEI recusa a operacao (regra de negocio,
530
+ # permissao, dado inexistente) e Savon::HTTPError em falha HTTP de transporte.
242
531
  def self.gerar_bloco(id_unidade, tipo, descricao, unidades_disponibilizacao = [], documentos = [], sin_disponibilizar = "N")
243
532
  message = {
244
533
  SiglaSistema: Sei.configuration.sigla,
@@ -255,186 +544,167 @@ module Sei
255
544
  Sei::Estruturas::RetornoGeracaoBloco.new body
256
545
  end
257
546
 
258
- def self.gerar_procedimento(id_unidade, procedimento, documentos = [], procedimentos_relacionados = [], unidades_envio = [], manter_aberto_unidade = "N",
259
- enviar_email_notificacao = "N", data_retorno_programado = nil, dias_retorno_programado = nil, dias_uteis_retorno_programado = "N")
260
- message = {
261
- SiglaSistema: Sei.configuration.sigla,
262
- IdentificacaoServico: Sei.configuration.identificacao,
263
- IdUnidade: id_unidade,
264
- Procedimento: procedimento.to_h,
265
- Documentos: documentos.empty? ? {} : {documento: documentos.map { |documento| documento.to_h }},
266
- ProcedimentosRelacionados: procedimentos_relacionados.empty? ? {} : {procedimento_relacionado: procedimentos_relacionados.map { |procedimentos_relacionado| procedimentos_relacionado.to_h }},
267
- UnidadesEnvio: unidades_envio.empty? ? {} : {unidade_envio: unidades_envio.map { |unidade_envio| unidade_envio.to_message }},
268
- SinManterAbertoUnidade: manter_aberto_unidade,
269
- SinEnviarEmailNotificacao: enviar_email_notificacao,
270
- DataRetornoProgramado: data_retorno_programado,
271
- DiasRetornoProgramado: dias_retorno_programado,
272
- SinDiasUteisRetornoProgramado: dias_uteis_retorno_programado
273
- }
274
- response = Sei::Connection.instance.call :gerar_procedimento, message: message
275
- body = response.body[:gerar_procedimento_response][:parametros]
276
- Sei::Estruturas::RetornoGeracaoProcedimento.new body
277
- end
278
-
279
- def self.incluir_documento(id_unidade, documento)
280
- message = {
281
- SiglaSistema: Sei.configuration.sigla,
282
- IdentificacaoServico: Sei.configuration.identificacao,
283
- IdUnidade: id_unidade,
284
- Documento: documento.to_h
285
- }
286
- response = Sei::Connection.instance.call :incluir_documento, message: message
287
- body = response.body[:incluir_documento_response][:parametros]
288
- Sei::Estruturas::RetornoInclusaoDocumento.new body
289
- end
290
-
291
- def self.incluir_documento_bloco(id_unidade, id_bloco, protocolo_documento)
547
+ # Consulta os dados de um documento (+consultarDocumento+).
548
+ #
549
+ # [id_unidade] String/Integer. +IdUnidade+: identificador da unidade no SEI.
550
+ # [protocolo_documento] String. +ProtocoloDocumento+: numero visivel do documento (ex.: 0003934).
551
+ # [sin_retornar_andamento_geracao] "S"/"N" (padrao "N"). +SinRetornarAndamentoGeracao+.
552
+ # [sin_retornar_assinaturas] "S"/"N" (padrao "N"). +SinRetornarAssinaturas+.
553
+ # [sin_retornar_publicacao] "S"/"N" (padrao "N"). +SinRetornarPublicacao+.
554
+ #
555
+ # Retorno: Sei::Estruturas::RetornoConsultarDocumento.
556
+ #
557
+ # Levanta Savon::SOAPFault quando o SEI recusa a operacao (regra de negocio,
558
+ # permissao, dado inexistente) e Savon::HTTPError em falha HTTP de transporte.
559
+ def self.consultar_documento(id_unidade, protocolo_documento, sin_retornar_andamento_geracao = "N", sin_retornar_assinaturas = "N", sin_retornar_publicacao = "N")
292
560
  message = {
293
561
  SiglaSistema: Sei.configuration.sigla,
294
562
  IdentificacaoServico: Sei.configuration.identificacao,
295
563
  IdUnidade: id_unidade,
296
- IdBloco: id_bloco,
297
- ProtocoloDocumento: protocolo_documento
564
+ ProtocoloDocumento: protocolo_documento,
565
+ SinRetornarAndamentoGeracao: sin_retornar_andamento_geracao,
566
+ SinRetornarAssinaturas: sin_retornar_assinaturas,
567
+ SinRetornarPublicacao: sin_retornar_publicacao
298
568
  }
299
-
300
- response = Sei::Connection.instance.call :incluir_documento_bloco, message: message
301
- body = response.body[:incluir_documento_bloco_response][:parametros]
302
- Sei::Estruturas::RetornoInclusaoDocumentoBloco.new body
569
+ response = Sei::Connection.instance.call :consultar_documento, message: message
570
+ body = response.body[:consultar_documento_response][:parametros]
571
+ Sei::Estruturas::RetornoConsultarDocumento.new body
303
572
  end
304
573
 
305
- def self.incluir_processo_bloco(id_unidade, id_bloco, protocolo_procedimento)
574
+ # Consulta os dados de um bloco e, opcionalmente, seus protocolos (+consultarBloco+).
575
+ #
576
+ # [id_unidade] String/Integer. +IdUnidade+: identificador da unidade no SEI.
577
+ # [id_bloco] String/Integer. +IdBloco+: numero do bloco.
578
+ # [sin_retornar_protocolos] "S"/"N" (padrao "S"; o manual 4.0 indica N como padrao do SEI). +SinRetornarProtocolos+.
579
+ #
580
+ # Retorno: Sei::Estruturas::RetornoConsultarBloco.
581
+ #
582
+ # Levanta Savon::SOAPFault quando o SEI recusa a operacao (regra de negocio,
583
+ # permissao, dado inexistente) e Savon::HTTPError em falha HTTP de transporte.
584
+ def self.consultar_bloco(id_unidade, id_bloco, sin_retornar_protocolos = "S")
306
585
  message = {
307
586
  SiglaSistema: Sei.configuration.sigla,
308
587
  IdentificacaoServico: Sei.configuration.identificacao,
309
588
  IdUnidade: id_unidade,
310
589
  IdBloco: id_bloco,
311
- ProtocoloProcedimento: protocolo_procedimento
312
- }
313
-
314
- response = Sei::Connection.instance.call :incluir_processo_bloco, message: message
315
- body = response.body[:incluir_processo_bloco_response][:parametros]
316
- Sei::Estruturas::RetornoInclusaoProcessoBloco.new body
317
- end
318
-
319
- # def self.lancar_andamento
320
- # end
321
-
322
- # def self.listar_andamentos
323
- # end
324
-
325
- # def self.listar_andamentos_marcadores
326
- # end
327
-
328
- # def self.listar_cargos
329
- # end
330
-
331
- # def self.listar_cidades
332
- # end
333
-
334
- # def self.listar_contatos
335
- # end
336
-
337
- # def self.listar_estados
338
- # end
339
-
340
- # def self.listar_extensoes_permitidas
341
- # end
342
-
343
- # def self.listar_feriados
344
- # end
345
-
346
- # def self.listar_hipoteses_legais
347
- # end
348
-
349
- # def self.listar_marcadores_unidade
350
- # end
351
-
352
- # def self.listar_paises
353
- # end
354
-
355
- # def self.listar_series
356
- # end
357
-
358
- # def self.listar_tipos_conferencia
359
- # end
360
-
361
- # def self.listar_tipos_procedimento
362
- # end
363
-
364
- def self.listar_unidades(id_tipo_procedimento = nil, id_serie = nil)
365
- message = {
366
- SiglaSistema: Sei.configuration.sigla,
367
- IdentificacaoServico: Sei.configuration.identificacao,
368
- IdTipoProcedimento: id_tipo_procedimento,
369
- IdSerie: id_serie
590
+ SinRetornarProtocolos: sin_retornar_protocolos
370
591
  }
371
- response = Sei::Connection.instance.call :listar_unidades, message: message
372
- body = response.body[:listar_unidades_response][:parametros]
373
- Sei::Estruturas::RetornoListUnidades.new body
592
+ response = Sei::Connection.instance.call :consultar_bloco, message: message
593
+ body = response.body[:consultar_bloco_response][:parametros]
594
+ Sei::Estruturas::RetornoConsultarBloco.new body
374
595
  end
375
596
 
376
- def self.listar_usuarios(id_unidade, id_usuario = nil)
597
+ # Envia (tramita) o processo para outras unidades (+enviarProcesso+).
598
+ #
599
+ # [id_unidade] String/Integer. +IdUnidade+: identificador da unidade no SEI.
600
+ # [procedimento_formatado] String. +ProtocoloProcedimento+: numero visivel do processo.
601
+ # [unidades_destino] Unidades de destino (padrao []). +UnidadesDestino+ e enviado como recebido; cada unidade
602
+ # precisa virar elemento filho: <tt>[{ id_unidade: '100000001' }]</tt> ou
603
+ # <tt>[{ id_unidade: ['100000001', '100000002'] }]</tt>. Passe sempre um Array: um Hash
604
+ # solto nesta posicao seria lido pelo Ruby como keywords.
605
+ # [data_retorno_programado] String dd/mm/aaaa ou nil (padrao nil). +DataRetornoProgramado+.
606
+ # [dias_retorno_programado] Integer ou nil (padrao nil). +DiasRetornoProgramado+.
607
+ # [sin_dias_uteis_retorno_programado] "S"/"N" (padrao "N"). +SinDiasUteisRetornoProgramado+.
608
+ # [sin_manter_aberto_unidade] keyword, "S"/"N" (padrao "N"). +SinManterAbertoUnidade+: mantem o processo aberto na unidade de origem.
609
+ # [sin_remover_anotacao] keyword, "S"/"N" (padrao "N"). +SinRemoverAnotacao+.
610
+ # [sin_enviar_email_notificacao] keyword, "S"/"N" (padrao "N"). +SinEnviarEmailNotificacao+.
611
+ # [sin_reabrir] keyword, "S"/"N" ou nil (padrao nil). +SinReabrir+: reabre o processo se estiver concluido;
612
+ # nao enviado quando nil (o SEI assume N).
613
+ #
614
+ # Retorno: Sei::Estruturas::EnviarProcesso (+status+).
615
+ #
616
+ # Levanta Savon::SOAPFault quando o SEI recusa a operacao (regra de negocio,
617
+ # permissao, dado inexistente) e Savon::HTTPError em falha HTTP de transporte.
618
+ def self.enviar_processo(id_unidade, procedimento_formatado, unidades_destino = [], data_retorno_programado = nil, dias_retorno_programado = nil, sin_dias_uteis_retorno_programado = "N",
619
+ sin_manter_aberto_unidade: "N", sin_remover_anotacao: "N", sin_enviar_email_notificacao: "N", sin_reabrir: nil)
377
620
  message = {
378
621
  SiglaSistema: Sei.configuration.sigla,
379
622
  IdentificacaoServico: Sei.configuration.identificacao,
380
623
  IdUnidade: id_unidade,
381
- IdUsuario: id_usuario
624
+ ProtocoloProcedimento: procedimento_formatado,
625
+ UnidadesDestino: unidades_destino,
626
+ SinManterAbertoUnidade: sin_manter_aberto_unidade,
627
+ SinRemoverAnotacao: sin_remover_anotacao,
628
+ SinEnviarEmailNotificacao: sin_enviar_email_notificacao,
629
+ DataRetornoProgramado: data_retorno_programado,
630
+ DiasRetornoProgramado: dias_retorno_programado,
631
+ SinDiasUteisRetornoProgramado: sin_dias_uteis_retorno_programado
382
632
  }
383
- response = Sei::Connection.instance.call :listar_usuarios, message: message
384
- body = response.body[:listar_usuarios_response][:parametros]
385
- Sei::Estruturas::RetornoListUsuarios.new body
633
+ message[:SinReabrir] = sin_reabrir unless sin_reabrir.nil?
634
+ response = Sei::Connection.instance.call :enviar_processo, message: message
635
+ body = response.body[:enviar_processo_response][:parametros]
636
+ Sei::Estruturas::EnviarProcesso.new body
386
637
  end
387
638
 
388
- def self.reabrir_processo(id_unidade, protocolo_procedimento)
639
+ # Lista os tipos de documento (series) que o servico pode usar (+listarSeries+). Consta do
640
+ # WSDL do SEI 5.0.5.
641
+ #
642
+ # [id_unidade] String/Integer. +IdUnidade+: identificador da unidade no SEI.
643
+ # [id_tipo_procedimento] String/Integer ou nil (padrao nil). +IdTipoProcedimento+: filtro; nao enviado quando nil.
644
+ #
645
+ # Retorno: Sei::Estruturas::RetornoListSeries (+retorno_list_series+ com Sei::Estruturas::RetornoSerie; vazia sem itens).
646
+ #
647
+ # Levanta Savon::SOAPFault quando o SEI recusa a operacao (regra de negocio,
648
+ # permissao, dado inexistente) e Savon::HTTPError em falha HTTP de transporte.
649
+ def self.listar_series(id_unidade, id_tipo_procedimento = nil)
389
650
  message = {
390
651
  SiglaSistema: Sei.configuration.sigla,
391
652
  IdentificacaoServico: Sei.configuration.identificacao,
392
- IdUnidade: id_unidade,
393
- ProtocoloProcedimento: protocolo_procedimento
653
+ IdUnidade: id_unidade
394
654
  }
395
-
396
- response = Sei::Connection.instance.call :reabrir_processo, message: message
397
- body = response.body[:reabrir_processo_response][:parametros]
398
- Sei::Estruturas::RetornoBoolean.new body
655
+ message[:IdTipoProcedimento] = id_tipo_procedimento unless id_tipo_procedimento.nil?
656
+ response = Sei::Connection.instance.call :listar_series, message: message
657
+ body = response.body[:listar_series_response][:parametros]
658
+ Sei::Estruturas::RetornoListSeries.new body
399
659
  end
400
660
 
401
- # def self.relacionar_processo
402
- # end
403
-
404
- # def self.remover_relacionamento_processo
405
- # end
406
-
407
- # def self.remover_sobrestamento_processo
408
- # end
409
-
410
- def self.retirar_documento_bloco(id_unidade, id_bloco, protocolo_documento)
661
+ # Lista os tipos de processo que o servico pode usar (+listarTiposProcedimento+). Consta do
662
+ # WSDL do SEI 5.0.5.
663
+ #
664
+ # [id_unidade] String/Integer. +IdUnidade+: identificador da unidade no SEI.
665
+ # [id_serie] String/Integer ou nil (padrao nil). +IdSerie+: filtro; nao enviado quando nil.
666
+ # [sin_individual] keyword, "S"/"N" ou nil (padrao nil). +SinIndividual+: filtra tipos de processo individuais;
667
+ # nao enviado quando nil.
668
+ #
669
+ # Retorno: Sei::Estruturas::RetornoListTiposProcedimento (+retorno_list_tipos_procedimento+ com
670
+ # Sei::Estruturas::RetornoTipoProcedimento; vazia sem itens).
671
+ #
672
+ # Levanta Savon::SOAPFault quando o SEI recusa a operacao (regra de negocio,
673
+ # permissao, dado inexistente) e Savon::HTTPError em falha HTTP de transporte.
674
+ def self.listar_tipos_procedimento(id_unidade, id_serie = nil, sin_individual: nil)
411
675
  message = {
412
676
  SiglaSistema: Sei.configuration.sigla,
413
677
  IdentificacaoServico: Sei.configuration.identificacao,
414
- IdUnidade: id_unidade,
415
- IdBloco: id_bloco,
416
- ProtocoloDocumento: protocolo_documento
678
+ IdUnidade: id_unidade
417
679
  }
418
- response = Sei::Connection.instance.call :retirar_documento_bloco, message: message
419
- body = response.body[:retirar_documento_bloco_response][:parametros]
420
- Sei::Estruturas::RetornoBoolean.new body
680
+ message[:IdSerie] = id_serie unless id_serie.nil?
681
+ message[:SinIndividual] = sin_individual unless sin_individual.nil?
682
+ response = Sei::Connection.instance.call :listar_tipos_procedimento, message: message
683
+ body = response.body[:listar_tipos_procedimento_response][:parametros]
684
+ Sei::Estruturas::RetornoListTiposProcedimento.new body
421
685
  end
422
686
 
423
- def self.retirar_processo_bloco(id_unidade, id_bloco, protocolo_procedimento)
687
+ # Lista as hipoteses legais de restricao de acesso (+listarHipotesesLegais+). Consta do
688
+ # WSDL do SEI 5.0.5.
689
+ #
690
+ # [id_unidade] String/Integer. +IdUnidade+: identificador da unidade no SEI.
691
+ # [nivel_acesso] String/Integer ou nil (padrao nil). +NivelAcesso+: filtro, 1 (restrito) ou 2 (sigiloso); nao enviado quando nil.
692
+ #
693
+ # Retorno: Sei::Estruturas::RetornoListHipotesesLegais (+retorno_list_hipoteses_legais+ com
694
+ # Sei::Estruturas::RetornoHipoteseLegal; vazia sem itens).
695
+ #
696
+ # Levanta Savon::SOAPFault quando o SEI recusa a operacao (regra de negocio,
697
+ # permissao, dado inexistente) e Savon::HTTPError em falha HTTP de transporte.
698
+ def self.listar_hipoteses_legais(id_unidade, nivel_acesso = nil)
424
699
  message = {
425
700
  SiglaSistema: Sei.configuration.sigla,
426
701
  IdentificacaoServico: Sei.configuration.identificacao,
427
- IdUnidade: id_unidade,
428
- IdBloco: id_bloco,
429
- ProtocoloProcedimento: protocolo_procedimento
702
+ IdUnidade: id_unidade
430
703
  }
431
-
432
- response = Sei::Connection.instance.call :retirar_processo_bloco, message: message
433
- body = response.body[:retirar_processo_bloco_response][:parametros]
434
- Sei::Estruturas::RetornoBoolean.new body
704
+ message[:NivelAcesso] = nivel_acesso unless nivel_acesso.nil?
705
+ response = Sei::Connection.instance.call :listar_hipoteses_legais, message: message
706
+ body = response.body[:listar_hipoteses_legais_response][:parametros]
707
+ Sei::Estruturas::RetornoListHipotesesLegais.new body
435
708
  end
436
-
437
- # def self.sobrestar_processo
438
- # end
439
709
  end
440
710
  end
data/lib/sei/version.rb CHANGED
@@ -1,3 +1,3 @@
1
1
  module Sei
2
- VERSION = "0.2.8"
2
+ VERSION = "0.3.0"
3
3
  end
data/lib/zei.rb CHANGED
@@ -26,6 +26,12 @@ require 'sei/estruturas/retorno_consultar_procedimento'
26
26
  require 'sei/estruturas/retorno_consultar_documento'
27
27
  require 'sei/estruturas/retorno_consultar_bloco'
28
28
  require 'sei/estruturas/enviar_processo'
29
+ require 'sei/estruturas/retorno_serie'
30
+ require 'sei/estruturas/retorno_list_series'
31
+ require 'sei/estruturas/retorno_tipo_procedimento'
32
+ require 'sei/estruturas/retorno_list_tipos_procedimento'
33
+ require 'sei/estruturas/retorno_hipotese_legal'
34
+ require 'sei/estruturas/retorno_list_hipoteses_legais'
29
35
 
30
36
  module Sei
31
37
 
metadata CHANGED
@@ -1,13 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: zei
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.8
4
+ version: 0.3.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Ricardo Viana
8
8
  bindir: exe
9
9
  cert_chain: []
10
- date: 2025-04-20 00:00:00.000000000 Z
10
+ date: 1980-01-02 00:00:00.000000000 Z
11
11
  dependencies:
12
12
  - !ruby/object:Gem::Dependency
13
13
  name: bundler
@@ -121,11 +121,17 @@ files:
121
121
  - lib/sei/estruturas/retorno_consultar_procedimento.rb
122
122
  - lib/sei/estruturas/retorno_geracao_bloco.rb
123
123
  - lib/sei/estruturas/retorno_geracao_procedimento.rb
124
+ - lib/sei/estruturas/retorno_hipotese_legal.rb
124
125
  - lib/sei/estruturas/retorno_inclusao_documento.rb
125
126
  - lib/sei/estruturas/retorno_inclusao_documento_bloco.rb
126
127
  - lib/sei/estruturas/retorno_inclusao_processo_bloco.rb
128
+ - lib/sei/estruturas/retorno_list_hipoteses_legais.rb
129
+ - lib/sei/estruturas/retorno_list_series.rb
130
+ - lib/sei/estruturas/retorno_list_tipos_procedimento.rb
127
131
  - lib/sei/estruturas/retorno_list_unidades.rb
128
132
  - lib/sei/estruturas/retorno_list_usuarios.rb
133
+ - lib/sei/estruturas/retorno_serie.rb
134
+ - lib/sei/estruturas/retorno_tipo_procedimento.rb
129
135
  - lib/sei/estruturas/retorno_unidade.rb
130
136
  - lib/sei/estruturas/retorno_usuario.rb
131
137
  - lib/sei/printer.rb
@@ -151,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
151
157
  - !ruby/object:Gem::Version
152
158
  version: '0'
153
159
  requirements: []
154
- rubygems_version: 3.6.5
160
+ rubygems_version: 4.0.20
155
161
  specification_version: 4
156
162
  summary: Integração com a API do SEI.
157
163
  test_files: []