@schematichq/schematic-components 2.24.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,63 @@ 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
+
100
+ /**
101
+ *
102
+ * @export
103
+ */
104
+ declare const BillingCollectionMethod: {
105
+ readonly ChargeAutomatically: "charge_automatically";
106
+ readonly SendInvoice: "send_invoice";
107
+ };
108
+
109
+ declare type BillingCollectionMethod = (typeof BillingCollectionMethod)[keyof typeof BillingCollectionMethod];
110
+
54
111
  /**
55
112
  *
56
113
  * @export
@@ -994,6 +1051,18 @@ declare type BillingPlanCreditGrantResetType_2 = (typeof BillingPlanCreditGrantR
994
1051
  * @interface BillingPlanCreditGrantResponseData
995
1052
  */
996
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;
997
1066
  /**
998
1067
  *
999
1068
  * @type {number}
@@ -1144,6 +1213,12 @@ declare interface BillingPlanCreditGrantResponseData {
1144
1213
  * @memberof BillingPlanCreditGrantResponseData
1145
1214
  */
1146
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;
1147
1222
  /**
1148
1223
  *
1149
1224
  * @type {PreviewObjectResponseData}
@@ -1169,6 +1244,24 @@ declare interface BillingPlanCreditGrantResponseData {
1169
1244
  * @memberof BillingPlanCreditGrantResponseData
1170
1245
  */
1171
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;
1172
1265
  /**
1173
1266
  *
1174
1267
  * @type {BillingPlanCreditGrantResetCadence}
@@ -3710,6 +3803,98 @@ export declare interface ColumnProps extends React.HTMLProps<HTMLDivElement> {
3710
3803
  basis?: string;
3711
3804
  }
3712
3805
 
3806
+ /**
3807
+ *
3808
+ * @export
3809
+ * @interface CompanyBillingProfileResponseData
3810
+ */
3811
+ declare interface CompanyBillingProfileResponseData {
3812
+ /**
3813
+ *
3814
+ * @type {string}
3815
+ * @memberof CompanyBillingProfileResponseData
3816
+ */
3817
+ accountId: string;
3818
+ /**
3819
+ *
3820
+ * @type {string}
3821
+ * @memberof CompanyBillingProfileResponseData
3822
+ */
3823
+ billingCustomerId?: string | null;
3824
+ /**
3825
+ *
3826
+ * @type {BillingCollectionMethod}
3827
+ * @memberof CompanyBillingProfileResponseData
3828
+ */
3829
+ collectionMethod: BillingCollectionMethod;
3830
+ /**
3831
+ *
3832
+ * @type {string}
3833
+ * @memberof CompanyBillingProfileResponseData
3834
+ */
3835
+ companyId: string;
3836
+ /**
3837
+ *
3838
+ * @type {Date}
3839
+ * @memberof CompanyBillingProfileResponseData
3840
+ */
3841
+ createdAt: Date;
3842
+ /**
3843
+ *
3844
+ * @type {number}
3845
+ * @memberof CompanyBillingProfileResponseData
3846
+ */
3847
+ daysUntilDue?: number | null;
3848
+ /**
3849
+ *
3850
+ * @type {string}
3851
+ * @memberof CompanyBillingProfileResponseData
3852
+ */
3853
+ environmentId: string;
3854
+ /**
3855
+ *
3856
+ * @type {string}
3857
+ * @memberof CompanyBillingProfileResponseData
3858
+ */
3859
+ id: string;
3860
+ /**
3861
+ *
3862
+ * @type {boolean}
3863
+ * @memberof CompanyBillingProfileResponseData
3864
+ */
3865
+ isDefault: boolean;
3866
+ /**
3867
+ *
3868
+ * @type {string}
3869
+ * @memberof CompanyBillingProfileResponseData
3870
+ */
3871
+ name?: string | null;
3872
+ /**
3873
+ *
3874
+ * @type {string}
3875
+ * @memberof CompanyBillingProfileResponseData
3876
+ */
3877
+ paymentMethodId?: string | null;
3878
+ /**
3879
+ *
3880
+ * @type {ProrationBehavior}
3881
+ * @memberof CompanyBillingProfileResponseData
3882
+ */
3883
+ prorationBehavior?: ProrationBehavior | null;
3884
+ /**
3885
+ *
3886
+ * @type {BillingProviderType}
3887
+ * @memberof CompanyBillingProfileResponseData
3888
+ */
3889
+ providerType: BillingProviderType;
3890
+ /**
3891
+ *
3892
+ * @type {Date}
3893
+ * @memberof CompanyBillingProfileResponseData
3894
+ */
3895
+ updatedAt: Date;
3896
+ }
3897
+
3713
3898
  /**
3714
3899
  *
3715
3900
  * @export
@@ -3744,6 +3929,18 @@ declare interface CompanyDetailResponseData {
3744
3929
  billingCreditBalances?: {
3745
3930
  [key: string]: number;
3746
3931
  } | null;
3932
+ /**
3933
+ *
3934
+ * @type {CompanyBillingProfileResponseData}
3935
+ * @memberof CompanyDetailResponseData
3936
+ */
3937
+ billingProfile?: CompanyBillingProfileResponseData;
3938
+ /**
3939
+ *
3940
+ * @type {Array<CompanyBillingProfileResponseData>}
3941
+ * @memberof CompanyDetailResponseData
3942
+ */
3943
+ billingProfiles?: Array<CompanyBillingProfileResponseData> | null;
3747
3944
  /**
3748
3945
  *
3749
3946
  * @type {BillingSubscriptionView}
@@ -3834,6 +4031,12 @@ declare interface CompanyDetailResponseData {
3834
4031
  * @memberof CompanyDetailResponseData
3835
4032
  */
3836
4033
  paymentMethods: Array<PaymentMethodResponseData>;
4034
+ /**
4035
+ *
4036
+ * @type {PendingMigrationResponseData}
4037
+ * @memberof CompanyDetailResponseData
4038
+ */
4039
+ pendingMigration?: PendingMigrationResponseData;
3837
4040
  /**
3838
4041
  *
3839
4042
  * @type {CompanyPlanWithBillingSubView}
@@ -4109,6 +4312,18 @@ declare interface CompanyOverrideResponseData {
4109
4312
  * @memberof CompanyOverrideResponseData
4110
4313
  */
4111
4314
  valueBool?: boolean | null;
4315
+ /**
4316
+ *
4317
+ * @type {BillingCreditResponseData}
4318
+ * @memberof CompanyOverrideResponseData
4319
+ */
4320
+ valueCredit?: BillingCreditResponseData;
4321
+ /**
4322
+ *
4323
+ * @type {string}
4324
+ * @memberof CompanyOverrideResponseData
4325
+ */
4326
+ valueCreditId?: string | null;
4112
4327
  /**
4113
4328
  *
4114
4329
  * @type {number}
@@ -4141,6 +4356,18 @@ declare interface CompanyOverrideResponseData {
4141
4356
  * @interface CompanyPlanCreditGrantView
4142
4357
  */
4143
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;
4144
4371
  /**
4145
4372
  *
4146
4373
  * @type {number}
@@ -4207,6 +4434,30 @@ declare interface CompanyPlanCreditGrantView {
4207
4434
  * @memberof CompanyPlanCreditGrantView
4208
4435
  */
4209
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;
4210
4461
  /**
4211
4462
  *
4212
4463
  * @type {number}
@@ -5392,10 +5643,10 @@ declare interface ComponentHydrateResponseData {
5392
5643
  trialPaymentMethodRequired?: boolean | null;
5393
5644
  /**
5394
5645
  *
5395
- * @type {InvoiceResponseData}
5646
+ * @type {UpcomingInvoiceResponseData}
5396
5647
  * @memberof ComponentHydrateResponseData
5397
5648
  */
5398
- upcomingInvoice?: InvoiceResponseData;
5649
+ upcomingInvoice?: UpcomingInvoiceResponseData;
5399
5650
  }
5400
5651
 
5401
5652
  declare interface ComponentProps extends TransientCSSProperties {
@@ -5690,6 +5941,12 @@ declare interface CreditBundleCurrencyPrice {
5690
5941
  * @interface CreditCompanyGrantView
5691
5942
  */
5692
5943
  declare interface CreditCompanyGrantView {
5944
+ /**
5945
+ *
5946
+ * @type {BillingArrearsCadence}
5947
+ * @memberof CreditCompanyGrantView
5948
+ */
5949
+ arrearsCadence?: BillingArrearsCadence | null;
5693
5950
  /**
5694
5951
  *
5695
5952
  * @type {string}
@@ -5816,6 +6073,42 @@ declare interface CreditCompanyGrantView {
5816
6073
  * @memberof CreditCompanyGrantView
5817
6074
  */
5818
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;
5819
6112
  /**
5820
6113
  *
5821
6114
  * @type {BillingProductPriceResponseData}
@@ -6265,6 +6558,12 @@ declare interface CustomPlanBillingResponseData {
6265
6558
  * @memberof CustomPlanBillingResponseData
6266
6559
  */
6267
6560
  planId: string;
6561
+ /**
6562
+ * Whether the shortened period the renewal date created was billed pro rata when the subscription started. False means that period is free and the first invoice is the one raised on the renewal date.
6563
+ * @type {boolean}
6564
+ * @memberof CustomPlanBillingResponseData
6565
+ */
6566
+ prorateFirstPeriod?: boolean | null;
6268
6567
  /**
6269
6568
  *
6270
6569
  * @type {Date}
@@ -6701,7 +7000,7 @@ declare interface ElementProps {
6701
7000
 
6702
7001
  export declare const EmbedContext: Context<EmbedContextProps>;
6703
7002
 
6704
- export declare interface EmbedContextProps extends EmbedState {
7003
+ export declare interface EmbedContextProps extends Omit<EmbedState, SettingsLayer> {
6705
7004
  hydratePublic: () => DebouncedApiPromise<PublicPlansResponseData>;
6706
7005
  hydrate: () => DebouncedApiPromise<HydrateDataWithCompanyContext>;
6707
7006
  hydrateComponent: (id: string) => DebouncedApiPromise<HydrateDataWithCompanyContext>;
@@ -6727,9 +7026,22 @@ export declare interface EmbedContextProps extends EmbedState {
6727
7026
  initializeWithPlan: (config: string | BypassConfig) => void;
6728
7027
  requestUnsubscribe: () => void;
6729
7028
  setData: (data: HydrateDataWithCompanyContext) => void;
7029
+ /**
7030
+ * Apply settings from the consuming app. These take precedence over the design
7031
+ * stored in the dashboard regardless of which arrives first, and survive the
7032
+ * re-hydration that follows a checkout or unsubscribe. Pass `{ update: true }`
7033
+ * to merge into the current values rather than replace them.
7034
+ */
6730
7035
  updateSettings: (settings: DeepPartial<EmbedSettings>, options?: {
6731
7036
  update?: boolean;
6732
7037
  }) => void;
7038
+ /**
7039
+ * Apply the design authored in the dashboard. Internal: `SchematicEmbed` calls
7040
+ * this with the settings inflated from the component AST. Anything supplied via
7041
+ * {@link EmbedContextProps.updateSettings} or the provider's `settings` prop
7042
+ * wins over it.
7043
+ */
7044
+ setBuilderSettings: (settings: DeepPartial<EmbedSettings>) => void;
6733
7045
  debug: (message: string, ...args: unknown[]) => void;
6734
7046
  }
6735
7047
 
@@ -6780,7 +7092,17 @@ export declare interface EmbedState {
6780
7092
  accessToken?: string;
6781
7093
  data?: HydrateDataWithCompanyContext;
6782
7094
  error?: Error;
7095
+ /**
7096
+ * The effective settings, derived from the layers below. Read this; write to
7097
+ * the layers via an `UPDATE_SETTINGS` action.
7098
+ */
6783
7099
  settings: EmbedSettings;
7100
+ /** Lowest-precedence layer: settings applied without an explicit source. */
7101
+ baseSettings: DeepPartial<EmbedSettings>;
7102
+ /** The design stored in the dashboard, applied once the component hydrates. */
7103
+ builderSettings: DeepPartial<EmbedSettings>;
7104
+ /** Runtime settings from the consuming app; these win over the stored design. */
7105
+ settingsOverrides: DeepPartial<EmbedSettings>;
6784
7106
  layout: EmbedLayout;
6785
7107
  checkoutState?: CheckoutState;
6786
7108
  currencyFilter?: string[];
@@ -8604,10 +8926,10 @@ declare type HydrateDataWithCompanyContext = ComponentHydrateResponseData;
8604
8926
  declare interface HydrateUpcomingInvoiceResponse {
8605
8927
  /**
8606
8928
  *
8607
- * @type {InvoiceResponseData}
8929
+ * @type {UpcomingInvoiceResponseData}
8608
8930
  * @memberof HydrateUpcomingInvoiceResponse
8609
8931
  */
8610
- data: InvoiceResponseData;
8932
+ data: UpcomingInvoiceResponseData;
8611
8933
  /**
8612
8934
  * Input parameters
8613
8935
  * @type {object}
@@ -8661,6 +8983,7 @@ export declare const initialContext: {
8661
8983
  requestUnsubscribe: () => never;
8662
8984
  setData: () => never;
8663
8985
  updateSettings: () => never;
8986
+ setBuilderSettings: () => never;
8664
8987
  debug: () => never;
8665
8988
  finishCheckout: () => never;
8666
8989
  isPending: boolean;
@@ -8669,6 +8992,9 @@ export declare const initialContext: {
8669
8992
  data?: HydrateDataWithCompanyContext;
8670
8993
  error?: Error;
8671
8994
  settings: EmbedSettings;
8995
+ baseSettings: DeepPartial<EmbedSettings>;
8996
+ builderSettings: DeepPartial<EmbedSettings>;
8997
+ settingsOverrides: DeepPartial<EmbedSettings>;
8672
8998
  layout: EmbedLayout;
8673
8999
  checkoutState?: CheckoutState;
8674
9000
  currencyFilter?: string[];
@@ -9146,28 +9472,6 @@ declare interface PaymentMethodResponseData {
9146
9472
  updatedAt: Date;
9147
9473
  }
9148
9474
 
9149
- declare interface PerLicenseCreditGrant {
9150
- /** credits granted per unit of the license */
9151
- amount: number;
9152
- /** the license whose quantity scales the grant */
9153
- licenseId: string;
9154
- }
9155
-
9156
- export declare const Plan: ({ portal, isLoading, plans, selectedPlan, period, selectPlan, shouldTrial, currency, }: PlanProps) => JSX.Element;
9157
-
9158
- declare type Plan_2 = CompanyPlanDetailResponseData;
9159
-
9160
- /**
9161
- *
9162
- * @export
9163
- */
9164
- declare const PlanBillingSource: {
9165
- readonly CustomPlan: "custom_plan";
9166
- readonly ManagePlan: "manage_plan";
9167
- };
9168
-
9169
- declare type PlanBillingSource = (typeof PlanBillingSource)[keyof typeof PlanBillingSource];
9170
-
9171
9475
  /**
9172
9476
  * Schematic API
9173
9477
  * Schematic API
@@ -9182,19 +9486,100 @@ declare type PlanBillingSource = (typeof PlanBillingSource)[keyof typeof PlanBil
9182
9486
  /**
9183
9487
  *
9184
9488
  * @export
9185
- * @interface PlanCatalogMembershipResponseData
9489
+ * @interface PendingMigrationResponseData
9186
9490
  */
9187
- declare interface PlanCatalogMembershipResponseData {
9491
+ declare interface PendingMigrationResponseData {
9188
9492
  /**
9189
9493
  *
9190
9494
  * @type {string}
9191
- * @memberof PlanCatalogMembershipResponseData
9495
+ * @memberof PendingMigrationResponseData
9192
9496
  */
9193
- id: string;
9497
+ migrationId: string;
9194
9498
  /**
9195
9499
  *
9196
- * @type {string}
9197
- * @memberof PlanCatalogMembershipResponseData
9500
+ * @type {Date}
9501
+ * @memberof PendingMigrationResponseData
9502
+ */
9503
+ scheduledFor?: Date | null;
9504
+ /**
9505
+ *
9506
+ * @type {string}
9507
+ * @memberof PendingMigrationResponseData
9508
+ */
9509
+ toPlanId: string;
9510
+ /**
9511
+ *
9512
+ * @type {string}
9513
+ * @memberof PendingMigrationResponseData
9514
+ */
9515
+ toPlanName: string;
9516
+ /**
9517
+ *
9518
+ * @type {string}
9519
+ * @memberof PendingMigrationResponseData
9520
+ */
9521
+ toPlanVersionId: string;
9522
+ /**
9523
+ *
9524
+ * @type {number}
9525
+ * @memberof PendingMigrationResponseData
9526
+ */
9527
+ toPlanVersionNumber?: number | null;
9528
+ }
9529
+
9530
+ declare interface PerLicenseCreditGrant {
9531
+ /** credits granted per unit of the license */
9532
+ amount: number;
9533
+ /**
9534
+ * The license whose quantity scales the grant. Undefined when the grant
9535
+ * declares per-license scaling without naming a license: the per-unit copy
9536
+ * still holds, but no effective total can be resolved from it.
9537
+ */
9538
+ licenseId?: string;
9539
+ }
9540
+
9541
+ export declare const Plan: ({ portal, isLoading, plans, selectedPlan, period, selectPlan, shouldTrial, currency, }: PlanProps) => JSX.Element;
9542
+
9543
+ declare type Plan_2 = CompanyPlanDetailResponseData;
9544
+
9545
+ /**
9546
+ *
9547
+ * @export
9548
+ */
9549
+ declare const PlanBillingSource: {
9550
+ readonly CustomPlan: "custom_plan";
9551
+ readonly ManagePlan: "manage_plan";
9552
+ };
9553
+
9554
+ declare type PlanBillingSource = (typeof PlanBillingSource)[keyof typeof PlanBillingSource];
9555
+
9556
+ /**
9557
+ * Schematic API
9558
+ * Schematic API
9559
+ *
9560
+ * The version of the OpenAPI document: 0.1
9561
+ *
9562
+ *
9563
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9564
+ * https://openapi-generator.tech
9565
+ * Do not edit the class manually.
9566
+ */
9567
+ /**
9568
+ *
9569
+ * @export
9570
+ * @interface PlanCatalogMembershipResponseData
9571
+ */
9572
+ declare interface PlanCatalogMembershipResponseData {
9573
+ /**
9574
+ *
9575
+ * @type {string}
9576
+ * @memberof PlanCatalogMembershipResponseData
9577
+ */
9578
+ id: string;
9579
+ /**
9580
+ *
9581
+ * @type {string}
9582
+ * @memberof PlanCatalogMembershipResponseData
9198
9583
  */
9199
9584
  name: string;
9200
9585
  }
@@ -9258,6 +9643,18 @@ declare type PlanCreditGrantScaling_2 = (typeof PlanCreditGrantScaling_2)[keyof
9258
9643
  * @interface PlanCreditGrantView
9259
9644
  */
9260
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;
9261
9658
  /**
9262
9659
  *
9263
9660
  * @type {number}
@@ -9324,6 +9721,30 @@ declare interface PlanCreditGrantView {
9324
9721
  * @memberof PlanCreditGrantView
9325
9722
  */
9326
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;
9327
9748
  /**
9328
9749
  *
9329
9750
  * @type {number}
@@ -9481,6 +9902,18 @@ declare interface PlanCreditGrantView {
9481
9902
  * @interface PlanCreditGrantView
9482
9903
  */
9483
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;
9484
9917
  /**
9485
9918
  *
9486
9919
  * @type {number}
@@ -9547,6 +9980,30 @@ declare interface PlanCreditGrantView_2 {
9547
9980
  * @memberof PlanCreditGrantView
9548
9981
  */
9549
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;
9550
10007
  /**
9551
10008
  *
9552
10009
  * @type {number}
@@ -11524,6 +11981,12 @@ declare interface PreviewSubscriptionFinanceResponseData {
11524
11981
  * @memberof PreviewSubscriptionFinanceResponseData
11525
11982
  */
11526
11983
  proration: number;
11984
+ /**
11985
+ *
11986
+ * @type {Date}
11987
+ * @memberof PreviewSubscriptionFinanceResponseData
11988
+ */
11989
+ prorationBilledAt?: Date | null;
11527
11990
  /**
11528
11991
  *
11529
11992
  * @type {number}
@@ -11738,6 +12201,9 @@ declare type RequestState<TData> = {
11738
12201
 
11739
12202
  export declare const ResetStyle: RuleSet<object>;
11740
12203
 
12204
+ /** Collapse the settings layers into the effective settings. */
12205
+ export declare const resolveSettings: (layers: Pick<EmbedState, SettingsLayer>) => EmbedSettings;
12206
+
11741
12207
  declare interface ResponseContext {
11742
12208
  fetch: FetchAPI;
11743
12209
  url: string;
@@ -11904,6 +12370,12 @@ declare interface RuleConditionDetailResponseData {
11904
12370
  * @memberof RuleConditionDetailResponseData
11905
12371
  */
11906
12372
  operator: ComparableOperator;
12373
+ /**
12374
+ *
12375
+ * @type {Array<RuleConditionPlanVersionResponseData>}
12376
+ * @memberof RuleConditionDetailResponseData
12377
+ */
12378
+ planVersions?: Array<RuleConditionPlanVersionResponseData>;
11907
12379
  /**
11908
12380
  *
11909
12381
  * @type {Array<string>}
@@ -12038,6 +12510,12 @@ declare interface RuleConditionDetailResponseData_2 {
12038
12510
  * @memberof RuleConditionDetailResponseData
12039
12511
  */
12040
12512
  operator: ComparableOperator_2;
12513
+ /**
12514
+ *
12515
+ * @type {Array<RuleConditionPlanVersionResponseData>}
12516
+ * @memberof RuleConditionDetailResponseData
12517
+ */
12518
+ planVersions?: Array<RuleConditionPlanVersionResponseData_2>;
12041
12519
  /**
12042
12520
  *
12043
12521
  * @type {Array<string>}
@@ -12188,6 +12666,70 @@ declare interface RuleConditionGroupDetailResponseData_2 {
12188
12666
  updatedAt: Date;
12189
12667
  }
12190
12668
 
12669
+ /**
12670
+ *
12671
+ * @export
12672
+ * @interface RuleConditionPlanVersionResponseData
12673
+ */
12674
+ declare interface RuleConditionPlanVersionResponseData {
12675
+ /**
12676
+ *
12677
+ * @type {string}
12678
+ * @memberof RuleConditionPlanVersionResponseData
12679
+ */
12680
+ id: string;
12681
+ /**
12682
+ *
12683
+ * @type {string}
12684
+ * @memberof RuleConditionPlanVersionResponseData
12685
+ */
12686
+ name: string;
12687
+ /**
12688
+ *
12689
+ * @type {PlanVersionStatus}
12690
+ * @memberof RuleConditionPlanVersionResponseData
12691
+ */
12692
+ status: PlanVersionStatus;
12693
+ /**
12694
+ *
12695
+ * @type {number}
12696
+ * @memberof RuleConditionPlanVersionResponseData
12697
+ */
12698
+ version: number;
12699
+ }
12700
+
12701
+ /**
12702
+ *
12703
+ * @export
12704
+ * @interface RuleConditionPlanVersionResponseData
12705
+ */
12706
+ declare interface RuleConditionPlanVersionResponseData_2 {
12707
+ /**
12708
+ *
12709
+ * @type {string}
12710
+ * @memberof RuleConditionPlanVersionResponseData
12711
+ */
12712
+ id: string;
12713
+ /**
12714
+ *
12715
+ * @type {string}
12716
+ * @memberof RuleConditionPlanVersionResponseData
12717
+ */
12718
+ name: string;
12719
+ /**
12720
+ *
12721
+ * @type {PlanVersionStatus}
12722
+ * @memberof RuleConditionPlanVersionResponseData
12723
+ */
12724
+ status: PlanVersionStatus_2;
12725
+ /**
12726
+ *
12727
+ * @type {number}
12728
+ * @memberof RuleConditionPlanVersionResponseData
12729
+ */
12730
+ version: number;
12731
+ }
12732
+
12191
12733
  /**
12192
12734
  *
12193
12735
  * @export
@@ -12477,6 +13019,34 @@ export declare interface SelectedProps {
12477
13019
  isTrial?: boolean;
12478
13020
  }
12479
13021
 
13022
+ export declare const SETTINGS_LAYER_BY_SOURCE: Record<SettingsSource, SettingsLayer>;
13023
+
13024
+ /**
13025
+ * The settings layers in ascending order of precedence. `settings` is derived
13026
+ * from these by {@link resolveSettings}; nothing should assign to it directly.
13027
+ */
13028
+ export declare const SETTINGS_LAYERS: readonly ["baseSettings", "builderSettings", "settingsOverrides"];
13029
+
13030
+ export declare type SettingsLayer = (typeof SETTINGS_LAYERS)[number];
13031
+
13032
+ /**
13033
+ * Where a settings update came from. Settings are layered rather than
13034
+ * last-writer-wins, because the two producers arrive in a fixed and unhelpful
13035
+ * order: the consuming app supplies its theme on mount, while the design stored
13036
+ * in the dashboard is only known once the component has hydrated. Layering lets
13037
+ * a runtime theme survive hydration (and every re-hydration after a checkout).
13038
+ *
13039
+ * - `builder`: the design authored in the Schematic dashboard, inflated from the
13040
+ * component AST.
13041
+ * - `consumer`: the `settings` prop on `EmbedProvider` and `updateSettings()`
13042
+ * calls made by the consuming app. Wins over the stored design.
13043
+ *
13044
+ * An update with no source lands in the lowest layer; it is how the provider's
13045
+ * `prefers-color-scheme` listener contributes a default without overriding
13046
+ * either of the above.
13047
+ */
13048
+ export declare type SettingsSource = "builder" | "consumer";
13049
+
12480
13050
  /**
12481
13051
  * Schematic API
12482
13052
  * Schematic API
@@ -12849,6 +13419,134 @@ export declare const UpcomingBill: ForwardRefExoticComponent<ElementProps & Deep
12849
13419
 
12850
13420
  export declare type UpcomingBillProps = DesignProps_10;
12851
13421
 
13422
+ /**
13423
+ *
13424
+ * @export
13425
+ * @interface UpcomingInvoiceResponseData
13426
+ */
13427
+ declare interface UpcomingInvoiceResponseData {
13428
+ /**
13429
+ *
13430
+ * @type {number}
13431
+ * @memberof UpcomingInvoiceResponseData
13432
+ */
13433
+ amountDue: number;
13434
+ /**
13435
+ *
13436
+ * @type {number}
13437
+ * @memberof UpcomingInvoiceResponseData
13438
+ */
13439
+ amountPaid: number;
13440
+ /**
13441
+ *
13442
+ * @type {number}
13443
+ * @memberof UpcomingInvoiceResponseData
13444
+ */
13445
+ amountRemaining: number;
13446
+ /**
13447
+ *
13448
+ * @type {string}
13449
+ * @memberof UpcomingInvoiceResponseData
13450
+ */
13451
+ collectionMethod: string;
13452
+ /**
13453
+ *
13454
+ * @type {string}
13455
+ * @memberof UpcomingInvoiceResponseData
13456
+ */
13457
+ companyId?: string | null;
13458
+ /**
13459
+ *
13460
+ * @type {Date}
13461
+ * @memberof UpcomingInvoiceResponseData
13462
+ */
13463
+ createdAt: Date;
13464
+ /**
13465
+ *
13466
+ * @type {string}
13467
+ * @memberof UpcomingInvoiceResponseData
13468
+ */
13469
+ currency: string;
13470
+ /**
13471
+ *
13472
+ * @type {string}
13473
+ * @memberof UpcomingInvoiceResponseData
13474
+ */
13475
+ customerExternalId: string;
13476
+ /**
13477
+ *
13478
+ * @type {Date}
13479
+ * @memberof UpcomingInvoiceResponseData
13480
+ */
13481
+ dueDate?: Date | null;
13482
+ /**
13483
+ *
13484
+ * @type {number}
13485
+ * @memberof UpcomingInvoiceResponseData
13486
+ */
13487
+ endingBalance: number;
13488
+ /**
13489
+ *
13490
+ * @type {string}
13491
+ * @memberof UpcomingInvoiceResponseData
13492
+ */
13493
+ environmentId: string;
13494
+ /**
13495
+ *
13496
+ * @type {string}
13497
+ * @memberof UpcomingInvoiceResponseData
13498
+ */
13499
+ externalId?: string | null;
13500
+ /**
13501
+ *
13502
+ * @type {string}
13503
+ * @memberof UpcomingInvoiceResponseData
13504
+ */
13505
+ paymentMethodExternalId?: string | null;
13506
+ /**
13507
+ *
13508
+ * @type {BillingProviderType}
13509
+ * @memberof UpcomingInvoiceResponseData
13510
+ */
13511
+ providerType: BillingProviderType;
13512
+ /**
13513
+ *
13514
+ * @type {number}
13515
+ * @memberof UpcomingInvoiceResponseData
13516
+ */
13517
+ startingBalance: number;
13518
+ /**
13519
+ *
13520
+ * @type {InvoiceStatus}
13521
+ * @memberof UpcomingInvoiceResponseData
13522
+ */
13523
+ status?: InvoiceStatus | null;
13524
+ /**
13525
+ *
13526
+ * @type {string}
13527
+ * @memberof UpcomingInvoiceResponseData
13528
+ */
13529
+ subscriptionExternalId?: string | null;
13530
+ /**
13531
+ *
13532
+ * @type {number}
13533
+ * @memberof UpcomingInvoiceResponseData
13534
+ */
13535
+ subtotal: number;
13536
+ /**
13537
+ *
13538
+ * @type {Date}
13539
+ * @memberof UpcomingInvoiceResponseData
13540
+ */
13541
+ updatedAt: Date;
13542
+ /**
13543
+ *
13544
+ * @type {string}
13545
+ * @memberof UpcomingInvoiceResponseData
13546
+ */
13547
+ url?: string | null;
13548
+ }
13549
+
12852
13550
  /**
12853
13551
  * Schematic API
12854
13552
  * Schematic API