Raims CLIComandos da API
raims accounts
Consulte os dados da conta e configure a aparência do checkout.
Consulte a sintaxe, os argumentos e as opções de cada comando. Use raims COMANDO --help para ler a ajuda no terminal.
raims accounts
Consulte os dados da conta e configure a aparência do checkout.
Shell
raims accounts [flags]--help,-hboolpadrão: false- Exibe a ajuda de accounts.
--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 accounts account-number, raims accounts checkout-settings, raims accounts context, raims accounts fees.
raims accounts account-number
Consulte o número da conta.
Shell
raims accounts account-number [flags]--dry-runboolpadrão: false- Valide e apresente a requisição sem credenciais ou acesso à rede.
--help,-hboolpadrão: false- Exibe a ajuda de account-number.
--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 the account number.
GET /v1/accounts/account_number
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: Production.Exemplo do comando
Shell
raims --profile PROFILE --output json accounts account-number --dry-runraims accounts checkout-settings
Gerencie a aparência do checkout e os uploads de imagem preparados.
Shell
raims accounts checkout-settings [flags]--help,-hboolpadrão: false- Exibe a ajuda de checkout-settings.
--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 accounts checkout-settings favicon-uploads, raims accounts checkout-settings get, raims accounts checkout-settings logo-uploads, raims accounts checkout-settings update, raims accounts checkout-settings uploads.
raims accounts checkout-settings favicon-uploads
Prepare uploads de favicon para o checkout.
Shell
raims accounts checkout-settings favicon-uploads [flags]--help,-hboolpadrão: false- Exibe a ajuda de favicon-uploads.
--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 accounts checkout-settings favicon-uploads create.
raims accounts checkout-settings favicon-uploads create
Prepare o upload de um favicon para o checkout.
Shell
raims accounts checkout-settings favicon-uploads create [flags]--content-typestringpadrão: vazio- Defina content_type no corpo JSON: texto obrigatório.
--data-filestringpadrão: vazio- Leia o corpo JSON de um arquivo UTF-8 ou use '-' para stdin.
--dry-runboolpadrão: false- Valide e apresente a requisição sem credenciais ou acesso à rede.
--file-sizeintegerpadrão: 0- Defina file_size no corpo JSON: inteiro obrigatório.
--heightintegerpadrão: 0- Defina height no corpo JSON: inteiro obrigatório.
--help,-hboolpadrão: false- Exibe a ajuda de create.
--idempotency-keystringpadrão: vazio- Reutilize esta chave de idempotência opcional ao repetir a mesma requisição.
--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.
--upload-filestringpadrão: vazio- Prepare o envio de um PNG ou JPEG local e envie seus bytes; não combine com opções do corpo JSON. A imagem não é aplicada ao checkout por este comando.
--widthintegerpadrão: 0- Defina width no corpo JSON: inteiro obrigatório.
--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.
Prepare a checkout favicon upload.
POST /v1/accounts/checkout_settings/favicon_uploads
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.
Read the JSON request body with --data-file PATH, or --data-file - for standard input. You can also provide the body options listed below. Repeat array options for each item. Do not combine file input with body options. Only supplied fields are sent. When listed, --body-null FIELD sends an explicit null for a nullable field. Array size and uniqueness follow the endpoint contract. Objects without dedicated body options and arrays of objects use file input.
JSON body fields:
content_type string required; allowed: "image/png", "image/jpeg"
file_size integer required
height integer required
width integer required
Nested requirements apply when the parent object is present, or for each supplied array item. Omit an optional field to leave it unspecified; null is accepted only for nullable fields.
JSON body example (save as request.json):
{
"content_type": "image/png",
"file_size": 4567,
"width": 128,
"height": 128
}
Example values are illustrative. Replace resource IDs and review the request before sending it.
Without --upload-file, this operation prepares an upload using JSON metadata and returns the API's upload instructions. Use --upload-file PATH to read a PNG or JPEG, prepare its metadata and upload its bytes. Do not combine it with --data-file or body options. With --dry-run, the file is validated locally and only the metadata request is previewed. Uploading does not apply the image: update checkout settings with the returned upload ID in a separate request.
With --upload-file, image metadata is read from the same bytes that are uploaded. The file must be PNG or JPEG, up to 524288 bytes, with width 128..512 pixels and height 128..512 pixels. The favicon must be square. --dry-run validates the local file and previews only the preparation request; it does not upload bytes. Apply the returned upload ID separately to change the checkout image.Exemplo do comando
Shell
raims --profile PROFILE --output json accounts checkout-settings favicon-uploads create --data-file request.json --dry-run
raims accounts checkout-settings favicon-uploads create --content-type="image/png" --file-size=4567 --height=128 --width=128 --dry-run
raims accounts checkout-settings favicon-uploads create --upload-file image.png --dry-runraims accounts checkout-settings get
Consulte as configurações de aparência do checkout.
Shell
raims accounts checkout-settings get [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 checkout appearance settings.
GET /v1/accounts/checkout_settings
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 accounts checkout-settings get --dry-runraims accounts checkout-settings logo-uploads
Prepare uploads de logo para o checkout.
Shell
raims accounts checkout-settings logo-uploads [flags]--help,-hboolpadrão: false- Exibe a ajuda de logo-uploads.
--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 accounts checkout-settings logo-uploads create.
raims accounts checkout-settings logo-uploads create
Prepare o upload de uma logo para o checkout.
Shell
raims accounts checkout-settings logo-uploads create [flags]--content-typestringpadrão: vazio- Defina content_type no corpo JSON: texto obrigatório.
--data-filestringpadrão: vazio- Leia o corpo JSON de um arquivo UTF-8 ou use '-' para stdin.
--dry-runboolpadrão: false- Valide e apresente a requisição sem credenciais ou acesso à rede.
--file-sizeintegerpadrão: 0- Defina file_size no corpo JSON: inteiro obrigatório.
--heightintegerpadrão: 0- Defina height no corpo JSON: inteiro obrigatório.
--help,-hboolpadrão: false- Exibe a ajuda de create.
--idempotency-keystringpadrão: vazio- Reutilize esta chave de idempotência opcional ao repetir a mesma requisição.
--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.
--upload-filestringpadrão: vazio- Prepare o envio de um PNG ou JPEG local e envie seus bytes; não combine com opções do corpo JSON. A imagem não é aplicada ao checkout por este comando.
--widthintegerpadrão: 0- Defina width no corpo JSON: inteiro obrigatório.
--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.
Prepare a checkout logo upload.
POST /v1/accounts/checkout_settings/logo_uploads
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.
Read the JSON request body with --data-file PATH, or --data-file - for standard input. You can also provide the body options listed below. Repeat array options for each item. Do not combine file input with body options. Only supplied fields are sent. When listed, --body-null FIELD sends an explicit null for a nullable field. Array size and uniqueness follow the endpoint contract. Objects without dedicated body options and arrays of objects use file input.
JSON body fields:
content_type string required; allowed: "image/png", "image/jpeg"
file_size integer required
height integer required
width integer required
Nested requirements apply when the parent object is present, or for each supplied array item. Omit an optional field to leave it unspecified; null is accepted only for nullable fields.
JSON body example (save as request.json):
{
"content_type": "image/png",
"file_size": 12345,
"width": 512,
"height": 128
}
Example values are illustrative. Replace resource IDs and review the request before sending it.
Without --upload-file, this operation prepares an upload using JSON metadata and returns the API's upload instructions. Use --upload-file PATH to read a PNG or JPEG, prepare its metadata and upload its bytes. Do not combine it with --data-file or body options. With --dry-run, the file is validated locally and only the metadata request is previewed. Uploading does not apply the image: update checkout settings with the returned upload ID in a separate request.
With --upload-file, image metadata is read from the same bytes that are uploaded. The file must be PNG or JPEG, up to 524288 bytes, with width 128..2048 pixels and height 128..2048 pixels. --dry-run validates the local file and previews only the preparation request; it does not upload bytes. Apply the returned upload ID separately to change the checkout image.Exemplo do comando
Shell
raims --profile PROFILE --output json accounts checkout-settings logo-uploads create --data-file request.json --dry-run
raims accounts checkout-settings logo-uploads create --content-type="image/png" --file-size=12345 --height=128 --width=512 --dry-run
raims accounts checkout-settings logo-uploads create --upload-file image.png --dry-runraims accounts checkout-settings update
Atualize as configurações de aparência do checkout.
Shell
raims accounts checkout-settings update [flags]--body-nullstringArraypadrão: []- Envie null em um campo do corpo que aceite esse valor, usando o nome JSON; repita para outros campos e não combine com --data-file.
--data-filestringpadrão: vazio- Leia o corpo JSON de um arquivo UTF-8 ou use '-' para stdin.
--dry-runboolpadrão: false- Valide e apresente a requisição sem credenciais ou acesso à rede.
--favicon-upload-idstringpadrão: vazio- Defina favicon_upload_id no corpo JSON: texto que aceita null.
--help,-hboolpadrão: false- Exibe a ajuda de update.
--hex-primary-colorstringpadrão: vazio- Defina hex_primary_color no corpo JSON: texto.
--hex-secondary-colorstringpadrão: vazio- Defina hex_secondary_color no corpo JSON: texto.
--idempotency-keystringpadrão: vazio- Reutilize esta chave de idempotência opcional ao repetir a mesma requisição.
--logo-upload-idstringpadrão: vazio- Defina logo_upload_id no corpo JSON: texto que aceita null.
--show-headersboolpadrão: false- Mostre os headers públicos da resposta, sem credenciais ou cookies.
--support-emailstringpadrão: vazio- Defina support_email no corpo JSON: texto que aceita null.
--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.
Update checkout appearance settings.
PATCH /v1/accounts/checkout_settings
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.
Read the JSON request body with --data-file PATH, or --data-file - for standard input. You can also provide the body options listed below. Repeat array options for each item. Do not combine file input with body options. Only supplied fields are sent. When listed, --body-null FIELD sends an explicit null for a nullable field. Array size and uniqueness follow the endpoint contract. Objects without dedicated body options and arrays of objects use file input.
JSON body fields:
favicon_upload_id string optional, nullable
hex_primary_color string optional
hex_secondary_color string optional
logo_upload_id string optional, nullable
support_email string optional, nullable
Nested requirements apply when the parent object is present, or for each supplied array item. Omit an optional field to leave it unspecified; null is accepted only for nullable fields.
JSON body example (save as request.json):
{
"logo_upload_id": "cau_3AbHiWSrsZBoaTg47OcMzC",
"favicon_upload_id": "cau_1AbXiWSrsCBoaTg47OcMzC"
}
Example values are illustrative. Replace resource IDs and review the request before sending it.
HTTP 202 means the request is pending. Inspect the returned resource before repeating an operation; this command does not wait for completion.Exemplo do comando
Shell
raims --profile PROFILE --output json accounts checkout-settings update --data-file request.json --dry-run
raims accounts checkout-settings update --favicon-upload-id="cau_1AbXiWSrsCBoaTg47OcMzC" --dry-runraims accounts checkout-settings uploads
Gerencie os uploads de imagem preparados para o checkout.
Shell
raims accounts checkout-settings uploads [flags]--help,-hboolpadrão: false- Exibe a ajuda de uploads.
--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 accounts checkout-settings uploads delete.
raims accounts checkout-settings uploads delete
Descarte um upload de imagem preparado para o checkout.
Shell
raims accounts checkout-settings uploads delete 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 delete.
--idempotency-keystringpadrão: vazio- Reutilize esta chave de idempotência opcional ao repetir a mesma requisição.
--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.
Discard a prepared checkout image upload.
DELETE /v1/accounts/checkout_settings/uploads/{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 accounts checkout-settings uploads delete ID --dry-runraims accounts context
Consulte o contexto da conta autenticada.
Shell
raims accounts context [flags]--dry-runboolpadrão: false- Valide e apresente a requisição sem credenciais ou acesso à rede.
--help,-hboolpadrão: false- Ajuda para context.
--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 the authenticated account context.
GET /v1/accounts/context
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 accounts context --dry-runraims accounts fees
Consulte as tarifas da conta.
Shell
raims accounts fees [flags]--dry-runboolpadrão: false- Valide e apresente a requisição sem credenciais ou acesso à rede.
--help,-hboolpadrão: false- Exibe a ajuda de fees.
--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 account fees.
GET /v1/accounts/fees
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 accounts fees --dry-run