Add Credit Grant resource

Author: solid-maksymtielnyi

lib/messages.dart

@@ -13,6 +13,7 @@ part 'src/messages/billing_details.dart';
 part 'src/messages/charge.dart';
 part 'src/messages/checkout_session.dart';
 part 'src/messages/coupon.dart';
+part 'src/messages/credit_grant.dart';
 part 'src/messages/customer.dart';
 part 'src/messages/data_list.dart';
 part 'src/messages/discount.dart';
@@ -28,6 +29,7 @@ part 'src/messages/promotion_code.dart';
 part 'src/messages/refund.dart';
 part 'src/messages/requests/confirm_payment_intent.dart';
 part 'src/messages/requests/create_checkout_session.dart';
+part 'src/messages/requests/create_credit_grant.dart';
 part 'src/messages/requests/create_customer.dart';
 part 'src/messages/requests/create_discount.dart';
 part 'src/messages/requests/create_invoice_preview_request.dart';
@@ -40,13 +42,15 @@ part 'src/messages/requests/create_subscription.dart';
 part 'src/messages/requests/create_subscription_schedule.dart';
 part 'src/messages/requests/created.dart';
 part 'src/messages/requests/list_coupons.dart';
+part 'src/messages/requests/list_credit_grants.dart';
 part 'src/messages/requests/list_prices.dart';
 part 'src/messages/requests/list_products.dart';
 part 'src/messages/requests/list_promotion_codes.dart';
 part 'src/messages/requests/list_subscription_items.dart';
 part 'src/messages/requests/list_subscription_schedules.dart';
 part 'src/messages/requests/list_subscriptions.dart';
 part 'src/messages/requests/subscription_payment_settings.dart';
+part 'src/messages/requests/update_credit_grant.dart';
 part 'src/messages/requests/update_customer.dart';
 part 'src/messages/requests/update_payment_intent.dart';
 part 'src/messages/requests/update_subscription.dart';

lib/messages.g.dart

@@ -0,0 +1,184 @@
+part of '../../messages.dart';
+
+enum _CreditGrantObject {
+  @JsonValue('billing.credit_grant')
+  billingCreditGrant,
+}
+
+/// https://docs.stripe.com/api/billing/credit-grant/object
+@JsonSerializable()
+class CreditGrant extends Message {
+  final _CreditGrantObject object;
+
+  /// Unique identifier for the object.
+  final String id;
+
+  /// Amount of this credit grant.
+  final CreditGrantAmount amount;
+
+  /// Configuration specifying what this credit grant applies to. We currently
+  /// only support metered prices that have a Billing Meter attached to them.
+  final CreditGrantApplicabilityConfig applicabilityConfig;
+
+  /// he category of this credit grant. This is for tracking purposes and isn’t
+  /// displayed to the customer.
+  final CreditGrantCategory category;
+
+  /// Time at which the object was created. Measured in seconds since the Unix
+  /// epoch.
+  final int created;
+
+  /// ID of the customer receiving the billing credits.
+  final String customer;
+
+  /// Has the value true if the object exists in live mode or the value false
+  /// if the object exists in test mode.
+  final bool livemode;
+
+  /// Time at which the object was last updated. Measured in seconds since the
+  /// Unix epoch.
+  final int updated;
+
+  /// The time when the billing credits become effective-when they’re eligible
+  /// for use.
+  final int? effectiveAt;
+
+  /// The time when the billing credits expire. If not present, the billing
+  /// credits don’t expire.
+  final int? expiresAt;
+
+  /// Set of key-value pairs that you can attach to an object. This can be
+  /// useful for storing additional information about the object in a structured
+  /// format.
+  final Map<String, dynamic>? metadata;
+
+  /// A descriptive name shown in dashboard.
+  final String? name;
+
+  /// The time when this credit grant was voided. If not present, the credit
+  /// grant hasn’t been voided.
+  final int? voidedAt;
+
+  CreditGrant({
+    required this.object,
+    required this.id,
+    required this.amount,
+    required this.applicabilityConfig,
+    required this.category,
+    required this.created,
+    required this.customer,
+    required this.livemode,
+    required this.updated,
+    this.effectiveAt,
+    this.expiresAt,
+    this.metadata,
+    this.name,
+    this.voidedAt,
+  });
+
+  factory CreditGrant.fromJson(Map<String, dynamic> json) =>
+      _$CreditGrantFromJson(json);
+
+  @override
+  Map<String, dynamic> toJson() => _$CreditGrantToJson(this);
+}
+
+/// https://docs.stripe.com/api/billing/credit-grant/object#billing_credit_grant_object-amount
+@JsonSerializable()
+class CreditGrantAmount {
+  /// The monetary amount.
+  final CreditGrantAmountMonetary? monetary;
+
+  /// The type of this amount. We currently only support monetary billing
+  /// credits.
+  final CreditGrantAmountType type;
+
+  CreditGrantAmount({
+
+    required this.type,
+    this.monetary,
+  });
+
+  factory CreditGrantAmount.fromJson(Map<String, dynamic> json) =>
+      _$CreditGrantAmountFromJson(json);
+
+  Map<String, dynamic> toJson() => _$CreditGrantAmountToJson(this);
+}
+
+/// https://docs.stripe.com/api/billing/credit-grant/object#billing_credit_grant_object-amount-monetary
+@JsonSerializable()
+class CreditGrantAmountMonetary {
+  /// Three-letter ISO currency code, in lowercase. Must be a supported
+  /// currency.
+  final String currency;
+
+  /// A positive integer representing the amount.
+  final int value;
+
+  CreditGrantAmountMonetary({
+    required this.currency,
+    required this.value,
+  });
+
+  factory CreditGrantAmountMonetary.fromJson(Map<String, dynamic> json) =>
+      _$CreditGrantAmountMonetaryFromJson(json);
+
+  Map<String, dynamic> toJson() => _$CreditGrantAmountMonetaryToJson(this);
+}
+
+/// https://docs.stripe.com/api/billing/credit-grant/object#billing_credit_grant_object-amount-type
+enum CreditGrantAmountType {
+  /// The amount is a monetary amount.
+  monetary,
+}
+
+/// https://docs.stripe.com/api/billing/credit-grant/object#billing_credit_grant_object-applicability_config
+@JsonSerializable()
+class CreditGrantApplicabilityConfig {
+  /// Specify the scope of this applicability config.
+  final CreditGrantApplicabilityConfigScope scope;
+
+  CreditGrantApplicabilityConfig({
+    required this.scope,
+  });
+
+  factory CreditGrantApplicabilityConfig.fromJson(Map<String, dynamic> json) =>
+      _$CreditGrantApplicabilityConfigFromJson(json);
+
+  Map<String, dynamic> toJson() => _$CreditGrantApplicabilityConfigToJson(this);
+}
+
+/// https://docs.stripe.com/api/billing/credit-grant/object#billing_credit_grant_object-applicability_config-scope
+@JsonSerializable()
+class CreditGrantApplicabilityConfigScope {
+  /// The price type that credit grants can apply to. We currently only support
+  /// the metered price type. This refers to prices that have a Billing Meter
+  /// attached to them. Cannot be used in combination with prices.
+  final CreditGrantApplicabilityConfigScopePriceType? priceType;
+
+  CreditGrantApplicabilityConfigScope({
+    this.priceType,
+  });
+
+  factory CreditGrantApplicabilityConfigScope.fromJson(
+          Map<String, dynamic> json) =>
+      _$CreditGrantApplicabilityConfigScopeFromJson(json);
+
+  Map<String, dynamic> toJson() =>
+      _$CreditGrantApplicabilityConfigScopeToJson(this);
+}
+
+/// https://docs.stripe.com/api/billing/credit-grant/object#billing_credit_grant_object-applicability_config-scope-price_type
+enum CreditGrantApplicabilityConfigScopePriceType {
+  /// Credit grants being created can only apply to metered prices.
+  metered,
+}
+
+/// https://docs.stripe.com/api/billing/credit-grant/object#billing_credit_grant_object-category
+enum CreditGrantCategory {
+  /// The credit grant was purchased by the customer for some amount.
+  paid,
+
+  /// The credit grant was given to the customer for free.
+  promotional,
+}

lib/src/messages/credit_grant.dart

@@ -0,0 +1,108 @@
+part of '../../../messages.dart';
+
+/// https://docs.stripe.com/api/billing/credit-grant/create
+@JsonSerializable()
+class CreateCreditGrantRequest {
+  /// Amount of this credit grant.
+  final CreditGrantCreateRequestAmount amount;
+
+  /// Configuration specifying what this credit grant applies to. We currently
+  /// only support metered prices that have a Billing Meter attached to them.
+  final CreditGrantCreateRequestApplicabilityConfig applicabilityConfig;
+
+  /// The category of this credit grant.
+  final CreditGrantCategory category;
+
+  /// ID of the customer to receive the billing credits.
+  final String customer;
+
+  /// The time when the billing credits become effective-when they’re eligible
+  /// for use. It defaults to the current timestamp if not specified.
+  final int? effectiveAt;
+
+  /// The time when the billing credits expire. If not specified, the billing
+  /// credits don’t expire.
+  final int? expiresAt;
+
+  /// Set of key-value pairs that you can attach to an object. You can use this
+  /// to store additional information about the object (for example, cost basis)
+  /// in a structured format.
+  final Map<String, dynamic>? metadata;
+
+  /// A descriptive name shown in the Dashboard.
+  final String? name;
+
+  CreateCreditGrantRequest({
+    required this.amount,
+    required this.applicabilityConfig,
+    required this.category,
+    required this.customer,
+    this.effectiveAt,
+    this.expiresAt,
+    this.metadata,
+    this.name,
+  });
+
+  factory CreateCreditGrantRequest.fromJson(Map<String, dynamic> json) =>
+      _$CreateCreditGrantRequestFromJson(json);
+
+  Map<String, dynamic> toJson() => _$CreateCreditGrantRequestToJson(this);
+}
+
+/// https://docs.stripe.com/api/billing/credit-grant/create#create_billing_credit_grant-amount
+@JsonSerializable()
+class CreditGrantCreateRequestAmount {
+  /// Specify the type of this amount. We currently only support monetary
+  /// billing credits.
+  final CreditGrantAmountType type;
+
+  /// The monetary amount.
+  final CreditGrantAmountMonetary monetary;
+
+  CreditGrantCreateRequestAmount({
+    required this.type,
+    required this.monetary,
+  });
+
+  factory CreditGrantCreateRequestAmount.fromJson(Map<String, dynamic> json) =>
+      _$CreditGrantCreateRequestAmountFromJson(json);
+
+  Map<String, dynamic> toJson() => _$CreditGrantCreateRequestAmountToJson(this);
+}
+
+/// https://docs.stripe.com/api/billing/credit-grant/create#create_billing_credit_grant-applicability_config
+@JsonSerializable()
+class CreditGrantCreateRequestApplicabilityConfig {
+  /// Specify the scope of this applicability config.
+  final CreditGrantCreateRequestApplicabilityConfigScope scope;
+
+  CreditGrantCreateRequestApplicabilityConfig({
+    required this.scope,
+  });
+
+  factory CreditGrantCreateRequestApplicabilityConfig.fromJson(
+          Map<String, dynamic> json) =>
+      _$CreditGrantCreateRequestApplicabilityConfigFromJson(json);
+
+  Map<String, dynamic> toJson() =>
+      _$CreditGrantCreateRequestApplicabilityConfigToJson(this);
+}
+
+/// https://docs.stripe.com/api/billing/credit-grant/create#create_billing_credit_grant-applicability_config
+@JsonSerializable()
+class CreditGrantCreateRequestApplicabilityConfigScope {
+  /// The price type that credit grants can apply to. We currently only support
+  /// the metered price type. Cannot be used in combination with prices.
+  final CreditGrantApplicabilityConfigScopePriceType? priceType;
+
+  CreditGrantCreateRequestApplicabilityConfigScope({
+    this.priceType,
+  });
+
+  factory CreditGrantCreateRequestApplicabilityConfigScope.fromJson(
+          Map<String, dynamic> json) =>
+      _$CreditGrantCreateRequestApplicabilityConfigScopeFromJson(json);
+
+  Map<String, dynamic> toJson() =>
+      _$CreditGrantCreateRequestApplicabilityConfigScopeToJson(this);
+}

lib/src/messages/requests/create_credit_grant.dart

@@ -0,0 +1,38 @@
+part of '../../../messages.dart';
+
+/// https://docs.stripe.com/api/billing/credit-grant/list
+@JsonSerializable()
+class ListCreditGrantsRequest {
+  /// Only return credit grants for this customer.
+  final String? customer;
+
+  /// A cursor for use in pagination. ending_before is an object ID that defines
+  /// your place in the list. For instance, if you make a list request and
+  /// receive 100 objects, starting with obj_bar, your subsequent call can
+  /// include ending_before=obj_bar in order to fetch the previous page of the
+  /// list.
+  final String? endingBefore;
+
+  /// A limit on the number of objects to be returned. Limit can range between 1
+  /// and 100, and the default is 10.
+  final int? limit;
+
+  /// A cursor for use in pagination. starting_after is an object ID that
+  /// defines your place in the list. For instance, if you make a list request
+  /// and receive 100 objects, ending with obj_foo, your subsequent call can
+  /// include starting_after=obj_foo in order to fetch the next page of the
+  /// list.
+  final String? startingAfter;
+
+  ListCreditGrantsRequest({
+    this.customer,
+    this.endingBefore,
+    this.limit,
+    this.startingAfter,
+  });
+
+  factory ListCreditGrantsRequest.fromJson(Map<String, dynamic> json) =>
+      _$ListCreditGrantsRequestFromJson(json);
+
+  Map<String, dynamic> toJson() => _$ListCreditGrantsRequestToJson(this);
+}

lib/src/messages/requests/list_credit_grants.dart

@@ -0,0 +1,28 @@
+part of '../../../messages.dart';
+
+/// https://docs.stripe.com/api/billing/credit-grant/update
+@JsonSerializable()
+class UpdateCreditGrantRequest {
+  /// Unique identifier for the object.
+  final String id;
+
+  /// The time when the billing credits created by this credit grant expire. If
+  /// set to empty, the billing credits never expire.
+  final int? expiresAt;
+
+  /// Set of key-value pairs you can attach to an object. You can use this to
+  /// store additional information about the object (for example, cost basis) in
+  /// a structured format.
+  final Map<String, dynamic>? metadata;
+
+  UpdateCreditGrantRequest({
+    required this.id,
+    this.expiresAt,
+    this.metadata,
+  });
+
+  factory UpdateCreditGrantRequest.fromJson(Map<String, dynamic> json) =>
+      _$UpdateCreditGrantRequestFromJson(json);
+
+  Map<String, dynamic> toJson() => _$UpdateCreditGrantRequestToJson(this);
+}