@schematichq/schematic-components 2.34.0 → 2.35.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1414,6 +1414,49 @@ declare interface BillingPlanCreditGrantResponseData {
1414
1414
  * @memberof BillingPlanCreditGrantResponseData
1415
1415
  */
1416
1416
  updatedAt: Date;
1417
+ /**
1418
+ * Usage-warning thresholds, in credits remaining in the company's balance, highest first. Schematic sends a credit.usage_warning_reached webhook when the balance drops to each one. Empty when none are set.
1419
+ * @type {Array<BillingPlanCreditGrantWarningTierResponseData>}
1420
+ * @memberof BillingPlanCreditGrantResponseData
1421
+ */
1422
+ warningTiers: Array<BillingPlanCreditGrantWarningTierResponseData>;
1423
+ }
1424
+
1425
+ /**
1426
+ * Schematic API
1427
+ * Schematic API
1428
+ *
1429
+ * The version of the OpenAPI document: 0.1
1430
+ *
1431
+ *
1432
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1433
+ * https://openapi-generator.tech
1434
+ * Do not edit the class manually.
1435
+ */
1436
+ /**
1437
+ *
1438
+ * @export
1439
+ * @interface BillingPlanCreditGrantWarningTierResponseData
1440
+ */
1441
+ declare interface BillingPlanCreditGrantWarningTierResponseData {
1442
+ /**
1443
+ *
1444
+ * @type {string}
1445
+ * @memberof BillingPlanCreditGrantWarningTierResponseData
1446
+ */
1447
+ id: string;
1448
+ /**
1449
+ *
1450
+ * @type {string}
1451
+ * @memberof BillingPlanCreditGrantWarningTierResponseData
1452
+ */
1453
+ key: string;
1454
+ /**
1455
+ * Credits remaining in the company's balance at which this warning is reached.
1456
+ * @type {number}
1457
+ * @memberof BillingPlanCreditGrantWarningTierResponseData
1458
+ */
1459
+ value: number;
1417
1460
  }
1418
1461
 
1419
1462
  /**
@@ -3483,6 +3526,18 @@ declare const CheckoutBundlePurchaseBehavior: {
3483
3526
 
3484
3527
  declare type CheckoutBundlePurchaseBehavior = (typeof CheckoutBundlePurchaseBehavior)[keyof typeof CheckoutBundlePurchaseBehavior];
3485
3528
 
3529
+ /**
3530
+ *
3531
+ * @export
3532
+ */
3533
+ declare const CheckoutChargeTiming: {
3534
+ readonly AtRenewal: "at_renewal";
3535
+ readonly None: "none";
3536
+ readonly Now: "now";
3537
+ };
3538
+
3539
+ declare type CheckoutChargeTiming = (typeof CheckoutChargeTiming)[keyof typeof CheckoutChargeTiming];
3540
+
3486
3541
  export declare const CheckoutDialog: ({ top }: CheckoutDialogProps) => JSX.Element | null;
3487
3542
 
3488
3543
  declare interface CheckoutDialogProps {
@@ -3612,6 +3667,7 @@ declare const CheckoutProblemCode: {
3612
3667
  readonly BillingStartDateNeedsRenewalDate: "billing_start_date_needs_renewal_date";
3613
3668
  readonly BillingStartDateNotBeforeRenewalDate: "billing_start_date_not_before_renewal_date";
3614
3669
  readonly BillingStartDateTooFarInPast: "billing_start_date_too_far_in_past";
3670
+ readonly CheckoutSuperseded: "checkout_superseded";
3615
3671
  readonly CreditBundleIncompatible: "credit_bundle_incompatible";
3616
3672
  readonly CreditBundleUnavailable: "credit_bundle_unavailable";
3617
3673
  readonly CreditBundlesActivateOnPayment: "credit_bundles_activate_on_payment";
@@ -3619,6 +3675,9 @@ declare const CheckoutProblemCode: {
3619
3675
  readonly CustomFieldRequired: "custom_field_required";
3620
3676
  readonly DiscountIneligible: "discount_ineligible";
3621
3677
  readonly DowngradeNotPermitted: "downgrade_not_permitted";
3678
+ readonly EndDateMustBeFuture: "end_date_must_be_future";
3679
+ readonly EndDateNeedsNewSubscription: "end_date_needs_new_subscription";
3680
+ readonly EndDateNotAfterRenewalDate: "end_date_not_after_renewal_date";
3622
3681
  readonly FreeFirstPeriodActivatesOnPayment: "free_first_period_activates_on_payment";
3623
3682
  readonly InvoiceEmailRequired: "invoice_email_required";
3624
3683
  readonly InvoicedSubscriptionConflictsWithTrial: "invoiced_subscription_conflicts_with_trial";
@@ -4056,6 +4115,18 @@ declare interface CheckoutUnsubscribeResponse {
4056
4115
  params: object;
4057
4116
  }
4058
4117
 
4118
+ /**
4119
+ *
4120
+ * @export
4121
+ */
4122
+ declare const Collector: {
4123
+ readonly External: "external";
4124
+ readonly StripeInvoice: "stripe_invoice";
4125
+ readonly StripePayments: "stripe_payments";
4126
+ };
4127
+
4128
+ declare type Collector = (typeof Collector)[keyof typeof Collector];
4129
+
4059
4130
  export declare const Column: ForwardRefExoticComponent<Omit<ColumnProps, "ref"> & RefAttributes<HTMLDivElement | null>>;
4060
4131
 
4061
4132
  export declare interface ColumnProps extends React.HTMLProps<HTMLDivElement> {
@@ -4086,6 +4157,12 @@ declare interface CompanyBillingProfileResponseData {
4086
4157
  * @memberof CompanyBillingProfileResponseData
4087
4158
  */
4088
4159
  collectionMethod: BillingCollectionMethod;
4160
+ /**
4161
+ *
4162
+ * @type {Collector}
4163
+ * @memberof CompanyBillingProfileResponseData
4164
+ */
4165
+ collector?: Collector | null;
4089
4166
  /**
4090
4167
  *
4091
4168
  * @type {string}
@@ -4098,6 +4175,12 @@ declare interface CompanyBillingProfileResponseData {
4098
4175
  * @memberof CompanyBillingProfileResponseData
4099
4176
  */
4100
4177
  createdAt: Date;
4178
+ /**
4179
+ *
4180
+ * @type {Currency}
4181
+ * @memberof CompanyBillingProfileResponseData
4182
+ */
4183
+ currency?: Currency | null;
4101
4184
  /**
4102
4185
  *
4103
4186
  * @type {number}
@@ -4110,6 +4193,12 @@ declare interface CompanyBillingProfileResponseData {
4110
4193
  * @memberof CompanyBillingProfileResponseData
4111
4194
  */
4112
4195
  environmentId: string;
4196
+ /**
4197
+ *
4198
+ * @type {number}
4199
+ * @memberof CompanyBillingProfileResponseData
4200
+ */
4201
+ gatingDays: number;
4113
4202
  /**
4114
4203
  *
4115
4204
  * @type {string}
@@ -4128,6 +4217,18 @@ declare interface CompanyBillingProfileResponseData {
4128
4217
  * @memberof CompanyBillingProfileResponseData
4129
4218
  */
4130
4219
  name?: string | null;
4220
+ /**
4221
+ *
4222
+ * @type {number}
4223
+ * @memberof CompanyBillingProfileResponseData
4224
+ */
4225
+ overdraftLimit?: number | null;
4226
+ /**
4227
+ *
4228
+ * @type {PaymentGating}
4229
+ * @memberof CompanyBillingProfileResponseData
4230
+ */
4231
+ paymentGating: PaymentGating;
4131
4232
  /**
4132
4233
  *
4133
4234
  * @type {string}
@@ -4146,6 +4247,12 @@ declare interface CompanyBillingProfileResponseData {
4146
4247
  * @memberof CompanyBillingProfileResponseData
4147
4248
  */
4148
4249
  providerType: BillingProviderType;
4250
+ /**
4251
+ *
4252
+ * @type {string}
4253
+ * @memberof CompanyBillingProfileResponseData
4254
+ */
4255
+ purchaseOrder?: string | null;
4149
4256
  /**
4150
4257
  *
4151
4258
  * @type {Date}
@@ -7194,6 +7301,12 @@ declare interface CustomPlanBillingResponseData {
7194
7301
  * @memberof CustomPlanBillingResponseData
7195
7302
  */
7196
7303
  daysUntilDue: number;
7304
+ /**
7305
+ * When a custom plan that doesn't renew ends: the renewal the subscription stops on and the company moves to the default plan. Null for a plan that renews.
7306
+ * @type {Date}
7307
+ * @memberof CustomPlanBillingResponseData
7308
+ */
7309
+ endDate?: Date | null;
7197
7310
  /**
7198
7311
  *
7199
7312
  * @type {string}
@@ -8248,6 +8361,7 @@ export declare interface EntitlementProps {
8248
8361
  */
8249
8362
  declare const EntitlementType: {
8250
8363
  readonly CompanyOverride: "company_override";
8364
+ readonly PlanCreditGrant: "plan_credit_grant";
8251
8365
  readonly PlanEntitlement: "plan_entitlement";
8252
8366
  readonly Unknown: "unknown";
8253
8367
  };
@@ -9721,11 +9835,12 @@ declare interface FlagInPlanResponseData {
9721
9835
  */
9722
9836
  createdAt: Date;
9723
9837
  /**
9724
- *
9838
+ * Deprecated. The value a check returns in the requesting environment when no other rule matches: its default rule, or the flag's seed value while it has none. Read the default rule instead
9725
9839
  * @type {boolean}
9726
9840
  * @memberof FlagInPlanResponseData
9841
+ * @deprecated
9727
9842
  */
9728
- defaultValue: boolean;
9843
+ defaultValue?: boolean | null;
9729
9844
  /**
9730
9845
  *
9731
9846
  * @type {string}
@@ -9807,11 +9922,12 @@ declare interface FlagInPlanResponseData_2 {
9807
9922
  */
9808
9923
  createdAt: Date;
9809
9924
  /**
9810
- *
9925
+ * Deprecated. The value a check returns in the requesting environment when no other rule matches: its default rule, or the flag's seed value while it has none. Read the default rule instead
9811
9926
  * @type {boolean}
9812
9927
  * @memberof FlagInPlanResponseData
9928
+ * @deprecated
9813
9929
  */
9814
- defaultValue: boolean;
9930
+ defaultValue?: boolean | null;
9815
9931
  /**
9816
9932
  *
9817
9933
  * @type {string}
@@ -10617,6 +10733,17 @@ style?: CSSProperties | CSSPropertiesWithVars | (CSSProperties & {
10617
10733
  }) | undefined;
10618
10734
  }> & string;
10619
10735
 
10736
+ /**
10737
+ *
10738
+ * @export
10739
+ */
10740
+ declare const PaymentGating: {
10741
+ readonly KeepServing: "keep_serving";
10742
+ readonly RevokeAfter: "revoke_after";
10743
+ };
10744
+
10745
+ declare type PaymentGating = (typeof PaymentGating)[keyof typeof PaymentGating];
10746
+
10620
10747
  export declare const PaymentMethod: ForwardRefExoticComponent<ElementProps & DeepPartial<DesignProps_5> & HTMLAttributes<HTMLDivElement> & {
10621
10748
  portal?: HTMLElement | null;
10622
10749
  allowEdit?: boolean;
@@ -12601,6 +12728,12 @@ declare interface PlanVersionResponseData {
12601
12728
  * @memberof PlanVersionResponseData
12602
12729
  */
12603
12730
  planType: PlanType;
12731
+ /**
12732
+ *
12733
+ * @type {RenewalPolicy}
12734
+ * @memberof PlanVersionResponseData
12735
+ */
12736
+ renewalPolicy: RenewalPolicy;
12604
12737
  /**
12605
12738
  *
12606
12739
  * @type {PlanVersionStatus}
@@ -12675,6 +12808,12 @@ declare interface PlanVersionResponseData_2 {
12675
12808
  * @memberof PlanVersionResponseData
12676
12809
  */
12677
12810
  planType: PlanType_2;
12811
+ /**
12812
+ *
12813
+ * @type {RenewalPolicy}
12814
+ * @memberof PlanVersionResponseData
12815
+ */
12816
+ renewalPolicy: RenewalPolicy_2;
12678
12817
  /**
12679
12818
  *
12680
12819
  * @type {PlanVersionStatus}
@@ -13383,6 +13522,18 @@ declare interface PreviewSubscriptionFinanceResponseData {
13383
13522
  * @memberof PreviewSubscriptionFinanceResponseData
13384
13523
  */
13385
13524
  currency: Currency;
13525
+ /**
13526
+ * What the company's stored credit covers of this invoice, in minor units.
13527
+ * @type {number}
13528
+ * @memberof PreviewSubscriptionFinanceResponseData
13529
+ */
13530
+ customerBalanceApplied: number;
13531
+ /**
13532
+ * Credit left on the company's balance after this invoice, in minor units: what it did not consume, plus what a total below zero adds, which the provider applies to later invoices.
13533
+ * @type {number}
13534
+ * @memberof PreviewSubscriptionFinanceResponseData
13535
+ */
13536
+ customerBalanceRemaining: number;
13386
13537
  /**
13387
13538
  *
13388
13539
  * @type {number}
@@ -13443,6 +13594,12 @@ declare interface PreviewSubscriptionFinanceResponseData {
13443
13594
  * @memberof PreviewSubscriptionFinanceResponseData
13444
13595
  */
13445
13596
  prorationBilledAt?: Date | null;
13597
+ /**
13598
+ * The proration itemized in the cart's terms, by plan and price. Null when the change prorates nothing. upcoming_invoice_line_items stays as the billing provider reported it.
13599
+ * @type {PreviewSubscriptionProrationResponseData}
13600
+ * @memberof PreviewSubscriptionFinanceResponseData
13601
+ */
13602
+ prorationDetail?: PreviewSubscriptionProrationResponseData;
13446
13603
  /**
13447
13604
  *
13448
13605
  * @type {number}
@@ -13481,6 +13638,106 @@ declare interface PreviewSubscriptionFinanceResponseData {
13481
13638
  upcomingInvoiceLineItems: Array<PreviewSubscriptionUpcomingInvoiceLineItems>;
13482
13639
  }
13483
13640
 
13641
+ /**
13642
+ *
13643
+ * @export
13644
+ * @interface PreviewSubscriptionProrationLineResponseData
13645
+ */
13646
+ declare interface PreviewSubscriptionProrationLineResponseData {
13647
+ /**
13648
+ * In minor units of the block's currency; negative on a credit.
13649
+ * @type {number}
13650
+ * @memberof PreviewSubscriptionProrationLineResponseData
13651
+ */
13652
+ amount: number;
13653
+ /**
13654
+ *
13655
+ * @type {ProrationLineKind}
13656
+ * @memberof PreviewSubscriptionProrationLineResponseData
13657
+ */
13658
+ kind: ProrationLineKind;
13659
+ /**
13660
+ *
13661
+ * @type {Date}
13662
+ * @memberof PreviewSubscriptionProrationLineResponseData
13663
+ */
13664
+ periodEnd?: Date | null;
13665
+ /**
13666
+ *
13667
+ * @type {Date}
13668
+ * @memberof PreviewSubscriptionProrationLineResponseData
13669
+ */
13670
+ periodStart?: Date | null;
13671
+ /**
13672
+ * The plan or add-on in the cart the price belongs to. Null for a price the subscription carries outside the cart.
13673
+ * @type {string}
13674
+ * @memberof PreviewSubscriptionProrationLineResponseData
13675
+ */
13676
+ planId?: string | null;
13677
+ /**
13678
+ * The Schematic price. Null when the provider priced something Schematic does not carry.
13679
+ * @type {string}
13680
+ * @memberof PreviewSubscriptionProrationLineResponseData
13681
+ */
13682
+ priceId?: string | null;
13683
+ /**
13684
+ *
13685
+ * @type {number}
13686
+ * @memberof PreviewSubscriptionProrationLineResponseData
13687
+ */
13688
+ quantity?: number | null;
13689
+ }
13690
+
13691
+ /**
13692
+ *
13693
+ * @export
13694
+ * @interface PreviewSubscriptionProrationResponseData
13695
+ */
13696
+ declare interface PreviewSubscriptionProrationResponseData {
13697
+ /**
13698
+ * When the proration is charged: the change for now, the period's end for at_renewal. Null when nothing is charged.
13699
+ * @type {Date}
13700
+ * @memberof PreviewSubscriptionProrationResponseData
13701
+ */
13702
+ billedAt?: Date | null;
13703
+ /**
13704
+ * Sum of the charge lines, in minor units, before tax.
13705
+ * @type {number}
13706
+ * @memberof PreviewSubscriptionProrationResponseData
13707
+ */
13708
+ charge: number;
13709
+ /**
13710
+ * Sum of the credit lines, in minor units, before tax: zero or below.
13711
+ * @type {number}
13712
+ * @memberof PreviewSubscriptionProrationResponseData
13713
+ */
13714
+ credit: number;
13715
+ /**
13716
+ *
13717
+ * @type {Currency}
13718
+ * @memberof PreviewSubscriptionProrationResponseData
13719
+ */
13720
+ currency: Currency;
13721
+ /**
13722
+ *
13723
+ * @type {Array<PreviewSubscriptionProrationLineResponseData>}
13724
+ * @memberof PreviewSubscriptionProrationResponseData
13725
+ */
13726
+ lines: Array<PreviewSubscriptionProrationLineResponseData>;
13727
+ /**
13728
+ * When the proration is charged: now, at_renewal, or none when it nets to nothing.
13729
+ * @type {CheckoutChargeTiming}
13730
+ * @memberof PreviewSubscriptionProrationResponseData
13731
+ */
13732
+ timing: CheckoutChargeTiming;
13733
+ /**
13734
+ * credit plus charge, before tax. Equals proration.
13735
+ * @type {number}
13736
+ * @memberof PreviewSubscriptionProrationResponseData
13737
+ */
13738
+ total: number;
13739
+ }
13740
+
13484
13741
  /**
13485
13742
  * Schematic API
13486
13743
  * Schematic API
@@ -13565,6 +13822,17 @@ declare const ProrationBehavior: {
13565
13822
 
13566
13823
  declare type ProrationBehavior = (typeof ProrationBehavior)[keyof typeof ProrationBehavior];
13567
13824
 
13825
+ /**
13826
+ *
13827
+ * @export
13828
+ */
13829
+ declare const ProrationLineKind: {
13830
+ readonly Charge: "charge";
13831
+ readonly Credit: "credit";
13832
+ };
13833
+
13834
+ declare type ProrationLineKind = (typeof ProrationLineKind)[keyof typeof ProrationLineKind];
13835
+
13568
13836
  /**
13569
13837
  *
13570
13838
  * @export
@@ -13657,6 +13925,30 @@ export declare interface RehydrateParams {
13657
13925
  includeAddOnIds?: string[];
13658
13926
  }
13659
13927
 
13928
+ /**
13929
+ *
13930
+ * @export
13931
+ */
13932
+ declare const RenewalPolicy: {
13933
+ readonly AutoRenew: "auto_renew";
13934
+ readonly ExpireToDefault: "expire_to_default";
13935
+ readonly HoldWithGrace: "hold_with_grace";
13936
+ };
13937
+
13938
+ declare type RenewalPolicy = (typeof RenewalPolicy)[keyof typeof RenewalPolicy];
13939
+
13940
+ /**
13941
+ *
13942
+ * @export
13943
+ */
13944
+ declare const RenewalPolicy_2: {
13945
+ readonly AutoRenew: "auto_renew";
13946
+ readonly ExpireToDefault: "expire_to_default";
13947
+ readonly HoldWithGrace: "hold_with_grace";
13948
+ };
13949
+
13950
+ declare type RenewalPolicy_2 = (typeof RenewalPolicy_2)[keyof typeof RenewalPolicy_2];
13951
+
13660
13952
  declare interface RequestContext {
13661
13953
  fetch: FetchAPI;
13662
13954
  url: string;