pu-admin-cli v0.33.0
pu-admin
Unified Portfolio CLI
Usage
$ yarn
$ yarn build
$ alias dev-pu="./bin/dev"
$ dev-pu
You can use yarn dev
to watch file changes and automatically build new bin.
Commands
pu-admin agency alias
pu-admin agency churn
pu-admin agency list
pu-admin agency pull
pu-admin agency save vista
pu-admin agency save xml
pu-admin distribution config
pu-admin distribution disable
pu-admin distribution enable
pu-admin distribution run
pu-admin help [COMMANDS]
pu-admin mapper get ENTITY DOMAIN
pu-admin mapper set ENTITY DOMAIN
pu-admin mapper unset ENTITY DOMAIN
pu-admin report supply-publication-summary
pu-admin supply advertiser config
pu-admin supply cities refresh
pu-admin supply marketplace disable
pu-admin supply marketplace enable
pu-admin supply refresh
pu-admin agency alias
Configura um nome amigável para um AgencyId
USAGE
$ pu-admin agency alias -i <value> -a <value> [--log-level fatal|error|warn|info|debug|trace]
FLAGS
-a, --alias=<value> (required) Apelido da imobiliária
-i, --agencyId=<value> (required) AgencyId da imobiliária
GLOBAL FLAGS
--log-level=<option> [default: error] Specify level for logging.
<options: fatal|error|warn|info|debug|trace>
DESCRIPTION
Configura um nome amigável para um AgencyId
EXAMPLES
$ pu-admin agency alias --agencyId 3285f81e-04cb-4725-ab91-b69bc36dcdb1 --alias prod_neon
See code: src/commands/agency/alias.ts
pu-admin agency churn
Churn/distrato de imobiliária do Portal + PU
USAGE
$ pu-admin agency churn -a <value> [--log-level fatal|error|warn|info|debug|trace] [-t <value>] [-e <value>]
FLAGS
-a, --agency=<value> (required) AgencyId da imobiliária
-e, --env=<value> [default: prod] Ambiente (prod ou staging)
-t, --taskId=<value> Id de um processo em andamento
GLOBAL FLAGS
--log-level=<option> [default: error] Specify level for logging.
<options: fatal|error|warn|info|debug|trace>
DESCRIPTION
Churn/distrato de imobiliária do Portal + PU
EXAMPLES
$ pu-admin agency churn --agency prod_neon
$ pu-admin agency churn --agency prod_neon --taskId c5bbdf63-3197-49f3-837c-b7b7ae6a7a38
See code: src/commands/agency/churn.ts
pu-admin agency list
Listar todos os apelidos de imobiliárias
USAGE
$ pu-admin agency list [--log-level fatal|error|warn|info|debug|trace]
GLOBAL FLAGS
--log-level=<option> [default: error] Specify level for logging.
<options: fatal|error|warn|info|debug|trace>
DESCRIPTION
Listar todos os apelidos de imobiliárias
EXAMPLES
$ pu-admin agency list
See code: src/commands/agency/list.ts
pu-admin agency pull
Obsoleto usar: pu-admin agency alias
USAGE
$ pu-admin agency pull -i <value> -a <value> [--log-level fatal|error|warn|info|debug|trace]
FLAGS
-a, --alias=<value> (required) Apelido da imobiliária
-i, --agencyId=<value> (required) AgencyId da imobiliária
GLOBAL FLAGS
--log-level=<option> [default: error] Specify level for logging.
<options: fatal|error|warn|info|debug|trace>
DESCRIPTION
[Obsoleto] usar: pu-admin agency alias
EXAMPLES
$ pu-admin agency pull --agencyId 3285f81e-04cb-4725-ab91-b69bc36dcdb1 --alias prod_neon
See code: src/commands/agency/pull.ts
pu-admin agency save vista
Configura ingestão de listings de uma imobiliária do Vista
USAGE
$ pu-admin agency save vista -i <value> -n <value> -k <value> -t <value> [--log-level
fatal|error|warn|info|debug|trace] [-a <value>] [-e <value>]
FLAGS
-a, --alias=<value> Apelido da imobiliária
-e, --env=<value> [default: prod] Ambiente (prod ou staging)
-i, --agencyId=<value> (required) AgencyId da imobiliária
-k, --apiKey=<value> (required) Chave de API do Vista (integração Portfolio Unico) da imobiliária
-n, --agencyName=<value> (required) Nome da imobiliária
-t, --tenantId=<value> (required) TenantId do Vista
GLOBAL FLAGS
--log-level=<option> [default: error] Specify level for logging.
<options: fatal|error|warn|info|debug|trace>
DESCRIPTION
Configura ingestão de listings de uma imobiliária do Vista
EXAMPLES
$ pu-admin agency save vista --agencyId 3285f81e-04cb-4725-ab91-b69bc36dcdb1 --apiKey example1234example1234example1234 --tenantId 1001 --alias prod_neon
See code: src/commands/agency/save/vista.ts
pu-admin agency save xml
Configura ingestão de listings de uma imobiliária XML
USAGE
$ pu-admin agency save xml -i <value> -n <value> -f <value> [--log-level fatal|error|warn|info|debug|trace] [-a
<value>] [-e <value>] [-u <value>]
FLAGS
-a, --alias=<value> Apelido da imobiliária
-e, --env=<value> [default: prod] Ambiente (prod ou staging)
-f, --fileName=<value> (required) Nome do arquivo xml. Exemplo: "imob_feliz.xml"
-i, --agencyId=<value> (required) AgencyId da imobiliária
-n, --agencyName=<value> (required) Nome da imobiliária
-u, --unpublishThreshold=<value> [default: 40] Limite máximo de despublicação em %
GLOBAL FLAGS
--log-level=<option> [default: error] Specify level for logging.
<options: fatal|error|warn|info|debug|trace>
DESCRIPTION
Configura ingestão de listings de uma imobiliária XML
EXAMPLES
$ pu-admin agency save xml --agencyId 3285f81e-04cb-4725-ab91-b69bc36dcdb1 --fileName imob_feliz.xml --unpublishThreshold 50
See code: src/commands/agency/save/xml.ts
pu-admin distribution config
Configurar regras de distribuição
USAGE
$ pu-admin distribution config -a <value> [--log-level fatal|error|warn|info|debug|trace] [-l] [-e <value>]
FLAGS
-a, --agency=<value> (required) AgencyId da imobiliária
-e, --env=<value> [default: prod] Ambiente (prod ou staging)
-l, --listOnly Listar a configuração atual
GLOBAL FLAGS
--log-level=<option> [default: error] Specify level for logging.
<options: fatal|error|warn|info|debug|trace>
DESCRIPTION
Configurar regras de distribuição
EXAMPLES
$ pu-admin distribution config --agency prod_neon
$ pu-admin distribution config --agency 80e90ce2-8739-48aa-9f35-cb120c67802f
See code: src/commands/distribution/config.ts
pu-admin distribution disable
Desativar distribuição de uma imobiliária
USAGE
$ pu-admin distribution disable -a <value> [--log-level fatal|error|warn|info|debug|trace] [-e <value>]
FLAGS
-a, --agency=<value> (required) AgencyId da imobiliária
-e, --env=<value> [default: prod] Ambiente (prod ou staging)
GLOBAL FLAGS
--log-level=<option> [default: error] Specify level for logging.
<options: fatal|error|warn|info|debug|trace>
DESCRIPTION
Desativar distribuição de uma imobiliária
EXAMPLES
$ pu-admin distribution disable --agency prod_neon
$ pu-admin distribution disable --agency 80e90ce2-8739-48aa-9f35-cb120c67802f
See code: src/commands/distribution/disable.ts
pu-admin distribution enable
Ativar distribuição de uma imobiliária
USAGE
$ pu-admin distribution enable -a <value> [--log-level fatal|error|warn|info|debug|trace] [-e <value>]
FLAGS
-a, --agency=<value> (required) AgencyId da imobiliária
-e, --env=<value> [default: prod] Ambiente (prod ou staging)
GLOBAL FLAGS
--log-level=<option> [default: error] Specify level for logging.
<options: fatal|error|warn|info|debug|trace>
DESCRIPTION
Ativar distribuição de uma imobiliária
EXAMPLES
$ pu-admin distribution enable --agency prod_neon
$ pu-admin distribution enable --agency 80e90ce2-8739-48aa-9f35-cb120c67802f
See code: src/commands/distribution/enable.ts
pu-admin distribution run
Inicia uma distribuição para uma imobiliária.
USAGE
$ pu-admin distribution run -a <value> [--log-level fatal|error|warn|info|debug|trace] [-u <value>] [-l <value>] [-e
<value>]
FLAGS
-a, --agency=<value> (required) AgencyId da imobiliária
-e, --env=<value> [default: prod] Ambiente (prod ou staging)
-l, --listingId=<value> ListingId específico
-u, --unitId=<value> UnitId específico
GLOBAL FLAGS
--log-level=<option> [default: error] Specify level for logging.
<options: fatal|error|warn|info|debug|trace>
DESCRIPTION
Inicia uma distribuição para uma imobiliária.
EXAMPLES
$ pu-admin distribution run --agency prod_neon
$ pu-admin distribution run --agency 80e90ce2-8739-48aa-9f35-cb120c67802f
$ pu-admin distribution run --agency 80e90ce2-8739-48aa-9f35-cb120c67802f --unitId 12345678 --listingId abc12345
See code: src/commands/distribution/run.ts
pu-admin help [COMMANDS]
Display help for pu-admin.
USAGE
$ pu-admin help [COMMANDS] [-n]
ARGUMENTS
COMMANDS Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for pu-admin.
See code: @oclif/plugin-help
pu-admin mapper get ENTITY DOMAIN
Lista mapeamentos personalizados
USAGE
$ pu-admin mapper get ENTITY DOMAIN -a <value> [--log-level fatal|error|warn|info|debug|trace] [-e <value>]
ARGUMENTS
ENTITY (listing|owner) Entidade
DOMAIN (supply|distribution) Domínio
FLAGS
-a, --agency=<value> (required) AgencyId da imobiliária
-e, --env=<value> [default: prod] Ambiente (prod ou staging)
GLOBAL FLAGS
--log-level=<option> [default: error] Specify level for logging.
<options: fatal|error|warn|info|debug|trace>
DESCRIPTION
Lista mapeamentos personalizados
EXAMPLES
$ pu-admin mapper get listing supply --agency prod_neon
$ pu-admin mapper get listing distribution --agency prod_neon
See code: src/commands/mapper/get.ts
pu-admin mapper set ENTITY DOMAIN
Adiciona novo mapeamento personalizado
USAGE
$ pu-admin mapper set ENTITY DOMAIN -a <value> -k <value> -e <value> [--log-level
fatal|error|warn|info|debug|trace] [-e <value>]
ARGUMENTS
ENTITY (listing|owner) Entidade
DOMAIN (supply|distribution) Domínio
FLAGS
-a, --agency=<value> (required) AgencyId da imobiliária
-e, --env=<value> [default: prod] Ambiente (prod ou staging)
-e, --expression=<value> (required) Expressão para calcular o valor do campo
-k, --key=<value> (required) Campo que será mapeado
GLOBAL FLAGS
--log-level=<option> [default: error] Specify level for logging.
<options: fatal|error|warn|info|debug|trace>
DESCRIPTION
Adiciona novo mapeamento personalizado
EXAMPLES
$ pu-admin mapper set listing distribution --agency prod_neon --key NewFieldName --expression "'hardcoded value'"
$ pu-admin mapper set listing distribution --agency prod_neon --key NewFieldName --expression "\$toVistaBoolean(aBooleanField)"
$ pu-admin mapper set listing distribution --agency prod_neon --key ListingId --expression "id"
See code: src/commands/mapper/set.ts
pu-admin mapper unset ENTITY DOMAIN
Apaga mapeamentos personalizados
USAGE
$ pu-admin mapper unset ENTITY DOMAIN -a <value> [--log-level fatal|error|warn|info|debug|trace] [-k <value>]
[-f] [-e <value>]
ARGUMENTS
ENTITY (listing|owner) Entidade
DOMAIN (supply|distribution) Domínio
FLAGS
-a, --agency=<value> (required) AgencyId da imobiliária
-e, --env=<value> [default: prod] Ambiente (prod ou staging)
-f, --all Remover todos os mapeamentos?
-k, --key=<value> Nome do campo
GLOBAL FLAGS
--log-level=<option> [default: error] Specify level for logging.
<options: fatal|error|warn|info|debug|trace>
DESCRIPTION
Apaga mapeamentos personalizados
EXAMPLES
$ pu-admin mapper unset listing distribution --agency prod_neon --key nomeDoCampo
$ pu-admin mapper unset listing distribution --agency prod_neon --all
See code: src/commands/mapper/unset.ts
pu-admin report supply-publication-summary
Relatório de publicação
USAGE
$ pu-admin report supply-publication-summary -a <value> [--log-level fatal|error|warn|info|debug|trace] [-f] [-e
<value>]
FLAGS
-a, --agency=<value> (required) AgencyId da imobiliária
-e, --env=<value> [default: prod] Ambiente (prod ou staging)
-f, --follow Atualizar relatório periodicamente
GLOBAL FLAGS
--log-level=<option> [default: error] Specify level for logging.
<options: fatal|error|warn|info|debug|trace>
DESCRIPTION
Relatório de publicação
EXAMPLES
$ pu-admin report supply-publication-summary --agency prod_neon
See code: src/commands/report/supply-publication-summary.ts
pu-admin supply advertiser config
Configurar contato do anunciante/estratégia de alocação
USAGE
$ pu-admin supply advertiser config -a <value> -i <value> -s BROKER_THEN_SECRETARY|SECRETARY [--log-level
fatal|error|warn|info|debug|trace] [-e <value>]
FLAGS
-a, --agency=<value>
(required) AgencyId da imobiliária
-e, --env=<value>
[default: prod] Ambiente (prod ou staging)
-i, --accountId=<value>
(required) AccountId da secretaria de vendas
-s, --strategy=<option>
(required) Estratégia de alocação.
BROKER_THEN_SECRETARY: preferência pelo contato do corretor do imóvel. Se não for encontrado, usa o contato da
secretaria de vendas.
SECRETARY: usa sempre o contato da secretaria de vendas.
<options: BROKER_THEN_SECRETARY|SECRETARY>
GLOBAL FLAGS
--log-level=<option> [default: error] Specify level for logging.
<options: fatal|error|warn|info|debug|trace>
DESCRIPTION
Configurar contato do anunciante/estratégia de alocação
EXAMPLES
$ pu-admin supply advertiser config --agency prod_neon --accountId 4e30cd07-e596-4240-842c-910284f2ed4e --strategy BROKER_THEN_SECRETARY
See code: src/commands/supply/advertiser/config.ts
pu-admin supply cities refresh
Rodar a ingestão de todos os listings em certas cidades
USAGE
$ pu-admin supply cities refresh [--log-level fatal|error|warn|info|debug|trace] [-t <value>] [-e <value>]
FLAGS
-e, --env=<value> [default: prod] Ambiente (prod ou staging)
-t, --taskId=<value> Id de um processo em andamento
GLOBAL FLAGS
--log-level=<option> [default: error] Specify level for logging.
<options: fatal|error|warn|info|debug|trace>
DESCRIPTION
Rodar a ingestão de todos os listings em certas cidades
EXAMPLES
$ pu-admin supply cities refresh
$ pu-admin supply cities refresh --taskId c5bbdf63-3197-49f3-837c-b7b7ae6a7a38
See code: src/commands/supply/cities/refresh.ts
pu-admin supply marketplace disable
Desativar integração com o Portal Loft
USAGE
$ pu-admin supply marketplace disable -a <value> [--log-level fatal|error|warn|info|debug|trace] [-e <value>]
FLAGS
-a, --agency=<value> (required) AgencyId da imobiliária
-e, --env=<value> [default: prod] Ambiente (prod ou staging)
GLOBAL FLAGS
--log-level=<option> [default: error] Specify level for logging.
<options: fatal|error|warn|info|debug|trace>
DESCRIPTION
Desativar integração com o Portal Loft
EXAMPLES
$ pu-admin supply marketplace disable --agency prod_neon
$ pu-admin supply marketplace disable --agency 80e90ce2-8739-48aa-9f35-cb120c67802f
See code: src/commands/supply/marketplace/disable.ts
pu-admin supply marketplace enable
Ativar integração com Portal Loft
USAGE
$ pu-admin supply marketplace enable -a <value> [--log-level fatal|error|warn|info|debug|trace] [-e <value>]
FLAGS
-a, --agency=<value> (required) AgencyId da imobiliária
-e, --env=<value> [default: prod] Ambiente (prod ou staging)
GLOBAL FLAGS
--log-level=<option> [default: error] Specify level for logging.
<options: fatal|error|warn|info|debug|trace>
DESCRIPTION
Ativar integração com Portal Loft
EXAMPLES
$ pu-admin supply marketplace enable --agency prod_neon
$ pu-admin supply marketplace enable --agency 80e90ce2-8739-48aa-9f35-cb120c67802f
See code: src/commands/supply/marketplace/enable.ts
pu-admin supply refresh
Rodar a ingestão de todos os listings da imobiliária
USAGE
$ pu-admin supply refresh -a <value> [--log-level fatal|error|warn|info|debug|trace] [-t <value>] [-e <value>]
[--ingestedOnly]
FLAGS
-a, --agency=<value> (required) AgencyId da imobiliária
-e, --env=<value> [default: prod] Ambiente (prod ou staging)
-t, --taskId=<value> Id de um processo em andamento
--ingestedOnly Reprocessar somente imóveis já ingeridos alguma vez
GLOBAL FLAGS
--log-level=<option> [default: error] Specify level for logging.
<options: fatal|error|warn|info|debug|trace>
DESCRIPTION
Rodar a ingestão de todos os listings da imobiliária
EXAMPLES
$ pu-admin supply refresh --agency prod_neon
$ pu-admin supply refresh --agency prod_neon --taskId c5bbdf63-3197-49f3-837c-b7b7ae6a7a38
See code: src/commands/supply/refresh.ts
16 days ago
23 days ago
29 days ago
29 days ago
1 month ago
1 month ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
7 months ago
6 months ago
5 months ago
7 months ago
7 months ago
8 months ago
8 months ago
8 months ago
9 months ago
9 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago