Merge pull request #21 from solid-software/add-list-params-to-subscri…

…ption_schedule Add list params to subscription schedule, fix phases
solid-software · May 28, 2024 · 7ae50a5 · 7ae50a5
2 parents ba88f92 + 9c3975f
commit 7ae50a5
Show file tree

Hide file tree

Showing 6 changed files with 84 additions and 16 deletions.
diff --git a/lib/messages.dart b/lib/messages.dart
@@ -33,6 +33,7 @@ part 'src/messages/requests/list_prices.dart';
 part 'src/messages/requests/list_products.dart';
 part 'src/messages/requests/list_subscription_items.dart';
 part 'src/messages/requests/list_subscriptions.dart';
+part 'src/messages/requests/list_subscription_schedules.dart';
 part 'src/messages/requests/update_customer.dart';
 part 'src/messages/requests/update_subscription.dart';
 part 'src/messages/requests/update_subscription_item.dart';

diff --git a/lib/messages.g.dart b/lib/messages.g.dart
diff --git a/lib/src/messages/requests/list_subscription_schedules.dart b/lib/src/messages/requests/list_subscription_schedules.dart
@@ -0,0 +1,21 @@
+part of '../../../messages.dart';
+
+@JsonSerializable()
+class ListSubscriptionSchedulesRequest extends Message {
+  final String? customer;
+
+  final int? limit;
+
+  const ListSubscriptionSchedulesRequest({
+    this.customer,
+    this.limit,
+  });
+
+  factory ListSubscriptionSchedulesRequest.fromJson(
+          Map<String, dynamic> json) =>
+      _$ListSubscriptionSchedulesRequestFromJson(json);
+
+  @override
+  Map<String, dynamic> toJson() =>
+      _$ListSubscriptionSchedulesRequestToJson(this);
+}
diff --git a/lib/src/messages/requests/update_subscription_schedule.dart b/lib/src/messages/requests/update_subscription_schedule.dart
@@ -19,8 +19,6 @@ class UpdateSubscriptionScheduleRequest extends Message {
 
 @JsonSerializable()
 class UpdateSubscriptionSchedulePhase extends Message {
-  final String id;
-
   @TimestampConverter()
   final DateTime? startDate;
 
@@ -30,7 +28,6 @@ class UpdateSubscriptionSchedulePhase extends Message {
   final List<UpdateSubscriptionSchedulePhaseItem> items;
 
   const UpdateSubscriptionSchedulePhase({
-    required this.id,
     this.startDate,
     this.endDate,
     required this.items,

diff --git a/lib/src/messages/subscription_schedule.dart b/lib/src/messages/subscription_schedule.dart
@@ -5,6 +5,19 @@ enum _SubscriptionScheduleObject {
   subscriptionSchedule,
 }
 
+enum SubscriptionScheduleStatus {
+  @JsonValue('not_started')
+  notStarted,
+  @JsonValue('active')
+  active,
+  @JsonValue('completed')
+  completed,
+  @JsonValue('released')
+  released,
+  @JsonValue('canceled')
+  canceled,
+}
+
 @JsonSerializable()
 class SubscriptionSchedule extends Message {
   final _SubscriptionScheduleObject object;
@@ -17,12 +30,18 @@ class SubscriptionSchedule extends Message {
 
   final List<SubscriptionSchedulePhase> phases;
 
+  final SubscriptionScheduleStatus status;
+
+  final String? subscription;
+
   const SubscriptionSchedule({
     required this.object,
     required this.id,
     this.customer,
     this.metadata,
     required this.phases,
+    required this.status,
+    this.subscription,
   });
 
   factory SubscriptionSchedule.fromJson(Map<String, dynamic> json) =>
@@ -34,8 +53,6 @@ class SubscriptionSchedule extends Message {
 
 @JsonSerializable()
 class SubscriptionSchedulePhase extends Message {
-  final String id;
-
   @TimestampConverter()
   final DateTime? startDate;
 
@@ -45,7 +62,6 @@ class SubscriptionSchedulePhase extends Message {
   final List<SubscriptionSchedulePhaseItem> items;
 
   const SubscriptionSchedulePhase({
-    required this.id,
     this.startDate,
     this.endDate,
     required this.items,

diff --git a/lib/src/resources/subscription_schedule.dart b/lib/src/resources/subscription_schedule.dart
@@ -13,8 +13,13 @@ class SubscriptionScheduleResource extends Resource {
   }
 
   /// https://stripe.com/docs/api/subscription_schedules/list
-  Future<DataList<SubscriptionSchedule>> list() async {
-    final map = await get('subscription_schedules');
+  Future<DataList<SubscriptionSchedule>> list([
+    ListSubscriptionSchedulesRequest? request,
+  ]) async {
+    final map = await get(
+      'subscription_schedules',
+      queryParameters: request?.toJson(),
+    );
 
     return DataList<SubscriptionSchedule>.fromJson(
       map,