feat: 3ff4b5dbe6c92aa518afce1b29d542219e428a00

Author: serverpod_cloud

ground_control_client/lib/src/protocol/client.dart

@@ -46,23 +46,25 @@ import 'package:ground_control_client/src/protocol/features/custom_domains/model
     as _i18;
 import 'package:ground_control_client/src/protocol/domains/environment_variables/models/variable.dart'
     as _i19;
-import 'package:ground_control_client/src/protocol/domains/logs/models/log_record.dart'
+import 'package:ground_control_client/src/protocol/features/insights/models/insights_connection_detail.dart'
     as _i20;
-import 'package:ground_control_client/src/protocol/domains/products/models/subscription_info.dart'
+import 'package:ground_control_client/src/protocol/domains/logs/models/log_record.dart'
     as _i21;
-import 'package:ground_control_client/src/protocol/domains/products/models/plan_info.dart'
+import 'package:ground_control_client/src/protocol/domains/products/models/subscription_info.dart'
     as _i22;
-import 'package:ground_control_client/src/protocol/features/databases/models/database_connection.dart'
+import 'package:ground_control_client/src/protocol/domains/products/models/plan_info.dart'
     as _i23;
-import 'package:ground_control_client/src/protocol/features/projects/models/project_config.dart'
+import 'package:ground_control_client/src/protocol/features/databases/models/database_connection.dart'
     as _i24;
-import 'package:ground_control_client/src/protocol/features/projects/models/role.dart'
+import 'package:ground_control_client/src/protocol/features/projects/models/project_config.dart'
     as _i25;
-import 'package:ground_control_client/src/protocol/domains/status/models/deploy_attempt_stage.dart'
+import 'package:ground_control_client/src/protocol/features/projects/models/role.dart'
     as _i26;
-import 'package:serverpod_auth_idp_client/serverpod_auth_idp_client.dart'
+import 'package:ground_control_client/src/protocol/domains/status/models/deploy_attempt_stage.dart'
     as _i27;
-import 'protocol.dart' as _i28;
+import 'package:serverpod_auth_idp_client/serverpod_auth_idp_client.dart'
+    as _i28;
+import 'protocol.dart' as _i29;
 
 /// Endpoint for global administrator to handle procurement for users.
 /// {@category Endpoint}
@@ -588,6 +590,28 @@ class EndpointEnvironmentVariables extends _i1.EndpointRef {
   );
 }
 
+/// {@category Endpoint}
+class EndpointInsights extends _i1.EndpointRef {
+  EndpointInsights(_i1.EndpointCaller caller) : super(caller);
+
+  @override
+  String get name => 'insights';
+
+  /// Gets the connection details for the insights service.
+  ///
+  /// Requires project authorization with all scopes.
+  ///
+  /// Throws [UnauthorizedException] if the user is not authorized.
+  /// Throws [NotFoundException] if insights service secret is not found.
+  _i2.Future<_i20.InsightsConnectionDetail> getConnectionDetails({
+    required String cloudProjectId,
+  }) => caller.callServerEndpoint<_i20.InsightsConnectionDetail>(
+    'insights',
+    'getConnectionDetails',
+    {'cloudProjectId': cloudProjectId},
+  );
+}
+
 /// Endpoint for accessing cloud logs.
 /// {@category Endpoint}
 class EndpointLogs extends _i1.EndpointRef {
@@ -597,14 +621,14 @@ class EndpointLogs extends _i1.EndpointRef {
   String get name => 'logs';
 
   /// Fetches log records from the specified project.
-  _i2.Stream<_i20.LogRecord> fetchRecords({
+  _i2.Stream<_i21.LogRecord> fetchRecords({
     String? cloudProjectId,
     String? cloudCapsuleId,
     DateTime? beforeTime,
     DateTime? afterTime,
     int? limit,
   }) => caller
-      .callStreamingServerEndpoint<_i2.Stream<_i20.LogRecord>, _i20.LogRecord>(
+      .callStreamingServerEndpoint<_i2.Stream<_i21.LogRecord>, _i21.LogRecord>(
         'logs',
         'fetchRecords',
         {
@@ -620,12 +644,12 @@ class EndpointLogs extends _i1.EndpointRef {
   /// Tails log records from the specified project.
   /// Continues until the client unsubscribes, [limit] is reached,
   /// or the internal max limit is reached.
-  _i2.Stream<_i20.LogRecord> tailRecords({
+  _i2.Stream<_i21.LogRecord> tailRecords({
     String? cloudProjectId,
     String? cloudCapsuleId,
     int? limit,
   }) => caller
-      .callStreamingServerEndpoint<_i2.Stream<_i20.LogRecord>, _i20.LogRecord>(
+      .callStreamingServerEndpoint<_i2.Stream<_i21.LogRecord>, _i21.LogRecord>(
         'logs',
         'tailRecords',
         {
@@ -637,13 +661,13 @@ class EndpointLogs extends _i1.EndpointRef {
       );
 
   /// Fetches the build log records for the specified deploy attempt.
-  _i2.Stream<_i20.LogRecord> fetchBuildLog({
+  _i2.Stream<_i21.LogRecord> fetchBuildLog({
     String? cloudProjectId,
     String? cloudCapsuleId,
     required String attemptId,
     int? limit,
   }) => caller
-      .callStreamingServerEndpoint<_i2.Stream<_i20.LogRecord>, _i20.LogRecord>(
+      .callStreamingServerEndpoint<_i2.Stream<_i21.LogRecord>, _i21.LogRecord>(
         'logs',
         'fetchBuildLog',
         {
@@ -683,8 +707,8 @@ class EndpointPlans extends _i1.EndpointRef {
   _i2.Future<List<String>> listProcuredPlanNames() => caller
       .callServerEndpoint<List<String>>('plans', 'listProcuredPlanNames', {});
 
-  _i2.Future<_i21.SubscriptionInfo> getSubscriptionInfo() =>
-      caller.callServerEndpoint<_i21.SubscriptionInfo>(
+  _i2.Future<_i22.SubscriptionInfo> getSubscriptionInfo() =>
+      caller.callServerEndpoint<_i22.SubscriptionInfo>(
         'plans',
         'getSubscriptionInfo',
         {},
@@ -702,8 +726,8 @@ class EndpointPlans extends _i1.EndpointRef {
     'planName': planName,
   });
 
-  _i2.Future<_i22.PlanInfo> getPlanInfo({required String planProductName}) =>
-      caller.callServerEndpoint<_i22.PlanInfo>('plans', 'getPlanInfo', {
+  _i2.Future<_i23.PlanInfo> getPlanInfo({required String planProductName}) =>
+      caller.callServerEndpoint<_i23.PlanInfo>('plans', 'getPlanInfo', {
         'planProductName': planProductName,
       });
 
@@ -720,9 +744,9 @@ class EndpointDatabase extends _i1.EndpointRef {
   @override
   String get name => 'database';
 
-  _i2.Future<_i23.DatabaseConnection> getConnectionDetails({
+  _i2.Future<_i24.DatabaseConnection> getConnectionDetails({
     required String cloudCapsuleId,
-  }) => caller.callServerEndpoint<_i23.DatabaseConnection>(
+  }) => caller.callServerEndpoint<_i24.DatabaseConnection>(
     'database',
     'getConnectionDetails',
     {'cloudCapsuleId': cloudCapsuleId},
@@ -831,9 +855,9 @@ class EndpointProjects extends _i1.EndpointRef {
         'cloudProjectId': cloudProjectId,
       });
 
-  _i2.Future<_i24.ProjectConfig> fetchProjectConfig({
+  _i2.Future<_i25.ProjectConfig> fetchProjectConfig({
     required String cloudProjectId,
-  }) => caller.callServerEndpoint<_i24.ProjectConfig>(
+  }) => caller.callServerEndpoint<_i25.ProjectConfig>(
     'projects',
     'fetchProjectConfig',
     {'cloudProjectId': cloudProjectId},
@@ -914,9 +938,9 @@ class EndpointRoles extends _i1.EndpointRef {
   String get name => 'roles';
 
   /// Fetches the user roles for a project.
-  _i2.Future<List<_i25.Role>> fetchRolesForProject({
+  _i2.Future<List<_i26.Role>> fetchRolesForProject({
     required String cloudProjectId,
-  }) => caller.callServerEndpoint<List<_i25.Role>>(
+  }) => caller.callServerEndpoint<List<_i26.Role>>(
     'roles',
     'fetchRolesForProject',
     {'cloudProjectId': cloudProjectId},
@@ -1003,10 +1027,10 @@ class EndpointStatus extends _i1.EndpointRef {
   );
 
   /// Gets the specified deploy attempt status of the a capsule.
-  _i2.Future<List<_i26.DeployAttemptStage>> getDeployAttemptStatus({
+  _i2.Future<List<_i27.DeployAttemptStage>> getDeployAttemptStatus({
     required String cloudCapsuleId,
     required String attemptId,
-  }) => caller.callServerEndpoint<List<_i26.DeployAttemptStage>>(
+  }) => caller.callServerEndpoint<List<_i27.DeployAttemptStage>>(
     'status',
     'getDeployAttemptStatus',
     {'cloudCapsuleId': cloudCapsuleId, 'attemptId': attemptId},
@@ -1062,11 +1086,11 @@ class EndpointUsers extends _i1.EndpointRef {
 
 class Modules {
   Modules(Client client) {
-    serverpod_auth_idp = _i27.Caller(client);
+    serverpod_auth_idp = _i28.Caller(client);
     serverpod_auth_core = _i10.Caller(client);
   }
 
-  late final _i27.Caller serverpod_auth_idp;
+  late final _i28.Caller serverpod_auth_idp;
 
   late final _i10.Caller serverpod_auth_core;
 }
@@ -1086,7 +1110,7 @@ class Client extends _i1.ServerpodClientShared {
     bool? disconnectStreamsOnLostInternetConnection,
   }) : super(
          host,
-         _i28.Protocol(),
+         _i29.Protocol(),
          securityContext: securityContext,
          streamingConnectionTimeout: streamingConnectionTimeout,
          connectionTimeout: connectionTimeout,
@@ -1104,6 +1128,7 @@ class Client extends _i1.ServerpodClientShared {
     customDomainName = EndpointCustomDomainName(this);
     deploy = EndpointDeploy(this);
     environmentVariables = EndpointEnvironmentVariables(this);
+    insights = EndpointInsights(this);
     logs = EndpointLogs(this);
     plans = EndpointPlans(this);
     database = EndpointDatabase(this);
@@ -1135,6 +1160,8 @@ class Client extends _i1.ServerpodClientShared {
 
   late final EndpointEnvironmentVariables environmentVariables;
 
+  late final EndpointInsights insights;
+
   late final EndpointLogs logs;
 
   late final EndpointPlans plans;
@@ -1168,6 +1195,7 @@ class Client extends _i1.ServerpodClientShared {
     'customDomainName': customDomainName,
     'deploy': deploy,
     'environmentVariables': environmentVariables,
+    'insights': insights,
     'logs': logs,
     'plans': plans,
     'database': database,

ground_control_client/lib/src/protocol/features/insights/models/insights_connection_detail.dart

@@ -0,0 +1,71 @@
+/* AUTOMATICALLY GENERATED CODE DO NOT MODIFY */
+/*   To generate run: "serverpod generate"    */
+
+// ignore_for_file: implementation_imports
+// ignore_for_file: library_private_types_in_public_api
+// ignore_for_file: non_constant_identifier_names
+// ignore_for_file: public_member_api_docs
+// ignore_for_file: type_literal_in_constant_pattern
+// ignore_for_file: use_super_parameters
+// ignore_for_file: invalid_use_of_internal_member
+
+// ignore_for_file: no_leading_underscores_for_library_prefixes
+import 'package:serverpod_client/serverpod_client.dart' as _i1;
+
+abstract class InsightsConnectionDetail implements _i1.SerializableModel {
+  InsightsConnectionDetail._({required this.url, required this.serviceSecret});
+
+  factory InsightsConnectionDetail({
+    required Uri url,
+    required String serviceSecret,
+  }) = _InsightsConnectionDetailImpl;
+
+  factory InsightsConnectionDetail.fromJson(
+    Map<String, dynamic> jsonSerialization,
+  ) {
+    return InsightsConnectionDetail(
+      url: _i1.UriJsonExtension.fromJson(jsonSerialization['url']),
+      serviceSecret: jsonSerialization['serviceSecret'] as String,
+    );
+  }
+
+  Uri url;
+
+  String serviceSecret;
+
+  /// Returns a shallow copy of this [InsightsConnectionDetail]
+  /// with some or all fields replaced by the given arguments.
+  @_i1.useResult
+  InsightsConnectionDetail copyWith({Uri? url, String? serviceSecret});
+  @override
+  Map<String, dynamic> toJson() {
+    return {
+      '__className__': 'InsightsConnectionDetail',
+      'url': url.toJson(),
+      'serviceSecret': serviceSecret,
+    };
+  }
+
+  @override
+  String toString() {
+    return _i1.SerializationManager.encode(this);
+  }
+}
+
+class _InsightsConnectionDetailImpl extends InsightsConnectionDetail {
+  _InsightsConnectionDetailImpl({
+    required Uri url,
+    required String serviceSecret,
+  }) : super._(url: url, serviceSecret: serviceSecret);
+
+  /// Returns a shallow copy of this [InsightsConnectionDetail]
+  /// with some or all fields replaced by the given arguments.
+  @_i1.useResult
+  @override
+  InsightsConnectionDetail copyWith({Uri? url, String? serviceSecret}) {
+    return InsightsConnectionDetail(
+      url: url ?? this.url,
+      serviceSecret: serviceSecret ?? this.serviceSecret,
+    );
+  }
+}