@roarkanalytics/cli 0.41.1 → 0.42.1

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.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,19 @@
1
1
  # Changelog
2
2
 
3
+ ## [0.42.1](https://github.com/roarkhq/cli-roark-analytics/compare/v0.42.0...v0.42.1) (2026-10-15)
4
+
5
+
6
+ ### Bug Fixes
7
+
8
+ * **deps:** raise the @roarkanalytics/sdk floor to 5.4.0 ([#107](https://github.com/roarkhq/cli-roark-analytics/issues/107)) ([518a28a](https://github.com/roarkhq/cli-roark-analytics/commit/518a28a7c04d3120182fa1a9c2e923f7157c3e8f))
9
+
10
+ ## [0.42.0](https://github.com/roarkhq/cli-roark-analytics/compare/v0.41.1...v0.42.0) (2026-10-14)
11
+
12
+
13
+ ### Features
14
+
15
+ * **cli:** cli update ([#105](https://github.com/roarkhq/cli-roark-analytics/issues/105)) ([a37560d](https://github.com/roarkhq/cli-roark-analytics/commit/a37560d504352a7c11cbcbcea8677cdb458d65a0))
16
+
3
17
  ## [0.41.1](https://github.com/roarkhq/cli-roark-analytics/compare/v0.41.0...v0.41.1) (2026-10-12)
4
18
 
5
19
 
package/README.md CHANGED
@@ -253,6 +253,12 @@ roark completion fish | source
253
253
  | `roark simulation environment get <environment-id>` | Get environment by ID |
254
254
  | `roark simulation environment list` | List environments |
255
255
  | `roark simulation environment update <environment-id>` | Update an environment |
256
+ | `roark simulation group create --name <value> --simulation-run-plan-ids <value>` | Create a simulation group |
257
+ | `roark simulation group delete <group-id>` | Delete a simulation group |
258
+ | `roark simulation group get <group-id>` | Get a simulation group |
259
+ | `roark simulation group list` | List simulation groups |
260
+ | `roark simulation group run <group-id>` | Run a simulation group |
261
+ | `roark simulation group update <group-id>` | Update a simulation group |
256
262
  | `roark simulation job get <job-id>` | Get simulation by ID |
257
263
  | `roark simulation job lookup --roark-phone-number <value>` | Lookup by phone number |
258
264
  | `roark simulation job tool-mock list <job-id>` | List mocked tool invocations |
package/commands.js CHANGED
@@ -44,6 +44,7 @@ exports.GROUPS = {
44
44
  project: 'Read projects',
45
45
  simulation: 'Manage simulations',
46
46
  'simulation environment': 'Manage simulation environments',
47
+ 'simulation group': 'Manage simulation groups',
47
48
  'simulation job': 'Read simulation jobs',
48
49
  'simulation job tool-mock': 'Read simulation job tool mocks',
49
50
  'simulation persona': 'Manage simulation personas',
@@ -3957,6 +3958,256 @@ exports.COMMANDS = [
3957
3958
  acceptsBody: true,
3958
3959
  requiresAuth: true,
3959
3960
  },
3961
+ {
3962
+ commandPath: ['simulation', 'group', 'create'],
3963
+ clientProperty: 'simulationGroup',
3964
+ methodName: 'create',
3965
+ httpMethod: 'post',
3966
+ httpPath: '/v1/simulation/group',
3967
+ summary: 'Create a simulation group',
3968
+ description: 'Saves a named set of plans to run together, again and again. Nothing runs yet: POST /v1/simulation/group/{groupId}/run starts one run of every plan and groups them into a run group with one combined report. Slack channels need Slack connected to the project. Email is on by default.',
3969
+ positionals: [],
3970
+ flags: [
3971
+ {
3972
+ name: 'name',
3973
+ path: ['name'],
3974
+ location: 'body',
3975
+ required: true,
3976
+ description: 'What to call the group.',
3977
+ valueKind: 'string',
3978
+ repeatable: false,
3979
+ },
3980
+ {
3981
+ name: 'description',
3982
+ path: ['description'],
3983
+ location: 'body',
3984
+ required: false,
3985
+ description: 'What the group is for.',
3986
+ valueKind: 'string',
3987
+ repeatable: false,
3988
+ },
3989
+ {
3990
+ name: 'simulation-run-plan-ids',
3991
+ path: ['simulationRunPlanIds'],
3992
+ location: 'body',
3993
+ required: true,
3994
+ description: 'The plans to run together, in run order (2 to 20). Duplicates are dropped.',
3995
+ valueKind: 'array',
3996
+ repeatable: true,
3997
+ },
3998
+ {
3999
+ name: 'notifications',
4000
+ path: ['notifications'],
4001
+ location: 'body',
4002
+ required: false,
4003
+ description: "Where each run's group report announces itself once it is ready.",
4004
+ valueKind: 'object',
4005
+ },
4006
+ {
4007
+ name: 'notifications.email',
4008
+ path: ['notifications', 'email'],
4009
+ location: 'body',
4010
+ required: false,
4011
+ valueKind: 'object',
4012
+ repeatable: false,
4013
+ },
4014
+ {
4015
+ name: 'notifications.slack',
4016
+ path: ['notifications', 'slack'],
4017
+ location: 'body',
4018
+ required: false,
4019
+ description: "Channels in the project's connected Slack workspace to post the report to (at most 10). Slack must be connected to the project first.",
4020
+ valueKind: 'array',
4021
+ repeatable: false,
4022
+ },
4023
+ ],
4024
+ hasParams: true,
4025
+ paramsAllOptional: false,
4026
+ bodyOpaque: false,
4027
+ bodyVariants: [],
4028
+ acceptsBody: true,
4029
+ requiresAuth: true,
4030
+ },
4031
+ {
4032
+ commandPath: ['simulation', 'group', 'delete'],
4033
+ clientProperty: 'simulationGroup',
4034
+ methodName: 'delete',
4035
+ httpMethod: 'delete',
4036
+ httpPath: '/v1/simulation/group/{groupId}',
4037
+ summary: 'Delete a simulation group',
4038
+ description: 'Deletes a saved simulation group and any schedules that run it. Run groups it already started, and their reports, stay. A group managed by config as code returns 409.',
4039
+ positionals: [
4040
+ {
4041
+ name: 'group-id',
4042
+ paramKey: 'groupId',
4043
+ description: 'The simulation group ID',
4044
+ },
4045
+ ],
4046
+ flags: [],
4047
+ hasParams: false,
4048
+ paramsAllOptional: true,
4049
+ bodyOpaque: false,
4050
+ bodyVariants: [],
4051
+ acceptsBody: false,
4052
+ requiresAuth: true,
4053
+ },
4054
+ {
4055
+ commandPath: ['simulation', 'group', 'get'],
4056
+ clientProperty: 'simulationGroup',
4057
+ methodName: 'getByID',
4058
+ httpMethod: 'get',
4059
+ httpPath: '/v1/simulation/group/{groupId}',
4060
+ summary: 'Get a simulation group',
4061
+ description: 'Returns a saved simulation group with its plans in run order and notification settings.',
4062
+ positionals: [
4063
+ {
4064
+ name: 'group-id',
4065
+ paramKey: 'groupId',
4066
+ description: 'The simulation group ID',
4067
+ },
4068
+ ],
4069
+ flags: [],
4070
+ hasParams: false,
4071
+ paramsAllOptional: true,
4072
+ bodyOpaque: false,
4073
+ bodyVariants: [],
4074
+ acceptsBody: false,
4075
+ requiresAuth: true,
4076
+ },
4077
+ {
4078
+ commandPath: ['simulation', 'group', 'list'],
4079
+ clientProperty: 'simulationGroup',
4080
+ methodName: 'list',
4081
+ httpMethod: 'get',
4082
+ httpPath: '/v1/simulation/group',
4083
+ summary: 'List simulation groups',
4084
+ description: 'Returns the saved simulation groups in the project, most recently edited first, each with its plans in run order and notification settings.',
4085
+ positionals: [],
4086
+ flags: [
4087
+ {
4088
+ name: 'limit',
4089
+ path: ['limit'],
4090
+ location: 'query',
4091
+ required: false,
4092
+ description: 'Maximum number of groups to return (default: 20, max: 100)',
4093
+ valueKind: 'integer',
4094
+ repeatable: false,
4095
+ },
4096
+ {
4097
+ name: 'offset',
4098
+ path: ['offset'],
4099
+ location: 'query',
4100
+ required: false,
4101
+ description: 'Pagination offset',
4102
+ valueKind: 'integer',
4103
+ repeatable: false,
4104
+ },
4105
+ ],
4106
+ hasParams: true,
4107
+ paramsAllOptional: true,
4108
+ bodyOpaque: false,
4109
+ bodyVariants: [],
4110
+ acceptsBody: false,
4111
+ requiresAuth: true,
4112
+ },
4113
+ {
4114
+ commandPath: ['simulation', 'group', 'run'],
4115
+ clientProperty: 'simulationGroup',
4116
+ methodName: 'run',
4117
+ httpMethod: 'post',
4118
+ httpPath: '/v1/simulation/group/{groupId}/run',
4119
+ summary: 'Run a simulation group',
4120
+ description: "Starts one run of every plan in the group, exactly as POST /v1/simulation/plan/{planId}/job would for each, and groups the runs into a run group whose combined report is announced through the group's notification settings once it is ready. This places real calls. Config-managed groups can be run here too. Returns the run group. Poll GET /v1/simulation/run-group/{groupId} until `latestReport.status` is READY. If a plan cannot start after others did, the runs that started are still grouped and the 400 names the run group id.",
4121
+ positionals: [
4122
+ {
4123
+ name: 'group-id',
4124
+ paramKey: 'groupId',
4125
+ description: 'The simulation group ID',
4126
+ },
4127
+ ],
4128
+ flags: [],
4129
+ hasParams: false,
4130
+ paramsAllOptional: true,
4131
+ bodyOpaque: false,
4132
+ bodyVariants: [],
4133
+ acceptsBody: false,
4134
+ requiresAuth: true,
4135
+ },
4136
+ {
4137
+ commandPath: ['simulation', 'group', 'update'],
4138
+ clientProperty: 'simulationGroup',
4139
+ methodName: 'update',
4140
+ httpMethod: 'put',
4141
+ httpPath: '/v1/simulation/group/{groupId}',
4142
+ summary: 'Update a simulation group',
4143
+ description: 'Edits a saved simulation group. Omitted fields keep their current value; `notifications`, when sent, replaces the settings as a whole. Run groups it already started keep theirs. A group managed by config as code (`configManaged: true`) returns 409: change it in the config file.',
4144
+ positionals: [
4145
+ {
4146
+ name: 'group-id',
4147
+ paramKey: 'groupId',
4148
+ description: 'The simulation group ID',
4149
+ },
4150
+ ],
4151
+ flags: [
4152
+ {
4153
+ name: 'name',
4154
+ path: ['name'],
4155
+ location: 'body',
4156
+ required: false,
4157
+ valueKind: 'string',
4158
+ repeatable: false,
4159
+ },
4160
+ {
4161
+ name: 'description',
4162
+ path: ['description'],
4163
+ location: 'body',
4164
+ required: false,
4165
+ description: 'Send null to clear it.',
4166
+ valueKind: 'string',
4167
+ repeatable: false,
4168
+ },
4169
+ {
4170
+ name: 'simulation-run-plan-ids',
4171
+ path: ['simulationRunPlanIds'],
4172
+ location: 'body',
4173
+ required: false,
4174
+ description: 'Replaces the plans, in run order.',
4175
+ valueKind: 'array',
4176
+ repeatable: true,
4177
+ },
4178
+ {
4179
+ name: 'notifications',
4180
+ path: ['notifications'],
4181
+ location: 'body',
4182
+ required: false,
4183
+ description: "Where each run's group report announces itself once it is ready.",
4184
+ valueKind: 'object',
4185
+ },
4186
+ {
4187
+ name: 'notifications.email',
4188
+ path: ['notifications', 'email'],
4189
+ location: 'body',
4190
+ required: false,
4191
+ valueKind: 'object',
4192
+ repeatable: false,
4193
+ },
4194
+ {
4195
+ name: 'notifications.slack',
4196
+ path: ['notifications', 'slack'],
4197
+ location: 'body',
4198
+ required: false,
4199
+ description: "Channels in the project's connected Slack workspace to post the report to (at most 10). Slack must be connected to the project first.",
4200
+ valueKind: 'array',
4201
+ repeatable: false,
4202
+ },
4203
+ ],
4204
+ hasParams: true,
4205
+ paramsAllOptional: true,
4206
+ bodyOpaque: false,
4207
+ bodyVariants: [],
4208
+ acceptsBody: true,
4209
+ requiresAuth: true,
4210
+ },
3960
4211
  {
3961
4212
  commandPath: ['simulation', 'job', 'get'],
3962
4213
  clientProperty: 'simulationJob',