Class SipClient

Fachada principal do cliente SIP.

Aplicações consumidoras podem usar client.consultas.* para consultas e client.replicacao.* para operações de escrita. Os métodos na raiz da classe são atalhos de compatibilidade retroativa para código existente que não usa os subclients.

Remarks

Prefira instanciar via createSipClient em vez de new SipClient() diretamente, pois a fábrica tem assinatura mais simples.

Example

import { createSipClient } from "@anpdgovbr/sip-client"

const sip = createSipClient({
  endpointUrl: process.env.SIP_SOAP_ENDPOINT!,
  accessKey:   process.env.SIP_ACCESS_KEY!,
  systemId:    process.env.SIP_SYSTEM_ID!,
  requestTimeoutMs: 30_000,
})

// Via subclient (recomendado)
const usuario = await sip.consultas.buscarUsuarioPorSigla("joao.silva")

// Via atalho de compatibilidade (equivalente ao acima)
const mesmo = await sip.buscarUsuarioPorSigla("joao.silva")

See

Index

Constructors

constructor

new SipClient(config: SipConfig): SipClient
Parameters
- config: SipConfig
  Configuração de conexão com o SIP.
Returns SipClient
- Defined in packages/sip-client/src/client.ts:666

Properties

`Readonly`consultas

consultas: SipConsultasClient

Subclient para operações somente leitura.

`Readonly`replicacao

replicacao: SipReplicacaoClient

Subclient para operações de escrita (replicação).

Methods

buscarUsuarioComPermissoesPorSigla

buscarUsuarioComPermissoesPorSigla(
    siglaUsuario: string,
): Promise<
    | Readonly<
        {
            permissoes: Readonly<
                {
                    dataFinal: string
                    | null;
                    dataInicial: string;
                    idOrgaoUnidade: string | null;
                    idOrgaoUsuario: string | null;
                    idOrigemUnidade: string | null;
                    idOrigemUsuario: string | null;
                    idPerfil: string;
                    idSistema: string;
                    idUnidade: string;
                    idUsuario: string;
                    sinSubunidades: boolean;
                },
            >[];
            usuario: SipUsuario;
        },
    >
    | null,
>
Parameters
- siglaUsuario: string
Returns Promise<
    | Readonly<
        {
            permissoes: Readonly<
                {
                    dataFinal: string
                    | null;
                    dataInicial: string;
                    idOrgaoUnidade: string | null;
                    idOrgaoUsuario: string | null;
                    idOrigemUnidade: string | null;
                    idOrigemUsuario: string | null;
                    idPerfil: string;
                    idSistema: string;
                    idUnidade: string;
                    idUsuario: string;
                    sinSubunidades: boolean;
                },
            >[];
            usuario: SipUsuario;
        },
    >
    | null,
>

Deprecated
Use sip.consultas.buscarUsuarioComPermissoesPorSigla() diretamente.
- Defined in packages/sip-client/src/client.ts:714

buscarUsuarioPorSigla

buscarUsuarioPorSigla(
    siglaUsuario: string,
): Promise<
    | Readonly<
        {
            ativo: boolean;
            cpf: string
            | null;
            email: string | null;
            id: string;
            idOrgao: string | null;
            idOrigem: string | null;
            nome: string;
            nomeSocial: string | null;
            sigla: string;
            unidades: string[];
        },
    >
    | null,
>
Parameters
- siglaUsuario: string
Returns Promise<
    | Readonly<
        {
            ativo: boolean;
            cpf: string
            | null;
            email: string | null;
            id: string;
            idOrgao: string | null;
            idOrigem: string | null;
            nome: string;
            nomeSocial: string | null;
            sigla: string;
            unidades: string[];
        },
    >
    | null,
>

Deprecated
Use sip.consultas.buscarUsuarioPorSigla() diretamente.
- Defined in packages/sip-client/src/client.ts:687

buscarUsuarios

buscarUsuarios(
    params: SipBuscarUsuariosParams,
): Promise<
    Readonly<
        {
            ativo: boolean;
            cpf: string
            | null;
            email: string | null;
            id: string;
            idOrgao: string | null;
            idOrigem: string | null;
            nome: string;
            nomeSocial: string | null;
            sigla: string;
            unidades: string[];
        },
    >[],
>
Parameters
- params: SipBuscarUsuariosParams
Returns Promise<
    Readonly<
        {
            ativo: boolean;
            cpf: string
            | null;
            email: string | null;
            id: string;
            idOrgao: string | null;
            idOrigem: string | null;
            nome: string;
            nomeSocial: string | null;
            sigla: string;
            unidades: string[];
        },
    >[],
>

Deprecated
Use sip.consultas.buscarUsuarios() diretamente.
- Defined in packages/sip-client/src/client.ts:682

buscarUsuariosSemPermissao

buscarUsuariosSemPermissao(
    params?: SipBuscarUsuariosSemPermissaoParams,
): Promise<
    Readonly<
        {
            ativo: boolean;
            cpf: string
            | null;
            email: string | null;
            id: string;
            idOrgao: string | null;
            idOrigem: string | null;
            nome: string;
            nomeSocial: string | null;
            sigla: string;
            unidades: string[];
        },
    >[],
>
Parameters
- params: SipBuscarUsuariosSemPermissaoParams = {}
Returns Promise<
    Readonly<
        {
            ativo: boolean;
            cpf: string
            | null;
            email: string | null;
            id: string;
            idOrgao: string | null;
            idOrigem: string | null;
            nome: string;
            nomeSocial: string | null;
            sigla: string;
            unidades: string[];
        },
    >[],
>

Deprecated
Use sip.consultas.buscarUsuariosSemPermissao() diretamente.
- Defined in packages/sip-client/src/client.ts:692

listarOrgaos

listarOrgaos(
    params?: SipListarOrgaosParams,
): Promise<
    Readonly<
        { ativo: boolean; descricao: string; id: string; sigla: string },
    >[],
>
Parameters
- params: SipListarOrgaosParams = {}
Returns Promise<
    Readonly<
        { ativo: boolean; descricao: string; id: string; sigla: string },
    >[],
>

Deprecated
Use sip.consultas.listarOrgaos() diretamente.
- Defined in packages/sip-client/src/client.ts:672

listarPerfis

listarPerfis(
    params?: SipListarPerfisParams,
): Promise<
    Readonly<
        {
            ativo: boolean;
            descricao: string
            | null;
            grupos: Readonly<{ ativo: boolean; id: string; nome: string }>[];
            id: string;
            menus: Readonly<
                {
                    ativo: boolean;
                    id: string;
                    itens: Readonly<
                        {
                            ativo: boolean;
                            id: string;
                            idRecurso: (...)
                            | (...);
                            ramificacao: (...) | (...);
                            rotulo: string;
                        },
                    >[];
                    nome: string;
                },
            >[];
            nome: string;
            recursos: Readonly<
                {
                    ativo: boolean;
                    descricao: string
                    | null;
                    id: string;
                    nome: string;
                },
            >[];
        },
    >[],
>
Parameters
- params: SipListarPerfisParams = {}
Returns Promise<
    Readonly<
        {
            ativo: boolean;
            descricao: string
            | null;
            grupos: Readonly<{ ativo: boolean; id: string; nome: string }>[];
            id: string;
            menus: Readonly<
                {
                    ativo: boolean;
                    id: string;
                    itens: Readonly<
                        {
                            ativo: boolean;
                            id: string;
                            idRecurso: (...)
                            | (...);
                            ramificacao: (...) | (...);
                            rotulo: string;
                        },
                    >[];
                    nome: string;
                },
            >[];
            nome: string;
            recursos: Readonly<
                {
                    ativo: boolean;
                    descricao: string
                    | null;
                    id: string;
                    nome: string;
                },
            >[];
        },
    >[],
>

Deprecated
Use sip.consultas.listarPerfis() diretamente.
- Defined in packages/sip-client/src/client.ts:699

listarPermissoes

listarPermissoes(
    params?: SipListarPermissoesParams,
): Promise<
    Readonly<
        {
            dataFinal: string
            | null;
            dataInicial: string;
            idOrgaoUnidade: string | null;
            idOrgaoUsuario: string | null;
            idOrigemUnidade: string | null;
            idOrigemUsuario: string | null;
            idPerfil: string;
            idSistema: string;
            idUnidade: string;
            idUsuario: string;
            sinSubunidades: boolean;
        },
    >[],
>
Parameters
- params: SipListarPermissoesParams = {}
Returns Promise<
    Readonly<
        {
            dataFinal: string
            | null;
            dataInicial: string;
            idOrgaoUnidade: string | null;
            idOrgaoUsuario: string | null;
            idOrigemUnidade: string | null;
            idOrigemUsuario: string | null;
            idPerfil: string;
            idSistema: string;
            idUnidade: string;
            idUsuario: string;
            sinSubunidades: boolean;
        },
    >[],
>

Deprecated
Use sip.consultas.listarPermissoes() diretamente.
- Defined in packages/sip-client/src/client.ts:709

listarRecursos

listarRecursos(params?: SipListarRecursosParams): Promise<string[]>
Parameters
- params: SipListarRecursosParams = {}
Returns Promise<string[]>

Deprecated
Use sip.consultas.listarRecursos() diretamente.
- Defined in packages/sip-client/src/client.ts:704

listarUnidades

listarUnidades(
    params?: SipListarUnidadesParams,
): Promise<
    Readonly<
        {
            ativo: boolean;
            descricao: string;
            id: string;
            idOrgao: string
            | null;
            idOrigem: string | null;
            sigla: string;
            subunidades: string[];
            unidadesSuperiores: string[];
        },
    >[],
>
Parameters
- params: SipListarUnidadesParams = {}
Returns Promise<
    Readonly<
        {
            ativo: boolean;
            descricao: string;
            id: string;
            idOrgao: string
            | null;
            idOrigem: string | null;
            sigla: string;
            subunidades: string[];
            unidadesSuperiores: string[];
        },
    >[],
>

Deprecated
Use sip.consultas.listarUnidades() diretamente.
- Defined in packages/sip-client/src/client.ts:677

Class SipClient

Remarks

Example

See

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SipClient

Properties

Readonlyconsultas

Readonlyreplicacao

Methods

buscarUsuarioComPermissoesPorSigla

Parameters

Deprecated

buscarUsuarioPorSigla

Parameters

Returns Promise< | Readonly< { ativo: boolean; cpf: string | null; email: string | null; id: string; idOrgao: string | null; idOrigem: string | null; nome: string; nomeSocial: string | null; sigla: string; unidades: string[]; }, > | null,>

Deprecated

buscarUsuarios

Parameters

Returns Promise< Readonly< { ativo: boolean; cpf: string | null; email: string | null; id: string; idOrgao: string | null; idOrigem: string | null; nome: string; nomeSocial: string | null; sigla: string; unidades: string[]; }, >[],>

Deprecated

buscarUsuariosSemPermissao

Parameters

Returns Promise< Readonly< { ativo: boolean; cpf: string | null; email: string | null; id: string; idOrgao: string | null; idOrigem: string | null; nome: string; nomeSocial: string | null; sigla: string; unidades: string[]; }, >[],>

Deprecated

listarOrgaos

Parameters

Returns Promise< Readonly< { ativo: boolean; descricao: string; id: string; sigla: string }, >[],>

Deprecated

listarPerfis

Parameters

Deprecated

listarPermissoes

Parameters

Deprecated

listarRecursos

Parameters

Returns Promise<string[]>

Deprecated

listarUnidades

Parameters

Returns Promise< Readonly< { ativo: boolean; descricao: string; id: string; idOrgao: string | null; idOrigem: string | null; sigla: string; subunidades: string[]; unidadesSuperiores: string[]; }, >[],>

Deprecated

Settings

On This Page

`Readonly`consultas

`Readonly`replicacao

Returns Promise<
| Readonly<
{
ativo: boolean;
cpf: string
| null;
email: string | null;
id: string;
idOrgao: string | null;
idOrigem: string | null;
nome: string;
nomeSocial: string | null;
sigla: string;
unidades: string[];
},
>
| null,
>

Returns Promise<
Readonly<
{
ativo: boolean;
cpf: string
| null;
email: string | null;
id: string;
idOrgao: string | null;
idOrigem: string | null;
nome: string;
nomeSocial: string | null;
sigla: string;
unidades: string[];
},
>[],
>

Returns Promise<
Readonly<
{
ativo: boolean;
cpf: string
| null;
email: string | null;
id: string;
idOrgao: string | null;
idOrigem: string | null;
nome: string;
nomeSocial: string | null;
sigla: string;
unidades: string[];
},
>[],
>

Returns Promise<
Readonly<
{ ativo: boolean; descricao: string; id: string; sigla: string },
>[],
>

Returns Promise<
Readonly<
{
ativo: boolean;
descricao: string;
id: string;
idOrgao: string
| null;
idOrigem: string | null;
sigla: string;
subunidades: string[];
unidadesSuperiores: string[];
},
>[],
>