@schematichq/schematic-components 2.9.1 → 2.10.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.
@@ -27,6 +27,11 @@ declare interface AddOnsProps {
27
27
  currency?: string;
28
28
  }
29
29
 
30
+ export declare interface AvailableCurrenciesResult {
31
+ currencies: string[];
32
+ invalidFilterEntries: string[];
33
+ }
34
+
30
35
  declare interface AvailablePlanOptions {
31
36
  useSelectedPeriod?: boolean;
32
37
  }
@@ -1085,6 +1090,12 @@ declare interface BillingPriceResponseData {
1085
1090
  * @memberof BillingPriceResponseData
1086
1091
  */
1087
1092
  interval: BillingProductPriceInterval;
1093
+ /**
1094
+ *
1095
+ * @type {string}
1096
+ * @memberof BillingPriceResponseData
1097
+ */
1098
+ nickname?: string | null;
1088
1099
  /**
1089
1100
  *
1090
1101
  * @type {number}
@@ -1141,6 +1152,12 @@ declare interface BillingPriceResponseData_2 {
1141
1152
  * @memberof BillingPriceResponseData
1142
1153
  */
1143
1154
  interval: BillingProductPriceInterval_2;
1155
+ /**
1156
+ *
1157
+ * @type {string}
1158
+ * @memberof BillingPriceResponseData
1159
+ */
1160
+ nickname?: string | null;
1144
1161
  /**
1145
1162
  *
1146
1163
  * @type {number}
@@ -1271,6 +1288,12 @@ declare interface BillingPriceView {
1271
1288
  * @memberof BillingPriceView
1272
1289
  */
1273
1290
  meterId?: string | null;
1291
+ /**
1292
+ *
1293
+ * @type {string}
1294
+ * @memberof BillingPriceView
1295
+ */
1296
+ nickname?: string | null;
1274
1297
  /**
1275
1298
  *
1276
1299
  * @type {number}
@@ -1411,6 +1434,12 @@ declare interface BillingPriceView_2 {
1411
1434
  * @memberof BillingPriceView
1412
1435
  */
1413
1436
  meterId?: string | null;
1437
+ /**
1438
+ *
1439
+ * @type {string}
1440
+ * @memberof BillingPriceView
1441
+ */
1442
+ nickname?: string | null;
1414
1443
  /**
1415
1444
  *
1416
1445
  * @type {number}
@@ -1903,6 +1932,12 @@ declare interface BillingProductPriceResponseData {
1903
1932
  * @memberof BillingProductPriceResponseData
1904
1933
  */
1905
1934
  meterId?: string | null;
1935
+ /**
1936
+ *
1937
+ * @type {string}
1938
+ * @memberof BillingProductPriceResponseData
1939
+ */
1940
+ nickname?: string | null;
1906
1941
  /**
1907
1942
  *
1908
1943
  * @type {number}
@@ -2224,6 +2259,7 @@ declare interface BillingProductResponseData_2 {
2224
2259
  * @export
2225
2260
  */
2226
2261
  declare const BillingProviderType: {
2262
+ readonly Orb: "orb";
2227
2263
  readonly Schematic: "schematic";
2228
2264
  readonly Stripe: "stripe";
2229
2265
  };
@@ -2235,6 +2271,7 @@ declare type BillingProviderType = (typeof BillingProviderType)[keyof typeof Bil
2235
2271
  * @export
2236
2272
  */
2237
2273
  declare const BillingProviderType_2: {
2274
+ readonly Orb: "orb";
2238
2275
  readonly Schematic: "schematic";
2239
2276
  readonly Stripe: "stripe";
2240
2277
  };
@@ -3115,6 +3152,12 @@ declare interface CompanyDetailResponseData {
3115
3152
  * @memberof CompanyDetailResponseData
3116
3153
  */
3117
3154
  createdAt: Date;
3155
+ /**
3156
+ *
3157
+ * @type {Array<CustomPlanBillingResponseData>}
3158
+ * @memberof CompanyDetailResponseData
3159
+ */
3160
+ customPlanBillings: Array<CustomPlanBillingResponseData>;
3118
3161
  /**
3119
3162
  *
3120
3163
  * @type {PaymentMethodResponseData}
@@ -3225,17 +3268,6 @@ declare interface CompanyDetailResponseData {
3225
3268
  userCount: number;
3226
3269
  }
3227
3270
 
3228
- /**
3229
- * Schematic API
3230
- * Schematic API
3231
- *
3232
- * The version of the OpenAPI document: 0.1
3233
- *
3234
- *
3235
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
3236
- * https://openapi-generator.tech
3237
- * Do not edit the class manually.
3238
- */
3239
3271
  /**
3240
3272
  *
3241
3273
  * @export
@@ -3286,16 +3318,16 @@ declare interface CompanyEventPeriodMetricsResponseData {
3286
3318
  eventSubtype: string;
3287
3319
  /**
3288
3320
  *
3289
- * @type {string}
3321
+ * @type {MetricPeriodMonthReset}
3290
3322
  * @memberof CompanyEventPeriodMetricsResponseData
3291
3323
  */
3292
- monthReset: string;
3324
+ monthReset: MetricPeriodMonthReset;
3293
3325
  /**
3294
3326
  *
3295
- * @type {string}
3327
+ * @type {MetricPeriod}
3296
3328
  * @memberof CompanyEventPeriodMetricsResponseData
3297
3329
  */
3298
- period: string;
3330
+ period: MetricPeriod;
3299
3331
  /**
3300
3332
  *
3301
3333
  * @type {Date}
@@ -3427,16 +3459,16 @@ declare interface CompanyOverrideResponseData {
3427
3459
  id: string;
3428
3460
  /**
3429
3461
  *
3430
- * @type {string}
3462
+ * @type {MetricPeriod}
3431
3463
  * @memberof CompanyOverrideResponseData
3432
3464
  */
3433
- metricPeriod?: string | null;
3465
+ metricPeriod?: MetricPeriod | null;
3434
3466
  /**
3435
3467
  *
3436
- * @type {string}
3468
+ * @type {MetricPeriodMonthReset}
3437
3469
  * @memberof CompanyOverrideResponseData
3438
3470
  */
3439
- metricPeriodMonthReset?: string | null;
3471
+ metricPeriodMonthReset?: MetricPeriodMonthReset | null;
3440
3472
  /**
3441
3473
  *
3442
3474
  * @type {Array<CompanyOverrideNoteResponseData>}
@@ -3542,6 +3574,18 @@ declare interface CompanyPlanDetailResponseData {
3542
3574
  * @memberof CompanyPlanDetailResponseData
3543
3575
  */
3544
3576
  companyCount: number;
3577
+ /**
3578
+ *
3579
+ * @type {string}
3580
+ * @memberof CompanyPlanDetailResponseData
3581
+ */
3582
+ companyId?: string | null;
3583
+ /**
3584
+ *
3585
+ * @type {string}
3586
+ * @memberof CompanyPlanDetailResponseData
3587
+ */
3588
+ companyName?: string | null;
3545
3589
  /**
3546
3590
  *
3547
3591
  * @type {Array<string>}
@@ -3550,10 +3594,16 @@ declare interface CompanyPlanDetailResponseData {
3550
3594
  compatiblePlanIds: Array<string>;
3551
3595
  /**
3552
3596
  *
3553
- * @type {PlanControlledByType}
3597
+ * @type {BillingProviderType}
3598
+ * @memberof CompanyPlanDetailResponseData
3599
+ */
3600
+ controlledBy: BillingProviderType;
3601
+ /**
3602
+ *
3603
+ * @type {string}
3554
3604
  * @memberof CompanyPlanDetailResponseData
3555
3605
  */
3556
- controlledBy: PlanControlledByType;
3606
+ copiedFromPlanId?: string | null;
3557
3607
  /**
3558
3608
  *
3559
3609
  * @type {Date}
@@ -3604,10 +3654,10 @@ declare interface CompanyPlanDetailResponseData {
3604
3654
  entitlements: Array<PlanEntitlementResponseData>;
3605
3655
  /**
3606
3656
  *
3607
- * @type {Array<FeatureDetailResponseData>}
3657
+ * @type {Array<FeatureInPlanResponseData>}
3608
3658
  * @memberof CompanyPlanDetailResponseData
3609
3659
  */
3610
- features: Array<FeatureDetailResponseData>;
3660
+ features: Array<FeatureInPlanResponseData>;
3611
3661
  /**
3612
3662
  *
3613
3663
  * @type {PlanIcon}
@@ -3870,6 +3920,12 @@ declare interface CompanySubscriptionResponseData {
3870
3920
  * @memberof CompanySubscriptionResponseData
3871
3921
  */
3872
3922
  products: Array<BillingProductForSubscriptionResponseData>;
3923
+ /**
3924
+ *
3925
+ * @type {BillingProviderType}
3926
+ * @memberof CompanySubscriptionResponseData
3927
+ */
3928
+ providerType: BillingProviderType;
3873
3929
  /**
3874
3930
  *
3875
3931
  * @type {string}
@@ -3896,6 +3952,40 @@ declare interface CompanySubscriptionResponseData {
3896
3952
  trialEnd?: Date | null;
3897
3953
  }
3898
3954
 
3955
+ /**
3956
+ *
3957
+ * @export
3958
+ */
3959
+ declare const ComparableOperator: {
3960
+ readonly Eq: "eq";
3961
+ readonly Gt: "gt";
3962
+ readonly Gte: "gte";
3963
+ readonly IsEmpty: "is_empty";
3964
+ readonly Lt: "lt";
3965
+ readonly Lte: "lte";
3966
+ readonly NotEmpty: "not_empty";
3967
+ readonly Ne: "ne";
3968
+ };
3969
+
3970
+ declare type ComparableOperator = (typeof ComparableOperator)[keyof typeof ComparableOperator];
3971
+
3972
+ /**
3973
+ *
3974
+ * @export
3975
+ */
3976
+ declare const ComparableOperator_2: {
3977
+ readonly Eq: "eq";
3978
+ readonly Gt: "gt";
3979
+ readonly Gte: "gte";
3980
+ readonly IsEmpty: "is_empty";
3981
+ readonly Lt: "lt";
3982
+ readonly Lte: "lte";
3983
+ readonly NotEmpty: "not_empty";
3984
+ readonly Ne: "ne";
3985
+ };
3986
+
3987
+ declare type ComparableOperator_2 = (typeof ComparableOperator_2)[keyof typeof ComparableOperator_2];
3988
+
3899
3989
  /**
3900
3990
  * Schematic API
3901
3991
  * Schematic API
@@ -4441,10 +4531,10 @@ declare interface Condition {
4441
4531
  comparisonTraitDefinition?: TraitDefinition;
4442
4532
  /**
4443
4533
  *
4444
- * @type {string}
4534
+ * @type {ConditionType}
4445
4535
  * @memberof Condition
4446
4536
  */
4447
- conditionType: ConditionConditionTypeEnum;
4537
+ conditionType: ConditionType;
4448
4538
  /**
4449
4539
  *
4450
4540
  * @type {number}
@@ -4477,16 +4567,16 @@ declare interface Condition {
4477
4567
  id: string;
4478
4568
  /**
4479
4569
  *
4480
- * @type {string}
4570
+ * @type {MetricPeriod}
4481
4571
  * @memberof Condition
4482
4572
  */
4483
- metricPeriod?: ConditionMetricPeriodEnum | null;
4573
+ metricPeriod?: MetricPeriod | null;
4484
4574
  /**
4485
4575
  *
4486
- * @type {string}
4576
+ * @type {MetricPeriodMonthReset}
4487
4577
  * @memberof Condition
4488
4578
  */
4489
- metricPeriodMonthReset?: ConditionMetricPeriodMonthResetEnum | null;
4579
+ metricPeriodMonthReset?: MetricPeriodMonthReset | null;
4490
4580
  /**
4491
4581
  *
4492
4582
  * @type {number}
@@ -4495,10 +4585,10 @@ declare interface Condition {
4495
4585
  metricValue?: number | null;
4496
4586
  /**
4497
4587
  *
4498
- * @type {string}
4588
+ * @type {ComparableOperator}
4499
4589
  * @memberof Condition
4500
4590
  */
4501
- operator: ConditionOperatorEnum;
4591
+ operator: ComparableOperator;
4502
4592
  /**
4503
4593
  *
4504
4594
  * @type {Array<string>}
@@ -4519,23 +4609,6 @@ declare interface Condition {
4519
4609
  traitValue: string;
4520
4610
  }
4521
4611
 
4522
- /**
4523
- * @export
4524
- */
4525
- declare const ConditionConditionTypeEnum: {
4526
- readonly BasePlan: "base_plan";
4527
- readonly BillingProduct: "billing_product";
4528
- readonly Company: "company";
4529
- readonly Credit: "credit";
4530
- readonly Metric: "metric";
4531
- readonly Plan: "plan";
4532
- readonly PlanVersion: "plan_version";
4533
- readonly Trait: "trait";
4534
- readonly User: "user";
4535
- };
4536
-
4537
- declare type ConditionConditionTypeEnum = (typeof ConditionConditionTypeEnum)[keyof typeof ConditionConditionTypeEnum];
4538
-
4539
4612
  /**
4540
4613
  *
4541
4614
  * @export
@@ -4551,42 +4624,40 @@ declare interface ConditionGroup {
4551
4624
  }
4552
4625
 
4553
4626
  /**
4627
+ *
4554
4628
  * @export
4555
4629
  */
4556
- declare const ConditionMetricPeriodEnum: {
4557
- readonly AllTime: "all_time";
4558
- readonly CurrentDay: "current_day";
4559
- readonly CurrentMonth: "current_month";
4560
- readonly CurrentWeek: "current_week";
4561
- };
4562
-
4563
- declare type ConditionMetricPeriodEnum = (typeof ConditionMetricPeriodEnum)[keyof typeof ConditionMetricPeriodEnum];
4564
-
4565
- /**
4566
- * @export
4567
- */
4568
- declare const ConditionMetricPeriodMonthResetEnum: {
4569
- readonly FirstOfMonth: "first_of_month";
4570
- readonly BillingCycle: "billing_cycle";
4630
+ declare const ConditionType: {
4631
+ readonly BasePlan: "base_plan";
4632
+ readonly BillingProduct: "billing_product";
4633
+ readonly Company: "company";
4634
+ readonly Credit: "credit";
4635
+ readonly Metric: "metric";
4636
+ readonly Plan: "plan";
4637
+ readonly PlanVersion: "plan_version";
4638
+ readonly Trait: "trait";
4639
+ readonly User: "user";
4571
4640
  };
4572
4641
 
4573
- declare type ConditionMetricPeriodMonthResetEnum = (typeof ConditionMetricPeriodMonthResetEnum)[keyof typeof ConditionMetricPeriodMonthResetEnum];
4642
+ declare type ConditionType = (typeof ConditionType)[keyof typeof ConditionType];
4574
4643
 
4575
4644
  /**
4645
+ *
4576
4646
  * @export
4577
4647
  */
4578
- declare const ConditionOperatorEnum: {
4579
- readonly Eq: "eq";
4580
- readonly Ne: "ne";
4581
- readonly Gt: "gt";
4582
- readonly Lt: "lt";
4583
- readonly Gte: "gte";
4584
- readonly Lte: "lte";
4585
- readonly IsEmpty: "is_empty";
4586
- readonly NotEmpty: "not_empty";
4648
+ declare const ConditionType_2: {
4649
+ readonly BasePlan: "base_plan";
4650
+ readonly BillingProduct: "billing_product";
4651
+ readonly Company: "company";
4652
+ readonly Credit: "credit";
4653
+ readonly Metric: "metric";
4654
+ readonly Plan: "plan";
4655
+ readonly PlanVersion: "plan_version";
4656
+ readonly Trait: "trait";
4657
+ readonly User: "user";
4587
4658
  };
4588
4659
 
4589
- declare type ConditionOperatorEnum = (typeof ConditionOperatorEnum)[keyof typeof ConditionOperatorEnum];
4660
+ declare type ConditionType_2 = (typeof ConditionType_2)[keyof typeof ConditionType_2];
4590
4661
 
4591
4662
  declare interface ConfigurationParameters {
4592
4663
  basePath?: string;
@@ -5077,6 +5148,104 @@ declare interface CurrencyBalance {
5077
5148
  currency: string;
5078
5149
  }
5079
5150
 
5151
+ /**
5152
+ *
5153
+ * @export
5154
+ */
5155
+ declare const CustomPlanActivationStrategy: {
5156
+ readonly Payment: "on_payment";
5157
+ readonly Publish: "on_publish";
5158
+ };
5159
+
5160
+ declare type CustomPlanActivationStrategy = (typeof CustomPlanActivationStrategy)[keyof typeof CustomPlanActivationStrategy];
5161
+
5162
+ /**
5163
+ *
5164
+ * @export
5165
+ * @interface CustomPlanBillingResponseData
5166
+ */
5167
+ declare interface CustomPlanBillingResponseData {
5168
+ /**
5169
+ *
5170
+ * @type {CustomPlanActivationStrategy}
5171
+ * @memberof CustomPlanBillingResponseData
5172
+ */
5173
+ activationStrategy: CustomPlanActivationStrategy;
5174
+ /**
5175
+ *
5176
+ * @type {string}
5177
+ * @memberof CustomPlanBillingResponseData
5178
+ */
5179
+ companyId: string;
5180
+ /**
5181
+ *
5182
+ * @type {Date}
5183
+ * @memberof CustomPlanBillingResponseData
5184
+ */
5185
+ createdAt: Date;
5186
+ /**
5187
+ *
5188
+ * @type {number}
5189
+ * @memberof CustomPlanBillingResponseData
5190
+ */
5191
+ daysUntilDue: number;
5192
+ /**
5193
+ *
5194
+ * @type {string}
5195
+ * @memberof CustomPlanBillingResponseData
5196
+ */
5197
+ id: string;
5198
+ /**
5199
+ *
5200
+ * @type {Date}
5201
+ * @memberof CustomPlanBillingResponseData
5202
+ */
5203
+ paidAt?: Date | null;
5204
+ /**
5205
+ *
5206
+ * @type {string}
5207
+ * @memberof CustomPlanBillingResponseData
5208
+ */
5209
+ planId: string;
5210
+ /**
5211
+ *
5212
+ * @type {Date}
5213
+ * @memberof CustomPlanBillingResponseData
5214
+ */
5215
+ publishedAt?: Date | null;
5216
+ /**
5217
+ *
5218
+ * @type {CustomPlanBillingStatus}
5219
+ * @memberof CustomPlanBillingResponseData
5220
+ */
5221
+ status: CustomPlanBillingStatus;
5222
+ /**
5223
+ *
5224
+ * @type {string}
5225
+ * @memberof CustomPlanBillingResponseData
5226
+ */
5227
+ stripeInvoiceUrl?: string | null;
5228
+ /**
5229
+ *
5230
+ * @type {Date}
5231
+ * @memberof CustomPlanBillingResponseData
5232
+ */
5233
+ updatedAt: Date;
5234
+ }
5235
+
5236
+ /**
5237
+ *
5238
+ * @export
5239
+ */
5240
+ declare const CustomPlanBillingStatus: {
5241
+ readonly Active: "active";
5242
+ readonly Expired: "expired";
5243
+ readonly Paid: "paid";
5244
+ readonly Pending: "pending";
5245
+ };
5246
+
5247
+ declare type CustomPlanBillingStatus = (typeof CustomPlanBillingStatus)[keyof typeof CustomPlanBillingStatus];
5248
+
5080
5249
  /**
5081
5250
  * Schematic API
5082
5251
  * Schematic API
@@ -5497,7 +5666,7 @@ export declare interface EmbedProps {
5497
5666
  accessToken?: string;
5498
5667
  }
5499
5668
 
5500
- export declare const EmbedProvider: ({ children, apiKey, apiConfig, ...options }: EmbedProviderProps) => JSX.Element;
5669
+ export declare const EmbedProvider: ({ children, apiKey, apiConfig, currencyFilter, ...options }: EmbedProviderProps) => JSX.Element;
5501
5670
 
5502
5671
  export declare interface EmbedProviderProps {
5503
5672
  children: React.ReactNode;
@@ -5505,6 +5674,12 @@ export declare interface EmbedProviderProps {
5505
5674
  apiConfig?: ConfigurationParameters;
5506
5675
  settings?: DeepPartial<EmbedSettings>;
5507
5676
  debug?: boolean;
5677
+ /**
5678
+ * Restricts which currencies are presented in components that support
5679
+ * multi-currency display (PricingTable, CheckoutDialog). Entries are
5680
+ * ISO-4217 codes; case-insensitive. Omit to disable filtering.
5681
+ */
5682
+ currencyFilter?: string[];
5508
5683
  }
5509
5684
 
5510
5685
  export declare type EmbedSettings = {
@@ -5525,6 +5700,7 @@ export declare interface EmbedState {
5525
5700
  settings: EmbedSettings;
5526
5701
  layout: EmbedLayout;
5527
5702
  checkoutState?: CheckoutState;
5703
+ currencyFilter?: string[];
5528
5704
  }
5529
5705
 
5530
5706
  export declare const Entitlement: ({ entitlement, period, credits, tooltipPortal, currency: selectedCurrency, }: EntitlementProps) => JSX.Element;
@@ -6058,115 +6234,207 @@ declare interface EventSummaryResponseData_2 {
6058
6234
  /**
6059
6235
  *
6060
6236
  * @export
6061
- * @interface FeatureDetailResponseData
6237
+ * @interface FeatureEntitlement
6062
6238
  */
6063
- declare interface FeatureDetailResponseData {
6064
- /**
6065
- *
6066
- * @type {BillingLinkedResourceResponseData}
6067
- * @memberof FeatureDetailResponseData
6068
- */
6069
- billingLinkedResource?: BillingLinkedResourceResponseData;
6239
+ declare interface FeatureEntitlement {
6070
6240
  /**
6071
- *
6072
- * @type {Date}
6073
- * @memberof FeatureDetailResponseData
6241
+ * If the company has a numeric entitlement for this feature, the allocated amount
6242
+ * @type {number}
6243
+ * @memberof FeatureEntitlement
6074
6244
  */
6075
- createdAt: Date;
6245
+ allocation?: number | null;
6076
6246
  /**
6077
- *
6247
+ * If the company has a credit-based entitlement for this feature, the ID of the credit
6078
6248
  * @type {string}
6079
- * @memberof FeatureDetailResponseData
6249
+ * @memberof FeatureEntitlement
6080
6250
  */
6081
- description: string;
6251
+ creditId?: string | null;
6082
6252
  /**
6083
- *
6084
- * @type {string}
6085
- * @memberof FeatureDetailResponseData
6253
+ * If the company has a credit-based entitlement for this feature, the remaining credit amount
6254
+ * @type {number}
6255
+ * @memberof FeatureEntitlement
6086
6256
  */
6087
- eventSubtype?: string | null;
6257
+ creditRemaining?: number | null;
6258
+ /**
6259
+ * If the company has a credit-based entitlement for this feature, the total credit amount
6260
+ * @type {number}
6261
+ * @memberof FeatureEntitlement
6262
+ */
6263
+ creditTotal?: number | null;
6264
+ /**
6265
+ * If the company has a credit-based entitlement for this feature, the amount of credit used
6266
+ * @type {number}
6267
+ * @memberof FeatureEntitlement
6268
+ */
6269
+ creditUsed?: number | null;
6270
+ /**
6271
+ * If the feature is event-based, the name of the event tracked for usage
6272
+ * @type {string}
6273
+ * @memberof FeatureEntitlement
6274
+ */
6275
+ eventName?: string | null;
6276
+ /**
6277
+ * The ID of the feature
6278
+ * @type {string}
6279
+ * @memberof FeatureEntitlement
6280
+ */
6281
+ featureId: string;
6282
+ /**
6283
+ * The key of the flag associated with the feature
6284
+ * @type {string}
6285
+ * @memberof FeatureEntitlement
6286
+ */
6287
+ featureKey: string;
6288
+ /**
6289
+ * For event-based feature entitlements, the period over which usage is tracked
6290
+ * @type {MetricPeriod}
6291
+ * @memberof FeatureEntitlement
6292
+ */
6293
+ metricPeriod?: MetricPeriod | null;
6294
+ /**
6295
+ * For event-based feature entitlements, when the usage period will reset
6296
+ * @type {Date}
6297
+ * @memberof FeatureEntitlement
6298
+ */
6299
+ metricResetAt?: Date | null;
6300
+ /**
6301
+ * For event-based feature entitlements that have a monthly period, whether that monthly reset is based on the calendar month or a billing cycle
6302
+ * @type {MetricPeriodMonthReset}
6303
+ * @memberof FeatureEntitlement
6304
+ */
6305
+ monthReset?: MetricPeriodMonthReset | null;
6306
+ /**
6307
+ * For usage-based pricing, the soft limit for overage charges or the next tier boundary
6308
+ * @type {number}
6309
+ * @memberof FeatureEntitlement
6310
+ */
6311
+ softLimit?: number | null;
6312
+ /**
6313
+ * If the company has a numeric entitlement for this feature, the current usage amount
6314
+ * @type {number}
6315
+ * @memberof FeatureEntitlement
6316
+ */
6317
+ usage?: number | null;
6318
+ /**
6319
+ * The type of the entitlement value
6320
+ * @type {EntitlementValueType}
6321
+ * @memberof FeatureEntitlement
6322
+ */
6323
+ valueType: EntitlementValueType;
6324
+ }
6325
+
6326
+ /**
6327
+ *
6328
+ * @export
6329
+ * @interface FeatureInPlanResponseData
6330
+ */
6331
+ declare interface FeatureInPlanResponseData {
6332
+ /**
6333
+ *
6334
+ * @type {BillingLinkedResourceResponseData}
6335
+ * @memberof FeatureInPlanResponseData
6336
+ */
6337
+ billingLinkedResource?: BillingLinkedResourceResponseData;
6338
+ /**
6339
+ *
6340
+ * @type {Date}
6341
+ * @memberof FeatureInPlanResponseData
6342
+ */
6343
+ createdAt: Date;
6344
+ /**
6345
+ *
6346
+ * @type {string}
6347
+ * @memberof FeatureInPlanResponseData
6348
+ */
6349
+ description: string;
6350
+ /**
6351
+ *
6352
+ * @type {string}
6353
+ * @memberof FeatureInPlanResponseData
6354
+ */
6355
+ eventSubtype?: string | null;
6088
6356
  /**
6089
6357
  *
6090
6358
  * @type {EventSummaryResponseData}
6091
- * @memberof FeatureDetailResponseData
6359
+ * @memberof FeatureInPlanResponseData
6092
6360
  */
6093
6361
  eventSummary?: EventSummaryResponseData;
6094
6362
  /**
6095
6363
  *
6096
6364
  * @type {FeatureType}
6097
- * @memberof FeatureDetailResponseData
6365
+ * @memberof FeatureInPlanResponseData
6098
6366
  */
6099
6367
  featureType: FeatureType;
6100
6368
  /**
6101
6369
  *
6102
- * @type {Array<FlagDetailResponseData>}
6103
- * @memberof FeatureDetailResponseData
6370
+ * @type {Array<FlagInPlanResponseData>}
6371
+ * @memberof FeatureInPlanResponseData
6104
6372
  */
6105
- flags: Array<FlagDetailResponseData>;
6373
+ flags: Array<FlagInPlanResponseData>;
6106
6374
  /**
6107
6375
  *
6108
6376
  * @type {string}
6109
- * @memberof FeatureDetailResponseData
6377
+ * @memberof FeatureInPlanResponseData
6110
6378
  */
6111
6379
  icon: string;
6112
6380
  /**
6113
6381
  *
6114
6382
  * @type {string}
6115
- * @memberof FeatureDetailResponseData
6383
+ * @memberof FeatureInPlanResponseData
6116
6384
  */
6117
6385
  id: string;
6118
6386
  /**
6119
6387
  *
6120
6388
  * @type {FeatureLifecyclePhase}
6121
- * @memberof FeatureDetailResponseData
6389
+ * @memberof FeatureInPlanResponseData
6122
6390
  */
6123
6391
  lifecyclePhase?: FeatureLifecyclePhase | null;
6124
6392
  /**
6125
6393
  *
6126
6394
  * @type {string}
6127
- * @memberof FeatureDetailResponseData
6395
+ * @memberof FeatureInPlanResponseData
6128
6396
  */
6129
- maintainerId?: string | null;
6397
+ maintainerAccountMemberId?: string | null;
6130
6398
  /**
6131
6399
  *
6132
6400
  * @type {string}
6133
- * @memberof FeatureDetailResponseData
6401
+ * @memberof FeatureInPlanResponseData
6134
6402
  */
6135
6403
  name: string;
6136
6404
  /**
6137
6405
  *
6138
6406
  * @type {Array<PreviewObject>}
6139
- * @memberof FeatureDetailResponseData
6407
+ * @memberof FeatureInPlanResponseData
6140
6408
  */
6141
6409
  plans: Array<PreviewObject>;
6142
6410
  /**
6143
6411
  *
6144
6412
  * @type {string}
6145
- * @memberof FeatureDetailResponseData
6413
+ * @memberof FeatureInPlanResponseData
6146
6414
  */
6147
6415
  pluralName?: string | null;
6148
6416
  /**
6149
6417
  *
6150
6418
  * @type {string}
6151
- * @memberof FeatureDetailResponseData
6419
+ * @memberof FeatureInPlanResponseData
6152
6420
  */
6153
6421
  singularName?: string | null;
6154
6422
  /**
6155
6423
  *
6156
6424
  * @type {EntityTraitDefinitionResponseData}
6157
- * @memberof FeatureDetailResponseData
6425
+ * @memberof FeatureInPlanResponseData
6158
6426
  */
6159
6427
  trait?: EntityTraitDefinitionResponseData;
6160
6428
  /**
6161
6429
  *
6162
6430
  * @type {string}
6163
- * @memberof FeatureDetailResponseData
6431
+ * @memberof FeatureInPlanResponseData
6164
6432
  */
6165
6433
  traitId?: string | null;
6166
6434
  /**
6167
6435
  *
6168
6436
  * @type {Date}
6169
- * @memberof FeatureDetailResponseData
6437
+ * @memberof FeatureInPlanResponseData
6170
6438
  */
6171
6439
  updatedAt: Date;
6172
6440
  }
@@ -6174,233 +6442,119 @@ declare interface FeatureDetailResponseData {
6174
6442
  /**
6175
6443
  *
6176
6444
  * @export
6177
- * @interface FeatureDetailResponseData
6445
+ * @interface FeatureInPlanResponseData
6178
6446
  */
6179
- declare interface FeatureDetailResponseData_2 {
6447
+ declare interface FeatureInPlanResponseData_2 {
6180
6448
  /**
6181
6449
  *
6182
6450
  * @type {BillingLinkedResourceResponseData}
6183
- * @memberof FeatureDetailResponseData
6451
+ * @memberof FeatureInPlanResponseData
6184
6452
  */
6185
6453
  billingLinkedResource?: BillingLinkedResourceResponseData_2;
6186
6454
  /**
6187
6455
  *
6188
6456
  * @type {Date}
6189
- * @memberof FeatureDetailResponseData
6457
+ * @memberof FeatureInPlanResponseData
6190
6458
  */
6191
6459
  createdAt: Date;
6192
6460
  /**
6193
6461
  *
6194
6462
  * @type {string}
6195
- * @memberof FeatureDetailResponseData
6463
+ * @memberof FeatureInPlanResponseData
6196
6464
  */
6197
6465
  description: string;
6198
6466
  /**
6199
6467
  *
6200
6468
  * @type {string}
6201
- * @memberof FeatureDetailResponseData
6469
+ * @memberof FeatureInPlanResponseData
6202
6470
  */
6203
6471
  eventSubtype?: string | null;
6204
6472
  /**
6205
6473
  *
6206
6474
  * @type {EventSummaryResponseData}
6207
- * @memberof FeatureDetailResponseData
6475
+ * @memberof FeatureInPlanResponseData
6208
6476
  */
6209
6477
  eventSummary?: EventSummaryResponseData_2;
6210
6478
  /**
6211
6479
  *
6212
6480
  * @type {FeatureType}
6213
- * @memberof FeatureDetailResponseData
6481
+ * @memberof FeatureInPlanResponseData
6214
6482
  */
6215
6483
  featureType: FeatureType_2;
6216
6484
  /**
6217
6485
  *
6218
- * @type {Array<FlagDetailResponseData>}
6219
- * @memberof FeatureDetailResponseData
6486
+ * @type {Array<FlagInPlanResponseData>}
6487
+ * @memberof FeatureInPlanResponseData
6220
6488
  */
6221
- flags: Array<FlagDetailResponseData_2>;
6489
+ flags: Array<FlagInPlanResponseData_2>;
6222
6490
  /**
6223
6491
  *
6224
6492
  * @type {string}
6225
- * @memberof FeatureDetailResponseData
6493
+ * @memberof FeatureInPlanResponseData
6226
6494
  */
6227
6495
  icon: string;
6228
6496
  /**
6229
6497
  *
6230
6498
  * @type {string}
6231
- * @memberof FeatureDetailResponseData
6499
+ * @memberof FeatureInPlanResponseData
6232
6500
  */
6233
6501
  id: string;
6234
6502
  /**
6235
6503
  *
6236
6504
  * @type {FeatureLifecyclePhase}
6237
- * @memberof FeatureDetailResponseData
6505
+ * @memberof FeatureInPlanResponseData
6238
6506
  */
6239
6507
  lifecyclePhase?: FeatureLifecyclePhase_2 | null;
6240
6508
  /**
6241
6509
  *
6242
6510
  * @type {string}
6243
- * @memberof FeatureDetailResponseData
6511
+ * @memberof FeatureInPlanResponseData
6244
6512
  */
6245
- maintainerId?: string | null;
6513
+ maintainerAccountMemberId?: string | null;
6246
6514
  /**
6247
6515
  *
6248
6516
  * @type {string}
6249
- * @memberof FeatureDetailResponseData
6517
+ * @memberof FeatureInPlanResponseData
6250
6518
  */
6251
6519
  name: string;
6252
6520
  /**
6253
6521
  *
6254
6522
  * @type {Array<PreviewObject>}
6255
- * @memberof FeatureDetailResponseData
6523
+ * @memberof FeatureInPlanResponseData
6256
6524
  */
6257
6525
  plans: Array<PreviewObject_2>;
6258
6526
  /**
6259
6527
  *
6260
6528
  * @type {string}
6261
- * @memberof FeatureDetailResponseData
6529
+ * @memberof FeatureInPlanResponseData
6262
6530
  */
6263
6531
  pluralName?: string | null;
6264
6532
  /**
6265
6533
  *
6266
6534
  * @type {string}
6267
- * @memberof FeatureDetailResponseData
6535
+ * @memberof FeatureInPlanResponseData
6268
6536
  */
6269
6537
  singularName?: string | null;
6270
6538
  /**
6271
6539
  *
6272
6540
  * @type {EntityTraitDefinitionResponseData}
6273
- * @memberof FeatureDetailResponseData
6541
+ * @memberof FeatureInPlanResponseData
6274
6542
  */
6275
6543
  trait?: EntityTraitDefinitionResponseData_2;
6276
6544
  /**
6277
6545
  *
6278
6546
  * @type {string}
6279
- * @memberof FeatureDetailResponseData
6547
+ * @memberof FeatureInPlanResponseData
6280
6548
  */
6281
6549
  traitId?: string | null;
6282
6550
  /**
6283
6551
  *
6284
6552
  * @type {Date}
6285
- * @memberof FeatureDetailResponseData
6553
+ * @memberof FeatureInPlanResponseData
6286
6554
  */
6287
6555
  updatedAt: Date;
6288
6556
  }
6289
6557
 
6290
- /**
6291
- *
6292
- * @export
6293
- * @interface FeatureEntitlement
6294
- */
6295
- declare interface FeatureEntitlement {
6296
- /**
6297
- * If the company has a numeric entitlement for this feature, the allocated amount
6298
- * @type {number}
6299
- * @memberof FeatureEntitlement
6300
- */
6301
- allocation?: number | null;
6302
- /**
6303
- * If the company has a credit-based entitlement for this feature, the ID of the credit
6304
- * @type {string}
6305
- * @memberof FeatureEntitlement
6306
- */
6307
- creditId?: string | null;
6308
- /**
6309
- * If the company has a credit-based entitlement for this feature, the remaining credit amount
6310
- * @type {number}
6311
- * @memberof FeatureEntitlement
6312
- */
6313
- creditRemaining?: number | null;
6314
- /**
6315
- * If the company has a credit-based entitlement for this feature, the total credit amount
6316
- * @type {number}
6317
- * @memberof FeatureEntitlement
6318
- */
6319
- creditTotal?: number | null;
6320
- /**
6321
- * If the company has a credit-based entitlement for this feature, the amount of credit used
6322
- * @type {number}
6323
- * @memberof FeatureEntitlement
6324
- */
6325
- creditUsed?: number | null;
6326
- /**
6327
- * If the feature is event-based, the name of the event tracked for usage
6328
- * @type {string}
6329
- * @memberof FeatureEntitlement
6330
- */
6331
- eventName?: string | null;
6332
- /**
6333
- * The ID of the feature
6334
- * @type {string}
6335
- * @memberof FeatureEntitlement
6336
- */
6337
- featureId: string;
6338
- /**
6339
- * The key of the flag associated with the feature
6340
- * @type {string}
6341
- * @memberof FeatureEntitlement
6342
- */
6343
- featureKey: string;
6344
- /**
6345
- * For event-based feature entitlements, the period over which usage is tracked
6346
- * @type {string}
6347
- * @memberof FeatureEntitlement
6348
- */
6349
- metricPeriod?: FeatureEntitlementMetricPeriodEnum | null;
6350
- /**
6351
- * For event-based feature entitlements, when the usage period will reset
6352
- * @type {Date}
6353
- * @memberof FeatureEntitlement
6354
- */
6355
- metricResetAt?: Date | null;
6356
- /**
6357
- * For event-based feature entitlements that have a monthly period, whether that monthly reset is based on the calendar month or a billing cycle
6358
- * @type {string}
6359
- * @memberof FeatureEntitlement
6360
- */
6361
- monthReset?: FeatureEntitlementMonthResetEnum | null;
6362
- /**
6363
- * For usage-based pricing, the soft limit for overage charges or the next tier boundary
6364
- * @type {number}
6365
- * @memberof FeatureEntitlement
6366
- */
6367
- softLimit?: number | null;
6368
- /**
6369
- * If the company has a numeric entitlement for this feature, the current usage amount
6370
- * @type {number}
6371
- * @memberof FeatureEntitlement
6372
- */
6373
- usage?: number | null;
6374
- /**
6375
- * The type of the entitlement value
6376
- * @type {EntitlementValueType}
6377
- * @memberof FeatureEntitlement
6378
- */
6379
- valueType: EntitlementValueType;
6380
- }
6381
-
6382
- /**
6383
- * @export
6384
- */
6385
- declare const FeatureEntitlementMetricPeriodEnum: {
6386
- readonly AllTime: "all_time";
6387
- readonly CurrentDay: "current_day";
6388
- readonly CurrentMonth: "current_month";
6389
- readonly CurrentWeek: "current_week";
6390
- };
6391
-
6392
- declare type FeatureEntitlementMetricPeriodEnum = (typeof FeatureEntitlementMetricPeriodEnum)[keyof typeof FeatureEntitlementMetricPeriodEnum];
6393
-
6394
- /**
6395
- * @export
6396
- */
6397
- declare const FeatureEntitlementMonthResetEnum: {
6398
- readonly FirstOfMonth: "first_of_month";
6399
- readonly BillingCycle: "billing_cycle";
6400
- };
6401
-
6402
- declare type FeatureEntitlementMonthResetEnum = (typeof FeatureEntitlementMonthResetEnum)[keyof typeof FeatureEntitlementMonthResetEnum];
6403
-
6404
6558
  /**
6405
6559
  *
6406
6560
  * @export
@@ -6490,7 +6644,7 @@ declare interface FeatureResponseData {
6490
6644
  * @type {string}
6491
6645
  * @memberof FeatureResponseData
6492
6646
  */
6493
- maintainerId?: string | null;
6647
+ maintainerAccountMemberId?: string | null;
6494
6648
  /**
6495
6649
  *
6496
6650
  * @type {string}
@@ -6576,7 +6730,7 @@ declare interface FeatureResponseData_2 {
6576
6730
  * @type {string}
6577
6731
  * @memberof FeatureResponseData
6578
6732
  */
6579
- maintainerId?: string | null;
6733
+ maintainerAccountMemberId?: string | null;
6580
6734
  /**
6581
6735
  *
6582
6736
  * @type {string}
@@ -6772,10 +6926,10 @@ declare interface FeatureUsageResponseData {
6772
6926
  entitlementType: EntitlementType;
6773
6927
  /**
6774
6928
  *
6775
- * @type {FeatureDetailResponseData}
6929
+ * @type {FeatureInPlanResponseData}
6776
6930
  * @memberof FeatureUsageResponseData
6777
6931
  */
6778
- feature?: FeatureDetailResponseData;
6932
+ feature?: FeatureInPlanResponseData;
6779
6933
  /**
6780
6934
  * Whether a valid allocation exists
6781
6935
  * @type {boolean}
@@ -6796,10 +6950,10 @@ declare interface FeatureUsageResponseData {
6796
6950
  metricResetAt?: Date | null;
6797
6951
  /**
6798
6952
  * If the period is current_month, when the month resets.
6799
- * @type {string}
6953
+ * @type {MetricPeriodMonthReset}
6800
6954
  * @memberof FeatureUsageResponseData
6801
6955
  */
6802
- monthReset?: string | null;
6956
+ monthReset?: MetricPeriodMonthReset | null;
6803
6957
  /**
6804
6958
  *
6805
6959
  * @type {BillingPriceView}
@@ -6820,10 +6974,10 @@ declare interface FeatureUsageResponseData {
6820
6974
  percentUsed?: number | null;
6821
6975
  /**
6822
6976
  * The period over which usage is measured.
6823
- * @type {string}
6977
+ * @type {MetricPeriod}
6824
6978
  * @memberof FeatureUsageResponseData
6825
6979
  */
6826
- period?: string | null;
6980
+ period?: MetricPeriod | null;
6827
6981
  /**
6828
6982
  *
6829
6983
  * @type {PlanResponseData}
@@ -6892,85 +7046,85 @@ declare interface FetchParams {
6892
7046
  /**
6893
7047
  *
6894
7048
  * @export
6895
- * @interface FlagDetailResponseData
7049
+ * @interface FlagInPlanResponseData
6896
7050
  */
6897
- declare interface FlagDetailResponseData {
7051
+ declare interface FlagInPlanResponseData {
6898
7052
  /**
6899
7053
  *
6900
7054
  * @type {Date}
6901
- * @memberof FlagDetailResponseData
7055
+ * @memberof FlagInPlanResponseData
6902
7056
  */
6903
7057
  createdAt: Date;
6904
7058
  /**
6905
7059
  *
6906
7060
  * @type {boolean}
6907
- * @memberof FlagDetailResponseData
7061
+ * @memberof FlagInPlanResponseData
6908
7062
  */
6909
7063
  defaultValue: boolean;
6910
7064
  /**
6911
7065
  *
6912
7066
  * @type {string}
6913
- * @memberof FlagDetailResponseData
7067
+ * @memberof FlagInPlanResponseData
6914
7068
  */
6915
7069
  description: string;
6916
7070
  /**
6917
7071
  *
6918
7072
  * @type {FeatureResponseData}
6919
- * @memberof FlagDetailResponseData
7073
+ * @memberof FlagInPlanResponseData
6920
7074
  */
6921
7075
  feature?: FeatureResponseData;
6922
7076
  /**
6923
7077
  *
6924
7078
  * @type {string}
6925
- * @memberof FlagDetailResponseData
7079
+ * @memberof FlagInPlanResponseData
6926
7080
  */
6927
7081
  featureId?: string | null;
6928
7082
  /**
6929
7083
  *
6930
7084
  * @type {FlagType}
6931
- * @memberof FlagDetailResponseData
7085
+ * @memberof FlagInPlanResponseData
6932
7086
  */
6933
7087
  flagType: FlagType;
6934
7088
  /**
6935
7089
  *
6936
7090
  * @type {string}
6937
- * @memberof FlagDetailResponseData
7091
+ * @memberof FlagInPlanResponseData
6938
7092
  */
6939
7093
  id: string;
6940
7094
  /**
6941
7095
  *
6942
7096
  * @type {string}
6943
- * @memberof FlagDetailResponseData
7097
+ * @memberof FlagInPlanResponseData
6944
7098
  */
6945
7099
  key: string;
6946
7100
  /**
6947
7101
  *
6948
7102
  * @type {Date}
6949
- * @memberof FlagDetailResponseData
7103
+ * @memberof FlagInPlanResponseData
6950
7104
  */
6951
7105
  lastCheckedAt?: Date | null;
6952
7106
  /**
6953
7107
  *
6954
7108
  * @type {string}
6955
- * @memberof FlagDetailResponseData
7109
+ * @memberof FlagInPlanResponseData
6956
7110
  */
6957
- maintainerId?: string | null;
7111
+ maintainerAccountMemberId?: string | null;
6958
7112
  /**
6959
7113
  *
6960
7114
  * @type {string}
6961
- * @memberof FlagDetailResponseData
7115
+ * @memberof FlagInPlanResponseData
6962
7116
  */
6963
7117
  name: string;
6964
7118
  /**
6965
7119
  *
6966
7120
  * @type {Array<RuleDetailResponseData>}
6967
- * @memberof FlagDetailResponseData
7121
+ * @memberof FlagInPlanResponseData
6968
7122
  */
6969
7123
  rules: Array<RuleDetailResponseData>;
6970
7124
  /**
6971
7125
  *
6972
7126
  * @type {Date}
6973
- * @memberof FlagDetailResponseData
7127
+ * @memberof FlagInPlanResponseData
6974
7128
  */
6975
7129
  updatedAt: Date;
6976
7130
  }
@@ -6978,85 +7132,85 @@ declare interface FlagDetailResponseData {
6978
7132
  /**
6979
7133
  *
6980
7134
  * @export
6981
- * @interface FlagDetailResponseData
7135
+ * @interface FlagInPlanResponseData
6982
7136
  */
6983
- declare interface FlagDetailResponseData_2 {
7137
+ declare interface FlagInPlanResponseData_2 {
6984
7138
  /**
6985
7139
  *
6986
7140
  * @type {Date}
6987
- * @memberof FlagDetailResponseData
7141
+ * @memberof FlagInPlanResponseData
6988
7142
  */
6989
7143
  createdAt: Date;
6990
7144
  /**
6991
7145
  *
6992
7146
  * @type {boolean}
6993
- * @memberof FlagDetailResponseData
7147
+ * @memberof FlagInPlanResponseData
6994
7148
  */
6995
7149
  defaultValue: boolean;
6996
7150
  /**
6997
7151
  *
6998
7152
  * @type {string}
6999
- * @memberof FlagDetailResponseData
7153
+ * @memberof FlagInPlanResponseData
7000
7154
  */
7001
7155
  description: string;
7002
7156
  /**
7003
7157
  *
7004
7158
  * @type {FeatureResponseData}
7005
- * @memberof FlagDetailResponseData
7159
+ * @memberof FlagInPlanResponseData
7006
7160
  */
7007
7161
  feature?: FeatureResponseData_2;
7008
7162
  /**
7009
7163
  *
7010
7164
  * @type {string}
7011
- * @memberof FlagDetailResponseData
7165
+ * @memberof FlagInPlanResponseData
7012
7166
  */
7013
7167
  featureId?: string | null;
7014
7168
  /**
7015
7169
  *
7016
7170
  * @type {FlagType}
7017
- * @memberof FlagDetailResponseData
7171
+ * @memberof FlagInPlanResponseData
7018
7172
  */
7019
7173
  flagType: FlagType_2;
7020
7174
  /**
7021
7175
  *
7022
7176
  * @type {string}
7023
- * @memberof FlagDetailResponseData
7177
+ * @memberof FlagInPlanResponseData
7024
7178
  */
7025
7179
  id: string;
7026
7180
  /**
7027
7181
  *
7028
7182
  * @type {string}
7029
- * @memberof FlagDetailResponseData
7183
+ * @memberof FlagInPlanResponseData
7030
7184
  */
7031
7185
  key: string;
7032
7186
  /**
7033
7187
  *
7034
7188
  * @type {Date}
7035
- * @memberof FlagDetailResponseData
7189
+ * @memberof FlagInPlanResponseData
7036
7190
  */
7037
7191
  lastCheckedAt?: Date | null;
7038
7192
  /**
7039
7193
  *
7040
7194
  * @type {string}
7041
- * @memberof FlagDetailResponseData
7195
+ * @memberof FlagInPlanResponseData
7042
7196
  */
7043
- maintainerId?: string | null;
7197
+ maintainerAccountMemberId?: string | null;
7044
7198
  /**
7045
7199
  *
7046
7200
  * @type {string}
7047
- * @memberof FlagDetailResponseData
7201
+ * @memberof FlagInPlanResponseData
7048
7202
  */
7049
7203
  name: string;
7050
7204
  /**
7051
7205
  *
7052
7206
  * @type {Array<RuleDetailResponseData>}
7053
- * @memberof FlagDetailResponseData
7207
+ * @memberof FlagInPlanResponseData
7054
7208
  */
7055
7209
  rules: Array<RuleDetailResponseData_2>;
7056
7210
  /**
7057
7211
  *
7058
7212
  * @type {Date}
7059
- * @memberof FlagDetailResponseData
7213
+ * @memberof FlagInPlanResponseData
7060
7214
  */
7061
7215
  updatedAt: Date;
7062
7216
  }
@@ -7303,6 +7457,7 @@ export declare const initialContext: {
7303
7457
  settings: EmbedSettings;
7304
7458
  layout: EmbedLayout;
7305
7459
  checkoutState?: CheckoutState;
7460
+ currencyFilter?: string[];
7306
7461
  };
7307
7462
 
7308
7463
  export declare const initialState: EmbedState;
@@ -7535,6 +7690,54 @@ export declare const MeteredFeatures: ForwardRefExoticComponent<ElementProps & D
7535
7690
 
7536
7691
  export declare type MeteredFeaturesProps = DesignProps_4;
7537
7692
 
7693
+ /**
7694
+ *
7695
+ * @export
7696
+ */
7697
+ declare const MetricPeriod: {
7698
+ readonly AllTime: "all_time";
7699
+ readonly CurrentDay: "current_day";
7700
+ readonly CurrentMonth: "current_month";
7701
+ readonly CurrentWeek: "current_week";
7702
+ };
7703
+
7704
+ declare type MetricPeriod = (typeof MetricPeriod)[keyof typeof MetricPeriod];
7705
+
7706
+ /**
7707
+ *
7708
+ * @export
7709
+ */
7710
+ declare const MetricPeriod_2: {
7711
+ readonly AllTime: "all_time";
7712
+ readonly CurrentDay: "current_day";
7713
+ readonly CurrentMonth: "current_month";
7714
+ readonly CurrentWeek: "current_week";
7715
+ };
7716
+
7717
+ declare type MetricPeriod_2 = (typeof MetricPeriod_2)[keyof typeof MetricPeriod_2];
7718
+
7719
+ /**
7720
+ *
7721
+ * @export
7722
+ */
7723
+ declare const MetricPeriodMonthReset: {
7724
+ readonly BillingCycle: "billing_cycle";
7725
+ readonly FirstOfMonth: "first_of_month";
7726
+ };
7727
+
7728
+ declare type MetricPeriodMonthReset = (typeof MetricPeriodMonthReset)[keyof typeof MetricPeriodMonthReset];
7729
+
7730
+ /**
7731
+ *
7732
+ * @export
7733
+ */
7734
+ declare const MetricPeriodMonthReset_2: {
7735
+ readonly BillingCycle: "billing_cycle";
7736
+ readonly FirstOfMonth: "first_of_month";
7737
+ };
7738
+
7739
+ declare type MetricPeriodMonthReset_2 = (typeof MetricPeriodMonthReset_2)[keyof typeof MetricPeriodMonthReset_2];
7740
+
7538
7741
  declare interface Middleware {
7539
7742
  pre?(context: RequestContext): Promise<FetchParams | void>;
7540
7743
  post?(context: ResponseContext): Promise<Response | void>;
@@ -7708,28 +7911,6 @@ export declare const Plan: ({ isLoading, plans, selectedPlan, period, selectPlan
7708
7911
 
7709
7912
  declare type Plan_2 = CompanyPlanDetailResponseData;
7710
7913
 
7711
- /**
7712
- *
7713
- * @export
7714
- */
7715
- declare const PlanControlledByType: {
7716
- readonly Schematic: "schematic";
7717
- readonly Stripe: "stripe";
7718
- };
7719
-
7720
- declare type PlanControlledByType = (typeof PlanControlledByType)[keyof typeof PlanControlledByType];
7721
-
7722
- /**
7723
- *
7724
- * @export
7725
- */
7726
- declare const PlanControlledByType_2: {
7727
- readonly Schematic: "schematic";
7728
- readonly Stripe: "stripe";
7729
- };
7730
-
7731
- declare type PlanControlledByType_2 = (typeof PlanControlledByType_2)[keyof typeof PlanControlledByType_2];
7732
-
7733
7914
  /**
7734
7915
  *
7735
7916
  * @export
@@ -8201,10 +8382,28 @@ declare interface PlanDetailResponseData {
8201
8382
  companyCount: number;
8202
8383
  /**
8203
8384
  *
8204
- * @type {PlanControlledByType}
8385
+ * @type {string}
8205
8386
  * @memberof PlanDetailResponseData
8206
8387
  */
8207
- controlledBy: PlanControlledByType;
8388
+ companyId?: string | null;
8389
+ /**
8390
+ *
8391
+ * @type {string}
8392
+ * @memberof PlanDetailResponseData
8393
+ */
8394
+ companyName?: string | null;
8395
+ /**
8396
+ *
8397
+ * @type {BillingProviderType}
8398
+ * @memberof PlanDetailResponseData
8399
+ */
8400
+ controlledBy: BillingProviderType;
8401
+ /**
8402
+ *
8403
+ * @type {string}
8404
+ * @memberof PlanDetailResponseData
8405
+ */
8406
+ copiedFromPlanId?: string | null;
8208
8407
  /**
8209
8408
  *
8210
8409
  * @type {Date}
@@ -8231,10 +8430,10 @@ declare interface PlanDetailResponseData {
8231
8430
  draftVersion?: PlanVersionResponseData;
8232
8431
  /**
8233
8432
  *
8234
- * @type {Array<FeatureDetailResponseData>}
8433
+ * @type {Array<FeatureInPlanResponseData>}
8235
8434
  * @memberof PlanDetailResponseData
8236
8435
  */
8237
- features: Array<FeatureDetailResponseData>;
8436
+ features: Array<FeatureInPlanResponseData>;
8238
8437
  /**
8239
8438
  *
8240
8439
  * @type {PlanIcon}
@@ -8396,16 +8595,16 @@ declare interface PlanEntitlementResponseData {
8396
8595
  meteredYearlyPrice?: BillingPriceView;
8397
8596
  /**
8398
8597
  *
8399
- * @type {string}
8598
+ * @type {MetricPeriod}
8400
8599
  * @memberof PlanEntitlementResponseData
8401
8600
  */
8402
- metricPeriod?: string | null;
8601
+ metricPeriod?: MetricPeriod | null;
8403
8602
  /**
8404
8603
  *
8405
- * @type {string}
8604
+ * @type {MetricPeriodMonthReset}
8406
8605
  * @memberof PlanEntitlementResponseData
8407
8606
  */
8408
- metricPeriodMonthReset?: string | null;
8607
+ metricPeriodMonthReset?: MetricPeriodMonthReset | null;
8409
8608
  /**
8410
8609
  *
8411
8610
  * @type {PlanResponseData}
@@ -8566,16 +8765,16 @@ declare interface PlanEntitlementResponseData_2 {
8566
8765
  meteredYearlyPrice?: BillingPriceView_2;
8567
8766
  /**
8568
8767
  *
8569
- * @type {string}
8768
+ * @type {MetricPeriod}
8570
8769
  * @memberof PlanEntitlementResponseData
8571
8770
  */
8572
- metricPeriod?: string | null;
8771
+ metricPeriod?: MetricPeriod_2 | null;
8573
8772
  /**
8574
8773
  *
8575
- * @type {string}
8774
+ * @type {MetricPeriodMonthReset}
8576
8775
  * @memberof PlanEntitlementResponseData
8577
8776
  */
8578
- metricPeriodMonthReset?: string | null;
8777
+ metricPeriodMonthReset?: MetricPeriodMonthReset_2 | null;
8579
8778
  /**
8580
8779
  *
8581
8780
  * @type {PlanResponseData}
@@ -8764,6 +8963,18 @@ declare interface PlanResponseData {
8764
8963
  * @deprecated
8765
8964
  */
8766
8965
  audienceType?: string | null;
8966
+ /**
8967
+ *
8968
+ * @type {string}
8969
+ * @memberof PlanResponseData
8970
+ */
8971
+ companyId?: string | null;
8972
+ /**
8973
+ *
8974
+ * @type {string}
8975
+ * @memberof PlanResponseData
8976
+ */
8977
+ copiedFromPlanId?: string | null;
8767
8978
  /**
8768
8979
  *
8769
8980
  * @type {Date}
@@ -8821,6 +9032,18 @@ declare interface PlanResponseData_2 {
8821
9032
  * @deprecated
8822
9033
  */
8823
9034
  audienceType?: string | null;
9035
+ /**
9036
+ *
9037
+ * @type {string}
9038
+ * @memberof PlanResponseData
9039
+ */
9040
+ companyId?: string | null;
9041
+ /**
9042
+ *
9043
+ * @type {string}
9044
+ * @memberof PlanResponseData
9045
+ */
9046
+ copiedFromPlanId?: string | null;
8824
9047
  /**
8825
9048
  *
8826
9049
  * @type {Date}
@@ -9102,6 +9325,18 @@ declare interface PlanViewPublicResponseData {
9102
9325
  * @memberof PlanViewPublicResponseData
9103
9326
  */
9104
9327
  companyCount: number;
9328
+ /**
9329
+ *
9330
+ * @type {string}
9331
+ * @memberof PlanViewPublicResponseData
9332
+ */
9333
+ companyId?: string | null;
9334
+ /**
9335
+ *
9336
+ * @type {string}
9337
+ * @memberof PlanViewPublicResponseData
9338
+ */
9339
+ companyName?: string | null;
9105
9340
  /**
9106
9341
  *
9107
9342
  * @type {Array<string>}
@@ -9110,10 +9345,16 @@ declare interface PlanViewPublicResponseData {
9110
9345
  compatiblePlanIds: Array<string>;
9111
9346
  /**
9112
9347
  *
9113
- * @type {PlanControlledByType}
9348
+ * @type {BillingProviderType}
9114
9349
  * @memberof PlanViewPublicResponseData
9115
9350
  */
9116
- controlledBy: PlanControlledByType_2;
9351
+ controlledBy: BillingProviderType_2;
9352
+ /**
9353
+ *
9354
+ * @type {string}
9355
+ * @memberof PlanViewPublicResponseData
9356
+ */
9357
+ copiedFromPlanId?: string | null;
9117
9358
  /**
9118
9359
  *
9119
9360
  * @type {Date}
@@ -9158,10 +9399,10 @@ declare interface PlanViewPublicResponseData {
9158
9399
  entitlements: Array<PlanEntitlementResponseData_2>;
9159
9400
  /**
9160
9401
  *
9161
- * @type {Array<FeatureDetailResponseData>}
9402
+ * @type {Array<FeatureInPlanResponseData>}
9162
9403
  * @memberof PlanViewPublicResponseData
9163
9404
  */
9164
- features: Array<FeatureDetailResponseData_2>;
9405
+ features: Array<FeatureInPlanResponseData_2>;
9165
9406
  /**
9166
9407
  *
9167
9408
  * @type {PlanIcon}
@@ -9864,10 +10105,10 @@ declare interface Rule {
9864
10105
  priority: number;
9865
10106
  /**
9866
10107
  *
9867
- * @type {string}
10108
+ * @type {RuleType}
9868
10109
  * @memberof Rule
9869
10110
  */
9870
- ruleType: RuleRuleTypeEnum;
10111
+ ruleType: RuleType;
9871
10112
  /**
9872
10113
  *
9873
10114
  * @type {boolean}
@@ -9902,10 +10143,10 @@ declare interface RuleConditionDetailResponseData {
9902
10143
  conditionGroupId?: string | null;
9903
10144
  /**
9904
10145
  *
9905
- * @type {string}
10146
+ * @type {ConditionType}
9906
10147
  * @memberof RuleConditionDetailResponseData
9907
10148
  */
9908
- conditionType: string;
10149
+ conditionType: ConditionType;
9909
10150
  /**
9910
10151
  *
9911
10152
  * @type {Date}
@@ -9938,16 +10179,16 @@ declare interface RuleConditionDetailResponseData {
9938
10179
  id: string;
9939
10180
  /**
9940
10181
  *
9941
- * @type {string}
10182
+ * @type {MetricPeriod}
9942
10183
  * @memberof RuleConditionDetailResponseData
9943
10184
  */
9944
- metricPeriod?: string | null;
10185
+ metricPeriod?: MetricPeriod | null;
9945
10186
  /**
9946
10187
  *
9947
- * @type {string}
10188
+ * @type {MetricPeriodMonthReset}
9948
10189
  * @memberof RuleConditionDetailResponseData
9949
10190
  */
9950
- metricPeriodMonthReset?: string | null;
10191
+ metricPeriodMonthReset?: MetricPeriodMonthReset | null;
9951
10192
  /**
9952
10193
  *
9953
10194
  * @type {number}
@@ -9956,10 +10197,10 @@ declare interface RuleConditionDetailResponseData {
9956
10197
  metricValue?: number | null;
9957
10198
  /**
9958
10199
  *
9959
- * @type {string}
10200
+ * @type {ComparableOperator}
9960
10201
  * @memberof RuleConditionDetailResponseData
9961
10202
  */
9962
- operator: string;
10203
+ operator: ComparableOperator;
9963
10204
  /**
9964
10205
  *
9965
10206
  * @type {Array<string>}
@@ -10036,10 +10277,10 @@ declare interface RuleConditionDetailResponseData_2 {
10036
10277
  conditionGroupId?: string | null;
10037
10278
  /**
10038
10279
  *
10039
- * @type {string}
10280
+ * @type {ConditionType}
10040
10281
  * @memberof RuleConditionDetailResponseData
10041
10282
  */
10042
- conditionType: string;
10283
+ conditionType: ConditionType_2;
10043
10284
  /**
10044
10285
  *
10045
10286
  * @type {Date}
@@ -10072,16 +10313,16 @@ declare interface RuleConditionDetailResponseData_2 {
10072
10313
  id: string;
10073
10314
  /**
10074
10315
  *
10075
- * @type {string}
10316
+ * @type {MetricPeriod}
10076
10317
  * @memberof RuleConditionDetailResponseData
10077
10318
  */
10078
- metricPeriod?: string | null;
10319
+ metricPeriod?: MetricPeriod_2 | null;
10079
10320
  /**
10080
10321
  *
10081
- * @type {string}
10322
+ * @type {MetricPeriodMonthReset}
10082
10323
  * @memberof RuleConditionDetailResponseData
10083
10324
  */
10084
- metricPeriodMonthReset?: string | null;
10325
+ metricPeriodMonthReset?: MetricPeriodMonthReset_2 | null;
10085
10326
  /**
10086
10327
  *
10087
10328
  * @type {number}
@@ -10090,10 +10331,10 @@ declare interface RuleConditionDetailResponseData_2 {
10090
10331
  metricValue?: number | null;
10091
10332
  /**
10092
10333
  *
10093
- * @type {string}
10334
+ * @type {ComparableOperator}
10094
10335
  * @memberof RuleConditionDetailResponseData
10095
10336
  */
10096
- operator: string;
10337
+ operator: ComparableOperator_2;
10097
10338
  /**
10098
10339
  *
10099
10340
  * @type {Array<string>}
@@ -10300,10 +10541,10 @@ declare interface RuleDetailResponseData {
10300
10541
  priority: number;
10301
10542
  /**
10302
10543
  *
10303
- * @type {string}
10544
+ * @type {RuleType}
10304
10545
  * @memberof RuleDetailResponseData
10305
10546
  */
10306
- ruleType: string;
10547
+ ruleType: RuleType;
10307
10548
  /**
10308
10549
  *
10309
10550
  * @type {Date}
@@ -10374,10 +10615,10 @@ declare interface RuleDetailResponseData_2 {
10374
10615
  priority: number;
10375
10616
  /**
10376
10617
  *
10377
- * @type {string}
10618
+ * @type {RuleType}
10378
10619
  * @memberof RuleDetailResponseData
10379
10620
  */
10380
- ruleType: string;
10621
+ ruleType: RuleType_2;
10381
10622
  /**
10382
10623
  *
10383
10624
  * @type {Date}
@@ -10393,19 +10634,36 @@ declare interface RuleDetailResponseData_2 {
10393
10634
  }
10394
10635
 
10395
10636
  /**
10637
+ *
10396
10638
  * @export
10397
10639
  */
10398
- declare const RuleRuleTypeEnum: {
10640
+ declare const RuleType: {
10641
+ readonly CompanyOverride: "company_override";
10642
+ readonly CompanyOverrideUsageExceeded: "company_override_usage_exceeded";
10399
10643
  readonly Default: "default";
10400
10644
  readonly GlobalOverride: "global_override";
10645
+ readonly PlanEntitlement: "plan_entitlement";
10646
+ readonly PlanEntitlementUsageExceeded: "plan_entitlement_usage_exceeded";
10647
+ readonly Standard: "standard";
10648
+ };
10649
+
10650
+ declare type RuleType = (typeof RuleType)[keyof typeof RuleType];
10651
+
10652
+ /**
10653
+ *
10654
+ * @export
10655
+ */
10656
+ declare const RuleType_2: {
10401
10657
  readonly CompanyOverride: "company_override";
10402
10658
  readonly CompanyOverrideUsageExceeded: "company_override_usage_exceeded";
10659
+ readonly Default: "default";
10660
+ readonly GlobalOverride: "global_override";
10403
10661
  readonly PlanEntitlement: "plan_entitlement";
10404
10662
  readonly PlanEntitlementUsageExceeded: "plan_entitlement_usage_exceeded";
10405
10663
  readonly Standard: "standard";
10406
10664
  };
10407
10665
 
10408
- declare type RuleRuleTypeEnum = (typeof RuleRuleTypeEnum)[keyof typeof RuleRuleTypeEnum];
10666
+ declare type RuleType_2 = (typeof RuleType_2)[keyof typeof RuleType_2];
10409
10667
 
10410
10668
  /**
10411
10669
  *
@@ -10928,16 +11186,16 @@ declare interface UsageBasedEntitlementResponseData {
10928
11186
  meteredPrice?: BillingPriceView;
10929
11187
  /**
10930
11188
  *
10931
- * @type {string}
11189
+ * @type {MetricPeriod}
10932
11190
  * @memberof UsageBasedEntitlementResponseData
10933
11191
  */
10934
- metricPeriod?: string | null;
11192
+ metricPeriod?: MetricPeriod | null;
10935
11193
  /**
10936
11194
  *
10937
- * @type {string}
11195
+ * @type {MetricPeriodMonthReset}
10938
11196
  * @memberof UsageBasedEntitlementResponseData
10939
11197
  */
10940
- metricPeriodMonthReset?: string | null;
11198
+ metricPeriodMonthReset?: MetricPeriodMonthReset | null;
10941
11199
  /**
10942
11200
  *
10943
11201
  * @type {BillingPriceView}
@@ -10976,8 +11234,21 @@ declare interface UsageBasedEntitlementResponseData {
10976
11234
  yearlyUsageBasedPrice?: BillingPriceView;
10977
11235
  }
10978
11236
 
11237
+ /**
11238
+ * Returns the currencies that should be displayed in the UI. When a
11239
+ * `currencyFilter` is configured on EmbedProvider, this is the intersection
11240
+ * of the filter with the hydrated currency set. Otherwise it is the full
11241
+ * hydrated set.
11242
+ */
10979
11243
  export declare function useAvailableCurrencies(): string[];
10980
11244
 
11245
+ /**
11246
+ * Like `useAvailableCurrencies` but also returns the list of filter entries
11247
+ * that did not match any currency in the hydrated data. Consumers can render
11248
+ * an error notice and (optionally) log these invalid inputs.
11249
+ */
11250
+ export declare function useAvailableCurrenciesWithInvalid(): AvailableCurrenciesResult;
11251
+
10981
11252
  export declare function useAvailablePlans(activePeriod: string, options?: AvailablePlanOptions): {
10982
11253
  plans: SelectedPlan[];
10983
11254
  addOns: SelectedPlan[];