@schematichq/schematic-components 2.33.0 → 2.34.1

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
  /**
@@ -3612,6 +3655,7 @@ declare const CheckoutProblemCode: {
3612
3655
  readonly BillingStartDateNeedsRenewalDate: "billing_start_date_needs_renewal_date";
3613
3656
  readonly BillingStartDateNotBeforeRenewalDate: "billing_start_date_not_before_renewal_date";
3614
3657
  readonly BillingStartDateTooFarInPast: "billing_start_date_too_far_in_past";
3658
+ readonly CheckoutSuperseded: "checkout_superseded";
3615
3659
  readonly CreditBundleIncompatible: "credit_bundle_incompatible";
3616
3660
  readonly CreditBundleUnavailable: "credit_bundle_unavailable";
3617
3661
  readonly CreditBundlesActivateOnPayment: "credit_bundles_activate_on_payment";
@@ -3619,6 +3663,9 @@ declare const CheckoutProblemCode: {
3619
3663
  readonly CustomFieldRequired: "custom_field_required";
3620
3664
  readonly DiscountIneligible: "discount_ineligible";
3621
3665
  readonly DowngradeNotPermitted: "downgrade_not_permitted";
3666
+ readonly EndDateMustBeFuture: "end_date_must_be_future";
3667
+ readonly EndDateNeedsNewSubscription: "end_date_needs_new_subscription";
3668
+ readonly EndDateNotAfterRenewalDate: "end_date_not_after_renewal_date";
3622
3669
  readonly FreeFirstPeriodActivatesOnPayment: "free_first_period_activates_on_payment";
3623
3670
  readonly InvoiceEmailRequired: "invoice_email_required";
3624
3671
  readonly InvoicedSubscriptionConflictsWithTrial: "invoiced_subscription_conflicts_with_trial";
@@ -4056,6 +4103,18 @@ declare interface CheckoutUnsubscribeResponse {
4056
4103
  params: object;
4057
4104
  }
4058
4105
 
4106
+ /**
4107
+ *
4108
+ * @export
4109
+ */
4110
+ declare const Collector: {
4111
+ readonly External: "external";
4112
+ readonly StripeInvoice: "stripe_invoice";
4113
+ readonly StripePayments: "stripe_payments";
4114
+ };
4115
+
4116
+ declare type Collector = (typeof Collector)[keyof typeof Collector];
4117
+
4059
4118
  export declare const Column: ForwardRefExoticComponent<Omit<ColumnProps, "ref"> & RefAttributes<HTMLDivElement | null>>;
4060
4119
 
4061
4120
  export declare interface ColumnProps extends React.HTMLProps<HTMLDivElement> {
@@ -4086,6 +4145,12 @@ declare interface CompanyBillingProfileResponseData {
4086
4145
  * @memberof CompanyBillingProfileResponseData
4087
4146
  */
4088
4147
  collectionMethod: BillingCollectionMethod;
4148
+ /**
4149
+ *
4150
+ * @type {Collector}
4151
+ * @memberof CompanyBillingProfileResponseData
4152
+ */
4153
+ collector?: Collector | null;
4089
4154
  /**
4090
4155
  *
4091
4156
  * @type {string}
@@ -4098,6 +4163,12 @@ declare interface CompanyBillingProfileResponseData {
4098
4163
  * @memberof CompanyBillingProfileResponseData
4099
4164
  */
4100
4165
  createdAt: Date;
4166
+ /**
4167
+ *
4168
+ * @type {Currency}
4169
+ * @memberof CompanyBillingProfileResponseData
4170
+ */
4171
+ currency?: Currency | null;
4101
4172
  /**
4102
4173
  *
4103
4174
  * @type {number}
@@ -4110,6 +4181,12 @@ declare interface CompanyBillingProfileResponseData {
4110
4181
  * @memberof CompanyBillingProfileResponseData
4111
4182
  */
4112
4183
  environmentId: string;
4184
+ /**
4185
+ *
4186
+ * @type {number}
4187
+ * @memberof CompanyBillingProfileResponseData
4188
+ */
4189
+ gatingDays: number;
4113
4190
  /**
4114
4191
  *
4115
4192
  * @type {string}
@@ -4128,6 +4205,18 @@ declare interface CompanyBillingProfileResponseData {
4128
4205
  * @memberof CompanyBillingProfileResponseData
4129
4206
  */
4130
4207
  name?: string | null;
4208
+ /**
4209
+ *
4210
+ * @type {number}
4211
+ * @memberof CompanyBillingProfileResponseData
4212
+ */
4213
+ overdraftLimit?: number | null;
4214
+ /**
4215
+ *
4216
+ * @type {PaymentGating}
4217
+ * @memberof CompanyBillingProfileResponseData
4218
+ */
4219
+ paymentGating: PaymentGating;
4131
4220
  /**
4132
4221
  *
4133
4222
  * @type {string}
@@ -4146,6 +4235,12 @@ declare interface CompanyBillingProfileResponseData {
4146
4235
  * @memberof CompanyBillingProfileResponseData
4147
4236
  */
4148
4237
  providerType: BillingProviderType;
4238
+ /**
4239
+ *
4240
+ * @type {string}
4241
+ * @memberof CompanyBillingProfileResponseData
4242
+ */
4243
+ purchaseOrder?: string | null;
4149
4244
  /**
4150
4245
  *
4151
4246
  * @type {Date}
@@ -7194,6 +7289,12 @@ declare interface CustomPlanBillingResponseData {
7194
7289
  * @memberof CustomPlanBillingResponseData
7195
7290
  */
7196
7291
  daysUntilDue: number;
7292
+ /**
7293
+ * 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.
7294
+ * @type {Date}
7295
+ * @memberof CustomPlanBillingResponseData
7296
+ */
7297
+ endDate?: Date | null;
7197
7298
  /**
7198
7299
  *
7199
7300
  * @type {string}
@@ -8248,6 +8349,7 @@ export declare interface EntitlementProps {
8248
8349
  */
8249
8350
  declare const EntitlementType: {
8250
8351
  readonly CompanyOverride: "company_override";
8352
+ readonly PlanCreditGrant: "plan_credit_grant";
8251
8353
  readonly PlanEntitlement: "plan_entitlement";
8252
8354
  readonly Unknown: "unknown";
8253
8355
  };
@@ -9721,11 +9823,12 @@ declare interface FlagInPlanResponseData {
9721
9823
  */
9722
9824
  createdAt: Date;
9723
9825
  /**
9724
- *
9826
+ * 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
9827
  * @type {boolean}
9726
9828
  * @memberof FlagInPlanResponseData
9829
+ * @deprecated
9727
9830
  */
9728
- defaultValue: boolean;
9831
+ defaultValue?: boolean | null;
9729
9832
  /**
9730
9833
  *
9731
9834
  * @type {string}
@@ -9807,11 +9910,12 @@ declare interface FlagInPlanResponseData_2 {
9807
9910
  */
9808
9911
  createdAt: Date;
9809
9912
  /**
9810
- *
9913
+ * 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
9914
  * @type {boolean}
9812
9915
  * @memberof FlagInPlanResponseData
9916
+ * @deprecated
9813
9917
  */
9814
- defaultValue: boolean;
9918
+ defaultValue?: boolean | null;
9815
9919
  /**
9816
9920
  *
9817
9921
  * @type {string}
@@ -10617,6 +10721,17 @@ style?: CSSProperties | CSSPropertiesWithVars | (CSSProperties & {
10617
10721
  }) | undefined;
10618
10722
  }> & string;
10619
10723
 
10724
+ /**
10725
+ *
10726
+ * @export
10727
+ */
10728
+ declare const PaymentGating: {
10729
+ readonly KeepServing: "keep_serving";
10730
+ readonly RevokeAfter: "revoke_after";
10731
+ };
10732
+
10733
+ declare type PaymentGating = (typeof PaymentGating)[keyof typeof PaymentGating];
10734
+
10620
10735
  export declare const PaymentMethod: ForwardRefExoticComponent<ElementProps & DeepPartial<DesignProps_5> & HTMLAttributes<HTMLDivElement> & {
10621
10736
  portal?: HTMLElement | null;
10622
10737
  allowEdit?: boolean;
@@ -12601,6 +12716,12 @@ declare interface PlanVersionResponseData {
12601
12716
  * @memberof PlanVersionResponseData
12602
12717
  */
12603
12718
  planType: PlanType;
12719
+ /**
12720
+ *
12721
+ * @type {RenewalPolicy}
12722
+ * @memberof PlanVersionResponseData
12723
+ */
12724
+ renewalPolicy: RenewalPolicy;
12604
12725
  /**
12605
12726
  *
12606
12727
  * @type {PlanVersionStatus}
@@ -12675,6 +12796,12 @@ declare interface PlanVersionResponseData_2 {
12675
12796
  * @memberof PlanVersionResponseData
12676
12797
  */
12677
12798
  planType: PlanType_2;
12799
+ /**
12800
+ *
12801
+ * @type {RenewalPolicy}
12802
+ * @memberof PlanVersionResponseData
12803
+ */
12804
+ renewalPolicy: RenewalPolicy_2;
12678
12805
  /**
12679
12806
  *
12680
12807
  * @type {PlanVersionStatus}
@@ -13657,6 +13784,30 @@ export declare interface RehydrateParams {
13657
13784
  includeAddOnIds?: string[];
13658
13785
  }
13659
13786
 
13787
+ /**
13788
+ *
13789
+ * @export
13790
+ */
13791
+ declare const RenewalPolicy: {
13792
+ readonly AutoRenew: "auto_renew";
13793
+ readonly ExpireToDefault: "expire_to_default";
13794
+ readonly HoldWithGrace: "hold_with_grace";
13795
+ };
13796
+
13797
+ declare type RenewalPolicy = (typeof RenewalPolicy)[keyof typeof RenewalPolicy];
13798
+
13799
+ /**
13800
+ *
13801
+ * @export
13802
+ */
13803
+ declare const RenewalPolicy_2: {
13804
+ readonly AutoRenew: "auto_renew";
13805
+ readonly ExpireToDefault: "expire_to_default";
13806
+ readonly HoldWithGrace: "hold_with_grace";
13807
+ };
13808
+
13809
+ declare type RenewalPolicy_2 = (typeof RenewalPolicy_2)[keyof typeof RenewalPolicy_2];
13810
+
13660
13811
  declare interface RequestContext {
13661
13812
  fetch: FetchAPI;
13662
13813
  url: string;