diff --git a/README.md b/README.md index a6dbaa00..01764a18 100644 --- a/README.md +++ b/README.md @@ -43,6 +43,8 @@ See our official document: https://help.autify.com/docs/autify-command-line-inte - [`autify web api describe-scenario`](#autify-web-api-describe-scenario) - [`autify web api execute-scenarios`](#autify-web-api-execute-scenarios) - [`autify web api execute-schedule`](#autify-web-api-execute-schedule) +- [`autify web api get-credit-usage`](#autify-web-api-get-credit-usage) +- [`autify web api get-project-info`](#autify-web-api-get-project-info) - [`autify web api list-access-points`](#autify-web-api-list-access-points) - [`autify web api list-capabilities`](#autify-web-api-list-capabilities) - [`autify web api list-results`](#autify-web-api-list-results) @@ -72,7 +74,7 @@ EXAMPLES $ autify connect access-point create --name NAME --web-workspace-id ID ``` -_See code: [src/commands/connect/access-point/create.ts](https://github.com/autifyhq/autify-cli/blob/v0.40.0-beta.0/src/commands/connect/access-point/create.ts)_ +_See code: [src/commands/connect/access-point/create.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/connect/access-point/create.ts)_ ## `autify connect access-point set` @@ -98,7 +100,7 @@ EXAMPLES $ autify connect access-point set --name=NAME < key.txt ``` -_See code: [src/commands/connect/access-point/set.ts](https://github.com/autifyhq/autify-cli/blob/v0.40.0-beta.0/src/commands/connect/access-point/set.ts)_ +_See code: [src/commands/connect/access-point/set.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/connect/access-point/set.ts)_ ## `autify connect client install [VERSION]` @@ -128,7 +130,7 @@ EXAMPLES $ autify connect client install stable ``` -_See code: [src/commands/connect/client/install.ts](https://github.com/autifyhq/autify-cli/blob/v0.40.0-beta.0/src/commands/connect/client/install.ts)_ +_See code: [src/commands/connect/client/install.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/connect/client/install.ts)_ ## `autify connect client start` @@ -162,7 +164,7 @@ EXAMPLES $ autify connect client start --web-workspace-id 000 ``` -_See code: [src/commands/connect/client/start.ts](https://github.com/autifyhq/autify-cli/blob/v0.40.0-beta.0/src/commands/connect/client/start.ts)_ +_See code: [src/commands/connect/client/start.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/connect/client/start.ts)_ ## `autify help [COMMANDS]` @@ -203,7 +205,7 @@ EXAMPLES $ autify mobile api describe-test-result ``` -_See code: [src/commands/mobile/api/describe-test-result.ts](https://github.com/autifyhq/autify-cli/blob/v0.40.0-beta.0/src/commands/mobile/api/describe-test-result.ts)_ +_See code: [src/commands/mobile/api/describe-test-result.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/mobile/api/describe-test-result.ts)_ ## `autify mobile api list-test-results` @@ -227,7 +229,7 @@ EXAMPLES $ autify mobile api list-test-results ``` -_See code: [src/commands/mobile/api/list-test-results.ts](https://github.com/autifyhq/autify-cli/blob/v0.40.0-beta.0/src/commands/mobile/api/list-test-results.ts)_ +_See code: [src/commands/mobile/api/list-test-results.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/mobile/api/list-test-results.ts)_ ## `autify mobile api run-test-plan` @@ -248,7 +250,7 @@ EXAMPLES $ autify mobile api run-test-plan ``` -_See code: [src/commands/mobile/api/run-test-plan.ts](https://github.com/autifyhq/autify-cli/blob/v0.40.0-beta.0/src/commands/mobile/api/run-test-plan.ts)_ +_See code: [src/commands/mobile/api/run-test-plan.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/mobile/api/run-test-plan.ts)_ ## `autify mobile api upload-build` @@ -269,7 +271,7 @@ EXAMPLES $ autify mobile api upload-build ``` -_See code: [src/commands/mobile/api/upload-build.ts](https://github.com/autifyhq/autify-cli/blob/v0.40.0-beta.0/src/commands/mobile/api/upload-build.ts)_ +_See code: [src/commands/mobile/api/upload-build.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/mobile/api/upload-build.ts)_ ## `autify mobile auth login` @@ -292,7 +294,7 @@ EXAMPLES $ autify mobile auth login < token.txt ``` -_See code: [src/commands/mobile/auth/login.ts](https://github.com/autifyhq/autify-cli/blob/v0.40.0-beta.0/src/commands/mobile/auth/login.ts)_ +_See code: [src/commands/mobile/auth/login.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/mobile/auth/login.ts)_ ## `autify mobile build upload BUILD-PATH` @@ -326,7 +328,7 @@ EXAMPLES $ autify mobile build upload --workspace-id AAA ./my.app --json ``` -_See code: [src/commands/mobile/build/upload.ts](https://github.com/autifyhq/autify-cli/blob/v0.40.0-beta.0/src/commands/mobile/build/upload.ts)_ +_See code: [src/commands/mobile/build/upload.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/mobile/build/upload.ts)_ ## `autify mobile test run TEST-PLAN-URL` @@ -366,7 +368,7 @@ EXAMPLES --timeout 600 ``` -_See code: [src/commands/mobile/test/run.ts](https://github.com/autifyhq/autify-cli/blob/v0.40.0-beta.0/src/commands/mobile/test/run.ts)_ +_See code: [src/commands/mobile/test/run.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/mobile/test/run.ts)_ ## `autify mobile test wait TEST-RESULT-URL` @@ -390,7 +392,7 @@ EXAMPLES $ autify mobile test wait https://mobile-app.autify.com/projects/AAA/results/BBB ``` -_See code: [src/commands/mobile/test/wait.ts](https://github.com/autifyhq/autify-cli/blob/v0.40.0-beta.0/src/commands/mobile/test/wait.ts)_ +_See code: [src/commands/mobile/test/wait.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/mobile/test/wait.ts)_ ## `autify update [CHANNEL]` @@ -449,7 +451,7 @@ EXAMPLES $ autify web api create-access-point ``` -_See code: [src/commands/web/api/create-access-point.ts](https://github.com/autifyhq/autify-cli/blob/v0.40.0-beta.0/src/commands/web/api/create-access-point.ts)_ +_See code: [src/commands/web/api/create-access-point.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/web/api/create-access-point.ts)_ ## `autify web api create-url-replacement` @@ -471,7 +473,7 @@ EXAMPLES $ autify web api create-url-replacement ``` -_See code: [src/commands/web/api/create-url-replacement.ts](https://github.com/autifyhq/autify-cli/blob/v0.40.0-beta.0/src/commands/web/api/create-url-replacement.ts)_ +_See code: [src/commands/web/api/create-url-replacement.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/web/api/create-url-replacement.ts)_ ## `autify web api delete-access-point` @@ -493,7 +495,7 @@ EXAMPLES $ autify web api delete-access-point ``` -_See code: [src/commands/web/api/delete-access-point.ts](https://github.com/autifyhq/autify-cli/blob/v0.40.0-beta.0/src/commands/web/api/delete-access-point.ts)_ +_See code: [src/commands/web/api/delete-access-point.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/web/api/delete-access-point.ts)_ ## `autify web api delete-url-replacement` @@ -515,7 +517,7 @@ EXAMPLES $ autify web api delete-url-replacement ``` -_See code: [src/commands/web/api/delete-url-replacement.ts](https://github.com/autifyhq/autify-cli/blob/v0.40.0-beta.0/src/commands/web/api/delete-url-replacement.ts)_ +_See code: [src/commands/web/api/delete-url-replacement.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/web/api/delete-url-replacement.ts)_ ## `autify web api describe-result` @@ -536,7 +538,7 @@ EXAMPLES $ autify web api describe-result ``` -_See code: [src/commands/web/api/describe-result.ts](https://github.com/autifyhq/autify-cli/blob/v0.40.0-beta.0/src/commands/web/api/describe-result.ts)_ +_See code: [src/commands/web/api/describe-result.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/web/api/describe-result.ts)_ ## `autify web api describe-scenario` @@ -557,7 +559,7 @@ EXAMPLES $ autify web api describe-scenario ``` -_See code: [src/commands/web/api/describe-scenario.ts](https://github.com/autifyhq/autify-cli/blob/v0.40.0-beta.0/src/commands/web/api/describe-scenario.ts)_ +_See code: [src/commands/web/api/describe-scenario.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/web/api/describe-scenario.ts)_ ## `autify web api execute-scenarios` @@ -580,7 +582,7 @@ EXAMPLES $ autify web api execute-scenarios ``` -_See code: [src/commands/web/api/execute-scenarios.ts](https://github.com/autifyhq/autify-cli/blob/v0.40.0-beta.0/src/commands/web/api/execute-scenarios.ts)_ +_See code: [src/commands/web/api/execute-scenarios.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/web/api/execute-scenarios.ts)_ ## `autify web api execute-schedule` @@ -602,7 +604,59 @@ EXAMPLES $ autify web api execute-schedule ``` -_See code: [src/commands/web/api/execute-schedule.ts](https://github.com/autifyhq/autify-cli/blob/v0.40.0-beta.0/src/commands/web/api/execute-schedule.ts)_ +_See code: [src/commands/web/api/execute-schedule.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/web/api/execute-schedule.ts)_ + +## `autify web api get-credit-usage` + +Get the number of credits used in the project\ \ Notes:\ This endpoint works only for organizations on credit-based plans. It always returns 0 for `credits_consumed` and `credit_consumption_event_count` if your organization is on a run-based plan. + +``` +USAGE + $ autify web api get-credit-usage --project-id [--date-from ] [--date-to ] [--scenario-id ] + [--test-plan-id ] [--user-id ] + +FLAGS + --date-from= The date to start counting used credits from.\ If not specified, the date will be set to 1 + week ago.\ Up to 90 days in advance can be specified. If the specified date is more than 90 + days in the past, the date will be set to 90 days ago.\ Date must follow the format YYYY-MM-DD + (example: "2023-09-21"). + --date-to= The date to end counting used credits from.\ If not specified, the date will be set to today.\ + Date must follow the format YYYY-MM-DD (example: "2023-09-28"). + --project-id= (required) For example, 1 for the following URL: https://app.autify.com/projects/1/credits + --scenario-id= The scenario ID to filter used credits by. + --test-plan-id= The test plan ID to filter used credits by. + --user-id= The user ID that executed tests to filter used credits by. + +DESCRIPTION + Get the number of credits used in the project\ \ Notes:\ This endpoint works only for organizations on credit-based + plans. It always returns 0 for `credits_consumed` and `credit_consumption_event_count` if your organization is on a + run-based plan. + +EXAMPLES + $ autify web api get-credit-usage +``` + +_See code: [src/commands/web/api/get-credit-usage.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/web/api/get-credit-usage.ts)_ + +## `autify web api get-project-info` + +Get project information. + +``` +USAGE + $ autify web api get-project-info --project-id + +FLAGS + --project-id= (required) For example, 1 for the following URL: https://app.autify.com/projects/1/project_info + +DESCRIPTION + Get project information. + +EXAMPLES + $ autify web api get-project-info +``` + +_See code: [src/commands/web/api/get-project-info.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/web/api/get-project-info.ts)_ ## `autify web api list-access-points` @@ -623,7 +677,7 @@ EXAMPLES $ autify web api list-access-points ``` -_See code: [src/commands/web/api/list-access-points.ts](https://github.com/autifyhq/autify-cli/blob/v0.40.0-beta.0/src/commands/web/api/list-access-points.ts)_ +_See code: [src/commands/web/api/list-access-points.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/web/api/list-access-points.ts)_ ## `autify web api list-capabilities` @@ -646,7 +700,7 @@ EXAMPLES $ autify web api list-capabilities ``` -_See code: [src/commands/web/api/list-capabilities.ts](https://github.com/autifyhq/autify-cli/blob/v0.40.0-beta.0/src/commands/web/api/list-capabilities.ts)_ +_See code: [src/commands/web/api/list-capabilities.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/web/api/list-capabilities.ts)_ ## `autify web api list-results` @@ -669,7 +723,7 @@ EXAMPLES $ autify web api list-results ``` -_See code: [src/commands/web/api/list-results.ts](https://github.com/autifyhq/autify-cli/blob/v0.40.0-beta.0/src/commands/web/api/list-results.ts)_ +_See code: [src/commands/web/api/list-results.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/web/api/list-results.ts)_ ## `autify web api list-scenarios` @@ -690,7 +744,7 @@ EXAMPLES $ autify web api list-scenarios ``` -_See code: [src/commands/web/api/list-scenarios.ts](https://github.com/autifyhq/autify-cli/blob/v0.40.0-beta.0/src/commands/web/api/list-scenarios.ts)_ +_See code: [src/commands/web/api/list-scenarios.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/web/api/list-scenarios.ts)_ ## `autify web api list-url-replacements` @@ -711,7 +765,7 @@ EXAMPLES $ autify web api list-url-replacements ``` -_See code: [src/commands/web/api/list-url-replacements.ts](https://github.com/autifyhq/autify-cli/blob/v0.40.0-beta.0/src/commands/web/api/list-url-replacements.ts)_ +_See code: [src/commands/web/api/list-url-replacements.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/web/api/list-url-replacements.ts)_ ## `autify web api update-url-replacement` @@ -736,7 +790,7 @@ EXAMPLES $ autify web api update-url-replacement ``` -_See code: [src/commands/web/api/update-url-replacement.ts](https://github.com/autifyhq/autify-cli/blob/v0.40.0-beta.0/src/commands/web/api/update-url-replacement.ts)_ +_See code: [src/commands/web/api/update-url-replacement.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/web/api/update-url-replacement.ts)_ ## `autify web auth login` @@ -759,7 +813,7 @@ EXAMPLES $ autify web auth login < token.txt ``` -_See code: [src/commands/web/auth/login.ts](https://github.com/autifyhq/autify-cli/blob/v0.40.0-beta.0/src/commands/web/auth/login.ts)_ +_See code: [src/commands/web/auth/login.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/web/auth/login.ts)_ ## `autify web test run SCENARIO-OR-TEST-PLAN-URL` @@ -838,7 +892,7 @@ EXAMPLES $ autify web test run https://app.autify.com/projects/0000/scenarios/0000 --wait --autify-connect-client ``` -_See code: [src/commands/web/test/run.ts](https://github.com/autifyhq/autify-cli/blob/v0.40.0-beta.0/src/commands/web/test/run.ts)_ +_See code: [src/commands/web/test/run.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/web/test/run.ts)_ ## `autify web test wait TEST-RESULT-URL` @@ -862,6 +916,6 @@ EXAMPLES $ autify web test wait https://app.autify.com/projects/0000/results/0000 ``` -_See code: [src/commands/web/test/wait.ts](https://github.com/autifyhq/autify-cli/blob/v0.40.0-beta.0/src/commands/web/test/wait.ts)_ +_See code: [src/commands/web/test/wait.ts](https://github.com/autifyhq/autify-cli/blob/v0.41.0-beta.0/src/commands/web/test/wait.ts)_ diff --git a/integration-test/package.json b/integration-test/package.json index 7fcdcc8c..97debd93 100644 --- a/integration-test/package.json +++ b/integration-test/package.json @@ -1,6 +1,6 @@ { "name": "@autifyhq/autify-cli-integration-test", - "version": "0.40.0-beta.0", + "version": "0.41.0-beta.0", "description": "Autify Command Line Interface (CLI) Integration Test", "author": "Autify", "bin": { diff --git a/package-lock.json b/package-lock.json index 06e579f6..e21782c3 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@autifyhq/autify-cli", - "version": "0.40.0-beta.0", + "version": "0.41.0-beta.0", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "@autifyhq/autify-cli", - "version": "0.40.0-beta.0", + "version": "0.41.0-beta.0", "hasInstallScript": true, "license": "MIT", "workspaces": [ @@ -79,7 +79,7 @@ }, "integration-test": { "name": "@autifyhq/autify-cli-integration-test", - "version": "0.40.0-beta.0", + "version": "0.41.0-beta.0", "license": "MIT", "dependencies": { "@pollyjs/adapter-node-http": "^6.0.6", diff --git a/package.json b/package.json index a1dfb1e4..eddc726d 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@autifyhq/autify-cli", - "version": "0.40.0-beta.0", + "version": "0.41.0-beta.0", "description": "Autify Command Line Interface (CLI)", "author": "Autify", "bin": {