postman-cli-completion 1.48.0 → 1.49.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.
@@ -1,4 +1,4 @@
1
- # Bash completion for Postman CLI (postman v1.48.0)
1
+ # Bash completion for Postman CLI (postman v1.49.0)
2
2
  # Auto-generated by scripts/generate.mjs — DO NOT EDIT
3
3
  # Source: spec/commands.json
4
4
  # https://github.com/yokawasa/postman-cli-completion
@@ -444,7 +444,7 @@ _postman_performance() {
444
444
 
445
445
  _postman_performance_run() {
446
446
  if [[ "$cur" == -* ]]; then
447
- COMPREPLY=( $(compgen -W "-e --environment -g --globals --vu-count -d --duration -p --load-profile --data-file --postman-api-key --pass-if -h --help" -- "$cur") )
447
+ COMPREPLY=( $(compgen -W "-e --environment -g --globals --vu-count -d --duration -p --load-profile --data-file --dataset-id --dataset-view-id --dataset-distribution --postman-api-key --pass-if -h --help" -- "$cur") )
448
448
  return 0
449
449
  fi
450
450
  case "$prev" in
@@ -519,7 +519,7 @@ _postman_flows_deploy() {
519
519
 
520
520
  _postman_flows_run() {
521
521
  if [[ "$cur" == -* ]]; then
522
- COMPREPLY=( $(compgen -W "-i --input -f --input-file -s --scenario -e --environment --working-dir --verbose --no-truncate --output --reporters -x --suppress-exit-code --workspace --verbose --debug --json -h --help" -- "$cur") )
522
+ COMPREPLY=( $(compgen -W "-i --input -f --input-file -s --scenario --iteration-data-dataset --iteration-data-view -m --map-column -e --environment --working-dir --no-insecure-file-read --verbose --no-truncate --output --reporters -x --suppress-exit-code --workspace --verbose --debug --json -h --help" -- "$cur") )
523
523
  return 0
524
524
  fi
525
525
  case "$prev" in
@@ -529,6 +529,9 @@ _postman_flows_run() {
529
529
  -f|--input-file)
530
530
  _postman_filematch '!*.@(json)' "$cur"
531
531
  return 0 ;;
532
+ --iteration-data-dataset)
533
+ _postman_filematch '!*.@(json|csv)' "$cur"
534
+ return 0 ;;
532
535
  -e|--environment)
533
536
  _postman_filematch '!*.@(json)' "$cur"
534
537
  return 0 ;;
@@ -1066,7 +1069,7 @@ _postman_webhook() {
1066
1069
  if [[ "$cur" == -* ]]; then
1067
1070
  COMPREPLY=( $(compgen -W "-h --help" -- "$cur") )
1068
1071
  else
1069
- COMPREPLY=( $(compgen -W "create start pause list delete status requests forward" -- "$cur") )
1072
+ COMPREPLY=( $(compgen -W "create start pause list delete status requests scripts forward" -- "$cur") )
1070
1073
  fi
1071
1074
  return 0
1072
1075
  fi
@@ -1078,6 +1081,7 @@ _postman_webhook() {
1078
1081
  delete) _postman_webhook_delete ;;
1079
1082
  status) _postman_webhook_status ;;
1080
1083
  requests) _postman_webhook_requests ;;
1084
+ scripts) _postman_webhook_scripts ;;
1081
1085
  forward) _postman_webhook_forward ;;
1082
1086
  esac
1083
1087
  }
@@ -1184,7 +1188,7 @@ _postman_webhook_requests_list() {
1184
1188
 
1185
1189
  _postman_webhook_requests_describe() {
1186
1190
  if [[ "$cur" == -* ]]; then
1187
- COMPREPLY=( $(compgen -W "-w --workspace --api-key -h --help" -- "$cur") )
1191
+ COMPREPLY=( $(compgen -W "-w --workspace --api-key --verbose -h --help" -- "$cur") )
1188
1192
  return 0
1189
1193
  fi
1190
1194
  case "$prev" in
@@ -1206,6 +1210,32 @@ _postman_webhook_requests_replay() {
1206
1210
  esac
1207
1211
  }
1208
1212
 
1213
+ _postman_webhook_scripts() {
1214
+ if [[ -z "$subcmd" ]]; then
1215
+ if [[ "$cur" == -* ]]; then
1216
+ COMPREPLY=( $(compgen -W "-h --help" -- "$cur") )
1217
+ else
1218
+ COMPREPLY=( $(compgen -W "set" -- "$cur") )
1219
+ fi
1220
+ return 0
1221
+ fi
1222
+ case "$subcmd" in
1223
+ set) _postman_webhook_scripts_set ;;
1224
+ esac
1225
+ }
1226
+
1227
+ _postman_webhook_scripts_set() {
1228
+ if [[ "$cur" == -* ]]; then
1229
+ COMPREPLY=( $(compgen -W "--event -w --workspace --api-key -h --help" -- "$cur") )
1230
+ return 0
1231
+ fi
1232
+ case "$prev" in
1233
+ --api-key)
1234
+ _postman_filematch '!*.@(pem|crt|key)' "$cur"
1235
+ return 0 ;;
1236
+ esac
1237
+ }
1238
+
1209
1239
  _postman_webhook_forward() {
1210
1240
  if [[ "$cur" == -* ]]; then
1211
1241
  COMPREPLY=( $(compgen -W "-w --workspace --api-key -h --help" -- "$cur") )
@@ -1,4 +1,4 @@
1
- # Fish completion for Postman CLI (postman v1.48.0)
1
+ # Fish completion for Postman CLI (postman v1.49.0)
2
2
  # Auto-generated by scripts/generate.mjs — DO NOT EDIT
3
3
  # Source: spec/commands.json
4
4
  # https://github.com/yokawasa/postman-cli-completion
@@ -247,6 +247,9 @@ complete -c postman -n '__fish_seen_subcommand_from performance; and __fish_seen
247
247
  complete -c postman -n '__fish_seen_subcommand_from performance; and __fish_seen_subcommand_from run' -s d -l duration -d 'Duration of the performance test in minutes (default: 1)' -x
248
248
  complete -c postman -n '__fish_seen_subcommand_from performance; and __fish_seen_subcommand_from run' -s p -l load-profile -d 'Load profile type: fixed, ramp-up, spike, peak (default: "ramp-up")' -x
249
249
  complete -c postman -n '__fish_seen_subcommand_from performance; and __fish_seen_subcommand_from run' -l data-file -d 'Path to a JSON or CSV data file to use with the collection' -r
250
+ complete -c postman -n '__fish_seen_subcommand_from performance; and __fish_seen_subcommand_from run' -l dataset-id -d 'Use a Postman Dataset as iteration data (with --dataset-view-id)' -x
251
+ complete -c postman -n '__fish_seen_subcommand_from performance; and __fish_seen_subcommand_from run' -l dataset-view-id -d 'Dataset view to execute for iteration data (requires --dataset-id)' -x
252
+ complete -c postman -n '__fish_seen_subcommand_from performance; and __fish_seen_subcommand_from run' -l dataset-distribution -d 'How rows map to VUs: round-robin (default), fixed, random' -x
250
253
  complete -c postman -n '__fish_seen_subcommand_from performance; and __fish_seen_subcommand_from run' -l postman-api-key -d 'API Key used to load the resources from the Postman API (Only supported in the US region, use \'postman login --region\' to authenticate instead)' -x
251
254
  complete -c postman -n '__fish_seen_subcommand_from performance; and __fish_seen_subcommand_from run' -l pass-if -d 'Pass condition in format: function(metric, value). Functions: less_than, greater_than, less_than_eq, greater_than_eq. Metrics: avg, p90, p95, p99, error_rate, rps. Example: less_than(p95, 500) or less_than(error_rate, 5)' -x
252
255
  complete -c postman -n '__fish_seen_subcommand_from performance; and __fish_seen_subcommand_from run' -s h -l help -d 'display help for command'
@@ -295,8 +298,12 @@ complete -c postman -n '__fish_seen_subcommand_from flows; and __fish_seen_subco
295
298
  complete -c postman -n '__fish_seen_subcommand_from flows; and __fish_seen_subcommand_from run' -s i -l input -d 'Set flow inputs as key=value pairs (e.g. --input foo=bar --input baz=qux) (default: [])' -r
296
299
  complete -c postman -n '__fish_seen_subcommand_from flows; and __fish_seen_subcommand_from run' -s f -l input-file -d 'Set flow inputs from JSON files (e.g. --input-file ./inputs.json --input-file ./config.json) (default: [])' -r
297
300
  complete -c postman -n '__fish_seen_subcommand_from flows; and __fish_seen_subcommand_from run' -s s -l scenario -d 'Use a pre-built scenario as flow inputs (by scenario name). Can be combined with --input and --input-file to override values.' -x
301
+ complete -c postman -n '__fish_seen_subcommand_from flows; and __fish_seen_subcommand_from run' -l iteration-data-dataset -d '[BETA] Run the flow once per row of a dataset view. Accepts a local .dataset.yaml path or a cloud dataset id (cloud requires login). Requires --iteration-data-view. Dataset columns feed the flow inputs (see --map-column).' -r
302
+ complete -c postman -n '__fish_seen_subcommand_from flows; and __fish_seen_subcommand_from run' -l iteration-data-view -d '[BETA] Name or id of the view (within --iteration-data-dataset) whose rows drive the run.' -x
303
+ complete -c postman -n '__fish_seen_subcommand_from flows; and __fish_seen_subcommand_from run' -s m -l map-column -d '[BETA] Bind a flow input to a dataset column (e.g. -m isActive=active). Repeatable. Inputs whose name matches a column bind automatically. (default: [])' -x
298
304
  complete -c postman -n '__fish_seen_subcommand_from flows; and __fish_seen_subcommand_from run' -s e -l environment -d 'Specify a path to a Postman Environment file (JSON or YAML)' -r
299
305
  complete -c postman -n '__fish_seen_subcommand_from flows; and __fish_seen_subcommand_from run' -l working-dir -d 'Specify the path to the working directory' -x
306
+ complete -c postman -n '__fish_seen_subcommand_from flows; and __fish_seen_subcommand_from run' -l no-insecure-file-read -d 'Prevent reading dataset files situated outside of the working directory (applies to --iteration-data-dataset)'
300
307
  complete -c postman -n '__fish_seen_subcommand_from flows; and __fish_seen_subcommand_from run' -l verbose -d 'Show detailed information of flow run and each request (method, URL, assertions)'
301
308
  complete -c postman -n '__fish_seen_subcommand_from flows; and __fish_seen_subcommand_from run' -l no-truncate -d 'Show full output without truncating long values'
302
309
  complete -c postman -n '__fish_seen_subcommand_from flows; and __fish_seen_subcommand_from run' -l output -d 'Save execution result to a file (supported: json)' -x
@@ -595,14 +602,15 @@ complete -c postman -n '__fish_seen_subcommand_from search; and __fish_seen_subc
595
602
  complete -c postman -n '__fish_seen_subcommand_from search; and __fish_seen_subcommand_from documents' -s h -l help -d 'display help for command'
596
603
 
597
604
  # ---------- webhook ----------
598
- complete -c postman -n '__postman_using_subcommand webhook create start pause list delete status requests forward' -a create -d 'Create a new webhook and print its public URL.'
599
- complete -c postman -n '__postman_using_subcommand webhook create start pause list delete status requests forward' -a start -d 'Activate a webhook so it can receive requests.'
600
- complete -c postman -n '__postman_using_subcommand webhook create start pause list delete status requests forward' -a pause -d 'Pause a webhook so it no longer accepts requests.'
601
- complete -c postman -n '__postman_using_subcommand webhook create start pause list delete status requests forward' -a list -d 'List all webhooks in a workspace.'
602
- complete -c postman -n '__postman_using_subcommand webhook create start pause list delete status requests forward' -a delete -d 'Permanently delete a webhook.'
603
- complete -c postman -n '__postman_using_subcommand webhook create start pause list delete status requests forward' -a status -d 'Show details for a webhook.'
604
- complete -c postman -n '__postman_using_subcommand webhook create start pause list delete status requests forward' -a requests -d 'List, inspect, and replay requests received by a webhook.'
605
- complete -c postman -n '__postman_using_subcommand webhook create start pause list delete status requests forward' -a forward -d 'Forward incoming webhook requests to a local port.'
605
+ complete -c postman -n '__postman_using_subcommand webhook create start pause list delete status requests scripts forward' -a create -d 'Create a new webhook and print its public URL.'
606
+ complete -c postman -n '__postman_using_subcommand webhook create start pause list delete status requests scripts forward' -a start -d 'Activate a webhook so it can receive requests.'
607
+ complete -c postman -n '__postman_using_subcommand webhook create start pause list delete status requests scripts forward' -a pause -d 'Pause a webhook so it no longer accepts requests.'
608
+ complete -c postman -n '__postman_using_subcommand webhook create start pause list delete status requests scripts forward' -a list -d 'List all webhooks in a workspace.'
609
+ complete -c postman -n '__postman_using_subcommand webhook create start pause list delete status requests scripts forward' -a delete -d 'Permanently delete a webhook.'
610
+ complete -c postman -n '__postman_using_subcommand webhook create start pause list delete status requests scripts forward' -a status -d 'Show details for a webhook.'
611
+ complete -c postman -n '__postman_using_subcommand webhook create start pause list delete status requests scripts forward' -a requests -d 'List, inspect, and replay requests received by a webhook.'
612
+ complete -c postman -n '__postman_using_subcommand webhook create start pause list delete status requests scripts forward' -a scripts -d 'Create or update scripts executed by a webhook.'
613
+ complete -c postman -n '__postman_using_subcommand webhook create start pause list delete status requests scripts forward' -a forward -d 'Forward incoming webhook requests to a local port.'
606
614
  complete -c postman -n '__fish_seen_subcommand_from webhook' -s h -l help -d 'display help for command'
607
615
  # ---------- webhook create ----------
608
616
  complete -c postman -n '__fish_seen_subcommand_from webhook; and __fish_seen_subcommand_from create' -s t -l title -d 'Name for the webhook (default: "CLI Webhook")' -x
@@ -642,11 +650,20 @@ complete -c postman -n '__fish_seen_subcommand_from webhook; and __fish_seen_sub
642
650
  # ---------- webhook requests describe ----------
643
651
  complete -c postman -n '__fish_seen_subcommand_from webhook; and __fish_seen_subcommand_from requests; and __fish_seen_subcommand_from describe' -s w -l workspace -d 'Postman workspace ID (falls back to .postman/resources.yaml or .postman/config.json)' -x
644
652
  complete -c postman -n '__fish_seen_subcommand_from webhook; and __fish_seen_subcommand_from requests; and __fish_seen_subcommand_from describe' -l api-key -d 'Postman API key' -r
653
+ complete -c postman -n '__fish_seen_subcommand_from webhook; and __fish_seen_subcommand_from requests; and __fish_seen_subcommand_from describe' -l verbose -d 'Show script execution logs'
645
654
  complete -c postman -n '__fish_seen_subcommand_from webhook; and __fish_seen_subcommand_from requests; and __fish_seen_subcommand_from describe' -s h -l help -d 'display help for command'
646
655
  # ---------- webhook requests replay ----------
647
656
  complete -c postman -n '__fish_seen_subcommand_from webhook; and __fish_seen_subcommand_from requests; and __fish_seen_subcommand_from replay' -s w -l workspace -d 'Postman workspace ID (falls back to .postman/resources.yaml or .postman/config.json)' -x
648
657
  complete -c postman -n '__fish_seen_subcommand_from webhook; and __fish_seen_subcommand_from requests; and __fish_seen_subcommand_from replay' -l api-key -d 'Postman API key' -r
649
658
  complete -c postman -n '__fish_seen_subcommand_from webhook; and __fish_seen_subcommand_from requests; and __fish_seen_subcommand_from replay' -s h -l help -d 'display help for command'
659
+ # ---------- webhook scripts ----------
660
+ complete -c postman -n '__postman_using_subcommand scripts set' -a set -d 'Create or update a webhook script from a JavaScript or TypeScript file.'
661
+ complete -c postman -n '__fish_seen_subcommand_from webhook; and __fish_seen_subcommand_from scripts' -s h -l help -d 'display help for command'
662
+ # ---------- webhook scripts set ----------
663
+ complete -c postman -n '__fish_seen_subcommand_from webhook; and __fish_seen_subcommand_from scripts; and __fish_seen_subcommand_from set' -l event -d 'Script event: onEvent or onResponse' -x
664
+ complete -c postman -n '__fish_seen_subcommand_from webhook; and __fish_seen_subcommand_from scripts; and __fish_seen_subcommand_from set' -s w -l workspace -d 'Postman workspace ID (falls back to .postman/resources.yaml or .postman/config.json)' -x
665
+ complete -c postman -n '__fish_seen_subcommand_from webhook; and __fish_seen_subcommand_from scripts; and __fish_seen_subcommand_from set' -l api-key -d 'Postman API key' -r
666
+ complete -c postman -n '__fish_seen_subcommand_from webhook; and __fish_seen_subcommand_from scripts; and __fish_seen_subcommand_from set' -s h -l help -d 'display help for command'
650
667
  # ---------- webhook forward ----------
651
668
  complete -c postman -n '__fish_seen_subcommand_from webhook; and __fish_seen_subcommand_from forward' -s w -l workspace -d 'Postman workspace ID' -x
652
669
  complete -c postman -n '__fish_seen_subcommand_from webhook; and __fish_seen_subcommand_from forward' -l api-key -d 'Postman API key' -r
@@ -1,6 +1,6 @@
1
1
  #compdef postman
2
2
  compdef _postman postman
3
- # Zsh completion for Postman CLI (postman v1.48.0)
3
+ # Zsh completion for Postman CLI (postman v1.49.0)
4
4
  # Auto-generated by scripts/generate.mjs — DO NOT EDIT
5
5
  # Source: spec/commands.json
6
6
  # https://github.com/yokawasa/postman-cli-completion
@@ -525,6 +525,9 @@ _postman_performance_run() {
525
525
  '(-d --duration)'{-d,--duration}'[Duration of the performance test in minutes (default\: 1)]:minutes' \
526
526
  '(-p --load-profile)'{-p,--load-profile}'[Load profile type\: fixed, ramp-up, spike, peak (default\: "ramp-up")]:profile' \
527
527
  '--data-file[Path to a JSON or CSV data file to use with the collection]:path:_files -g "*.json"' \
528
+ '--dataset-id[Use a Postman Dataset as iteration data (with --dataset-view-id)]:id' \
529
+ '--dataset-view-id[Dataset view to execute for iteration data (requires --dataset-id)]:id' \
530
+ '--dataset-distribution[How rows map to VUs\: round-robin (default), fixed, random]:strategy' \
528
531
  '--postman-api-key[API Key used to load the resources from the Postman API (Only supported in the US region, use '\''postman login --region'\'' to authenticate instead)]:apiKey' \
529
532
  '--pass-if[Pass condition in format\: function(metric, value). Functions\: less_than, greater_than, less_than_eq, greater_than_eq. Metrics\: avg, p90, p95, p99, error_rate, rps. Example\: less_than(p95, 500) or less_than(error_rate, 5)]:condition' \
530
533
  '(-h --help)'{-h,--help}'[display help for command]' \
@@ -613,8 +616,12 @@ _postman_flows_run() {
613
616
  '(-i --input)'{-i,--input}'[Set flow inputs as key=value pairs (e.g. --input foo=bar --input baz=qux) (default\: \[\])]:key=value:_files -g "*.(pem|crt|key)"' \
614
617
  '(-f --input-file)'{-f,--input-file}'[Set flow inputs from JSON files (e.g. --input-file ./inputs.json --input-file ./config.json) (default\: \[\])]:path.json:_files -g "*.json"' \
615
618
  '(-s --scenario)'{-s,--scenario}'[Use a pre-built scenario as flow inputs (by scenario name). Can be combined with --input and --input-file to override values.]:name' \
619
+ '--iteration-data-dataset[\[BETA\] Run the flow once per row of a dataset view. Accepts a local .dataset.yaml path or a cloud dataset id (cloud requires login). Requires --iteration-data-view. Dataset columns feed the flow inputs (see --map-column).]:pathOrId:_files -g "*.(json|csv)"' \
620
+ '--iteration-data-view[\[BETA\] Name or id of the view (within --iteration-data-dataset) whose rows drive the run.]:nameOrId' \
621
+ '(-m --map-column)'{-m,--map-column}'[\[BETA\] Bind a flow input to a dataset column (e.g. -m isActive=active). Repeatable. Inputs whose name matches a column bind automatically. (default\: \[\])]:input=column' \
616
622
  '(-e --environment)'{-e,--environment}'[Specify a path to a Postman Environment file (JSON or YAML)]:path:_files -g "*.json"' \
617
623
  '--working-dir[Specify the path to the working directory]:path:_files -/' \
624
+ '--no-insecure-file-read[Prevent reading dataset files situated outside of the working directory (applies to --iteration-data-dataset)]' \
618
625
  '--verbose[Show detailed information of flow run and each request (method, URL, assertions)]' \
619
626
  '--no-truncate[Show full output without truncating long values]' \
620
627
  '--output[Save execution result to a file (supported\: json)]:format' \
@@ -1337,6 +1344,7 @@ _postman_webhook() {
1337
1344
  delete) _postman_webhook_delete ;;
1338
1345
  status) _postman_webhook_status ;;
1339
1346
  requests) _postman_webhook_requests ;;
1347
+ scripts) _postman_webhook_scripts ;;
1340
1348
  forward) _postman_webhook_forward ;;
1341
1349
  esac
1342
1350
  ;;
@@ -1353,6 +1361,7 @@ _postman_webhook_commands() {
1353
1361
  'delete:Permanently delete a webhook.'
1354
1362
  'status:Show details for a webhook.'
1355
1363
  'requests:List, inspect, and replay requests received by a webhook.'
1364
+ 'scripts:Create or update scripts executed by a webhook.'
1356
1365
  'forward:Forward incoming webhook requests to a local port.'
1357
1366
  )
1358
1367
  _describe -t commands 'webhook command' sub
@@ -1446,6 +1455,7 @@ _postman_webhook_requests_describe() {
1446
1455
  _arguments \
1447
1456
  '(-w --workspace)'{-w,--workspace}'[Postman workspace ID (falls back to .postman/resources.yaml or .postman/config.json)]:workspaceId' \
1448
1457
  '--api-key[Postman API key]:key:_files -g "*.(pem|crt|key)"' \
1458
+ '--verbose[Show script execution logs]' \
1449
1459
  '(-h --help)'{-h,--help}'[display help for command]' \
1450
1460
  '*:requestId:'
1451
1461
  }
@@ -1458,6 +1468,39 @@ _postman_webhook_requests_replay() {
1458
1468
  '*:requestId:'
1459
1469
  }
1460
1470
 
1471
+ _postman_webhook_scripts() {
1472
+ local context state state_descr line
1473
+ typeset -A opt_args
1474
+ _arguments -C \
1475
+ '(-h --help)'{-h,--help}'[display help for command]' \
1476
+ '1: :_postman_webhook_scripts_commands' \
1477
+ '*::arg:->args'
1478
+ case $state in
1479
+ args)
1480
+ case $words[1] in
1481
+ set) _postman_webhook_scripts_set ;;
1482
+ esac
1483
+ ;;
1484
+ esac
1485
+ }
1486
+
1487
+ _postman_webhook_scripts_commands() {
1488
+ local -a sub
1489
+ sub=(
1490
+ 'set:Create or update a webhook script from a JavaScript or TypeScript file.'
1491
+ )
1492
+ _describe -t commands 'scripts command' sub
1493
+ }
1494
+
1495
+ _postman_webhook_scripts_set() {
1496
+ _arguments \
1497
+ '--event[Script event\: onEvent or onResponse]:event' \
1498
+ '(-w --workspace)'{-w,--workspace}'[Postman workspace ID (falls back to .postman/resources.yaml or .postman/config.json)]:workspaceId' \
1499
+ '--api-key[Postman API key]:key:_files -g "*.(pem|crt|key)"' \
1500
+ '(-h --help)'{-h,--help}'[display help for command]' \
1501
+ '*:scriptPath:'
1502
+ }
1503
+
1461
1504
  _postman_webhook_forward() {
1462
1505
  _arguments \
1463
1506
  '(-w --workspace)'{-w,--workspace}'[Postman workspace ID]:workspaceId' \
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "postman-cli-completion",
3
- "version": "1.48.0",
3
+ "version": "1.49.0",
4
4
  "description": "Shell completions for the Postman CLI (zsh, bash, fish)",
5
5
  "type": "module",
6
6
  "bin": {