feat: 8e46ac969236eea7633c0f35d09ee5b5f87338cc

Author: serverpod_cloud

ground_control_client/lib/src/protocol/client.dart

@@ -29,36 +29,38 @@ import 'package:ground_control_client/src/protocol/domains/billing/models/owner.
     as _i10;
 import 'package:ground_control_client/src/protocol/domains/billing/models/billing_info.dart'
     as _i11;
-import 'package:ground_control_client/src/protocol/features/custom_domain_name/models/view_models/custom_domain_name_with_default_domains.dart'
+import 'package:ground_control_client/src/protocol/domains/billing/models/payment_setup_intent.dart'
     as _i12;
-import 'package:ground_control_client/src/protocol/features/custom_domain_name/models/domain_name_target.dart'
+import 'package:ground_control_client/src/protocol/features/custom_domain_name/models/view_models/custom_domain_name_with_default_domains.dart'
     as _i13;
-import 'package:ground_control_client/src/protocol/features/custom_domain_name/models/custom_domain_name_list.dart'
+import 'package:ground_control_client/src/protocol/features/custom_domain_name/models/domain_name_target.dart'
     as _i14;
-import 'package:ground_control_client/src/protocol/features/custom_domain_name/models/domain_name_status.dart'
+import 'package:ground_control_client/src/protocol/features/custom_domain_name/models/custom_domain_name_list.dart'
     as _i15;
-import 'package:ground_control_client/src/protocol/features/environment_variables/models/environment_variable.dart'
+import 'package:ground_control_client/src/protocol/features/custom_domain_name/models/domain_name_status.dart'
     as _i16;
-import 'package:ground_control_client/src/protocol/domains/logs/models/log_record.dart'
+import 'package:ground_control_client/src/protocol/features/environment_variables/models/environment_variable.dart'
     as _i17;
-import 'package:ground_control_client/src/protocol/features/database/models/database_connection.dart'
+import 'package:ground_control_client/src/protocol/domains/logs/models/log_record.dart'
     as _i18;
-import 'package:ground_control_client/src/protocol/features/project/models/project_config.dart'
+import 'package:ground_control_client/src/protocol/features/database/models/database_connection.dart'
     as _i19;
-import 'package:ground_control_client/src/protocol/features/project/models/role.dart'
+import 'package:ground_control_client/src/protocol/features/project/models/project_config.dart'
     as _i20;
-import 'package:ground_control_client/src/protocol/domains/status/models/deploy_attempt.dart'
+import 'package:ground_control_client/src/protocol/features/project/models/role.dart'
     as _i21;
-import 'package:ground_control_client/src/protocol/domains/status/models/deploy_attempt_stage.dart'
+import 'package:ground_control_client/src/protocol/domains/status/models/deploy_attempt.dart'
     as _i22;
-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 _i23;
-import 'package:serverpod_auth_migration_client/serverpod_auth_migration_client.dart'
+import 'package:serverpod_auth_idp_client/serverpod_auth_idp_client.dart'
     as _i24;
-import 'package:serverpod_auth_bridge_client/serverpod_auth_bridge_client.dart'
+import 'package:serverpod_auth_migration_client/serverpod_auth_migration_client.dart'
     as _i25;
-import 'package:serverpod_auth_client/serverpod_auth_client.dart' as _i26;
-import 'protocol.dart' as _i27;
+import 'package:serverpod_auth_bridge_client/serverpod_auth_bridge_client.dart'
+    as _i26;
+import 'package:serverpod_auth_client/serverpod_auth_client.dart' as _i27;
+import 'protocol.dart' as _i28;
 
 /// Endpoint for global administrator to handle procurement for users.
 /// {@category Endpoint}
@@ -345,6 +347,31 @@ class EndpointBilling extends _i1.EndpointRef {
           'billingInfo': billingInfo,
         },
       );
+
+  /// Creates a setup intent for collecting payment methods.
+  ///
+  /// This endpoint creates a setup intent that can be used by the client
+  /// to collect payment method details (e.g., card information) from the user.
+  /// The setup intent is associated with the authenticated user's payment customer.
+  ///
+  /// The client can use the returned [PaymentSetupIntent] to:
+  /// 1. Display a payment form to the user
+  /// 2. Collect payment method details (card number, expiry, etc.)
+  /// 3. Confirm the setup intent with the payment provider
+  /// 4. Save the payment method for future use
+  ///
+  /// Returns a [PaymentSetupIntent] containing:
+  /// - [id]: The setup intent ID
+  /// - [clientSecret]: Secret for client-side confirmation
+  /// - [status]: Current status of the setup intent
+  ///
+  /// Throws [NotFoundException] if the user is not found or has no payment customer.
+  _i2.Future<_i12.PaymentSetupIntent> createSetupIntent() =>
+      caller.callServerEndpoint<_i12.PaymentSetupIntent>(
+        'billing',
+        'createSetupIntent',
+        {},
+      );
 }
 
 /// {@category Endpoint}
@@ -354,12 +381,12 @@ class EndpointCustomDomainName extends _i1.EndpointRef {
   @override
   String get name => 'customDomainName';
 
-  _i2.Future<_i12.CustomDomainNameWithDefaultDomains> add({
+  _i2.Future<_i13.CustomDomainNameWithDefaultDomains> add({
     required String domainName,
-    required _i13.DomainNameTarget target,
+    required _i14.DomainNameTarget target,
     required String cloudCapsuleId,
   }) =>
-      caller.callServerEndpoint<_i12.CustomDomainNameWithDefaultDomains>(
+      caller.callServerEndpoint<_i13.CustomDomainNameWithDefaultDomains>(
         'customDomainName',
         'add',
         {
@@ -382,19 +409,19 @@ class EndpointCustomDomainName extends _i1.EndpointRef {
         },
       );
 
-  _i2.Future<_i14.CustomDomainNameList> list(
+  _i2.Future<_i15.CustomDomainNameList> list(
           {required String cloudCapsuleId}) =>
-      caller.callServerEndpoint<_i14.CustomDomainNameList>(
+      caller.callServerEndpoint<_i15.CustomDomainNameList>(
         'customDomainName',
         'list',
         {'cloudCapsuleId': cloudCapsuleId},
       );
 
-  _i2.Future<_i15.DomainNameStatus> refreshRecord({
+  _i2.Future<_i16.DomainNameStatus> refreshRecord({
     required String domainName,
     required String cloudCapsuleId,
   }) =>
-      caller.callServerEndpoint<_i15.DomainNameStatus>(
+      caller.callServerEndpoint<_i16.DomainNameStatus>(
         'customDomainName',
         'refreshRecord',
         {
@@ -429,12 +456,12 @@ class EndpointEnvironmentVariables extends _i1.EndpointRef {
 
   /// Creates a new [EnvironmentVariable] with the specified [name] and [value].
   /// Throws a [DuplicateEntryException] if an environment variable with the same name already exists.
-  _i2.Future<_i16.EnvironmentVariable> create(
+  _i2.Future<_i17.EnvironmentVariable> create(
     String name,
     String value,
     String cloudCapsuleId,
   ) =>
-      caller.callServerEndpoint<_i16.EnvironmentVariable>(
+      caller.callServerEndpoint<_i17.EnvironmentVariable>(
         'environmentVariables',
         'create',
         {
@@ -446,11 +473,11 @@ class EndpointEnvironmentVariables extends _i1.EndpointRef {
 
   /// Fetches the specified environment variable.
   /// Throws a [NotFoundException] if the environment variable is not found.
-  _i2.Future<_i16.EnvironmentVariable> read({
+  _i2.Future<_i17.EnvironmentVariable> read({
     required String name,
     required String cloudCapsuleId,
   }) =>
-      caller.callServerEndpoint<_i16.EnvironmentVariable>(
+      caller.callServerEndpoint<_i17.EnvironmentVariable>(
         'environmentVariables',
         'read',
         {
@@ -460,21 +487,21 @@ class EndpointEnvironmentVariables extends _i1.EndpointRef {
       );
 
   /// Gets the list of environment variables for the given [cloudCapsuleId].
-  _i2.Future<List<_i16.EnvironmentVariable>> list(String cloudCapsuleId) =>
-      caller.callServerEndpoint<List<_i16.EnvironmentVariable>>(
+  _i2.Future<List<_i17.EnvironmentVariable>> list(String cloudCapsuleId) =>
+      caller.callServerEndpoint<List<_i17.EnvironmentVariable>>(
         'environmentVariables',
         'list',
         {'cloudCapsuleId': cloudCapsuleId},
       );
 
   /// Creates a new [EnvironmentVariable] with the specified [name] and [value].
   /// Throws a [NotFoundException] if the environment variable is not found.
-  _i2.Future<_i16.EnvironmentVariable> update({
+  _i2.Future<_i17.EnvironmentVariable> update({
     required String name,
     required String value,
     required String cloudCapsuleId,
   }) =>
-      caller.callServerEndpoint<_i16.EnvironmentVariable>(
+      caller.callServerEndpoint<_i17.EnvironmentVariable>(
         'environmentVariables',
         'update',
         {
@@ -486,11 +513,11 @@ class EndpointEnvironmentVariables extends _i1.EndpointRef {
 
   /// Permanently deletes an environment variable.
   /// Throws a [NotFoundException] if the environment variable is not found.
-  _i2.Future<_i16.EnvironmentVariable> delete({
+  _i2.Future<_i17.EnvironmentVariable> delete({
     required String cloudCapsuleId,
     required String name,
   }) =>
-      caller.callServerEndpoint<_i16.EnvironmentVariable>(
+      caller.callServerEndpoint<_i17.EnvironmentVariable>(
         'environmentVariables',
         'delete',
         {
@@ -509,15 +536,15 @@ class EndpointLogs extends _i1.EndpointRef {
   String get name => 'logs';
 
   /// Fetches log records from the specified project.
-  _i2.Stream<_i17.LogRecord> fetchRecords({
+  _i2.Stream<_i18.LogRecord> fetchRecords({
     String? cloudProjectId,
     String? cloudCapsuleId,
     DateTime? beforeTime,
     DateTime? afterTime,
     int? limit,
   }) =>
-      caller.callStreamingServerEndpoint<_i2.Stream<_i17.LogRecord>,
-          _i17.LogRecord>(
+      caller.callStreamingServerEndpoint<_i2.Stream<_i18.LogRecord>,
+          _i18.LogRecord>(
         'logs',
         'fetchRecords',
         {
@@ -533,13 +560,13 @@ 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<_i17.LogRecord> tailRecords({
+  _i2.Stream<_i18.LogRecord> tailRecords({
     String? cloudProjectId,
     String? cloudCapsuleId,
     int? limit,
   }) =>
-      caller.callStreamingServerEndpoint<_i2.Stream<_i17.LogRecord>,
-          _i17.LogRecord>(
+      caller.callStreamingServerEndpoint<_i2.Stream<_i18.LogRecord>,
+          _i18.LogRecord>(
         'logs',
         'tailRecords',
         {
@@ -551,14 +578,14 @@ class EndpointLogs extends _i1.EndpointRef {
       );
 
   /// Fetches the build log records for the specified deploy attempt.
-  _i2.Stream<_i17.LogRecord> fetchBuildLog({
+  _i2.Stream<_i18.LogRecord> fetchBuildLog({
     String? cloudProjectId,
     String? cloudCapsuleId,
     required String attemptId,
     int? limit,
   }) =>
-      caller.callStreamingServerEndpoint<_i2.Stream<_i17.LogRecord>,
-          _i17.LogRecord>(
+      caller.callStreamingServerEndpoint<_i2.Stream<_i18.LogRecord>,
+          _i18.LogRecord>(
         'logs',
         'fetchBuildLog',
         {
@@ -612,9 +639,9 @@ class EndpointDatabase extends _i1.EndpointRef {
   @override
   String get name => 'database';
 
-  _i2.Future<_i18.DatabaseConnection> getConnectionDetails(
+  _i2.Future<_i19.DatabaseConnection> getConnectionDetails(
           {required String cloudCapsuleId}) =>
-      caller.callServerEndpoint<_i18.DatabaseConnection>(
+      caller.callServerEndpoint<_i19.DatabaseConnection>(
         'database',
         'getConnectionDetails',
         {'cloudCapsuleId': cloudCapsuleId},
@@ -711,9 +738,9 @@ class EndpointProjects extends _i1.EndpointRef {
         {'cloudProjectId': cloudProjectId},
       );
 
-  _i2.Future<_i19.ProjectConfig> fetchProjectConfig(
+  _i2.Future<_i20.ProjectConfig> fetchProjectConfig(
           {required String cloudProjectId}) =>
-      caller.callServerEndpoint<_i19.ProjectConfig>(
+      caller.callServerEndpoint<_i20.ProjectConfig>(
         'projects',
         'fetchProjectConfig',
         {'cloudProjectId': cloudProjectId},
@@ -814,9 +841,9 @@ class EndpointRoles extends _i1.EndpointRef {
   String get name => 'roles';
 
   /// Fetches the user roles for a project.
-  _i2.Future<List<_i20.Role>> fetchRolesForProject(
+  _i2.Future<List<_i21.Role>> fetchRolesForProject(
           {required String cloudProjectId}) =>
-      caller.callServerEndpoint<List<_i20.Role>>(
+      caller.callServerEndpoint<List<_i21.Role>>(
         'roles',
         'fetchRolesForProject',
         {'cloudProjectId': cloudProjectId},
@@ -874,11 +901,11 @@ class EndpointStatus extends _i1.EndpointRef {
 
   /// Gets deploy attempts of the specified capsule.
   /// Gets the recent-most attempts, up till [limit] if specified.
-  _i2.Future<List<_i21.DeployAttempt>> getDeployAttempts({
+  _i2.Future<List<_i22.DeployAttempt>> getDeployAttempts({
     required String cloudCapsuleId,
     int? limit,
   }) =>
-      caller.callServerEndpoint<List<_i21.DeployAttempt>>(
+      caller.callServerEndpoint<List<_i22.DeployAttempt>>(
         'status',
         'getDeployAttempts',
         {
@@ -888,11 +915,11 @@ class EndpointStatus extends _i1.EndpointRef {
       );
 
   /// Gets the specified deploy attempt status of the a capsule.
-  _i2.Future<List<_i22.DeployAttemptStage>> getDeployAttemptStatus({
+  _i2.Future<List<_i23.DeployAttemptStage>> getDeployAttemptStatus({
     required String cloudCapsuleId,
     required String attemptId,
   }) =>
-      caller.callServerEndpoint<List<_i22.DeployAttemptStage>>(
+      caller.callServerEndpoint<List<_i23.DeployAttemptStage>>(
         'status',
         'getDeployAttemptStatus',
         {
@@ -944,20 +971,20 @@ class EndpointUsers extends _i1.EndpointRef {
 
 class Modules {
   Modules(Client client) {
-    serverpod_auth_idp = _i23.Caller(client);
-    serverpod_auth_migration = _i24.Caller(client);
-    serverpod_auth_bridge = _i25.Caller(client);
-    auth = _i26.Caller(client);
+    serverpod_auth_idp = _i24.Caller(client);
+    serverpod_auth_migration = _i25.Caller(client);
+    serverpod_auth_bridge = _i26.Caller(client);
+    auth = _i27.Caller(client);
     serverpod_auth_core = _i8.Caller(client);
   }
 
-  late final _i23.Caller serverpod_auth_idp;
+  late final _i24.Caller serverpod_auth_idp;
 
-  late final _i24.Caller serverpod_auth_migration;
+  late final _i25.Caller serverpod_auth_migration;
 
-  late final _i25.Caller serverpod_auth_bridge;
+  late final _i26.Caller serverpod_auth_bridge;
 
-  late final _i26.Caller auth;
+  late final _i27.Caller auth;
 
   late final _i8.Caller serverpod_auth_core;
 }
@@ -978,7 +1005,7 @@ class Client extends _i1.ServerpodClientShared {
     bool? disconnectStreamsOnLostInternetConnection,
   }) : super(
           host,
-          _i27.Protocol(),
+          _i28.Protocol(),
           securityContext: securityContext,
           authenticationKeyManager: authenticationKeyManager,
           streamingConnectionTimeout: streamingConnectionTimeout,