@groundcover/api-client 0.10.0 → 0.11.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.
@@ -5975,12 +5975,25 @@ export type ServiceAccountsWithPolicy = {
5975
5975
  serviceAccountId?: string;
5976
5976
  };
5977
5977
  export type Session = {
5978
+ /**
5979
+ * AppVersion is the mobile application version. Empty for web sessions, which
5980
+ * report ReleaseID instead.
5981
+ */
5982
+ appVersion?: string;
5978
5983
  browser?: string;
5979
5984
  country?: string;
5985
+ deviceBrand?: string;
5986
+ deviceModel?: string;
5980
5987
  durationMilli?: number;
5981
5988
  endTime?: string;
5982
5989
  hasSessionReplay?: number;
5983
5990
  isMobile?: string;
5991
+ /**
5992
+ * Mobile RUM. Empty for web sessions, which report browser.* instead. The client
5993
+ * platform is not returned: it is a filter dimension only.
5994
+ */
5995
+ osName?: string;
5996
+ osVersion?: string;
5984
5997
  pageCount?: number;
5985
5998
  releaseId?: string;
5986
5999
  serviceName?: string;
@@ -5992,6 +6005,11 @@ export type Session = {
5992
6005
  userOrganization?: string;
5993
6006
  };
5994
6007
  export type SessionDetailsRequestParams = {
6008
+ /**
6009
+ * Category selects the platform to query: 'rum' for web RUM, 'mobile-rum' for
6010
+ * React Native. Defaults to 'rum' when omitted.
6011
+ */
6012
+ category?: 'rum' | 'mobile-rum';
5995
6013
  conditions?: Array<Condition>;
5996
6014
  end?: string;
5997
6015
  sessionID?: string;
@@ -6069,6 +6087,11 @@ export type SessionReplayVelocityResponse = {
6069
6087
  series?: Array<MetricVelocityWithLabels>;
6070
6088
  };
6071
6089
  export type SessionsFiltersRequestParams = {
6090
+ /**
6091
+ * Category selects the platform to query: 'rum' for web RUM, 'mobile-rum' for
6092
+ * React Native. Defaults to 'rum' when omitted.
6093
+ */
6094
+ category?: 'rum' | 'mobile-rum';
6072
6095
  conditions?: Array<Condition>;
6073
6096
  end?: string;
6074
6097
  required?: Array<Column>;
@@ -6079,11 +6102,21 @@ export type SessionsFiltersResponse = {
6079
6102
  filters?: FiltersWithEstimatedMapResponse;
6080
6103
  };
6081
6104
  export type SessionsQueryRequestParams = {
6105
+ /**
6106
+ * Category selects the platform to query: 'rum' for web RUM, 'mobile-rum' for
6107
+ * React Native. Defaults to 'rum' when omitted.
6108
+ */
6109
+ category?: 'rum' | 'mobile-rum';
6082
6110
  conditions?: Array<Condition>;
6083
6111
  end?: string;
6084
6112
  limit?: number;
6085
6113
  skip?: number;
6086
- sortBy?: string;
6114
+ /**
6115
+ * Interpolated raw into ORDER BY, so this list is the only guard - and it is
6116
+ * version-independent while the template is version-selected, so every value
6117
+ * needs an alias in all three variants. Keep the enum below in lockstep.
6118
+ */
6119
+ sortBy?: 'sessionID' | 'startTime' | 'endTime' | 'userEmail' | 'userId' | 'country' | 'isMobile' | 'browser' | 'sessionErrors' | 'pageCount' | 'durationMilli' | 'osName' | 'deviceModel';
6087
6120
  sortOrder?: string;
6088
6121
  sources?: Array<Condition>;
6089
6122
  start?: string;
@@ -6092,6 +6125,11 @@ export type SessionsQueryResponse = {
6092
6125
  sessions?: Array<Session>;
6093
6126
  };
6094
6127
  export type SessionsSummaryRequestParams = {
6128
+ /**
6129
+ * Category selects the platform to query: 'rum' for web RUM, 'mobile-rum' for
6130
+ * React Native. Defaults to 'rum' when omitted.
6131
+ */
6132
+ category?: 'rum' | 'mobile-rum';
6095
6133
  conditions?: Array<Condition>;
6096
6134
  end?: string;
6097
6135
  sources?: Array<Condition>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@groundcover/api-client",
3
- "version": "0.10.0",
3
+ "version": "0.11.0",
4
4
  "description": "groundcover TypeScript API Client",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -6437,12 +6437,25 @@ export type ServiceAccountsWithPolicy = {
6437
6437
  };
6438
6438
 
6439
6439
  export type Session = {
6440
+ /**
6441
+ * AppVersion is the mobile application version. Empty for web sessions, which
6442
+ * report ReleaseID instead.
6443
+ */
6444
+ appVersion?: string;
6440
6445
  browser?: string;
6441
6446
  country?: string;
6447
+ deviceBrand?: string;
6448
+ deviceModel?: string;
6442
6449
  durationMilli?: number;
6443
6450
  endTime?: string;
6444
6451
  hasSessionReplay?: number;
6445
6452
  isMobile?: string;
6453
+ /**
6454
+ * Mobile RUM. Empty for web sessions, which report browser.* instead. The client
6455
+ * platform is not returned: it is a filter dimension only.
6456
+ */
6457
+ osName?: string;
6458
+ osVersion?: string;
6446
6459
  pageCount?: number;
6447
6460
  releaseId?: string;
6448
6461
  serviceName?: string;
@@ -6455,6 +6468,11 @@ export type Session = {
6455
6468
  };
6456
6469
 
6457
6470
  export type SessionDetailsRequestParams = {
6471
+ /**
6472
+ * Category selects the platform to query: 'rum' for web RUM, 'mobile-rum' for
6473
+ * React Native. Defaults to 'rum' when omitted.
6474
+ */
6475
+ category?: 'rum' | 'mobile-rum';
6458
6476
  conditions?: Array<Condition>;
6459
6477
  end?: string;
6460
6478
  sessionID?: string;
@@ -6540,6 +6558,11 @@ export type SessionReplayVelocityResponse = {
6540
6558
  };
6541
6559
 
6542
6560
  export type SessionsFiltersRequestParams = {
6561
+ /**
6562
+ * Category selects the platform to query: 'rum' for web RUM, 'mobile-rum' for
6563
+ * React Native. Defaults to 'rum' when omitted.
6564
+ */
6565
+ category?: 'rum' | 'mobile-rum';
6543
6566
  conditions?: Array<Condition>;
6544
6567
  end?: string;
6545
6568
  required?: Array<Column>;
@@ -6552,11 +6575,21 @@ export type SessionsFiltersResponse = {
6552
6575
  };
6553
6576
 
6554
6577
  export type SessionsQueryRequestParams = {
6578
+ /**
6579
+ * Category selects the platform to query: 'rum' for web RUM, 'mobile-rum' for
6580
+ * React Native. Defaults to 'rum' when omitted.
6581
+ */
6582
+ category?: 'rum' | 'mobile-rum';
6555
6583
  conditions?: Array<Condition>;
6556
6584
  end?: string;
6557
6585
  limit?: number;
6558
6586
  skip?: number;
6559
- sortBy?: string;
6587
+ /**
6588
+ * Interpolated raw into ORDER BY, so this list is the only guard - and it is
6589
+ * version-independent while the template is version-selected, so every value
6590
+ * needs an alias in all three variants. Keep the enum below in lockstep.
6591
+ */
6592
+ sortBy?: 'sessionID' | 'startTime' | 'endTime' | 'userEmail' | 'userId' | 'country' | 'isMobile' | 'browser' | 'sessionErrors' | 'pageCount' | 'durationMilli' | 'osName' | 'deviceModel';
6560
6593
  sortOrder?: string;
6561
6594
  sources?: Array<Condition>;
6562
6595
  start?: string;
@@ -6567,6 +6600,11 @@ export type SessionsQueryResponse = {
6567
6600
  };
6568
6601
 
6569
6602
  export type SessionsSummaryRequestParams = {
6603
+ /**
6604
+ * Category selects the platform to query: 'rum' for web RUM, 'mobile-rum' for
6605
+ * React Native. Defaults to 'rum' when omitted.
6606
+ */
6607
+ category?: 'rum' | 'mobile-rum';
6570
6608
  conditions?: Array<Condition>;
6571
6609
  end?: string;
6572
6610
  sources?: Array<Condition>;