@schematichq/schematic-components 2.25.0 → 2.25.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.
@@ -51,6 +51,52 @@ declare interface AvailablePlanOptions {
51
51
  useSelectedPeriod?: boolean;
52
52
  }
53
53
 
54
+ /**
55
+ *
56
+ * @export
57
+ */
58
+ declare const BillingArrearsAnchor: {
59
+ readonly BillingPeriodStart: "billing_period_start";
60
+ readonly MonthEnd: "month_end";
61
+ };
62
+
63
+ declare type BillingArrearsAnchor = (typeof BillingArrearsAnchor)[keyof typeof BillingArrearsAnchor];
64
+
65
+ /**
66
+ *
67
+ * @export
68
+ */
69
+ declare const BillingArrearsAnchor_2: {
70
+ readonly BillingPeriodStart: "billing_period_start";
71
+ readonly MonthEnd: "month_end";
72
+ };
73
+
74
+ declare type BillingArrearsAnchor_2 = (typeof BillingArrearsAnchor_2)[keyof typeof BillingArrearsAnchor_2];
75
+
76
+ /**
77
+ *
78
+ * @export
79
+ */
80
+ declare const BillingArrearsCadence: {
81
+ readonly Daily: "daily";
82
+ readonly EndOfBillingPeriod: "end_of_billing_period";
83
+ readonly Monthly: "monthly";
84
+ };
85
+
86
+ declare type BillingArrearsCadence = (typeof BillingArrearsCadence)[keyof typeof BillingArrearsCadence];
87
+
88
+ /**
89
+ *
90
+ * @export
91
+ */
92
+ declare const BillingArrearsCadence_2: {
93
+ readonly Daily: "daily";
94
+ readonly EndOfBillingPeriod: "end_of_billing_period";
95
+ readonly Monthly: "monthly";
96
+ };
97
+
98
+ declare type BillingArrearsCadence_2 = (typeof BillingArrearsCadence_2)[keyof typeof BillingArrearsCadence_2];
99
+
54
100
  /**
55
101
  *
56
102
  * @export
@@ -1005,6 +1051,18 @@ declare type BillingPlanCreditGrantResetType_2 = (typeof BillingPlanCreditGrantR
1005
1051
  * @interface BillingPlanCreditGrantResponseData
1006
1052
  */
1007
1053
  declare interface BillingPlanCreditGrantResponseData {
1054
+ /**
1055
+ * Which boundary closes a monthly arrears window. Only meaningful when arrears_cadence is monthly.
1056
+ * @type {BillingArrearsAnchor}
1057
+ * @memberof BillingPlanCreditGrantResponseData
1058
+ */
1059
+ arrearsAnchor?: BillingArrearsAnchor | null;
1060
+ /**
1061
+ * How often postpaid charges are closed and invoiced. Defaults to end_of_billing_period.
1062
+ * @type {BillingArrearsCadence}
1063
+ * @memberof BillingPlanCreditGrantResponseData
1064
+ */
1065
+ arrearsCadence?: BillingArrearsCadence | null;
1008
1066
  /**
1009
1067
  *
1010
1068
  * @type {number}
@@ -1155,6 +1213,12 @@ declare interface BillingPlanCreditGrantResponseData {
1155
1213
  * @memberof BillingPlanCreditGrantResponseData
1156
1214
  */
1157
1215
  licenseId?: string | null;
1216
+ /**
1217
+ * Optional limit on how far the balance may go below zero, in credits. A floor on the balance, not an allowance per invoice window: consumption is denied once the balance would fall below minus this figure, and stays denied until a new grant lands or the negative balance is settled. Absent means no limit.
1218
+ * @type {number}
1219
+ * @memberof BillingPlanCreditGrantResponseData
1220
+ */
1221
+ overdraftLimit?: number | null;
1158
1222
  /**
1159
1223
  *
1160
1224
  * @type {PreviewObjectResponseData}
@@ -1180,6 +1244,24 @@ declare interface BillingPlanCreditGrantResponseData {
1180
1244
  * @memberof BillingPlanCreditGrantResponseData
1181
1245
  */
1182
1246
  planVersionId?: string | null;
1247
+ /**
1248
+ * Whether consumption may continue past a zero balance, accruing at postpaid_rate_per_unit rather than being denied.
1249
+ * @type {boolean}
1250
+ * @memberof BillingPlanCreditGrantResponseData
1251
+ */
1252
+ postpaidEnabled: boolean;
1253
+ /**
1254
+ * Amount charged per credit consumed past zero, in the currency's minor unit. Defaults to the credit's own cost basis when postpaid is enabled without one.
1255
+ * @type {number}
1256
+ * @memberof BillingPlanCreditGrantResponseData
1257
+ */
1258
+ postpaidRatePerUnit?: number | null;
1259
+ /**
1260
+ * Decimal form of postpaid_rate_per_unit, for rates finer than one minor unit.
1261
+ * @type {string}
1262
+ * @memberof BillingPlanCreditGrantResponseData
1263
+ */
1264
+ postpaidRatePerUnitDecimal?: string | null;
1183
1265
  /**
1184
1266
  *
1185
1267
  * @type {BillingPlanCreditGrantResetCadence}
@@ -4274,6 +4356,18 @@ declare interface CompanyOverrideResponseData {
4274
4356
  * @interface CompanyPlanCreditGrantView
4275
4357
  */
4276
4358
  declare interface CompanyPlanCreditGrantView {
4359
+ /**
4360
+ *
4361
+ * @type {BillingArrearsAnchor}
4362
+ * @memberof CompanyPlanCreditGrantView
4363
+ */
4364
+ billingCreditArrearsAnchor?: BillingArrearsAnchor | null;
4365
+ /**
4366
+ *
4367
+ * @type {BillingArrearsCadence}
4368
+ * @memberof CompanyPlanCreditGrantView
4369
+ */
4370
+ billingCreditArrearsCadence?: BillingArrearsCadence | null;
4277
4371
  /**
4278
4372
  *
4279
4373
  * @type {number}
@@ -4340,6 +4434,30 @@ declare interface CompanyPlanCreditGrantView {
4340
4434
  * @memberof CompanyPlanCreditGrantView
4341
4435
  */
4342
4436
  billingCreditCanBuyBundles: boolean;
4437
+ /**
4438
+ *
4439
+ * @type {number}
4440
+ * @memberof CompanyPlanCreditGrantView
4441
+ */
4442
+ billingCreditOverdraftLimit?: number | null;
4443
+ /**
4444
+ *
4445
+ * @type {boolean}
4446
+ * @memberof CompanyPlanCreditGrantView
4447
+ */
4448
+ billingCreditPostpaidEnabled: boolean;
4449
+ /**
4450
+ *
4451
+ * @type {number}
4452
+ * @memberof CompanyPlanCreditGrantView
4453
+ */
4454
+ billingCreditPostpaidRatePerUnit?: number | null;
4455
+ /**
4456
+ *
4457
+ * @type {string}
4458
+ * @memberof CompanyPlanCreditGrantView
4459
+ */
4460
+ billingCreditPostpaidRatePerUnitDecimal?: string | null;
4343
4461
  /**
4344
4462
  *
4345
4463
  * @type {number}
@@ -5823,6 +5941,12 @@ declare interface CreditBundleCurrencyPrice {
5823
5941
  * @interface CreditCompanyGrantView
5824
5942
  */
5825
5943
  declare interface CreditCompanyGrantView {
5944
+ /**
5945
+ *
5946
+ * @type {BillingArrearsCadence}
5947
+ * @memberof CreditCompanyGrantView
5948
+ */
5949
+ arrearsCadence?: BillingArrearsCadence | null;
5826
5950
  /**
5827
5951
  *
5828
5952
  * @type {string}
@@ -5949,6 +6073,42 @@ declare interface CreditCompanyGrantView {
5949
6073
  * @memberof CreditCompanyGrantView
5950
6074
  */
5951
6075
  pluralName?: string | null;
6076
+ /**
6077
+ *
6078
+ * @type {number}
6079
+ * @memberof CreditCompanyGrantView
6080
+ */
6081
+ postpaidChargeAmount?: number | null;
6082
+ /**
6083
+ *
6084
+ * @type {string}
6085
+ * @memberof CreditCompanyGrantView
6086
+ */
6087
+ postpaidChargeCurrency?: string | null;
6088
+ /**
6089
+ *
6090
+ * @type {number}
6091
+ * @memberof CreditCompanyGrantView
6092
+ */
6093
+ postpaidChargedCredits?: number | null;
6094
+ /**
6095
+ *
6096
+ * @type {Date}
6097
+ * @memberof CreditCompanyGrantView
6098
+ */
6099
+ postpaidPeriodEnd?: Date | null;
6100
+ /**
6101
+ *
6102
+ * @type {number}
6103
+ * @memberof CreditCompanyGrantView
6104
+ */
6105
+ postpaidRate?: number | null;
6106
+ /**
6107
+ *
6108
+ * @type {string}
6109
+ * @memberof CreditCompanyGrantView
6110
+ */
6111
+ postpaidRateDecimal?: string | null;
5952
6112
  /**
5953
6113
  *
5954
6114
  * @type {BillingProductPriceResponseData}
@@ -9483,6 +9643,18 @@ declare type PlanCreditGrantScaling_2 = (typeof PlanCreditGrantScaling_2)[keyof
9483
9643
  * @interface PlanCreditGrantView
9484
9644
  */
9485
9645
  declare interface PlanCreditGrantView {
9646
+ /**
9647
+ *
9648
+ * @type {BillingArrearsAnchor}
9649
+ * @memberof PlanCreditGrantView
9650
+ */
9651
+ billingCreditArrearsAnchor?: BillingArrearsAnchor | null;
9652
+ /**
9653
+ *
9654
+ * @type {BillingArrearsCadence}
9655
+ * @memberof PlanCreditGrantView
9656
+ */
9657
+ billingCreditArrearsCadence?: BillingArrearsCadence | null;
9486
9658
  /**
9487
9659
  *
9488
9660
  * @type {number}
@@ -9549,6 +9721,30 @@ declare interface PlanCreditGrantView {
9549
9721
  * @memberof PlanCreditGrantView
9550
9722
  */
9551
9723
  billingCreditCanBuyBundles: boolean;
9724
+ /**
9725
+ *
9726
+ * @type {number}
9727
+ * @memberof PlanCreditGrantView
9728
+ */
9729
+ billingCreditOverdraftLimit?: number | null;
9730
+ /**
9731
+ *
9732
+ * @type {boolean}
9733
+ * @memberof PlanCreditGrantView
9734
+ */
9735
+ billingCreditPostpaidEnabled: boolean;
9736
+ /**
9737
+ *
9738
+ * @type {number}
9739
+ * @memberof PlanCreditGrantView
9740
+ */
9741
+ billingCreditPostpaidRatePerUnit?: number | null;
9742
+ /**
9743
+ *
9744
+ * @type {string}
9745
+ * @memberof PlanCreditGrantView
9746
+ */
9747
+ billingCreditPostpaidRatePerUnitDecimal?: string | null;
9552
9748
  /**
9553
9749
  *
9554
9750
  * @type {number}
@@ -9706,6 +9902,18 @@ declare interface PlanCreditGrantView {
9706
9902
  * @interface PlanCreditGrantView
9707
9903
  */
9708
9904
  declare interface PlanCreditGrantView_2 {
9905
+ /**
9906
+ *
9907
+ * @type {BillingArrearsAnchor}
9908
+ * @memberof PlanCreditGrantView
9909
+ */
9910
+ billingCreditArrearsAnchor?: BillingArrearsAnchor_2 | null;
9911
+ /**
9912
+ *
9913
+ * @type {BillingArrearsCadence}
9914
+ * @memberof PlanCreditGrantView
9915
+ */
9916
+ billingCreditArrearsCadence?: BillingArrearsCadence_2 | null;
9709
9917
  /**
9710
9918
  *
9711
9919
  * @type {number}
@@ -9772,6 +9980,30 @@ declare interface PlanCreditGrantView_2 {
9772
9980
  * @memberof PlanCreditGrantView
9773
9981
  */
9774
9982
  billingCreditCanBuyBundles: boolean;
9983
+ /**
9984
+ *
9985
+ * @type {number}
9986
+ * @memberof PlanCreditGrantView
9987
+ */
9988
+ billingCreditOverdraftLimit?: number | null;
9989
+ /**
9990
+ *
9991
+ * @type {boolean}
9992
+ * @memberof PlanCreditGrantView
9993
+ */
9994
+ billingCreditPostpaidEnabled: boolean;
9995
+ /**
9996
+ *
9997
+ * @type {number}
9998
+ * @memberof PlanCreditGrantView
9999
+ */
10000
+ billingCreditPostpaidRatePerUnit?: number | null;
10001
+ /**
10002
+ *
10003
+ * @type {string}
10004
+ * @memberof PlanCreditGrantView
10005
+ */
10006
+ billingCreditPostpaidRatePerUnitDecimal?: string | null;
9775
10007
  /**
9776
10008
  *
9777
10009
  * @type {number}