@roarkanalytics/cli 0.71.0 → 0.73.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,33 @@
1
1
  # Changelog
2
2
 
3
+ ## [0.73.1](https://github.com/roarkhq/cli-roark-analytics/compare/v0.73.0...v0.73.1) (2026-11-08)
4
+
5
+
6
+ ### Bug Fixes
7
+
8
+ * **deps:** raise the @roarkanalytics/sdk floor to 7.8.0 ([#192](https://github.com/roarkhq/cli-roark-analytics/issues/192)) ([aeb5854](https://github.com/roarkhq/cli-roark-analytics/commit/aeb5854c9de80ae231354d9694ed1b36985f57db))
9
+
10
+ ## [0.73.0](https://github.com/roarkhq/cli-roark-analytics/compare/v0.72.1...v0.73.0) (2026-11-08)
11
+
12
+
13
+ ### Features
14
+
15
+ * **cli:** cli update ([#190](https://github.com/roarkhq/cli-roark-analytics/issues/190)) ([5db5b98](https://github.com/roarkhq/cli-roark-analytics/commit/5db5b980506ca814d3c33514edbc08822d06a5c6))
16
+
17
+ ## [0.72.1](https://github.com/roarkhq/cli-roark-analytics/compare/v0.72.0...v0.72.1) (2026-11-06)
18
+
19
+
20
+ ### Bug Fixes
21
+
22
+ * **deps:** raise the @roarkanalytics/sdk floor to 7.4.0 ([#188](https://github.com/roarkhq/cli-roark-analytics/issues/188)) ([b6b19f4](https://github.com/roarkhq/cli-roark-analytics/commit/b6b19f4b35c6bcef1337e0469c22727cb522957f))
23
+
24
+ ## [0.72.0](https://github.com/roarkhq/cli-roark-analytics/compare/v0.71.0...v0.72.0) (2026-11-06)
25
+
26
+
27
+ ### Features
28
+
29
+ * **cli:** cli update ([#186](https://github.com/roarkhq/cli-roark-analytics/issues/186)) ([5292ee3](https://github.com/roarkhq/cli-roark-analytics/commit/5292ee369cb8ca9fcfb2c608a9f6dcd39a7ac6b9))
30
+
3
31
  ## [0.71.0](https://github.com/roarkhq/cli-roark-analytics/compare/v0.70.1...v0.71.0) (2026-11-06)
4
32
 
5
33
 
package/README.md CHANGED
@@ -256,6 +256,19 @@ roark completion fish | source
256
256
  | `roark customer-flow list` | List customer flows |
257
257
  | `roark customer-flow update <flow-id> --off-script-policy.reaction <value> --off-script-policy.max-attempts <value> --off-script-policy.then <value>` | Update a customer flow |
258
258
 
259
+ ### customer-profile
260
+
261
+ | Command | Description |
262
+ | ------------------------------------------------------------------------------------- | -------------------------------------- |
263
+ | `roark customer-profile attribute delete <customer-profile-id> <key>` | Clear a customer profile field |
264
+ | `roark customer-profile attribute unlock <customer-profile-id> <key>` | Unlock a customer profile field |
265
+ | `roark customer-profile attribute update <customer-profile-id> <key> --value <value>` | Set a customer profile field |
266
+ | `roark customer-profile conversation list <customer-profile-id>` | List a customer's conversations |
267
+ | `roark customer-profile delete <customer-profile-id>` | Erase a customer profile |
268
+ | `roark customer-profile get <customer-profile-id>` | Get a customer profile |
269
+ | `roark customer-profile list` | List customer profiles |
270
+ | `roark customer-profile notes update <customer-profile-id> --notes <value>` | Update the notes on a customer profile |
271
+
259
272
  ### dashboard
260
273
 
261
274
  | Command | Description |
@@ -367,6 +380,7 @@ roark completion fish | source
367
380
  | `roark simulation plan job cancel <job-id>` | Cancel a simulation plan job |
368
381
  | `roark simulation plan job cost get <job-id>` | Get simulation run cost |
369
382
  | `roark simulation plan job debrief create <job-id>` | Generate simulation run debrief |
383
+ | `roark simulation plan job delete <job-id>` | Delete a simulation plan job |
370
384
  | `roark simulation plan job get <job-id>` | Get simulation plan job |
371
385
  | `roark simulation plan job list` | List simulation plan jobs |
372
386
  | `roark simulation plan job result get <job-id>` | Get simulation run results |
package/commands.js CHANGED
@@ -44,6 +44,10 @@ exports.GROUPS = {
44
44
  'customer-flow edge-case': 'Manage customer flow edge cases',
45
45
  'customer-flow graph': 'Manage customer flow graph',
46
46
  'customer-flow happy-path': 'Manage customer flow happy path',
47
+ 'customer-profile': 'Manage customer profiles',
48
+ 'customer-profile attribute': 'Manage customer profile attributes',
49
+ 'customer-profile conversation': 'Read customer profile conversations',
50
+ 'customer-profile notes': 'Manage customer profile notes',
47
51
  dashboard: 'Manage dashboards',
48
52
  'dashboard data': 'Read dashboard data',
49
53
  'dashboard widget': 'Manage dashboard widgets',
@@ -2518,6 +2522,15 @@ exports.COMMANDS = [
2518
2522
  valueKind: 'string',
2519
2523
  repeatable: false,
2520
2524
  },
2525
+ {
2526
+ name: 'customer.external-id',
2527
+ path: ['customer', 'externalId'],
2528
+ location: 'body',
2529
+ required: false,
2530
+ description: 'Your own stable id for this person. Links conversations to one customer profile where there is no phone number, such as web calls.',
2531
+ valueKind: 'string',
2532
+ repeatable: false,
2533
+ },
2521
2534
  {
2522
2535
  name: 'customers',
2523
2536
  path: ['customers'],
@@ -3769,6 +3782,362 @@ exports.COMMANDS = [
3769
3782
  acceptsBody: true,
3770
3783
  requiresAuth: true,
3771
3784
  },
3785
+ {
3786
+ commandPath: ['customer-profile', 'attribute', 'delete'],
3787
+ clientProperty: 'customerProfile',
3788
+ methodName: 'clearAttribute',
3789
+ httpMethod: 'delete',
3790
+ httpPath: '/v1/customer-profile/{customerProfileId}/attributes/{key}',
3791
+ summary: 'Clear a customer profile field',
3792
+ description: 'Removes the value and any lock, so a later conversation can fill it again.',
3793
+ positionals: [
3794
+ {
3795
+ name: 'customer-profile-id',
3796
+ paramKey: 'customerProfileId',
3797
+ },
3798
+ {
3799
+ name: 'key',
3800
+ paramKey: 'key',
3801
+ },
3802
+ ],
3803
+ flags: [],
3804
+ hasParams: true,
3805
+ paramsAllOptional: false,
3806
+ bodyOpaque: false,
3807
+ bodyVariants: [],
3808
+ acceptsBody: false,
3809
+ requiresAuth: true,
3810
+ },
3811
+ {
3812
+ commandPath: ['customer-profile', 'attribute', 'unlock'],
3813
+ clientProperty: 'customerProfile',
3814
+ methodName: 'unlockAttribute',
3815
+ httpMethod: 'post',
3816
+ httpPath: '/v1/customer-profile/{customerProfileId}/attributes/{key}/unlock',
3817
+ summary: 'Unlock a customer profile field',
3818
+ description: 'Lets newer conversations change this field again. The current value stays until one does.',
3819
+ positionals: [
3820
+ {
3821
+ name: 'customer-profile-id',
3822
+ paramKey: 'customerProfileId',
3823
+ },
3824
+ {
3825
+ name: 'key',
3826
+ paramKey: 'key',
3827
+ },
3828
+ ],
3829
+ flags: [],
3830
+ hasParams: true,
3831
+ paramsAllOptional: false,
3832
+ bodyOpaque: false,
3833
+ bodyVariants: [],
3834
+ acceptsBody: false,
3835
+ requiresAuth: true,
3836
+ },
3837
+ {
3838
+ commandPath: ['customer-profile', 'attribute', 'update'],
3839
+ clientProperty: 'customerProfile',
3840
+ methodName: 'setAttribute',
3841
+ httpMethod: 'put',
3842
+ httpPath: '/v1/customer-profile/{customerProfileId}/attributes/{key}',
3843
+ summary: 'Set a customer profile field',
3844
+ description: 'Sets the value and locks the field, so newer conversations cannot change it.',
3845
+ positionals: [
3846
+ {
3847
+ name: 'customer-profile-id',
3848
+ paramKey: 'customerProfileId',
3849
+ },
3850
+ {
3851
+ name: 'key',
3852
+ paramKey: 'key',
3853
+ },
3854
+ ],
3855
+ flags: [
3856
+ {
3857
+ name: 'value',
3858
+ path: ['value'],
3859
+ location: 'body',
3860
+ required: true,
3861
+ description: 'The new value. Setting a field locks it, so newer conversations cannot change it.',
3862
+ valueKind: 'string',
3863
+ repeatable: false,
3864
+ },
3865
+ ],
3866
+ hasParams: true,
3867
+ paramsAllOptional: false,
3868
+ bodyOpaque: false,
3869
+ bodyVariants: [],
3870
+ acceptsBody: true,
3871
+ requiresAuth: true,
3872
+ },
3873
+ {
3874
+ commandPath: ['customer-profile', 'conversation', 'list'],
3875
+ clientProperty: 'customerProfile',
3876
+ methodName: 'listConversations',
3877
+ httpMethod: 'get',
3878
+ httpPath: '/v1/customer-profile/{customerProfileId}/conversations',
3879
+ summary: "List a customer's conversations",
3880
+ description: 'Calls and chats with this customer, newest first.',
3881
+ positionals: [
3882
+ {
3883
+ name: 'customer-profile-id',
3884
+ paramKey: 'customerProfileId',
3885
+ },
3886
+ ],
3887
+ flags: [
3888
+ {
3889
+ name: 'limit',
3890
+ path: ['limit'],
3891
+ location: 'query',
3892
+ required: false,
3893
+ valueKind: 'integer',
3894
+ repeatable: false,
3895
+ },
3896
+ {
3897
+ name: 'page',
3898
+ path: ['page'],
3899
+ location: 'query',
3900
+ required: false,
3901
+ valueKind: 'integer',
3902
+ repeatable: false,
3903
+ },
3904
+ ],
3905
+ hasParams: true,
3906
+ paramsAllOptional: true,
3907
+ bodyOpaque: false,
3908
+ bodyVariants: [],
3909
+ acceptsBody: false,
3910
+ requiresAuth: true,
3911
+ },
3912
+ {
3913
+ commandPath: ['customer-profile', 'delete'],
3914
+ clientProperty: 'customerProfile',
3915
+ methodName: 'delete',
3916
+ httpMethod: 'delete',
3917
+ httpPath: '/v1/customer-profile/{customerProfileId}',
3918
+ summary: 'Erase a customer profile',
3919
+ description: 'Permanently removes the profile, its fields, evidence and notes. Conversations are kept. A new conversation from the same identifier creates a new profile.',
3920
+ positionals: [
3921
+ {
3922
+ name: 'customer-profile-id',
3923
+ paramKey: 'customerProfileId',
3924
+ },
3925
+ ],
3926
+ flags: [],
3927
+ hasParams: false,
3928
+ paramsAllOptional: true,
3929
+ bodyOpaque: false,
3930
+ bodyVariants: [],
3931
+ acceptsBody: false,
3932
+ requiresAuth: true,
3933
+ },
3934
+ {
3935
+ commandPath: ['customer-profile', 'get'],
3936
+ clientProperty: 'customerProfile',
3937
+ methodName: 'getByID',
3938
+ httpMethod: 'get',
3939
+ httpPath: '/v1/customer-profile/{customerProfileId}',
3940
+ summary: 'Get a customer profile',
3941
+ description: 'Get a customer profile',
3942
+ positionals: [
3943
+ {
3944
+ name: 'customer-profile-id',
3945
+ paramKey: 'customerProfileId',
3946
+ },
3947
+ ],
3948
+ flags: [],
3949
+ hasParams: false,
3950
+ paramsAllOptional: true,
3951
+ bodyOpaque: false,
3952
+ bodyVariants: [],
3953
+ acceptsBody: false,
3954
+ requiresAuth: true,
3955
+ },
3956
+ {
3957
+ commandPath: ['customer-profile', 'list'],
3958
+ clientProperty: 'customerProfile',
3959
+ methodName: 'list',
3960
+ httpMethod: 'get',
3961
+ httpPath: '/v1/customer-profile',
3962
+ summary: 'List customer profiles',
3963
+ description: 'Returns the people who have talked to your agents in this project. Customers we hold nothing about beyond their identifier are left out unless includeNoData is true.',
3964
+ positionals: [],
3965
+ flags: [
3966
+ {
3967
+ name: 'limit',
3968
+ path: ['limit'],
3969
+ location: 'query',
3970
+ required: false,
3971
+ valueKind: 'integer',
3972
+ repeatable: false,
3973
+ },
3974
+ {
3975
+ name: 'page',
3976
+ path: ['page'],
3977
+ location: 'query',
3978
+ required: false,
3979
+ valueKind: 'integer',
3980
+ repeatable: false,
3981
+ },
3982
+ {
3983
+ name: 'search',
3984
+ path: ['search'],
3985
+ location: 'query',
3986
+ required: false,
3987
+ valueKind: 'string',
3988
+ repeatable: false,
3989
+ },
3990
+ {
3991
+ name: 'agent-id',
3992
+ path: ['agentId'],
3993
+ location: 'query',
3994
+ required: false,
3995
+ valueKind: 'string',
3996
+ repeatable: false,
3997
+ },
3998
+ {
3999
+ name: 'modality',
4000
+ path: ['modality'],
4001
+ location: 'query',
4002
+ required: false,
4003
+ valueKind: 'string',
4004
+ enumValues: ['call', 'chat'],
4005
+ repeatable: false,
4006
+ },
4007
+ {
4008
+ name: 'include-no-data',
4009
+ path: ['includeNoData'],
4010
+ location: 'query',
4011
+ required: false,
4012
+ description: 'Include customers we hold nothing about beyond their identifier. Defaults to false.',
4013
+ valueKind: 'string',
4014
+ enumValues: ['true', 'false'],
4015
+ repeatable: false,
4016
+ },
4017
+ {
4018
+ name: 'sort-by',
4019
+ path: ['sortBy'],
4020
+ location: 'query',
4021
+ required: false,
4022
+ description: "A column, or field.<KEY> (for example field.COMPANY) to sort by a field's value. Customers without a value sort last.",
4023
+ valueKind: 'string',
4024
+ enumValues: [
4025
+ 'lastSeenAt',
4026
+ 'firstSeenAt',
4027
+ 'conversationCount',
4028
+ 'voiceCount',
4029
+ 'chatCount',
4030
+ 'talkTimeMs',
4031
+ 'displayName',
4032
+ 'field.FULL_NAME',
4033
+ 'field.PREFERRED_NAME',
4034
+ 'field.ACCOUNT_ID',
4035
+ 'field.COMPANY',
4036
+ 'field.JOB_TITLE',
4037
+ 'field.EMAIL',
4038
+ 'field.ALTERNATE_PHONE',
4039
+ 'field.AGE',
4040
+ 'field.GENDER',
4041
+ 'field.LANGUAGE',
4042
+ 'field.LOCATION',
4043
+ 'field.TIMEZONE',
4044
+ 'field.BEST_TIME_TO_REACH',
4045
+ 'field.PREFERRED_CHANNEL',
4046
+ ],
4047
+ repeatable: false,
4048
+ },
4049
+ {
4050
+ name: 'sort-direction',
4051
+ path: ['sortDirection'],
4052
+ location: 'query',
4053
+ required: false,
4054
+ valueKind: 'string',
4055
+ enumValues: ['asc', 'desc'],
4056
+ repeatable: false,
4057
+ },
4058
+ {
4059
+ name: 'field-key',
4060
+ path: ['fieldKey'],
4061
+ location: 'query',
4062
+ required: false,
4063
+ description: 'Filter by this field. Use with fieldOperator and, unless checking presence, fieldValue.',
4064
+ valueKind: 'string',
4065
+ enumValues: [
4066
+ 'FULL_NAME',
4067
+ 'PREFERRED_NAME',
4068
+ 'ACCOUNT_ID',
4069
+ 'COMPANY',
4070
+ 'JOB_TITLE',
4071
+ 'EMAIL',
4072
+ 'ALTERNATE_PHONE',
4073
+ 'AGE',
4074
+ 'GENDER',
4075
+ 'LANGUAGE',
4076
+ 'LOCATION',
4077
+ 'TIMEZONE',
4078
+ 'BEST_TIME_TO_REACH',
4079
+ 'PREFERRED_CHANNEL',
4080
+ ],
4081
+ repeatable: false,
4082
+ },
4083
+ {
4084
+ name: 'field-operator',
4085
+ path: ['fieldOperator'],
4086
+ location: 'query',
4087
+ required: false,
4088
+ description: 'How fieldValue is compared, ignoring case. NOT_EQUALS includes customers without the field.',
4089
+ valueKind: 'string',
4090
+ enumValues: ['EQUALS', 'NOT_EQUALS', 'CONTAINS', 'STARTS_WITH', 'IS_SET', 'IS_NOT_SET'],
4091
+ repeatable: false,
4092
+ },
4093
+ {
4094
+ name: 'field-value',
4095
+ path: ['fieldValue'],
4096
+ location: 'query',
4097
+ required: false,
4098
+ valueKind: 'string',
4099
+ repeatable: false,
4100
+ },
4101
+ ],
4102
+ hasParams: true,
4103
+ paramsAllOptional: true,
4104
+ bodyOpaque: false,
4105
+ bodyVariants: [],
4106
+ acceptsBody: false,
4107
+ requiresAuth: true,
4108
+ },
4109
+ {
4110
+ commandPath: ['customer-profile', 'notes', 'update'],
4111
+ clientProperty: 'customerProfile',
4112
+ methodName: 'updateNotes',
4113
+ httpMethod: 'put',
4114
+ httpPath: '/v1/customer-profile/{customerProfileId}/notes',
4115
+ summary: 'Update the notes on a customer profile',
4116
+ description: "Replaces your team's shared notes. Null or empty clears them. The last save wins.",
4117
+ positionals: [
4118
+ {
4119
+ name: 'customer-profile-id',
4120
+ paramKey: 'customerProfileId',
4121
+ },
4122
+ ],
4123
+ flags: [
4124
+ {
4125
+ name: 'notes',
4126
+ path: ['notes'],
4127
+ location: 'body',
4128
+ required: true,
4129
+ description: 'Replaces the existing notes. Null or empty clears them.',
4130
+ valueKind: 'string',
4131
+ repeatable: false,
4132
+ },
4133
+ ],
4134
+ hasParams: true,
4135
+ paramsAllOptional: false,
4136
+ bodyOpaque: false,
4137
+ bodyVariants: [],
4138
+ acceptsBody: true,
4139
+ requiresAuth: true,
4140
+ },
3772
4141
  {
3773
4142
  commandPath: ['dashboard', 'create'],
3774
4143
  clientProperty: 'dashboard',
@@ -7744,6 +8113,29 @@ exports.COMMANDS = [
7744
8113
  acceptsBody: true,
7745
8114
  requiresAuth: true,
7746
8115
  },
8116
+ {
8117
+ commandPath: ['simulation', 'plan', 'job', 'delete'],
8118
+ clientProperty: 'simulationRunPlanJob',
8119
+ methodName: 'delete',
8120
+ httpMethod: 'delete',
8121
+ httpPath: '/v1/simulation/plan/job/{jobId}',
8122
+ summary: 'Delete a simulation plan job',
8123
+ description: 'Removes a finished run from the run history (a soft delete). The run stops appearing in run lists, counts and plan run histories, and reading it by ID returns 404. A run that is still in progress is refused with 409: cancel it first.',
8124
+ positionals: [
8125
+ {
8126
+ name: 'job-id',
8127
+ paramKey: 'jobId',
8128
+ description: 'Simulation run plan job ID',
8129
+ },
8130
+ ],
8131
+ flags: [],
8132
+ hasParams: false,
8133
+ paramsAllOptional: true,
8134
+ bodyOpaque: false,
8135
+ bodyVariants: [],
8136
+ acceptsBody: false,
8137
+ requiresAuth: true,
8138
+ },
7747
8139
  {
7748
8140
  commandPath: ['simulation', 'plan', 'job', 'get'],
7749
8141
  clientProperty: 'simulationRunPlanJob',