refactor: 622f147c05e298aacb3fc86d3ca45495219b8de8

Author: serverpod_cloud

ground_control_client/lib/src/protocol/client.dart

@@ -108,15 +108,17 @@ class EndpointAdminProcurement extends _i1.EndpointRef {
   /// If [trialPeriodOverride] is provided, it will override the trial period (number of days).
   /// If [overrideChecks] is true, the product availability checks are overridden.
   ///
+  /// Returns the subscription ID of the created subscription.
+  ///
   /// Throws a [NotFoundException] if the user or product is not found.
   /// Throws a [InvalidValueException] if the user has no owner (not fully registered).
-  _i2.Future<void> procurePlan({
+  _i2.Future<String> procurePlan({
     required String userEmail,
     required String planProductName,
     int? planProductVersion,
     int? trialPeriodOverride,
     bool? overrideChecks,
-  }) => caller.callServerEndpoint<void>('adminProcurement', 'procurePlan', {
+  }) => caller.callServerEndpoint<String>('adminProcurement', 'procurePlan', {
     'userEmail': userEmail,
     'planProductName': planProductName,
     'planProductVersion': planProductVersion,
@@ -137,8 +139,8 @@ class EndpointAdminProcurement extends _i1.EndpointRef {
     {'userEmail': userEmail},
   );
 
-  /// Cancels the primary plan subscription of the user
-  /// at the end of its current term.
+  /// Cancels a subscription of the user at the end of its current term.
+  /// Either [subscriptionId] or [cloudProjectId] must be provided.
   ///
   /// If [terminateImmediately] is true, the subscription is terminated
   /// immediately. If the user still has any active resource products,
@@ -149,9 +151,13 @@ class EndpointAdminProcurement extends _i1.EndpointRef {
   /// already been cancelled or ended.
   _i2.Future<void> cancelPlan({
     required String userEmail,
+    String? subscriptionId,
+    String? cloudProjectId,
     bool? terminateImmediately,
   }) => caller.callServerEndpoint<void>('adminProcurement', 'cancelPlan', {
     'userEmail': userEmail,
+    'subscriptionId': subscriptionId,
+    'cloudProjectId': cloudProjectId,
     'terminateImmediately': terminateImmediately,
   });
 }
@@ -967,6 +973,9 @@ class EndpointLogs extends _i1.EndpointRef {
 }
 
 /// Endpoint for managing subscription plans.
+///
+/// - Throws [ProcurementDeniedException] if the procurement fails.
+/// - Throws [NotFoundException] if the plan is not found.
 /// {@category Endpoint}
 class EndpointPlans extends _i1.EndpointRef {
   EndpointPlans(_i1.EndpointCaller caller) : super(caller);
@@ -975,33 +984,61 @@ class EndpointPlans extends _i1.EndpointRef {
   String get name => 'plans';
 
   /// Procures a subscription plan.
-  _i2.Future<void> procurePlan({
+  _i2.Future<String> procurePlan({
     String? planProductName,
     @Deprecated('Use planProductName instead') String? planName,
-  }) => caller.callServerEndpoint<void>('plans', 'procurePlan', {
+  }) => caller.callServerEndpoint<String>('plans', 'procurePlan', {
     'planProductName': planProductName,
     'planName': planName,
   });
 
-  /// Cancels the primary plan subscription of the user.
+  /// Cancels a subscription of the user.
   ///
   /// - Throws [ProcurementCancellationException] if the cancellation fails,
   /// e.g. if the subscription still has active resources or is already cancelled.
   /// - Throws [NoSubscriptionException] if the user has no subscription.
-  _i2.Future<void> cancelPlan() =>
-      caller.callServerEndpoint<void>('plans', 'cancelPlan', {});
+  _i2.Future<void> cancelPlan({required String subscriptionId}) =>
+      caller.callServerEndpoint<void>('plans', 'cancelPlan', {
+        'subscriptionId': subscriptionId,
+      });
 
   /// Fetches the names of the procured subscription plans.
   _i2.Future<List<String>> listProcuredPlanNames() => caller
       .callServerEndpoint<List<String>>('plans', 'listProcuredPlanNames', {});
 
-  _i2.Future<_i29.SubscriptionInfo> getSubscriptionInfo() =>
-      caller.callServerEndpoint<_i29.SubscriptionInfo>(
+  /// Lists the subscriptions of the user.
+  _i2.Future<List<_i29.SubscriptionInfo>> listSubscriptions() =>
+      caller.callServerEndpoint<List<_i29.SubscriptionInfo>>(
         'plans',
-        'getSubscriptionInfo',
+        'listSubscriptions',
         {},
       );
 
+  /// Gets the subscription info for the subscription of the given project id.
+  ///
+  /// Throws [NotFoundException] if the project's subscription is not found.
+  _i2.Future<_i29.SubscriptionInfo> getSubscriptionInfoOfProject({
+    required String cloudProjectId,
+  }) => caller.callServerEndpoint<_i29.SubscriptionInfo>(
+    'plans',
+    'getSubscriptionInfoOfProject',
+    {'cloudProjectId': cloudProjectId},
+  );
+
+  /// Gets a subscription info.
+  ///
+  /// [subscriptionId] is currently nullable for backwards compatibility,
+  /// in which case the first found subscription of the owner is used.
+  ///
+  /// Throws [NotFoundException] if the subscription is not found.
+  _i2.Future<_i29.SubscriptionInfo> getSubscriptionInfo({
+    String? subscriptionId,
+  }) => caller.callServerEndpoint<_i29.SubscriptionInfo>(
+    'plans',
+    'getSubscriptionInfo',
+    {'subscriptionId': subscriptionId},
+  );
+
   /// Checks if a plan is available for procurement.
   ///
   /// - Throws [NotFoundException] if the product is not found.
@@ -1042,11 +1079,19 @@ class EndpointProjects extends _i1.EndpointRef {
       });
 
   /// Creates a new project with basic setup.
+  ///
   /// The [cloudProjectId] must be globally unique.
-  /// [underSubscriptionId] optionally specify a subscription to procure the
-  /// project under, or the user's primary subscription will be used.
+  ///
+  /// [underSubscriptionId] optionally specifies a subscription to procure the
+  /// project under, or the user's first found subscription will be used.
+  /// In future this parameter will be mandatory.
+  ///
   /// [projectProductName] optionally specify the project product name to use,
   /// defaults to the first available bundled product for the subscription plan.
+  ///
+  /// Throws [InvalidValueException] if the project name is invalid.
+  /// Throws [NotFoundException] if the subscription or the product is not found.
+  /// Throws [ProcurementDeniedException] if the procurement fails.
   _i2.Future<_i3.Project> createProject({
     required String cloudProjectId,
     String? underSubscriptionId,

ground_control_client/lib/src/protocol/domains/billing/models/owner.dart

@@ -19,23 +19,29 @@ import 'package:ground_control_client/src/protocol/protocol.dart' as _i5;
 abstract class Owner implements _i1.SerializableModel {
   Owner._({
     _i1.UuidValue? id,
+    DateTime? createdAt,
+    DateTime? updatedAt,
+    this.archivedAt,
     required this.externalBillingId,
     required this.externalPaymentId,
     required this.billingPortalUrl,
     required this.billingEmails,
-    this.primarySubscriptionId,
     this.user,
     this.billingInfo,
     this.projects,
-  }) : id = id ?? const _i1.Uuid().v4obj();
+  }) : id = id ?? const _i1.Uuid().v4obj(),
+       createdAt = createdAt ?? DateTime.now(),
+       updatedAt = updatedAt ?? DateTime.now();
 
   factory Owner({
     _i1.UuidValue? id,
+    DateTime? createdAt,
+    DateTime? updatedAt,
+    DateTime? archivedAt,
     required String externalBillingId,
     required String externalPaymentId,
     required Uri billingPortalUrl,
     required List<String> billingEmails,
-    String? primarySubscriptionId,
     _i2.User? user,
     _i3.BillingInfo? billingInfo,
     List<_i4.Project>? projects,
@@ -46,6 +52,15 @@ abstract class Owner implements _i1.SerializableModel {
       id: jsonSerialization['id'] == null
           ? null
           : _i1.UuidValueJsonExtension.fromJson(jsonSerialization['id']),
+      createdAt: jsonSerialization['createdAt'] == null
+          ? null
+          : _i1.DateTimeJsonExtension.fromJson(jsonSerialization['createdAt']),
+      updatedAt: jsonSerialization['updatedAt'] == null
+          ? null
+          : _i1.DateTimeJsonExtension.fromJson(jsonSerialization['updatedAt']),
+      archivedAt: jsonSerialization['archivedAt'] == null
+          ? null
+          : _i1.DateTimeJsonExtension.fromJson(jsonSerialization['archivedAt']),
       externalBillingId: jsonSerialization['externalBillingId'] as String,
       externalPaymentId: jsonSerialization['externalPaymentId'] as String,
       billingPortalUrl: _i1.UriJsonExtension.fromJson(
@@ -54,8 +69,6 @@ abstract class Owner implements _i1.SerializableModel {
       billingEmails: _i5.Protocol().deserialize<List<String>>(
         jsonSerialization['billingEmails'],
       ),
-      primarySubscriptionId:
-          jsonSerialization['primarySubscriptionId'] as String?,
       user: jsonSerialization['user'] == null
           ? null
           : _i5.Protocol().deserialize<_i2.User>(jsonSerialization['user']),
@@ -75,6 +88,13 @@ abstract class Owner implements _i1.SerializableModel {
   /// The id of the object.
   _i1.UuidValue id;
 
+  DateTime createdAt;
+
+  DateTime updatedAt;
+
+  /// If non-null this Owner is archived.
+  DateTime? archivedAt;
+
   String externalBillingId;
 
   String externalPaymentId;
@@ -83,10 +103,6 @@ abstract class Owner implements _i1.SerializableModel {
 
   List<String> billingEmails;
 
-  /// The id of the primary (default) subscription of this owner.
-  /// Null if the owner has no subscription.
-  String? primarySubscriptionId;
-
   _i2.User? user;
 
   _i3.BillingInfo? billingInfo;
@@ -98,11 +114,13 @@ abstract class Owner implements _i1.SerializableModel {
   @_i1.useResult
   Owner copyWith({
     _i1.UuidValue? id,
+    DateTime? createdAt,
+    DateTime? updatedAt,
+    DateTime? archivedAt,
     String? externalBillingId,
     String? externalPaymentId,
     Uri? billingPortalUrl,
     List<String>? billingEmails,
-    String? primarySubscriptionId,
     _i2.User? user,
     _i3.BillingInfo? billingInfo,
     List<_i4.Project>? projects,
@@ -112,12 +130,13 @@ abstract class Owner implements _i1.SerializableModel {
     return {
       '__className__': 'Owner',
       'id': id.toJson(),
+      'createdAt': createdAt.toJson(),
+      'updatedAt': updatedAt.toJson(),
+      if (archivedAt != null) 'archivedAt': archivedAt?.toJson(),
       'externalBillingId': externalBillingId,
       'externalPaymentId': externalPaymentId,
       'billingPortalUrl': billingPortalUrl.toJson(),
       'billingEmails': billingEmails.toJson(),
-      if (primarySubscriptionId != null)
-        'primarySubscriptionId': primarySubscriptionId,
       if (user != null) 'user': user?.toJson(),
       if (billingInfo != null) 'billingInfo': billingInfo?.toJson(),
       if (projects != null)
@@ -136,21 +155,25 @@ class _Undefined {}
 class _OwnerImpl extends Owner {
   _OwnerImpl({
     _i1.UuidValue? id,
+    DateTime? createdAt,
+    DateTime? updatedAt,
+    DateTime? archivedAt,
     required String externalBillingId,
     required String externalPaymentId,
     required Uri billingPortalUrl,
     required List<String> billingEmails,
-    String? primarySubscriptionId,
     _i2.User? user,
     _i3.BillingInfo? billingInfo,
     List<_i4.Project>? projects,
   }) : super._(
          id: id,
+         createdAt: createdAt,
+         updatedAt: updatedAt,
+         archivedAt: archivedAt,
          externalBillingId: externalBillingId,
          externalPaymentId: externalPaymentId,
          billingPortalUrl: billingPortalUrl,
          billingEmails: billingEmails,
-         primarySubscriptionId: primarySubscriptionId,
          user: user,
          billingInfo: billingInfo,
          projects: projects,
@@ -162,25 +185,27 @@ class _OwnerImpl extends Owner {
   @override
   Owner copyWith({
     _i1.UuidValue? id,
+    DateTime? createdAt,
+    DateTime? updatedAt,
+    Object? archivedAt = _Undefined,
     String? externalBillingId,
     String? externalPaymentId,
     Uri? billingPortalUrl,
     List<String>? billingEmails,
-    Object? primarySubscriptionId = _Undefined,
     Object? user = _Undefined,
     Object? billingInfo = _Undefined,
     Object? projects = _Undefined,
   }) {
     return Owner(
       id: id ?? this.id,
+      createdAt: createdAt ?? this.createdAt,
+      updatedAt: updatedAt ?? this.updatedAt,
+      archivedAt: archivedAt is DateTime? ? archivedAt : this.archivedAt,
       externalBillingId: externalBillingId ?? this.externalBillingId,
       externalPaymentId: externalPaymentId ?? this.externalPaymentId,
       billingPortalUrl: billingPortalUrl ?? this.billingPortalUrl,
       billingEmails:
           billingEmails ?? this.billingEmails.map((e0) => e0).toList(),
-      primarySubscriptionId: primarySubscriptionId is String?
-          ? primarySubscriptionId
-          : this.primarySubscriptionId,
       user: user is _i2.User? ? user : this.user?.copyWith(),
       billingInfo: billingInfo is _i3.BillingInfo?
           ? billingInfo