@schematichq/schematic-components 2.25.1 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -78,9 +78,9 @@ declare type BillingArrearsAnchor_2 = (typeof BillingArrearsAnchor_2)[keyof type
78
78
  * @export
79
79
  */
80
80
  declare const BillingArrearsCadence: {
81
- readonly Daily: "daily";
82
81
  readonly EndOfBillingPeriod: "end_of_billing_period";
83
82
  readonly Monthly: "monthly";
83
+ readonly Quarterly: "quarterly";
84
84
  };
85
85
 
86
86
  declare type BillingArrearsCadence = (typeof BillingArrearsCadence)[keyof typeof BillingArrearsCadence];
@@ -90,9 +90,9 @@ declare type BillingArrearsCadence = (typeof BillingArrearsCadence)[keyof typeof
90
90
  * @export
91
91
  */
92
92
  declare const BillingArrearsCadence_2: {
93
- readonly Daily: "daily";
94
93
  readonly EndOfBillingPeriod: "end_of_billing_period";
95
94
  readonly Monthly: "monthly";
95
+ readonly Quarterly: "quarterly";
96
96
  };
97
97
 
98
98
  declare type BillingArrearsCadence_2 = (typeof BillingArrearsCadence_2)[keyof typeof BillingArrearsCadence_2];
@@ -372,6 +372,7 @@ declare const BillingCreditGrantReason: {
372
372
  readonly BillingCreditAutoTopup: "billing_credit_auto_topup";
373
373
  readonly Free: "free";
374
374
  readonly Plan: "plan";
375
+ readonly PostpaidOverdraft: "postpaid_overdraft";
375
376
  readonly Purchased: "purchased";
376
377
  readonly Rollover: "rollover";
377
378
  };
@@ -6428,6 +6429,62 @@ declare interface CreditUsageAggregation {
6428
6429
  usageToday?: number | null;
6429
6430
  }
6430
6431
 
6432
+ /**
6433
+ *
6434
+ * @export
6435
+ * @interface CreditUserUsageResponseData
6436
+ */
6437
+ declare interface CreditUserUsageResponseData {
6438
+ /**
6439
+ *
6440
+ * @type {string}
6441
+ * @memberof CreditUserUsageResponseData
6442
+ */
6443
+ billingCreditId: string;
6444
+ /**
6445
+ * The display name of the credit type
6446
+ * @type {string}
6447
+ * @memberof CreditUserUsageResponseData
6448
+ */
6449
+ creditName: string;
6450
+ /**
6451
+ * End of the window the consumption is measured over (exclusive)
6452
+ * @type {Date}
6453
+ * @memberof CreditUserUsageResponseData
6454
+ */
6455
+ endTime: Date;
6456
+ /**
6457
+ * This page of per-user net consumption of the credit within the window, highest first
6458
+ * @type {Array<UserCreditUsageResponseData>}
6459
+ * @memberof CreditUserUsageResponseData
6460
+ */
6461
+ entries: Array<UserCreditUsageResponseData>;
6462
+ /**
6463
+ * Start of the window, the earliest valid-from among the credit's currently-active grants
6464
+ * @type {Date}
6465
+ * @memberof CreditUserUsageResponseData
6466
+ */
6467
+ startTime: Date;
6468
+ /**
6469
+ * Consumption across every user in the window, not just this page
6470
+ * @type {number}
6471
+ * @memberof CreditUserUsageResponseData
6472
+ */
6473
+ total: number;
6474
+ /**
6475
+ * How many users the window has entries for, to page against; excludes unattributed
6476
+ * @type {number}
6477
+ * @memberof CreditUserUsageResponseData
6478
+ */
6479
+ totalUsers: number;
6480
+ /**
6481
+ * Consumption from events sent without a user; not a user, so it is excluded from entries and total_users and returned on every page. Null when the window has none
6482
+ * @type {UserCreditUsageResponseData}
6483
+ * @memberof CreditUserUsageResponseData
6484
+ */
6485
+ unattributed?: UserCreditUsageResponseData;
6486
+ }
6487
+
6431
6488
  declare interface CreditWithCompanyContext {
6432
6489
  id: CreditCompanyGrantView["billingCreditId"];
6433
6490
  name: CreditCompanyGrantView["creditName"];
@@ -6850,6 +6907,9 @@ declare interface DesignProps_4 {
6850
6907
  isVisible: boolean;
6851
6908
  fontStyle: FontStyle;
6852
6909
  };
6910
+ usageByUser: {
6911
+ isVisible: boolean;
6912
+ };
6853
6913
  visibleFeatures?: string[];
6854
6914
  }
6855
6915
 
@@ -7008,6 +7068,8 @@ export declare interface EmbedContextProps extends Omit<EmbedState, SettingsLaye
7008
7068
  getUpcomingInvoice: (id: string) => DebouncedApiPromise<HydrateUpcomingInvoiceResponse>;
7009
7069
  getCustomerBalance: () => DebouncedApiPromise<FetchCustomerBalanceResponse>;
7010
7070
  listInvoices: () => DebouncedApiPromise<ListInvoicesResponse>;
7071
+ getCreditUsageByUser: (billingCreditId: string, limit?: number) => DebouncedApiPromise<GetCreditUsageByUserResponse>;
7072
+ getFeatureUsageByUser: (featureId: string, limit?: number) => DebouncedApiPromise<GetFeatureUsageByUserResponse>;
7011
7073
  createSetupIntent: () => DebouncedApiPromise<GetSetupIntentResponse>;
7012
7074
  updatePaymentMethod: (paymentMethodId: string) => DebouncedApiPromise<UpdatePaymentMethodResponse>;
7013
7075
  deletePaymentMethod: (checkoutId: string) => DebouncedApiPromise<DeletePaymentMethodResponse>;
@@ -8521,6 +8583,56 @@ declare interface FeatureUsageResponseData {
8521
8583
  yearlyUsageBasedPrice?: BillingPriceView;
8522
8584
  }
8523
8585
 
8586
+ /**
8587
+ *
8588
+ * @export
8589
+ * @interface FeatureUserUsageResponseData
8590
+ */
8591
+ declare interface FeatureUserUsageResponseData {
8592
+ /**
8593
+ * End of the feature's current metric period (exclusive)
8594
+ * @type {Date}
8595
+ * @memberof FeatureUserUsageResponseData
8596
+ */
8597
+ endTime: Date;
8598
+ /**
8599
+ *
8600
+ * @type {FeatureResponseData}
8601
+ * @memberof FeatureUserUsageResponseData
8602
+ */
8603
+ feature?: FeatureResponseData;
8604
+ /**
8605
+ * This page of per-user usage of the feature within the period, highest first
8606
+ * @type {Array<UserFeatureUsageResponseData>}
8607
+ * @memberof FeatureUserUsageResponseData
8608
+ */
8609
+ rows: Array<UserFeatureUsageResponseData>;
8610
+ /**
8611
+ * Start of the feature's current metric period
8612
+ * @type {Date}
8613
+ * @memberof FeatureUserUsageResponseData
8614
+ */
8615
+ startTime: Date;
8616
+ /**
8617
+ * Usage across every user in the period, not just this page
8618
+ * @type {number}
8619
+ * @memberof FeatureUserUsageResponseData
8620
+ */
8621
+ total: number;
8622
+ /**
8623
+ * How many users the period has rows for, to page against; excludes unattributed
8624
+ * @type {number}
8625
+ * @memberof FeatureUserUsageResponseData
8626
+ */
8627
+ totalUsers: number;
8628
+ /**
8629
+ * Usage from events sent without a user; not a user, so it is excluded from rows and total_users and returned on every page. Null when the period has none
8630
+ * @type {UserFeatureUsageResponseData}
8631
+ * @memberof FeatureUserUsageResponseData
8632
+ */
8633
+ unattributed?: UserFeatureUsageResponseData;
8634
+ }
8635
+
8524
8636
  declare type FetchAPI = WindowOrWorkerGlobalScope["fetch"];
8525
8637
 
8526
8638
  /**
@@ -8888,6 +9000,108 @@ declare interface GetCheckoutTaxIDResponse {
8888
9000
  params: object;
8889
9001
  }
8890
9002
 
9003
+ /**
9004
+ * Schematic API
9005
+ * Schematic API
9006
+ *
9007
+ * The version of the OpenAPI document: 0.1
9008
+ *
9009
+ *
9010
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9011
+ * https://openapi-generator.tech
9012
+ * Do not edit the class manually.
9013
+ */
9014
+ /**
9015
+ * Input parameters
9016
+ * @export
9017
+ * @interface GetCreditUsageByUserParams
9018
+ */
9019
+ declare interface GetCreditUsageByUserParams {
9020
+ /**
9021
+ * Page limit (default 100)
9022
+ * @type {number}
9023
+ * @memberof GetCreditUsageByUserParams
9024
+ */
9025
+ limit?: number;
9026
+ /**
9027
+ * Page offset (default 0)
9028
+ * @type {number}
9029
+ * @memberof GetCreditUsageByUserParams
9030
+ */
9031
+ offset?: number;
9032
+ }
9033
+
9034
+ /**
9035
+ *
9036
+ * @export
9037
+ * @interface GetCreditUsageByUserResponse
9038
+ */
9039
+ declare interface GetCreditUsageByUserResponse {
9040
+ /**
9041
+ *
9042
+ * @type {CreditUserUsageResponseData}
9043
+ * @memberof GetCreditUsageByUserResponse
9044
+ */
9045
+ data: CreditUserUsageResponseData;
9046
+ /**
9047
+ *
9048
+ * @type {GetCreditUsageByUserParams}
9049
+ * @memberof GetCreditUsageByUserResponse
9050
+ */
9051
+ params: GetCreditUsageByUserParams;
9052
+ }
9053
+
9054
+ /**
9055
+ * Schematic API
9056
+ * Schematic API
9057
+ *
9058
+ * The version of the OpenAPI document: 0.1
9059
+ *
9060
+ *
9061
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9062
+ * https://openapi-generator.tech
9063
+ * Do not edit the class manually.
9064
+ */
9065
+ /**
9066
+ * Input parameters
9067
+ * @export
9068
+ * @interface GetFeatureUsageByUserParams
9069
+ */
9070
+ declare interface GetFeatureUsageByUserParams {
9071
+ /**
9072
+ * Page limit (default 100)
9073
+ * @type {number}
9074
+ * @memberof GetFeatureUsageByUserParams
9075
+ */
9076
+ limit?: number;
9077
+ /**
9078
+ * Page offset (default 0)
9079
+ * @type {number}
9080
+ * @memberof GetFeatureUsageByUserParams
9081
+ */
9082
+ offset?: number;
9083
+ }
9084
+
9085
+ /**
9086
+ *
9087
+ * @export
9088
+ * @interface GetFeatureUsageByUserResponse
9089
+ */
9090
+ declare interface GetFeatureUsageByUserResponse {
9091
+ /**
9092
+ *
9093
+ * @type {FeatureUserUsageResponseData}
9094
+ * @memberof GetFeatureUsageByUserResponse
9095
+ */
9096
+ data: FeatureUserUsageResponseData;
9097
+ /**
9098
+ *
9099
+ * @type {GetFeatureUsageByUserParams}
9100
+ * @memberof GetFeatureUsageByUserResponse
9101
+ */
9102
+ params: GetFeatureUsageByUserParams;
9103
+ }
9104
+
8891
9105
  /**
8892
9106
  *
8893
9107
  * @export
@@ -8965,6 +9179,8 @@ export declare const initialContext: {
8965
9179
  getUpcomingInvoice: () => never;
8966
9180
  getCustomerBalance: () => never;
8967
9181
  listInvoices: () => never;
9182
+ getCreditUsageByUser: () => never;
9183
+ getFeatureUsageByUser: () => never;
8968
9184
  createSetupIntent: () => never;
8969
9185
  updatePaymentMethod: () => never;
8970
9186
  deletePaymentMethod: () => never;
@@ -10542,6 +10758,18 @@ declare interface PlanEntitlementResponseData {
10542
10758
  * @memberof PlanEntitlementResponseData
10543
10759
  */
10544
10760
  metricPeriodMonthReset?: MetricPeriodMonthReset | null;
10761
+ /**
10762
+ * How often overage charges are assessed and invoiced. Null or end_of_billing_period means the billing provider aggregates usage over the subscription's own period and bills it at period end. Monthly and quarterly mean Schematic assesses the overage each month or quarter and bills it on its own invoice. Only applies to overage price behavior.
10763
+ * @type {BillingArrearsCadence}
10764
+ * @memberof PlanEntitlementResponseData
10765
+ */
10766
+ overageBillingCadence?: BillingArrearsCadence | null;
10767
+ /**
10768
+ * Which boundary closes a monthly or quarterly overage window: the subscription's own recurrence (billing_period_start) or the calendar month (month_end), which for a quarterly window means calendar quarters. Only meaningful when overage_billing_cadence is monthly or quarterly.
10769
+ * @type {BillingArrearsAnchor}
10770
+ * @memberof PlanEntitlementResponseData
10771
+ */
10772
+ overageInvoiceAnchor?: BillingArrearsAnchor | null;
10545
10773
  /**
10546
10774
  *
10547
10775
  * @type {PlanResponseData}
@@ -10730,6 +10958,18 @@ declare interface PlanEntitlementResponseData_2 {
10730
10958
  * @memberof PlanEntitlementResponseData
10731
10959
  */
10732
10960
  metricPeriodMonthReset?: MetricPeriodMonthReset_2 | null;
10961
+ /**
10962
+ * How often overage charges are assessed and invoiced. Null or end_of_billing_period means the billing provider aggregates usage over the subscription's own period and bills it at period end. Monthly and quarterly mean Schematic assesses the overage each month or quarter and bills it on its own invoice. Only applies to overage price behavior.
10963
+ * @type {BillingArrearsCadence}
10964
+ * @memberof PlanEntitlementResponseData
10965
+ */
10966
+ overageBillingCadence?: BillingArrearsCadence_2 | null;
10967
+ /**
10968
+ * Which boundary closes a monthly or quarterly overage window: the subscription's own recurrence (billing_period_start) or the calendar month (month_end), which for a quarterly window means calendar quarters. Only meaningful when overage_billing_cadence is monthly or quarterly.
10969
+ * @type {BillingArrearsAnchor}
10970
+ * @memberof PlanEntitlementResponseData
10971
+ */
10972
+ overageInvoiceAnchor?: BillingArrearsAnchor_2 | null;
10733
10973
  /**
10734
10974
  *
10735
10975
  * @type {PlanResponseData}
@@ -13876,10 +14116,153 @@ declare interface UsePaymentConfirmationReturn {
13876
14116
  reset: () => void;
13877
14117
  }
13878
14118
 
14119
+ /**
14120
+ *
14121
+ * @export
14122
+ * @interface UserCreditUsageResponseData
14123
+ */
14124
+ declare interface UserCreditUsageResponseData {
14125
+ /**
14126
+ *
14127
+ * @type {string}
14128
+ * @memberof UserCreditUsageResponseData
14129
+ */
14130
+ billingCreditId: string;
14131
+ /**
14132
+ * The display name of the credit type
14133
+ * @type {string}
14134
+ * @memberof UserCreditUsageResponseData
14135
+ */
14136
+ creditName: string;
14137
+ /**
14138
+ * The user's net track-driven consumption of the credit within the window (draws minus refunds)
14139
+ * @type {number}
14140
+ * @memberof UserCreditUsageResponseData
14141
+ */
14142
+ creditsUsed: number;
14143
+ /**
14144
+ * This row's fraction (0-1) of the company's total track-driven consumption of the credit within the window, including unattributed consumption
14145
+ * @type {number}
14146
+ * @memberof UserCreditUsageResponseData
14147
+ */
14148
+ share: number;
14149
+ /**
14150
+ * The user the consumption is attributed to; null for consumption from events sent without a user
14151
+ * @type {UserResponseData}
14152
+ * @memberof UserCreditUsageResponseData
14153
+ */
14154
+ user?: UserResponseData;
14155
+ /**
14156
+ * The user the consumption is attributed to; null for unattributed consumption
14157
+ * @type {string}
14158
+ * @memberof UserCreditUsageResponseData
14159
+ */
14160
+ userId?: string | null;
14161
+ }
14162
+
13879
14163
  export declare function useRequest<TData>(fn: () => Promise<{
13880
14164
  data: TData;
13881
14165
  }> | undefined): [RequestState<TData>, () => Promise<void>];
13882
14166
 
14167
+ /**
14168
+ *
14169
+ * @export
14170
+ * @interface UserFeatureUsageResponseData
14171
+ */
14172
+ declare interface UserFeatureUsageResponseData {
14173
+ /**
14174
+ *
14175
+ * @type {FeatureResponseData}
14176
+ * @memberof UserFeatureUsageResponseData
14177
+ */
14178
+ feature?: FeatureResponseData;
14179
+ /**
14180
+ * When the user last used the feature within the window
14181
+ * @type {Date}
14182
+ * @memberof UserFeatureUsageResponseData
14183
+ */
14184
+ lastSeen: Date;
14185
+ /**
14186
+ * This row's fraction (0-1) of the company's total usage of the feature within the window, including unattributed usage
14187
+ * @type {number}
14188
+ * @memberof UserFeatureUsageResponseData
14189
+ */
14190
+ share: number;
14191
+ /**
14192
+ * The user the usage is attributed to; null for usage from events sent without a user
14193
+ * @type {UserResponseData}
14194
+ * @memberof UserFeatureUsageResponseData
14195
+ */
14196
+ user?: UserResponseData;
14197
+ /**
14198
+ * The user the usage is attributed to; null for unattributed usage
14199
+ * @type {string}
14200
+ * @memberof UserFeatureUsageResponseData
14201
+ */
14202
+ userId?: string | null;
14203
+ /**
14204
+ * The user's usage of the feature within the window
14205
+ * @type {number}
14206
+ * @memberof UserFeatureUsageResponseData
14207
+ */
14208
+ value: number;
14209
+ }
14210
+
14211
+ /**
14212
+ * Schematic API
14213
+ * Schematic API
14214
+ *
14215
+ * The version of the OpenAPI document: 0.1
14216
+ *
14217
+ *
14218
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
14219
+ * https://openapi-generator.tech
14220
+ * Do not edit the class manually.
14221
+ */
14222
+ /**
14223
+ *
14224
+ * @export
14225
+ * @interface UserResponseData
14226
+ */
14227
+ declare interface UserResponseData {
14228
+ /**
14229
+ *
14230
+ * @type {Date}
14231
+ * @memberof UserResponseData
14232
+ */
14233
+ createdAt: Date;
14234
+ /**
14235
+ *
14236
+ * @type {string}
14237
+ * @memberof UserResponseData
14238
+ */
14239
+ environmentId: string;
14240
+ /**
14241
+ *
14242
+ * @type {string}
14243
+ * @memberof UserResponseData
14244
+ */
14245
+ id: string;
14246
+ /**
14247
+ *
14248
+ * @type {Date}
14249
+ * @memberof UserResponseData
14250
+ */
14251
+ lastSeenAt?: Date | null;
14252
+ /**
14253
+ *
14254
+ * @type {string}
14255
+ * @memberof UserResponseData
14256
+ */
14257
+ name: string;
14258
+ /**
14259
+ *
14260
+ * @type {Date}
14261
+ * @memberof UserResponseData
14262
+ */
14263
+ updatedAt: Date;
14264
+ }
14265
+
13883
14266
  /**
13884
14267
  * Returns the currency of the company's active subscription, if any.
13885
14268
  * Stripe does not allow mixing currencies on a subscription, so when