Raims CLIComandos da API
raims statements
Consulte os lançamentos do extrato.
Consulte a sintaxe, os argumentos e as opções de cada comando. Use raims COMANDO --help para ler a ajuda no terminal.
raims statements
Consulte os lançamentos do extrato.
Shell
raims statements [flags]--help,-hboolpadrão: false- Exibe a ajuda de statements.
--colorstringpadrão: auto- Cores no terminal: auto, on ou off. JSON e scripts de autocompletar continuam sem cores.
--debugboolpadrão: false- Envia eventos de diagnóstico em JSON para stderr, sem credenciais nem argumentos do comando.
--environmentstringpadrão: vazio- Selecione sandbox ou production para OAuth ou uma prévia OAuth; a chave de API define o próprio ambiente.
--mapstringpadrão: vazio- Liste a árvore de comandos sem executar uma ação: tree, compact, paths ou json.
--no-inputboolpadrão: false- Desativa perguntas durante a execução; também se aplica em CI e quando não há um terminal.
--output,-ostringpadrão: text- Formato da saída: text ou json.
--profilestringpadrão: vazio- Usa um perfil neste comando, com prioridade sobre RAIMS_PROFILE e o padrão salvo.
Subcomandos: raims statements get, raims statements list.
raims statements get
Consulte um lançamento do extrato.
Shell
raims statements get ID [flags]--dry-runboolpadrão: false- Valide e apresente a requisição sem credenciais ou acesso à rede.
--help,-hboolpadrão: false- Exibe a ajuda de get.
--show-headersboolpadrão: false- Mostre os headers públicos da resposta, sem credenciais ou cookies.
--timeoutdurationpadrão: 1m0s- Prazo total da requisição, incluindo novas tentativas. Exemplos: 30s ou 2m.
--colorstringpadrão: auto- Cores no terminal: auto, on ou off. JSON e scripts de autocompletar continuam sem cores.
--debugboolpadrão: false- Envia eventos de diagnóstico em JSON para stderr, sem credenciais nem argumentos do comando.
--environmentstringpadrão: vazio- Selecione sandbox ou production para OAuth ou uma prévia OAuth; a chave de API define o próprio ambiente.
--mapstringpadrão: vazio- Liste a árvore de comandos sem executar uma ação: tree, compact, paths ou json.
--no-inputboolpadrão: false- Desativa perguntas durante a execução; também se aplica em CI e quando não há um terminal.
--output,-ostringpadrão: text- Formato da saída: text ou json.
--profilestringpadrão: vazio- Usa um perfil neste comando, com prioridade sobre RAIMS_PROFILE e o padrão salvo.
Get an account statement entry.
GET /v1/statements/{id}
Uses https://api.raims.com and the credential referenced by the selected profile. The API validates the credential's company, environment and permissions. API keys determine their own environment; --environment is available only with OAuth.
Use --dry-run to validate and preview the request without reading a profile, loading credentials or contacting the API. Add --environment to preview an OAuth request; without it, the preview uses API-key authentication and has no environment header.
OAuth environments accepted by this operation: Sandbox, Production.Exemplo do comando
Shell
raims --profile PROFILE --output json statements get ID --dry-runraims statements list
Liste os lançamentos do extrato.
Shell
raims statements list [flags]--afterstringpadrão: vazio- Consulte após este cursor opaco. Não combine com --before.
--allboolpadrão: false- Leia todas as páginas como resultados separados. Com --output json, a saída usa JSON Lines.
--beforestringpadrão: vazio- Consulte antes deste cursor opaco. Não combine com --after.
--created-gteint64padrão: 0- Criado a partir desta data Unix, em segundos.
--created-lteint64padrão: 0- Criado até esta data Unix, em segundos.
--dry-runboolpadrão: false- Valide e apresente a requisição sem credenciais ou acesso à rede.
--help,-hboolpadrão: false- Exibe a ajuda de list.
--max-pagesintpadrão: 100- Limite de páginas com --all, entre 1 e 10000.
--page-sizeint64padrão: 10- Quantidade de resultados por página. A API ajusta o tamanho solicitado.
--reference-idstringpadrão: vazio- Filtre pelo identificador do recurso referenciado.
--show-headersboolpadrão: false- Mostre os headers públicos da resposta, sem credenciais ou cookies.
--sort-orderstringpadrão: desc- Direção da ordenação: asc ou desc.
--statement-typestringpadrão: vazio- Filtre pelos códigos dos tipos de lançamento, separados por vírgula.
--timeoutdurationpadrão: 1m0s- Prazo total da requisição, incluindo novas tentativas. Exemplos: 30s ou 2m.
--colorstringpadrão: auto- Cores no terminal: auto, on ou off. JSON e scripts de autocompletar continuam sem cores.
--debugboolpadrão: false- Envia eventos de diagnóstico em JSON para stderr, sem credenciais nem argumentos do comando.
--environmentstringpadrão: vazio- Selecione sandbox ou production para OAuth ou uma prévia OAuth; a chave de API define o próprio ambiente.
--mapstringpadrão: vazio- Liste a árvore de comandos sem executar uma ação: tree, compact, paths ou json.
--no-inputboolpadrão: false- Desativa perguntas durante a execução; também se aplica em CI e quando não há um terminal.
--output,-ostringpadrão: text- Formato da saída: text ou json.
--profilestringpadrão: vazio- Usa um perfil neste comando, com prioridade sobre RAIMS_PROFILE e o padrão salvo.
List account statement entries.
GET /v1/statements
Uses https://api.raims.com and the credential referenced by the selected profile. The API validates the credential's company, environment and permissions. API keys determine their own environment; --environment is available only with OAuth.
Use --dry-run to validate and preview the request without reading a profile, loading credentials or contacting the API. Add --environment to preview an OAuth request; without it, the preview uses API-key authentication and has no environment header.
OAuth environments accepted by this operation: Sandbox, Production.Exemplo do comando
Shell
raims --profile PROFILE --output json statements list --dry-run