@schematichq/schematic-components 2.25.1 → 2.25.2

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,7 +78,6 @@ 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";
84
83
  };
@@ -90,7 +89,6 @@ declare type BillingArrearsCadence = (typeof BillingArrearsCadence)[keyof typeof
90
89
  * @export
91
90
  */
92
91
  declare const BillingArrearsCadence_2: {
93
- readonly Daily: "daily";
94
92
  readonly EndOfBillingPeriod: "end_of_billing_period";
95
93
  readonly Monthly: "monthly";
96
94
  };
@@ -6428,6 +6426,62 @@ declare interface CreditUsageAggregation {
6428
6426
  usageToday?: number | null;
6429
6427
  }
6430
6428
 
6429
+ /**
6430
+ *
6431
+ * @export
6432
+ * @interface CreditUserUsageResponseData
6433
+ */
6434
+ declare interface CreditUserUsageResponseData {
6435
+ /**
6436
+ *
6437
+ * @type {string}
6438
+ * @memberof CreditUserUsageResponseData
6439
+ */
6440
+ billingCreditId: string;
6441
+ /**
6442
+ * The display name of the credit type
6443
+ * @type {string}
6444
+ * @memberof CreditUserUsageResponseData
6445
+ */
6446
+ creditName: string;
6447
+ /**
6448
+ * End of the window the consumption is measured over (exclusive)
6449
+ * @type {Date}
6450
+ * @memberof CreditUserUsageResponseData
6451
+ */
6452
+ endTime: Date;
6453
+ /**
6454
+ * This page of per-user net consumption of the credit within the window, highest first
6455
+ * @type {Array<UserCreditUsageResponseData>}
6456
+ * @memberof CreditUserUsageResponseData
6457
+ */
6458
+ entries: Array<UserCreditUsageResponseData>;
6459
+ /**
6460
+ * Start of the window, the earliest valid-from among the credit's currently-active grants
6461
+ * @type {Date}
6462
+ * @memberof CreditUserUsageResponseData
6463
+ */
6464
+ startTime: Date;
6465
+ /**
6466
+ * Consumption across every user in the window, not just this page
6467
+ * @type {number}
6468
+ * @memberof CreditUserUsageResponseData
6469
+ */
6470
+ total: number;
6471
+ /**
6472
+ * How many users the window has entries for, to page against; excludes unattributed
6473
+ * @type {number}
6474
+ * @memberof CreditUserUsageResponseData
6475
+ */
6476
+ totalUsers: number;
6477
+ /**
6478
+ * 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
6479
+ * @type {UserCreditUsageResponseData}
6480
+ * @memberof CreditUserUsageResponseData
6481
+ */
6482
+ unattributed?: UserCreditUsageResponseData;
6483
+ }
6484
+
6431
6485
  declare interface CreditWithCompanyContext {
6432
6486
  id: CreditCompanyGrantView["billingCreditId"];
6433
6487
  name: CreditCompanyGrantView["creditName"];
@@ -6850,6 +6904,9 @@ declare interface DesignProps_4 {
6850
6904
  isVisible: boolean;
6851
6905
  fontStyle: FontStyle;
6852
6906
  };
6907
+ usageByUser: {
6908
+ isVisible: boolean;
6909
+ };
6853
6910
  visibleFeatures?: string[];
6854
6911
  }
6855
6912
 
@@ -7008,6 +7065,8 @@ export declare interface EmbedContextProps extends Omit<EmbedState, SettingsLaye
7008
7065
  getUpcomingInvoice: (id: string) => DebouncedApiPromise<HydrateUpcomingInvoiceResponse>;
7009
7066
  getCustomerBalance: () => DebouncedApiPromise<FetchCustomerBalanceResponse>;
7010
7067
  listInvoices: () => DebouncedApiPromise<ListInvoicesResponse>;
7068
+ getCreditUsageByUser: (billingCreditId: string, limit?: number) => DebouncedApiPromise<GetCreditUsageByUserResponse>;
7069
+ getFeatureUsageByUser: (featureId: string, limit?: number) => DebouncedApiPromise<GetFeatureUsageByUserResponse>;
7011
7070
  createSetupIntent: () => DebouncedApiPromise<GetSetupIntentResponse>;
7012
7071
  updatePaymentMethod: (paymentMethodId: string) => DebouncedApiPromise<UpdatePaymentMethodResponse>;
7013
7072
  deletePaymentMethod: (checkoutId: string) => DebouncedApiPromise<DeletePaymentMethodResponse>;
@@ -8521,6 +8580,56 @@ declare interface FeatureUsageResponseData {
8521
8580
  yearlyUsageBasedPrice?: BillingPriceView;
8522
8581
  }
8523
8582
 
8583
+ /**
8584
+ *
8585
+ * @export
8586
+ * @interface FeatureUserUsageResponseData
8587
+ */
8588
+ declare interface FeatureUserUsageResponseData {
8589
+ /**
8590
+ * End of the feature's current metric period (exclusive)
8591
+ * @type {Date}
8592
+ * @memberof FeatureUserUsageResponseData
8593
+ */
8594
+ endTime: Date;
8595
+ /**
8596
+ *
8597
+ * @type {FeatureResponseData}
8598
+ * @memberof FeatureUserUsageResponseData
8599
+ */
8600
+ feature?: FeatureResponseData;
8601
+ /**
8602
+ * This page of per-user usage of the feature within the period, highest first
8603
+ * @type {Array<UserFeatureUsageResponseData>}
8604
+ * @memberof FeatureUserUsageResponseData
8605
+ */
8606
+ rows: Array<UserFeatureUsageResponseData>;
8607
+ /**
8608
+ * Start of the feature's current metric period
8609
+ * @type {Date}
8610
+ * @memberof FeatureUserUsageResponseData
8611
+ */
8612
+ startTime: Date;
8613
+ /**
8614
+ * Usage across every user in the period, not just this page
8615
+ * @type {number}
8616
+ * @memberof FeatureUserUsageResponseData
8617
+ */
8618
+ total: number;
8619
+ /**
8620
+ * How many users the period has rows for, to page against; excludes unattributed
8621
+ * @type {number}
8622
+ * @memberof FeatureUserUsageResponseData
8623
+ */
8624
+ totalUsers: number;
8625
+ /**
8626
+ * 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
8627
+ * @type {UserFeatureUsageResponseData}
8628
+ * @memberof FeatureUserUsageResponseData
8629
+ */
8630
+ unattributed?: UserFeatureUsageResponseData;
8631
+ }
8632
+
8524
8633
  declare type FetchAPI = WindowOrWorkerGlobalScope["fetch"];
8525
8634
 
8526
8635
  /**
@@ -8888,6 +8997,108 @@ declare interface GetCheckoutTaxIDResponse {
8888
8997
  params: object;
8889
8998
  }
8890
8999
 
9000
+ /**
9001
+ * Schematic API
9002
+ * Schematic API
9003
+ *
9004
+ * The version of the OpenAPI document: 0.1
9005
+ *
9006
+ *
9007
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9008
+ * https://openapi-generator.tech
9009
+ * Do not edit the class manually.
9010
+ */
9011
+ /**
9012
+ * Input parameters
9013
+ * @export
9014
+ * @interface GetCreditUsageByUserParams
9015
+ */
9016
+ declare interface GetCreditUsageByUserParams {
9017
+ /**
9018
+ * Page limit (default 100)
9019
+ * @type {number}
9020
+ * @memberof GetCreditUsageByUserParams
9021
+ */
9022
+ limit?: number;
9023
+ /**
9024
+ * Page offset (default 0)
9025
+ * @type {number}
9026
+ * @memberof GetCreditUsageByUserParams
9027
+ */
9028
+ offset?: number;
9029
+ }
9030
+
9031
+ /**
9032
+ *
9033
+ * @export
9034
+ * @interface GetCreditUsageByUserResponse
9035
+ */
9036
+ declare interface GetCreditUsageByUserResponse {
9037
+ /**
9038
+ *
9039
+ * @type {CreditUserUsageResponseData}
9040
+ * @memberof GetCreditUsageByUserResponse
9041
+ */
9042
+ data: CreditUserUsageResponseData;
9043
+ /**
9044
+ *
9045
+ * @type {GetCreditUsageByUserParams}
9046
+ * @memberof GetCreditUsageByUserResponse
9047
+ */
9048
+ params: GetCreditUsageByUserParams;
9049
+ }
9050
+
9051
+ /**
9052
+ * Schematic API
9053
+ * Schematic API
9054
+ *
9055
+ * The version of the OpenAPI document: 0.1
9056
+ *
9057
+ *
9058
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9059
+ * https://openapi-generator.tech
9060
+ * Do not edit the class manually.
9061
+ */
9062
+ /**
9063
+ * Input parameters
9064
+ * @export
9065
+ * @interface GetFeatureUsageByUserParams
9066
+ */
9067
+ declare interface GetFeatureUsageByUserParams {
9068
+ /**
9069
+ * Page limit (default 100)
9070
+ * @type {number}
9071
+ * @memberof GetFeatureUsageByUserParams
9072
+ */
9073
+ limit?: number;
9074
+ /**
9075
+ * Page offset (default 0)
9076
+ * @type {number}
9077
+ * @memberof GetFeatureUsageByUserParams
9078
+ */
9079
+ offset?: number;
9080
+ }
9081
+
9082
+ /**
9083
+ *
9084
+ * @export
9085
+ * @interface GetFeatureUsageByUserResponse
9086
+ */
9087
+ declare interface GetFeatureUsageByUserResponse {
9088
+ /**
9089
+ *
9090
+ * @type {FeatureUserUsageResponseData}
9091
+ * @memberof GetFeatureUsageByUserResponse
9092
+ */
9093
+ data: FeatureUserUsageResponseData;
9094
+ /**
9095
+ *
9096
+ * @type {GetFeatureUsageByUserParams}
9097
+ * @memberof GetFeatureUsageByUserResponse
9098
+ */
9099
+ params: GetFeatureUsageByUserParams;
9100
+ }
9101
+
8891
9102
  /**
8892
9103
  *
8893
9104
  * @export
@@ -8965,6 +9176,8 @@ export declare const initialContext: {
8965
9176
  getUpcomingInvoice: () => never;
8966
9177
  getCustomerBalance: () => never;
8967
9178
  listInvoices: () => never;
9179
+ getCreditUsageByUser: () => never;
9180
+ getFeatureUsageByUser: () => never;
8968
9181
  createSetupIntent: () => never;
8969
9182
  updatePaymentMethod: () => never;
8970
9183
  deletePaymentMethod: () => never;
@@ -13876,10 +14089,153 @@ declare interface UsePaymentConfirmationReturn {
13876
14089
  reset: () => void;
13877
14090
  }
13878
14091
 
14092
+ /**
14093
+ *
14094
+ * @export
14095
+ * @interface UserCreditUsageResponseData
14096
+ */
14097
+ declare interface UserCreditUsageResponseData {
14098
+ /**
14099
+ *
14100
+ * @type {string}
14101
+ * @memberof UserCreditUsageResponseData
14102
+ */
14103
+ billingCreditId: string;
14104
+ /**
14105
+ * The display name of the credit type
14106
+ * @type {string}
14107
+ * @memberof UserCreditUsageResponseData
14108
+ */
14109
+ creditName: string;
14110
+ /**
14111
+ * The user's net track-driven consumption of the credit within the window (draws minus refunds)
14112
+ * @type {number}
14113
+ * @memberof UserCreditUsageResponseData
14114
+ */
14115
+ creditsUsed: number;
14116
+ /**
14117
+ * This row's fraction (0-1) of the company's total track-driven consumption of the credit within the window, including unattributed consumption
14118
+ * @type {number}
14119
+ * @memberof UserCreditUsageResponseData
14120
+ */
14121
+ share: number;
14122
+ /**
14123
+ * The user the consumption is attributed to; null for consumption from events sent without a user
14124
+ * @type {UserResponseData}
14125
+ * @memberof UserCreditUsageResponseData
14126
+ */
14127
+ user?: UserResponseData;
14128
+ /**
14129
+ * The user the consumption is attributed to; null for unattributed consumption
14130
+ * @type {string}
14131
+ * @memberof UserCreditUsageResponseData
14132
+ */
14133
+ userId?: string | null;
14134
+ }
14135
+
13879
14136
  export declare function useRequest<TData>(fn: () => Promise<{
13880
14137
  data: TData;
13881
14138
  }> | undefined): [RequestState<TData>, () => Promise<void>];
13882
14139
 
14140
+ /**
14141
+ *
14142
+ * @export
14143
+ * @interface UserFeatureUsageResponseData
14144
+ */
14145
+ declare interface UserFeatureUsageResponseData {
14146
+ /**
14147
+ *
14148
+ * @type {FeatureResponseData}
14149
+ * @memberof UserFeatureUsageResponseData
14150
+ */
14151
+ feature?: FeatureResponseData;
14152
+ /**
14153
+ * When the user last used the feature within the window
14154
+ * @type {Date}
14155
+ * @memberof UserFeatureUsageResponseData
14156
+ */
14157
+ lastSeen: Date;
14158
+ /**
14159
+ * This row's fraction (0-1) of the company's total usage of the feature within the window, including unattributed usage
14160
+ * @type {number}
14161
+ * @memberof UserFeatureUsageResponseData
14162
+ */
14163
+ share: number;
14164
+ /**
14165
+ * The user the usage is attributed to; null for usage from events sent without a user
14166
+ * @type {UserResponseData}
14167
+ * @memberof UserFeatureUsageResponseData
14168
+ */
14169
+ user?: UserResponseData;
14170
+ /**
14171
+ * The user the usage is attributed to; null for unattributed usage
14172
+ * @type {string}
14173
+ * @memberof UserFeatureUsageResponseData
14174
+ */
14175
+ userId?: string | null;
14176
+ /**
14177
+ * The user's usage of the feature within the window
14178
+ * @type {number}
14179
+ * @memberof UserFeatureUsageResponseData
14180
+ */
14181
+ value: number;
14182
+ }
14183
+
14184
+ /**
14185
+ * Schematic API
14186
+ * Schematic API
14187
+ *
14188
+ * The version of the OpenAPI document: 0.1
14189
+ *
14190
+ *
14191
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
14192
+ * https://openapi-generator.tech
14193
+ * Do not edit the class manually.
14194
+ */
14195
+ /**
14196
+ *
14197
+ * @export
14198
+ * @interface UserResponseData
14199
+ */
14200
+ declare interface UserResponseData {
14201
+ /**
14202
+ *
14203
+ * @type {Date}
14204
+ * @memberof UserResponseData
14205
+ */
14206
+ createdAt: Date;
14207
+ /**
14208
+ *
14209
+ * @type {string}
14210
+ * @memberof UserResponseData
14211
+ */
14212
+ environmentId: string;
14213
+ /**
14214
+ *
14215
+ * @type {string}
14216
+ * @memberof UserResponseData
14217
+ */
14218
+ id: string;
14219
+ /**
14220
+ *
14221
+ * @type {Date}
14222
+ * @memberof UserResponseData
14223
+ */
14224
+ lastSeenAt?: Date | null;
14225
+ /**
14226
+ *
14227
+ * @type {string}
14228
+ * @memberof UserResponseData
14229
+ */
14230
+ name: string;
14231
+ /**
14232
+ *
14233
+ * @type {Date}
14234
+ * @memberof UserResponseData
14235
+ */
14236
+ updatedAt: Date;
14237
+ }
14238
+
13883
14239
  /**
13884
14240
  * Returns the currency of the company's active subscription, if any.
13885
14241
  * Stripe does not allow mixing currencies on a subscription, so when