@perpetualsystems/typescript-sdk 0.4.0 → 0.4.2

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.
@@ -412,7 +412,7 @@ export type Detection = {
412
412
  createdByUserId: string | null;
413
413
  deleted?: boolean;
414
414
  /**
415
- * Whether to deploy the detection (required). It should only be set to true if the user explicitly asks it to be deployed.
415
+ * Whether to deploy the detection.
416
416
  */
417
417
  deploy: boolean;
418
418
  deploymentStatus: 'UNDEPLOYED' | 'DEPLOYED' | 'FAILED' | 'DEGRADED' | 'DEPLOY_PENDING' | 'DEPLOY_IN_PROGRESS' | 'UPDATE_PENDING' | 'UPDATE_IN_PROGRESS' | 'REFRESH_IN_PROGRESS' | 'ARCHIVED' | 'CLEANUP_PENDING' | 'CLEANUP_IN_PROGRESS';
@@ -5096,12 +5096,11 @@ export type ChangesetsGetResponses = {
5096
5096
  x: number;
5097
5097
  y: number;
5098
5098
  };
5099
- queries?: Array<{
5099
+ queries: Array<{
5100
5100
  id: string;
5101
5101
  name: string;
5102
5102
  query: string;
5103
5103
  }>;
5104
- query: string;
5105
5104
  spec: {
5106
5105
  [key: string]: unknown;
5107
5106
  };
@@ -5284,6 +5283,10 @@ export type ChangesetsGetResponses = {
5284
5283
  baseVersion: number | null;
5285
5284
  changesetId: string | null;
5286
5285
  changesetStatus: 'Unchanged' | 'Added' | 'Modified' | 'Deleted' | null;
5286
+ /**
5287
+ * The state connector that fills this lookup. Null for a lookup that does not use a connector. Set at create and cannot change.
5288
+ */
5289
+ connectorId?: string | null;
5287
5290
  contentPackId?: string;
5288
5291
  createdAt: string;
5289
5292
  createdByUserId: string | null;
@@ -5480,7 +5483,7 @@ export type ChangesetsGetResponses = {
5480
5483
  createdByUserId: string | null;
5481
5484
  deleted?: boolean;
5482
5485
  /**
5483
- * Whether to deploy the detection (required). It should only be set to true if the user explicitly asks it to be deployed.
5486
+ * Whether to deploy the detection.
5484
5487
  */
5485
5488
  deploy: boolean;
5486
5489
  deploymentStatus: 'UNDEPLOYED' | 'DEPLOYED' | 'FAILED' | 'DEGRADED' | 'DEPLOY_PENDING' | 'DEPLOY_IN_PROGRESS' | 'UPDATE_PENDING' | 'UPDATE_IN_PROGRESS' | 'REFRESH_IN_PROGRESS' | 'ARCHIVED' | 'CLEANUP_PENDING' | 'CLEANUP_IN_PROGRESS';
@@ -7791,6 +7794,7 @@ export type ConnectorsListBuiltinKindsResponses = {
7791
7794
  label: string;
7792
7795
  required: boolean;
7793
7796
  }>;
7797
+ datasetKind?: 'event' | 'state';
7794
7798
  description?: string;
7795
7799
  displayName: string;
7796
7800
  iconUrl?: string;
@@ -8497,7 +8501,7 @@ export type ContentListResponses = {
8497
8501
  detectionMaturity?: 'EXPERIMENTAL' | 'TEST' | 'STABLE' | 'DEPRECATED';
8498
8502
  folderPath: string;
8499
8503
  id: string;
8500
- lookupType?: 'Static' | 'Computed';
8504
+ lookupType?: 'Static' | 'Computed' | 'Connector';
8501
8505
  name: string;
8502
8506
  parentFolderId?: string | null;
8503
8507
  readOnly?: boolean;
@@ -8573,6 +8577,8 @@ export type ContentPackInstallationsListResponses = {
8573
8577
  */
8574
8578
  count: number;
8575
8579
  items: Array<{
8580
+ automaticUpdateFailed: boolean;
8581
+ automaticUpdatePending: boolean;
8576
8582
  changesetId: string | null;
8577
8583
  changesetStatus: 'Unchanged' | 'Added' | 'Modified' | 'Deleted' | null;
8578
8584
  contentPackId: string;
@@ -8580,6 +8586,7 @@ export type ContentPackInstallationsListResponses = {
8580
8586
  createdByUserId: string | null;
8581
8587
  deleted?: boolean;
8582
8588
  draftChangesetId: string | null;
8589
+ hasOpenChangesetChange: boolean;
8583
8590
  id: string;
8584
8591
  installDeployed: boolean;
8585
8592
  /**
@@ -8590,6 +8597,7 @@ export type ContentPackInstallationsListResponses = {
8590
8597
  installedReleaseVersion: number;
8591
8598
  linkMode: 'Manual' | 'Copy' | 'Automatic';
8592
8599
  name: string;
8600
+ openChangesetChangeCount: number;
8593
8601
  organizationId: string;
8594
8602
  packMeetsMinHamelinVersion: boolean;
8595
8603
  packMinHamelinVersion: string | null;
@@ -8762,6 +8770,8 @@ export type ContentPackInstallationsInstallResponses = {
8762
8770
  */
8763
8771
  installFolderId: string;
8764
8772
  installation: {
8773
+ automaticUpdateFailed: boolean;
8774
+ automaticUpdatePending: boolean;
8765
8775
  changesetId: string | null;
8766
8776
  changesetStatus: 'Unchanged' | 'Added' | 'Modified' | 'Deleted' | null;
8767
8777
  contentPackId: string;
@@ -8769,6 +8779,7 @@ export type ContentPackInstallationsInstallResponses = {
8769
8779
  createdByUserId: string | null;
8770
8780
  deleted?: boolean;
8771
8781
  draftChangesetId: string | null;
8782
+ hasOpenChangesetChange: boolean;
8772
8783
  id: string;
8773
8784
  installDeployed: boolean;
8774
8785
  /**
@@ -8779,6 +8790,7 @@ export type ContentPackInstallationsInstallResponses = {
8779
8790
  installedReleaseVersion: number;
8780
8791
  linkMode: 'Manual' | 'Copy' | 'Automatic';
8781
8792
  name: string;
8793
+ openChangesetChangeCount: number;
8782
8794
  organizationId: string;
8783
8795
  packMeetsMinHamelinVersion: boolean;
8784
8796
  packMinHamelinVersion: string | null;
@@ -8846,6 +8858,8 @@ export type ContentPackInstallationsBatchUpdateResponses = {
8846
8858
  updatedAt: string;
8847
8859
  } | null;
8848
8860
  installations: Array<{
8861
+ automaticUpdateFailed: boolean;
8862
+ automaticUpdatePending: boolean;
8849
8863
  changesetId: string | null;
8850
8864
  changesetStatus: 'Unchanged' | 'Added' | 'Modified' | 'Deleted' | null;
8851
8865
  contentPackId: string;
@@ -8853,6 +8867,7 @@ export type ContentPackInstallationsBatchUpdateResponses = {
8853
8867
  createdByUserId: string | null;
8854
8868
  deleted?: boolean;
8855
8869
  draftChangesetId: string | null;
8870
+ hasOpenChangesetChange: boolean;
8856
8871
  id: string;
8857
8872
  installDeployed: boolean;
8858
8873
  /**
@@ -8863,6 +8878,7 @@ export type ContentPackInstallationsBatchUpdateResponses = {
8863
8878
  installedReleaseVersion: number;
8864
8879
  linkMode: 'Manual' | 'Copy' | 'Automatic';
8865
8880
  name: string;
8881
+ openChangesetChangeCount: number;
8866
8882
  organizationId: string;
8867
8883
  packMeetsMinHamelinVersion: boolean;
8868
8884
  packMinHamelinVersion: string | null;
@@ -8951,6 +8967,8 @@ export type ContentPackInstallationsLinkResponses = {
8951
8967
  */
8952
8968
  installFolderId: string;
8953
8969
  installation: {
8970
+ automaticUpdateFailed: boolean;
8971
+ automaticUpdatePending: boolean;
8954
8972
  changesetId: string | null;
8955
8973
  changesetStatus: 'Unchanged' | 'Added' | 'Modified' | 'Deleted' | null;
8956
8974
  contentPackId: string;
@@ -8958,6 +8976,7 @@ export type ContentPackInstallationsLinkResponses = {
8958
8976
  createdByUserId: string | null;
8959
8977
  deleted?: boolean;
8960
8978
  draftChangesetId: string | null;
8979
+ hasOpenChangesetChange: boolean;
8961
8980
  id: string;
8962
8981
  installDeployed: boolean;
8963
8982
  /**
@@ -8968,6 +8987,7 @@ export type ContentPackInstallationsLinkResponses = {
8968
8987
  installedReleaseVersion: number;
8969
8988
  linkMode: 'Manual' | 'Copy' | 'Automatic';
8970
8989
  name: string;
8990
+ openChangesetChangeCount: number;
8971
8991
  organizationId: string;
8972
8992
  packMeetsMinHamelinVersion: boolean;
8973
8993
  packMinHamelinVersion: string | null;
@@ -9017,6 +9037,8 @@ export type ContentPackInstallationsGetByIdResponses = {
9017
9037
  * Content Pack Installation
9018
9038
  */
9019
9039
  200: {
9040
+ automaticUpdateFailed: boolean;
9041
+ automaticUpdatePending: boolean;
9020
9042
  changesetId: string | null;
9021
9043
  changesetStatus: 'Unchanged' | 'Added' | 'Modified' | 'Deleted' | null;
9022
9044
  contentPackId: string;
@@ -9024,6 +9046,7 @@ export type ContentPackInstallationsGetByIdResponses = {
9024
9046
  createdByUserId: string | null;
9025
9047
  deleted?: boolean;
9026
9048
  draftChangesetId: string | null;
9049
+ hasOpenChangesetChange: boolean;
9027
9050
  id: string;
9028
9051
  installDeployed: boolean;
9029
9052
  /**
@@ -9034,6 +9057,7 @@ export type ContentPackInstallationsGetByIdResponses = {
9034
9057
  installedReleaseVersion: number;
9035
9058
  linkMode: 'Manual' | 'Copy' | 'Automatic';
9036
9059
  name: string;
9060
+ openChangesetChangeCount: number;
9037
9061
  organizationId: string;
9038
9062
  packMeetsMinHamelinVersion: boolean;
9039
9063
  packMinHamelinVersion: string | null;
@@ -9081,6 +9105,8 @@ export type ContentPackInstallationsUpdateInstallDeployedResponses = {
9081
9105
  * Content Pack Installation
9082
9106
  */
9083
9107
  200: {
9108
+ automaticUpdateFailed: boolean;
9109
+ automaticUpdatePending: boolean;
9084
9110
  changesetId: string | null;
9085
9111
  changesetStatus: 'Unchanged' | 'Added' | 'Modified' | 'Deleted' | null;
9086
9112
  contentPackId: string;
@@ -9088,6 +9114,7 @@ export type ContentPackInstallationsUpdateInstallDeployedResponses = {
9088
9114
  createdByUserId: string | null;
9089
9115
  deleted?: boolean;
9090
9116
  draftChangesetId: string | null;
9117
+ hasOpenChangesetChange: boolean;
9091
9118
  id: string;
9092
9119
  installDeployed: boolean;
9093
9120
  /**
@@ -9098,6 +9125,7 @@ export type ContentPackInstallationsUpdateInstallDeployedResponses = {
9098
9125
  installedReleaseVersion: number;
9099
9126
  linkMode: 'Manual' | 'Copy' | 'Automatic';
9100
9127
  name: string;
9128
+ openChangesetChangeCount: number;
9101
9129
  organizationId: string;
9102
9130
  packMeetsMinHamelinVersion: boolean;
9103
9131
  packMinHamelinVersion: string | null;
@@ -9149,6 +9177,8 @@ export type ContentPackInstallationsUpdateLinkModeResponses = {
9149
9177
  * Content Pack Installation
9150
9178
  */
9151
9179
  200: {
9180
+ automaticUpdateFailed: boolean;
9181
+ automaticUpdatePending: boolean;
9152
9182
  changesetId: string | null;
9153
9183
  changesetStatus: 'Unchanged' | 'Added' | 'Modified' | 'Deleted' | null;
9154
9184
  contentPackId: string;
@@ -9156,6 +9186,7 @@ export type ContentPackInstallationsUpdateLinkModeResponses = {
9156
9186
  createdByUserId: string | null;
9157
9187
  deleted?: boolean;
9158
9188
  draftChangesetId: string | null;
9189
+ hasOpenChangesetChange: boolean;
9159
9190
  id: string;
9160
9191
  installDeployed: boolean;
9161
9192
  /**
@@ -9166,6 +9197,7 @@ export type ContentPackInstallationsUpdateLinkModeResponses = {
9166
9197
  installedReleaseVersion: number;
9167
9198
  linkMode: 'Manual' | 'Copy' | 'Automatic';
9168
9199
  name: string;
9200
+ openChangesetChangeCount: number;
9169
9201
  organizationId: string;
9170
9202
  packMeetsMinHamelinVersion: boolean;
9171
9203
  packMinHamelinVersion: string | null;
@@ -9353,6 +9385,8 @@ export type ContentPackInstallationsUpdateResponses = {
9353
9385
  * Content Pack Installation
9354
9386
  */
9355
9387
  installation: {
9388
+ automaticUpdateFailed: boolean;
9389
+ automaticUpdatePending: boolean;
9356
9390
  changesetId: string | null;
9357
9391
  changesetStatus: 'Unchanged' | 'Added' | 'Modified' | 'Deleted' | null;
9358
9392
  contentPackId: string;
@@ -9360,6 +9394,7 @@ export type ContentPackInstallationsUpdateResponses = {
9360
9394
  createdByUserId: string | null;
9361
9395
  deleted?: boolean;
9362
9396
  draftChangesetId: string | null;
9397
+ hasOpenChangesetChange: boolean;
9363
9398
  id: string;
9364
9399
  installDeployed: boolean;
9365
9400
  /**
@@ -9370,6 +9405,7 @@ export type ContentPackInstallationsUpdateResponses = {
9370
9405
  installedReleaseVersion: number;
9371
9406
  linkMode: 'Manual' | 'Copy' | 'Automatic';
9372
9407
  name: string;
9408
+ openChangesetChangeCount: number;
9373
9409
  organizationId: string;
9374
9410
  packMeetsMinHamelinVersion: boolean;
9375
9411
  packMinHamelinVersion: string | null;
@@ -9801,7 +9837,7 @@ export type ContentPacksListContentResponses = {
9801
9837
  detectionMaturity?: 'EXPERIMENTAL' | 'TEST' | 'STABLE' | 'DEPRECATED';
9802
9838
  folderPath: string;
9803
9839
  id: string;
9804
- lookupType?: 'Static' | 'Computed';
9840
+ lookupType?: 'Static' | 'Computed' | 'Connector';
9805
9841
  name: string;
9806
9842
  parentFolderId?: string | null;
9807
9843
  readOnly?: boolean;
@@ -9827,12 +9863,11 @@ export type ContentPacksDashboardsCreateData = {
9827
9863
  x: number;
9828
9864
  y: number;
9829
9865
  };
9830
- queries?: Array<{
9866
+ queries: Array<{
9831
9867
  id: string;
9832
9868
  name: string;
9833
9869
  query: string;
9834
9870
  }>;
9835
- query: string;
9836
9871
  spec: {
9837
9872
  [key: string]: unknown;
9838
9873
  };
@@ -9976,12 +10011,11 @@ export type ContentPacksDashboardsCreateResponses = {
9976
10011
  x: number;
9977
10012
  y: number;
9978
10013
  };
9979
- queries?: Array<{
10014
+ queries: Array<{
9980
10015
  id: string;
9981
10016
  name: string;
9982
10017
  query: string;
9983
10018
  }>;
9984
- query: string;
9985
10019
  spec: {
9986
10020
  [key: string]: unknown;
9987
10021
  };
@@ -10154,12 +10188,11 @@ export type ContentPacksDashboardsGetByIdResponses = {
10154
10188
  x: number;
10155
10189
  y: number;
10156
10190
  };
10157
- queries?: Array<{
10191
+ queries: Array<{
10158
10192
  id: string;
10159
10193
  name: string;
10160
10194
  query: string;
10161
10195
  }>;
10162
- query: string;
10163
10196
  spec: {
10164
10197
  [key: string]: unknown;
10165
10198
  };
@@ -10257,12 +10290,11 @@ export type ContentPacksDashboardsUpdateData = {
10257
10290
  x: number;
10258
10291
  y: number;
10259
10292
  };
10260
- queries?: Array<{
10293
+ queries: Array<{
10261
10294
  id: string;
10262
10295
  name: string;
10263
10296
  query: string;
10264
10297
  }>;
10265
- query: string;
10266
10298
  spec: {
10267
10299
  [key: string]: unknown;
10268
10300
  };
@@ -10390,12 +10422,11 @@ export type ContentPacksDashboardsUpdateResponses = {
10390
10422
  x: number;
10391
10423
  y: number;
10392
10424
  };
10393
- queries?: Array<{
10425
+ queries: Array<{
10394
10426
  id: string;
10395
10427
  name: string;
10396
10428
  query: string;
10397
10429
  }>;
10398
- query: string;
10399
10430
  spec: {
10400
10431
  [key: string]: unknown;
10401
10432
  };
@@ -13988,12 +14019,11 @@ export type ContentPacksGetContentTemplateResponses = {
13988
14019
  x: number;
13989
14020
  y: number;
13990
14021
  };
13991
- queries?: Array<{
14022
+ queries: Array<{
13992
14023
  id: string;
13993
14024
  name: string;
13994
14025
  query: string;
13995
14026
  }>;
13996
- query: string;
13997
14027
  spec: {
13998
14028
  [key: string]: unknown;
13999
14029
  };
@@ -15939,12 +15969,11 @@ export type DashboardsListResponses = {
15939
15969
  x: number;
15940
15970
  y: number;
15941
15971
  };
15942
- queries?: Array<{
15972
+ queries: Array<{
15943
15973
  id: string;
15944
15974
  name: string;
15945
15975
  query: string;
15946
15976
  }>;
15947
- query: string;
15948
15977
  spec: {
15949
15978
  [key: string]: unknown;
15950
15979
  };
@@ -16051,12 +16080,11 @@ export type DashboardsCreateData = {
16051
16080
  x: number;
16052
16081
  y: number;
16053
16082
  };
16054
- queries?: Array<{
16083
+ queries: Array<{
16055
16084
  id: string;
16056
16085
  name: string;
16057
16086
  query: string;
16058
16087
  }>;
16059
- query: string;
16060
16088
  spec: {
16061
16089
  [key: string]: unknown;
16062
16090
  };
@@ -16212,12 +16240,11 @@ export type DashboardsCreateResponses = {
16212
16240
  x: number;
16213
16241
  y: number;
16214
16242
  };
16215
- queries?: Array<{
16243
+ queries: Array<{
16216
16244
  id: string;
16217
16245
  name: string;
16218
16246
  query: string;
16219
16247
  }>;
16220
- query: string;
16221
16248
  spec: {
16222
16249
  [key: string]: unknown;
16223
16250
  };
@@ -16474,12 +16501,11 @@ export type DashboardsGetByIdResponses = {
16474
16501
  x: number;
16475
16502
  y: number;
16476
16503
  };
16477
- queries?: Array<{
16504
+ queries: Array<{
16478
16505
  id: string;
16479
16506
  name: string;
16480
16507
  query: string;
16481
16508
  }>;
16482
- query: string;
16483
16509
  spec: {
16484
16510
  [key: string]: unknown;
16485
16511
  };
@@ -16577,12 +16603,11 @@ export type DashboardsUpdateData = {
16577
16603
  x: number;
16578
16604
  y: number;
16579
16605
  };
16580
- queries?: Array<{
16606
+ queries: Array<{
16581
16607
  id: string;
16582
16608
  name: string;
16583
16609
  query: string;
16584
16610
  }>;
16585
- query: string;
16586
16611
  spec: {
16587
16612
  [key: string]: unknown;
16588
16613
  };
@@ -16725,12 +16750,11 @@ export type DashboardsUpdateResponses = {
16725
16750
  x: number;
16726
16751
  y: number;
16727
16752
  };
16728
- queries?: Array<{
16753
+ queries: Array<{
16729
16754
  id: string;
16730
16755
  name: string;
16731
16756
  query: string;
16732
16757
  }>;
16733
- query: string;
16734
16758
  spec: {
16735
16759
  [key: string]: unknown;
16736
16760
  };
@@ -17594,7 +17618,7 @@ export type DetectionCreateData = {
17594
17618
  */
17595
17619
  createCase?: boolean;
17596
17620
  /**
17597
- * Whether to deploy the detection (required). It should only be set to true if the user explicitly asks it to be deployed.
17621
+ * Whether to deploy the detection.
17598
17622
  */
17599
17623
  deploy: boolean;
17600
17624
  /**
@@ -17850,7 +17874,7 @@ export type DetectionUpdateData = {
17850
17874
  */
17851
17875
  createCase?: boolean;
17852
17876
  /**
17853
- * Whether to deploy the detection (required). It should only be set to true if the user explicitly asks it to be deployed.
17877
+ * Whether to deploy the detection.
17854
17878
  */
17855
17879
  deploy?: boolean;
17856
17880
  /**
@@ -20963,6 +20987,10 @@ export type LookupsListResponses = {
20963
20987
  archived: boolean;
20964
20988
  changesetId: string | null;
20965
20989
  changesetStatus: 'Unchanged' | 'Added' | 'Modified' | 'Deleted' | null;
20990
+ /**
20991
+ * The state connector that fills this lookup. Null for a lookup that does not use a connector. Set at create and cannot change.
20992
+ */
20993
+ connectorId?: string | null;
20966
20994
  createdAt: string;
20967
20995
  createdByUserId: string | null;
20968
20996
  deleted?: boolean;
@@ -21042,6 +21070,10 @@ export type LookupsCreateData = {
21042
21070
  body: {
21043
21071
  archived?: boolean;
21044
21072
  changesetId?: string;
21073
+ /**
21074
+ * State connector that fills this lookup. The lookup is deployed and backed by a table that reads the connector. Set at create and cannot change.
21075
+ */
21076
+ connectorId?: string;
21045
21077
  /**
21046
21078
  * Whether the lookup is deployed. A deployed lookup has a backing dataset that queries can join against.
21047
21079
  */
@@ -21050,7 +21082,10 @@ export type LookupsCreateData = {
21050
21082
  keyColumns?: Array<string>;
21051
21083
  name: string;
21052
21084
  originKey?: string;
21053
- query: string;
21085
+ /**
21086
+ * The Hamelin query. Optional when connectorId is set: the default query is FROM source | SET source_id = state.id. A custom query must start with FROM source and must output a string column source_id.
21087
+ */
21088
+ query?: string;
21054
21089
  sourceFormat?: 'parsed_lines' | 'csv';
21055
21090
  spaceId: string;
21056
21091
  };
@@ -21100,6 +21135,10 @@ export type LookupsCreateResponses = {
21100
21135
  archived: boolean;
21101
21136
  changesetId: string | null;
21102
21137
  changesetStatus: 'Unchanged' | 'Added' | 'Modified' | 'Deleted' | null;
21138
+ /**
21139
+ * The state connector that fills this lookup. Null for a lookup that does not use a connector. Set at create and cannot change.
21140
+ */
21141
+ connectorId?: string | null;
21103
21142
  createdAt: string;
21104
21143
  createdByUserId: string | null;
21105
21144
  deleted?: boolean;
@@ -21241,6 +21280,10 @@ export type LookupsGetByIdResponses = {
21241
21280
  archived: boolean;
21242
21281
  changesetId: string | null;
21243
21282
  changesetStatus: 'Unchanged' | 'Added' | 'Modified' | 'Deleted' | null;
21283
+ /**
21284
+ * The state connector that fills this lookup. Null for a lookup that does not use a connector. Set at create and cannot change.
21285
+ */
21286
+ connectorId?: string | null;
21244
21287
  createdAt: string;
21245
21288
  createdByUserId: string | null;
21246
21289
  deleted?: boolean;
@@ -21360,6 +21403,10 @@ export type LookupsUpdateResponses = {
21360
21403
  archived: boolean;
21361
21404
  changesetId: string | null;
21362
21405
  changesetStatus: 'Unchanged' | 'Added' | 'Modified' | 'Deleted' | null;
21406
+ /**
21407
+ * The state connector that fills this lookup. Null for a lookup that does not use a connector. Set at create and cannot change.
21408
+ */
21409
+ connectorId?: string | null;
21363
21410
  createdAt: string;
21364
21411
  createdByUserId: string | null;
21365
21412
  deleted?: boolean;