@openmeter/sdk 1.0.0-beta.216 → 1.0.0-beta.218

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.
@@ -8334,6 +8334,568 @@ export declare const deleteCustomerAppDataParams: zod.ZodObject<{
8334
8334
  customerIdOrKey: string;
8335
8335
  appId: string;
8336
8336
  }>;
8337
+ /**
8338
+ * OpenMeter has three types of entitlements: metered, boolean, and static. The type property determines the type of entitlement. The underlying feature has to be compatible with the entitlement type specified in the request (e.g., a metered entitlement needs a feature associated with a meter).
8339
+
8340
+ - Boolean entitlements define static feature access, e.g. "Can use SSO authentication".
8341
+ - Static entitlements let you pass along a configuration while granting access, e.g. "Using this feature with X Y settings" (passed in the config).
8342
+ - Metered entitlements have many use cases, from setting up usage-based access to implementing complex credit systems. Example: The customer can use 10000 AI tokens during the usage period of the entitlement.
8343
+
8344
+ A given customer can only have one active (non-deleted) entitlement per featureKey. If you try to create a new entitlement for a featureKey that already has an active entitlement, the request will fail with a 409 error.
8345
+
8346
+ Once an entitlement is created you cannot modify it, only delete it.
8347
+ * @summary Create a customer entitlement
8348
+ */
8349
+ export declare const createCustomerEntitlementPathCustomerIdOrKeyRegExpOne: RegExp;
8350
+ export declare const createCustomerEntitlementPathCustomerIdOrKeyMaxTwo = 256;
8351
+ export declare const createCustomerEntitlementParams: zod.ZodObject<{
8352
+ customerIdOrKey: zod.ZodUnion<[zod.ZodString, zod.ZodString]>;
8353
+ }, "strip", zod.ZodTypeAny, {
8354
+ customerIdOrKey: string;
8355
+ }, {
8356
+ customerIdOrKey: string;
8357
+ }>;
8358
+ export declare const createCustomerEntitlementBodyFeatureKeyMax = 64;
8359
+ export declare const createCustomerEntitlementBodyFeatureKeyRegExp: RegExp;
8360
+ export declare const createCustomerEntitlementBodyFeatureIdRegExp: RegExp;
8361
+ export declare const createCustomerEntitlementBodyIsSoftLimitDefault = false;
8362
+ export declare const createCustomerEntitlementBodyIsUnlimitedDefault = false;
8363
+ export declare const createCustomerEntitlementBodyIssueAfterResetMin = 0;
8364
+ export declare const createCustomerEntitlementBodyIssueAfterResetPriorityDefault = 1;
8365
+ export declare const createCustomerEntitlementBodyIssueAfterResetPriorityMax = 255;
8366
+ export declare const createCustomerEntitlementBodyPreserveOverageAtResetDefault = false;
8367
+ export declare const createCustomerEntitlementBodyFeatureKeyMaxOne = 64;
8368
+ export declare const createCustomerEntitlementBodyFeatureKeyRegExpOne: RegExp;
8369
+ export declare const createCustomerEntitlementBodyFeatureIdRegExpOne: RegExp;
8370
+ export declare const createCustomerEntitlementBodyFeatureKeyMaxTwo = 64;
8371
+ export declare const createCustomerEntitlementBodyFeatureKeyRegExpTwo: RegExp;
8372
+ export declare const createCustomerEntitlementBodyFeatureIdRegExpTwo: RegExp;
8373
+ export declare const createCustomerEntitlementBody: zod.ZodDiscriminatedUnion<"type", [zod.ZodObject<{
8374
+ featureId: zod.ZodOptional<zod.ZodString>;
8375
+ featureKey: zod.ZodOptional<zod.ZodString>;
8376
+ isSoftLimit: zod.ZodOptional<zod.ZodBoolean>;
8377
+ issueAfterReset: zod.ZodOptional<zod.ZodNumber>;
8378
+ issueAfterResetPriority: zod.ZodDefault<zod.ZodNumber>;
8379
+ isUnlimited: zod.ZodOptional<zod.ZodBoolean>;
8380
+ measureUsageFrom: zod.ZodOptional<zod.ZodUnion<[zod.ZodEnum<["CURRENT_PERIOD_START", "NOW"]>, zod.ZodDate]>>;
8381
+ metadata: zod.ZodOptional<zod.ZodRecord<zod.ZodString, zod.ZodString>>;
8382
+ preserveOverageAtReset: zod.ZodOptional<zod.ZodBoolean>;
8383
+ type: zod.ZodEnum<["metered"]>;
8384
+ usagePeriod: zod.ZodObject<{
8385
+ anchor: zod.ZodOptional<zod.ZodDate>;
8386
+ interval: zod.ZodUnion<[zod.ZodString, zod.ZodEnum<["DAY", "WEEK", "MONTH", "YEAR"]>]>;
8387
+ }, "strip", zod.ZodTypeAny, {
8388
+ interval: string;
8389
+ anchor?: Date | undefined;
8390
+ }, {
8391
+ interval: string;
8392
+ anchor?: Date | undefined;
8393
+ }>;
8394
+ }, "strip", zod.ZodTypeAny, {
8395
+ type: "metered";
8396
+ usagePeriod: {
8397
+ interval: string;
8398
+ anchor?: Date | undefined;
8399
+ };
8400
+ issueAfterResetPriority: number;
8401
+ featureKey?: string | undefined;
8402
+ featureId?: string | undefined;
8403
+ metadata?: Record<string, string> | undefined;
8404
+ isSoftLimit?: boolean | undefined;
8405
+ issueAfterReset?: number | undefined;
8406
+ preserveOverageAtReset?: boolean | undefined;
8407
+ isUnlimited?: boolean | undefined;
8408
+ measureUsageFrom?: Date | "CURRENT_PERIOD_START" | "NOW" | undefined;
8409
+ }, {
8410
+ type: "metered";
8411
+ usagePeriod: {
8412
+ interval: string;
8413
+ anchor?: Date | undefined;
8414
+ };
8415
+ featureKey?: string | undefined;
8416
+ featureId?: string | undefined;
8417
+ metadata?: Record<string, string> | undefined;
8418
+ isSoftLimit?: boolean | undefined;
8419
+ issueAfterReset?: number | undefined;
8420
+ issueAfterResetPriority?: number | undefined;
8421
+ preserveOverageAtReset?: boolean | undefined;
8422
+ isUnlimited?: boolean | undefined;
8423
+ measureUsageFrom?: Date | "CURRENT_PERIOD_START" | "NOW" | undefined;
8424
+ }>, zod.ZodObject<{
8425
+ config: zod.ZodString;
8426
+ featureId: zod.ZodOptional<zod.ZodString>;
8427
+ featureKey: zod.ZodOptional<zod.ZodString>;
8428
+ metadata: zod.ZodOptional<zod.ZodRecord<zod.ZodString, zod.ZodString>>;
8429
+ type: zod.ZodEnum<["static"]>;
8430
+ usagePeriod: zod.ZodOptional<zod.ZodObject<{
8431
+ anchor: zod.ZodOptional<zod.ZodDate>;
8432
+ interval: zod.ZodUnion<[zod.ZodString, zod.ZodEnum<["DAY", "WEEK", "MONTH", "YEAR"]>]>;
8433
+ }, "strip", zod.ZodTypeAny, {
8434
+ interval: string;
8435
+ anchor?: Date | undefined;
8436
+ }, {
8437
+ interval: string;
8438
+ anchor?: Date | undefined;
8439
+ }>>;
8440
+ }, "strip", zod.ZodTypeAny, {
8441
+ type: "static";
8442
+ config: string;
8443
+ featureKey?: string | undefined;
8444
+ featureId?: string | undefined;
8445
+ metadata?: Record<string, string> | undefined;
8446
+ usagePeriod?: {
8447
+ interval: string;
8448
+ anchor?: Date | undefined;
8449
+ } | undefined;
8450
+ }, {
8451
+ type: "static";
8452
+ config: string;
8453
+ featureKey?: string | undefined;
8454
+ featureId?: string | undefined;
8455
+ metadata?: Record<string, string> | undefined;
8456
+ usagePeriod?: {
8457
+ interval: string;
8458
+ anchor?: Date | undefined;
8459
+ } | undefined;
8460
+ }>, zod.ZodObject<{
8461
+ featureId: zod.ZodOptional<zod.ZodString>;
8462
+ featureKey: zod.ZodOptional<zod.ZodString>;
8463
+ metadata: zod.ZodOptional<zod.ZodRecord<zod.ZodString, zod.ZodString>>;
8464
+ type: zod.ZodEnum<["boolean"]>;
8465
+ usagePeriod: zod.ZodOptional<zod.ZodObject<{
8466
+ anchor: zod.ZodOptional<zod.ZodDate>;
8467
+ interval: zod.ZodUnion<[zod.ZodString, zod.ZodEnum<["DAY", "WEEK", "MONTH", "YEAR"]>]>;
8468
+ }, "strip", zod.ZodTypeAny, {
8469
+ interval: string;
8470
+ anchor?: Date | undefined;
8471
+ }, {
8472
+ interval: string;
8473
+ anchor?: Date | undefined;
8474
+ }>>;
8475
+ }, "strip", zod.ZodTypeAny, {
8476
+ type: "boolean";
8477
+ featureKey?: string | undefined;
8478
+ featureId?: string | undefined;
8479
+ metadata?: Record<string, string> | undefined;
8480
+ usagePeriod?: {
8481
+ interval: string;
8482
+ anchor?: Date | undefined;
8483
+ } | undefined;
8484
+ }, {
8485
+ type: "boolean";
8486
+ featureKey?: string | undefined;
8487
+ featureId?: string | undefined;
8488
+ metadata?: Record<string, string> | undefined;
8489
+ usagePeriod?: {
8490
+ interval: string;
8491
+ anchor?: Date | undefined;
8492
+ } | undefined;
8493
+ }>]>;
8494
+ /**
8495
+ * List all entitlements for a customer. For checking entitlement access, use the /value endpoint instead.
8496
+ * @summary List customer entitlements
8497
+ */
8498
+ export declare const listCustomerEntitlementsPathCustomerIdOrKeyRegExpOne: RegExp;
8499
+ export declare const listCustomerEntitlementsPathCustomerIdOrKeyMaxTwo = 256;
8500
+ export declare const listCustomerEntitlementsParams: zod.ZodObject<{
8501
+ customerIdOrKey: zod.ZodUnion<[zod.ZodString, zod.ZodString]>;
8502
+ }, "strip", zod.ZodTypeAny, {
8503
+ customerIdOrKey: string;
8504
+ }, {
8505
+ customerIdOrKey: string;
8506
+ }>;
8507
+ export declare const listCustomerEntitlementsQueryIncludeDeletedDefault = false;
8508
+ export declare const listCustomerEntitlementsQueryParams: zod.ZodObject<{
8509
+ includeDeleted: zod.ZodOptional<zod.ZodBoolean>;
8510
+ }, "strip", zod.ZodTypeAny, {
8511
+ includeDeleted?: boolean | undefined;
8512
+ }, {
8513
+ includeDeleted?: boolean | undefined;
8514
+ }>;
8515
+ /**
8516
+ * Get entitlement by feature key. For checking entitlement access, use the /value endpoint instead.
8517
+ * @summary Get customer entitlement
8518
+ */
8519
+ export declare const getCustomerEntitlementPathCustomerIdOrKeyRegExpOne: RegExp;
8520
+ export declare const getCustomerEntitlementPathCustomerIdOrKeyMaxTwo = 256;
8521
+ export declare const getCustomerEntitlementPathFeatureKeyMax = 64;
8522
+ export declare const getCustomerEntitlementPathFeatureKeyRegExp: RegExp;
8523
+ export declare const getCustomerEntitlementParams: zod.ZodObject<{
8524
+ customerIdOrKey: zod.ZodUnion<[zod.ZodString, zod.ZodString]>;
8525
+ featureKey: zod.ZodString;
8526
+ }, "strip", zod.ZodTypeAny, {
8527
+ featureKey: string;
8528
+ customerIdOrKey: string;
8529
+ }, {
8530
+ featureKey: string;
8531
+ customerIdOrKey: string;
8532
+ }>;
8533
+ /**
8534
+ * Deleting an entitlement revokes access to the associated feature. As a single customer can only have one entitlement per featureKey, when "migrating" features you have to delete the old entitlements as well.
8535
+ As access and status checks can be historical queries, deleting an entitlement populates the deletedAt timestamp. When queried for a time before that, the entitlement is still considered active, you cannot have retroactive changes to access, which is important for, among other things, auditing.
8536
+ * @summary Delete customer entitlement
8537
+ */
8538
+ export declare const deleteCustomerEntitlementPathCustomerIdOrKeyRegExpOne: RegExp;
8539
+ export declare const deleteCustomerEntitlementPathCustomerIdOrKeyMaxTwo = 256;
8540
+ export declare const deleteCustomerEntitlementPathFeatureKeyMax = 64;
8541
+ export declare const deleteCustomerEntitlementPathFeatureKeyRegExp: RegExp;
8542
+ export declare const deleteCustomerEntitlementParams: zod.ZodObject<{
8543
+ customerIdOrKey: zod.ZodUnion<[zod.ZodString, zod.ZodString]>;
8544
+ featureKey: zod.ZodString;
8545
+ }, "strip", zod.ZodTypeAny, {
8546
+ featureKey: string;
8547
+ customerIdOrKey: string;
8548
+ }, {
8549
+ featureKey: string;
8550
+ customerIdOrKey: string;
8551
+ }>;
8552
+ /**
8553
+ * List all grants issued for an entitlement. The entitlement can be defined either by its id or featureKey.
8554
+ * @summary List customer entitlement grants
8555
+ */
8556
+ export declare const listCustomerEntitlementGrantsPathCustomerIdOrKeyRegExpOne: RegExp;
8557
+ export declare const listCustomerEntitlementGrantsPathCustomerIdOrKeyMaxTwo = 256;
8558
+ export declare const listCustomerEntitlementGrantsPathFeatureKeyMax = 64;
8559
+ export declare const listCustomerEntitlementGrantsPathFeatureKeyRegExp: RegExp;
8560
+ export declare const listCustomerEntitlementGrantsParams: zod.ZodObject<{
8561
+ customerIdOrKey: zod.ZodUnion<[zod.ZodString, zod.ZodString]>;
8562
+ featureKey: zod.ZodString;
8563
+ }, "strip", zod.ZodTypeAny, {
8564
+ featureKey: string;
8565
+ customerIdOrKey: string;
8566
+ }, {
8567
+ featureKey: string;
8568
+ customerIdOrKey: string;
8569
+ }>;
8570
+ export declare const listCustomerEntitlementGrantsQueryIncludeDeletedDefault = false;
8571
+ export declare const listCustomerEntitlementGrantsQueryParams: zod.ZodObject<{
8572
+ includeDeleted: zod.ZodOptional<zod.ZodBoolean>;
8573
+ orderBy: zod.ZodOptional<zod.ZodEnum<["id", "createdAt", "updatedAt"]>>;
8574
+ }, "strip", zod.ZodTypeAny, {
8575
+ orderBy?: "id" | "createdAt" | "updatedAt" | undefined;
8576
+ includeDeleted?: boolean | undefined;
8577
+ }, {
8578
+ orderBy?: "id" | "createdAt" | "updatedAt" | undefined;
8579
+ includeDeleted?: boolean | undefined;
8580
+ }>;
8581
+ /**
8582
+ * Grants define a behavior of granting usage for a metered entitlement. They can have complicated recurrence and rollover rules, thanks to which you can define a wide range of access patterns with a single grant, in most cases you don't have to periodically create new grants. You can only issue grants for active metered entitlements.
8583
+
8584
+ A grant defines a given amount of usage that can be consumed for the entitlement. The grant is in effect between its effective date and its expiration date. Specifying both is mandatory for new grants.
8585
+
8586
+ Grants have a priority setting that determines their order of use. Lower numbers have higher priority, with 0 being the highest priority.
8587
+
8588
+ Grants can have a recurrence setting intended to automate the manual reissuing of grants. For example, a daily recurrence is equal to reissuing that same grant every day (ignoring rollover settings).
8589
+
8590
+ Rollover settings define what happens to the remaining balance of a grant at a reset. Balance_After_Reset = MIN(MaxRolloverAmount, MAX(Balance_Before_Reset, MinRolloverAmount))
8591
+
8592
+ Grants cannot be changed once created, only deleted. This is to ensure that balance is deterministic regardless of when it is queried.
8593
+ * @summary Create customer entitlement grant
8594
+ */
8595
+ export declare const createCustomerEntitlementGrantPathCustomerIdOrKeyRegExpOne: RegExp;
8596
+ export declare const createCustomerEntitlementGrantPathCustomerIdOrKeyMaxTwo = 256;
8597
+ export declare const createCustomerEntitlementGrantPathFeatureKeyMax = 64;
8598
+ export declare const createCustomerEntitlementGrantPathFeatureKeyRegExp: RegExp;
8599
+ export declare const createCustomerEntitlementGrantParams: zod.ZodObject<{
8600
+ customerIdOrKey: zod.ZodUnion<[zod.ZodString, zod.ZodString]>;
8601
+ featureKey: zod.ZodString;
8602
+ }, "strip", zod.ZodTypeAny, {
8603
+ featureKey: string;
8604
+ customerIdOrKey: string;
8605
+ }, {
8606
+ featureKey: string;
8607
+ customerIdOrKey: string;
8608
+ }>;
8609
+ export declare const createCustomerEntitlementGrantBodyAmountMin = 0;
8610
+ export declare const createCustomerEntitlementGrantBodyPriorityMax = 255;
8611
+ export declare const createCustomerEntitlementGrantBodyMaxRolloverAmountDefault = 0;
8612
+ export declare const createCustomerEntitlementGrantBodyMinRolloverAmountDefault = 0;
8613
+ export declare const createCustomerEntitlementGrantBody: zod.ZodObject<{
8614
+ amount: zod.ZodNumber;
8615
+ effectiveAt: zod.ZodDate;
8616
+ expiration: zod.ZodObject<{
8617
+ count: zod.ZodNumber;
8618
+ duration: zod.ZodEnum<["HOUR", "DAY", "WEEK", "MONTH", "YEAR"]>;
8619
+ }, "strip", zod.ZodTypeAny, {
8620
+ duration: "HOUR" | "DAY" | "WEEK" | "MONTH" | "YEAR";
8621
+ count: number;
8622
+ }, {
8623
+ duration: "HOUR" | "DAY" | "WEEK" | "MONTH" | "YEAR";
8624
+ count: number;
8625
+ }>;
8626
+ maxRolloverAmount: zod.ZodOptional<zod.ZodNumber>;
8627
+ metadata: zod.ZodOptional<zod.ZodRecord<zod.ZodString, zod.ZodString>>;
8628
+ minRolloverAmount: zod.ZodOptional<zod.ZodNumber>;
8629
+ priority: zod.ZodOptional<zod.ZodNumber>;
8630
+ recurrence: zod.ZodOptional<zod.ZodObject<{
8631
+ anchor: zod.ZodOptional<zod.ZodDate>;
8632
+ interval: zod.ZodUnion<[zod.ZodString, zod.ZodEnum<["DAY", "WEEK", "MONTH", "YEAR"]>]>;
8633
+ }, "strip", zod.ZodTypeAny, {
8634
+ interval: string;
8635
+ anchor?: Date | undefined;
8636
+ }, {
8637
+ interval: string;
8638
+ anchor?: Date | undefined;
8639
+ }>>;
8640
+ }, "strip", zod.ZodTypeAny, {
8641
+ amount: number;
8642
+ effectiveAt: Date;
8643
+ expiration: {
8644
+ duration: "HOUR" | "DAY" | "WEEK" | "MONTH" | "YEAR";
8645
+ count: number;
8646
+ };
8647
+ metadata?: Record<string, string> | undefined;
8648
+ maxRolloverAmount?: number | undefined;
8649
+ minRolloverAmount?: number | undefined;
8650
+ priority?: number | undefined;
8651
+ recurrence?: {
8652
+ interval: string;
8653
+ anchor?: Date | undefined;
8654
+ } | undefined;
8655
+ }, {
8656
+ amount: number;
8657
+ effectiveAt: Date;
8658
+ expiration: {
8659
+ duration: "HOUR" | "DAY" | "WEEK" | "MONTH" | "YEAR";
8660
+ count: number;
8661
+ };
8662
+ metadata?: Record<string, string> | undefined;
8663
+ maxRolloverAmount?: number | undefined;
8664
+ minRolloverAmount?: number | undefined;
8665
+ priority?: number | undefined;
8666
+ recurrence?: {
8667
+ interval: string;
8668
+ anchor?: Date | undefined;
8669
+ } | undefined;
8670
+ }>;
8671
+ /**
8672
+ * Returns historical balance and usage data for the entitlement. The queried history can span accross multiple reset events.
8673
+
8674
+ BurndownHistory returns a continous history of segments, where the segments are seperated by events that changed either the grant burndown priority or the usage period.
8675
+
8676
+ WindowedHistory returns windowed usage data for the period enriched with balance information and the list of grants that were being burnt down in that window.
8677
+ * @summary Get customer entitlement history
8678
+ */
8679
+ export declare const getCustomerEntitlementHistoryPathCustomerIdOrKeyRegExpOne: RegExp;
8680
+ export declare const getCustomerEntitlementHistoryPathCustomerIdOrKeyMaxTwo = 256;
8681
+ export declare const getCustomerEntitlementHistoryPathFeatureKeyMax = 64;
8682
+ export declare const getCustomerEntitlementHistoryPathFeatureKeyRegExp: RegExp;
8683
+ export declare const getCustomerEntitlementHistoryParams: zod.ZodObject<{
8684
+ customerIdOrKey: zod.ZodUnion<[zod.ZodString, zod.ZodString]>;
8685
+ featureKey: zod.ZodString;
8686
+ }, "strip", zod.ZodTypeAny, {
8687
+ featureKey: string;
8688
+ customerIdOrKey: string;
8689
+ }, {
8690
+ featureKey: string;
8691
+ customerIdOrKey: string;
8692
+ }>;
8693
+ export declare const getCustomerEntitlementHistoryQueryWindowTimeZoneDefault = "UTC";
8694
+ export declare const getCustomerEntitlementHistoryQueryParams: zod.ZodObject<{
8695
+ from: zod.ZodOptional<zod.ZodDate>;
8696
+ to: zod.ZodOptional<zod.ZodDate>;
8697
+ windowSize: zod.ZodEnum<["MINUTE", "HOUR", "DAY", "MONTH"]>;
8698
+ windowTimeZone: zod.ZodDefault<zod.ZodString>;
8699
+ }, "strip", zod.ZodTypeAny, {
8700
+ windowSize: "HOUR" | "DAY" | "MONTH" | "MINUTE";
8701
+ windowTimeZone: string;
8702
+ from?: Date | undefined;
8703
+ to?: Date | undefined;
8704
+ }, {
8705
+ windowSize: "HOUR" | "DAY" | "MONTH" | "MINUTE";
8706
+ from?: Date | undefined;
8707
+ to?: Date | undefined;
8708
+ windowTimeZone?: string | undefined;
8709
+ }>;
8710
+ /**
8711
+ * Overriding an entitlement creates a new entitlement from the provided inputs and soft deletes the previous entitlement for the provided customer-feature pair. If the previous entitlement is already deleted or otherwise doesnt exist, the override will fail.
8712
+
8713
+ This endpoint is useful for upgrades, downgrades, or other changes to entitlements that require a new entitlement to be created with zero downtime.
8714
+ * @summary Override customer entitlement
8715
+ */
8716
+ export declare const overrideCustomerEntitlementPathCustomerIdOrKeyRegExpOne: RegExp;
8717
+ export declare const overrideCustomerEntitlementPathCustomerIdOrKeyMaxTwo = 256;
8718
+ export declare const overrideCustomerEntitlementPathFeatureKeyMax = 64;
8719
+ export declare const overrideCustomerEntitlementPathFeatureKeyRegExp: RegExp;
8720
+ export declare const overrideCustomerEntitlementParams: zod.ZodObject<{
8721
+ customerIdOrKey: zod.ZodUnion<[zod.ZodString, zod.ZodString]>;
8722
+ featureKey: zod.ZodString;
8723
+ }, "strip", zod.ZodTypeAny, {
8724
+ featureKey: string;
8725
+ customerIdOrKey: string;
8726
+ }, {
8727
+ featureKey: string;
8728
+ customerIdOrKey: string;
8729
+ }>;
8730
+ export declare const overrideCustomerEntitlementBodyFeatureKeyMax = 64;
8731
+ export declare const overrideCustomerEntitlementBodyFeatureKeyRegExp: RegExp;
8732
+ export declare const overrideCustomerEntitlementBodyFeatureIdRegExp: RegExp;
8733
+ export declare const overrideCustomerEntitlementBodyIsSoftLimitDefault = false;
8734
+ export declare const overrideCustomerEntitlementBodyIsUnlimitedDefault = false;
8735
+ export declare const overrideCustomerEntitlementBodyIssueAfterResetMin = 0;
8736
+ export declare const overrideCustomerEntitlementBodyIssueAfterResetPriorityDefault = 1;
8737
+ export declare const overrideCustomerEntitlementBodyIssueAfterResetPriorityMax = 255;
8738
+ export declare const overrideCustomerEntitlementBodyPreserveOverageAtResetDefault = false;
8739
+ export declare const overrideCustomerEntitlementBodyFeatureKeyMaxOne = 64;
8740
+ export declare const overrideCustomerEntitlementBodyFeatureKeyRegExpOne: RegExp;
8741
+ export declare const overrideCustomerEntitlementBodyFeatureIdRegExpOne: RegExp;
8742
+ export declare const overrideCustomerEntitlementBodyFeatureKeyMaxTwo = 64;
8743
+ export declare const overrideCustomerEntitlementBodyFeatureKeyRegExpTwo: RegExp;
8744
+ export declare const overrideCustomerEntitlementBodyFeatureIdRegExpTwo: RegExp;
8745
+ export declare const overrideCustomerEntitlementBody: zod.ZodDiscriminatedUnion<"type", [zod.ZodObject<{
8746
+ featureId: zod.ZodOptional<zod.ZodString>;
8747
+ featureKey: zod.ZodOptional<zod.ZodString>;
8748
+ isSoftLimit: zod.ZodOptional<zod.ZodBoolean>;
8749
+ issueAfterReset: zod.ZodOptional<zod.ZodNumber>;
8750
+ issueAfterResetPriority: zod.ZodDefault<zod.ZodNumber>;
8751
+ isUnlimited: zod.ZodOptional<zod.ZodBoolean>;
8752
+ measureUsageFrom: zod.ZodOptional<zod.ZodUnion<[zod.ZodEnum<["CURRENT_PERIOD_START", "NOW"]>, zod.ZodDate]>>;
8753
+ metadata: zod.ZodOptional<zod.ZodRecord<zod.ZodString, zod.ZodString>>;
8754
+ preserveOverageAtReset: zod.ZodOptional<zod.ZodBoolean>;
8755
+ type: zod.ZodEnum<["metered"]>;
8756
+ usagePeriod: zod.ZodObject<{
8757
+ anchor: zod.ZodOptional<zod.ZodDate>;
8758
+ interval: zod.ZodUnion<[zod.ZodString, zod.ZodEnum<["DAY", "WEEK", "MONTH", "YEAR"]>]>;
8759
+ }, "strip", zod.ZodTypeAny, {
8760
+ interval: string;
8761
+ anchor?: Date | undefined;
8762
+ }, {
8763
+ interval: string;
8764
+ anchor?: Date | undefined;
8765
+ }>;
8766
+ }, "strip", zod.ZodTypeAny, {
8767
+ type: "metered";
8768
+ usagePeriod: {
8769
+ interval: string;
8770
+ anchor?: Date | undefined;
8771
+ };
8772
+ issueAfterResetPriority: number;
8773
+ featureKey?: string | undefined;
8774
+ featureId?: string | undefined;
8775
+ metadata?: Record<string, string> | undefined;
8776
+ isSoftLimit?: boolean | undefined;
8777
+ issueAfterReset?: number | undefined;
8778
+ preserveOverageAtReset?: boolean | undefined;
8779
+ isUnlimited?: boolean | undefined;
8780
+ measureUsageFrom?: Date | "CURRENT_PERIOD_START" | "NOW" | undefined;
8781
+ }, {
8782
+ type: "metered";
8783
+ usagePeriod: {
8784
+ interval: string;
8785
+ anchor?: Date | undefined;
8786
+ };
8787
+ featureKey?: string | undefined;
8788
+ featureId?: string | undefined;
8789
+ metadata?: Record<string, string> | undefined;
8790
+ isSoftLimit?: boolean | undefined;
8791
+ issueAfterReset?: number | undefined;
8792
+ issueAfterResetPriority?: number | undefined;
8793
+ preserveOverageAtReset?: boolean | undefined;
8794
+ isUnlimited?: boolean | undefined;
8795
+ measureUsageFrom?: Date | "CURRENT_PERIOD_START" | "NOW" | undefined;
8796
+ }>, zod.ZodObject<{
8797
+ config: zod.ZodString;
8798
+ featureId: zod.ZodOptional<zod.ZodString>;
8799
+ featureKey: zod.ZodOptional<zod.ZodString>;
8800
+ metadata: zod.ZodOptional<zod.ZodRecord<zod.ZodString, zod.ZodString>>;
8801
+ type: zod.ZodEnum<["static"]>;
8802
+ usagePeriod: zod.ZodOptional<zod.ZodObject<{
8803
+ anchor: zod.ZodOptional<zod.ZodDate>;
8804
+ interval: zod.ZodUnion<[zod.ZodString, zod.ZodEnum<["DAY", "WEEK", "MONTH", "YEAR"]>]>;
8805
+ }, "strip", zod.ZodTypeAny, {
8806
+ interval: string;
8807
+ anchor?: Date | undefined;
8808
+ }, {
8809
+ interval: string;
8810
+ anchor?: Date | undefined;
8811
+ }>>;
8812
+ }, "strip", zod.ZodTypeAny, {
8813
+ type: "static";
8814
+ config: string;
8815
+ featureKey?: string | undefined;
8816
+ featureId?: string | undefined;
8817
+ metadata?: Record<string, string> | undefined;
8818
+ usagePeriod?: {
8819
+ interval: string;
8820
+ anchor?: Date | undefined;
8821
+ } | undefined;
8822
+ }, {
8823
+ type: "static";
8824
+ config: string;
8825
+ featureKey?: string | undefined;
8826
+ featureId?: string | undefined;
8827
+ metadata?: Record<string, string> | undefined;
8828
+ usagePeriod?: {
8829
+ interval: string;
8830
+ anchor?: Date | undefined;
8831
+ } | undefined;
8832
+ }>, zod.ZodObject<{
8833
+ featureId: zod.ZodOptional<zod.ZodString>;
8834
+ featureKey: zod.ZodOptional<zod.ZodString>;
8835
+ metadata: zod.ZodOptional<zod.ZodRecord<zod.ZodString, zod.ZodString>>;
8836
+ type: zod.ZodEnum<["boolean"]>;
8837
+ usagePeriod: zod.ZodOptional<zod.ZodObject<{
8838
+ anchor: zod.ZodOptional<zod.ZodDate>;
8839
+ interval: zod.ZodUnion<[zod.ZodString, zod.ZodEnum<["DAY", "WEEK", "MONTH", "YEAR"]>]>;
8840
+ }, "strip", zod.ZodTypeAny, {
8841
+ interval: string;
8842
+ anchor?: Date | undefined;
8843
+ }, {
8844
+ interval: string;
8845
+ anchor?: Date | undefined;
8846
+ }>>;
8847
+ }, "strip", zod.ZodTypeAny, {
8848
+ type: "boolean";
8849
+ featureKey?: string | undefined;
8850
+ featureId?: string | undefined;
8851
+ metadata?: Record<string, string> | undefined;
8852
+ usagePeriod?: {
8853
+ interval: string;
8854
+ anchor?: Date | undefined;
8855
+ } | undefined;
8856
+ }, {
8857
+ type: "boolean";
8858
+ featureKey?: string | undefined;
8859
+ featureId?: string | undefined;
8860
+ metadata?: Record<string, string> | undefined;
8861
+ usagePeriod?: {
8862
+ interval: string;
8863
+ anchor?: Date | undefined;
8864
+ } | undefined;
8865
+ }>]>;
8866
+ /**
8867
+ * Reset marks the start of a new usage period for the entitlement and initiates grant rollover. At the start of a period usage is zerod out and grants are rolled over based on their rollover settings. It would typically be synced with the customers billing period to enforce usage based on their subscription.
8868
+
8869
+ Usage is automatically reset for metered entitlements based on their usage period, but this endpoint allows to manually reset it at any time. When doing so the period anchor of the entitlement can be changed if needed.
8870
+ * @summary Reset customer entitlement
8871
+ */
8872
+ export declare const resetCustomerEntitlementUsagePathCustomerIdOrKeyRegExpOne: RegExp;
8873
+ export declare const resetCustomerEntitlementUsagePathCustomerIdOrKeyMaxTwo = 256;
8874
+ export declare const resetCustomerEntitlementUsagePathFeatureKeyMax = 64;
8875
+ export declare const resetCustomerEntitlementUsagePathFeatureKeyRegExp: RegExp;
8876
+ export declare const resetCustomerEntitlementUsageParams: zod.ZodObject<{
8877
+ customerIdOrKey: zod.ZodUnion<[zod.ZodString, zod.ZodString]>;
8878
+ featureKey: zod.ZodString;
8879
+ }, "strip", zod.ZodTypeAny, {
8880
+ featureKey: string;
8881
+ customerIdOrKey: string;
8882
+ }, {
8883
+ featureKey: string;
8884
+ customerIdOrKey: string;
8885
+ }>;
8886
+ export declare const resetCustomerEntitlementUsageBody: zod.ZodObject<{
8887
+ effectiveAt: zod.ZodOptional<zod.ZodDate>;
8888
+ preserveOverage: zod.ZodOptional<zod.ZodBoolean>;
8889
+ retainAnchor: zod.ZodOptional<zod.ZodBoolean>;
8890
+ }, "strip", zod.ZodTypeAny, {
8891
+ effectiveAt?: Date | undefined;
8892
+ preserveOverage?: boolean | undefined;
8893
+ retainAnchor?: boolean | undefined;
8894
+ }, {
8895
+ effectiveAt?: Date | undefined;
8896
+ preserveOverage?: boolean | undefined;
8897
+ retainAnchor?: boolean | undefined;
8898
+ }>;
8337
8899
  /**
8338
8900
  * Checks customer access to a given feature (by key). All entitlement types share the hasAccess property in their value response, but multiple other properties are returned based on the entitlement type.
8339
8901
  * @summary Get customer entitlement value
@@ -8359,6 +8921,74 @@ export declare const getCustomerEntitlementValueQueryParams: zod.ZodObject<{
8359
8921
  }, {
8360
8922
  time?: Date | undefined;
8361
8923
  }>;
8924
+ /**
8925
+ * Get stripe app data for a customer.
8926
+ Only returns data if the customer billing profile is linked to a stripe app.
8927
+ * @summary Get customer stripe app data
8928
+ */
8929
+ export declare const getCustomerStripeAppDataPathCustomerIdOrKeyRegExpOne: RegExp;
8930
+ export declare const getCustomerStripeAppDataPathCustomerIdOrKeyMaxTwo = 256;
8931
+ export declare const getCustomerStripeAppDataParams: zod.ZodObject<{
8932
+ customerIdOrKey: zod.ZodUnion<[zod.ZodString, zod.ZodString]>;
8933
+ }, "strip", zod.ZodTypeAny, {
8934
+ customerIdOrKey: string;
8935
+ }, {
8936
+ customerIdOrKey: string;
8937
+ }>;
8938
+ /**
8939
+ * Upsert stripe app data for a customer.
8940
+ Only updates data if the customer billing profile is linked to a stripe app.
8941
+ * @summary Upsert customer stripe app data
8942
+ */
8943
+ export declare const upsertCustomerStripeAppDataPathCustomerIdOrKeyRegExpOne: RegExp;
8944
+ export declare const upsertCustomerStripeAppDataPathCustomerIdOrKeyMaxTwo = 256;
8945
+ export declare const upsertCustomerStripeAppDataParams: zod.ZodObject<{
8946
+ customerIdOrKey: zod.ZodUnion<[zod.ZodString, zod.ZodString]>;
8947
+ }, "strip", zod.ZodTypeAny, {
8948
+ customerIdOrKey: string;
8949
+ }, {
8950
+ customerIdOrKey: string;
8951
+ }>;
8952
+ export declare const upsertCustomerStripeAppDataBody: zod.ZodObject<{
8953
+ stripeCustomerId: zod.ZodString;
8954
+ stripeDefaultPaymentMethodId: zod.ZodOptional<zod.ZodString>;
8955
+ }, "strip", zod.ZodTypeAny, {
8956
+ stripeCustomerId: string;
8957
+ stripeDefaultPaymentMethodId?: string | undefined;
8958
+ }, {
8959
+ stripeCustomerId: string;
8960
+ stripeDefaultPaymentMethodId?: string | undefined;
8961
+ }>;
8962
+ /**
8963
+ * Create Stripe customer portal session.
8964
+ Only returns URL if the customer billing profile is linked to a stripe app and customer.
8965
+
8966
+ Useful to redirect the customer to the Stripe customer portal to manage their payment methods,
8967
+ change their billing address and access their invoice history.
8968
+ * @summary Create Stripe customer portal session
8969
+ */
8970
+ export declare const createCustomerStripePortalSessionPathCustomerIdOrKeyRegExpOne: RegExp;
8971
+ export declare const createCustomerStripePortalSessionPathCustomerIdOrKeyMaxTwo = 256;
8972
+ export declare const createCustomerStripePortalSessionParams: zod.ZodObject<{
8973
+ customerIdOrKey: zod.ZodUnion<[zod.ZodString, zod.ZodString]>;
8974
+ }, "strip", zod.ZodTypeAny, {
8975
+ customerIdOrKey: string;
8976
+ }, {
8977
+ customerIdOrKey: string;
8978
+ }>;
8979
+ export declare const createCustomerStripePortalSessionBody: zod.ZodObject<{
8980
+ configurationId: zod.ZodOptional<zod.ZodString>;
8981
+ locale: zod.ZodOptional<zod.ZodString>;
8982
+ returnUrl: zod.ZodOptional<zod.ZodString>;
8983
+ }, "strip", zod.ZodTypeAny, {
8984
+ configurationId?: string | undefined;
8985
+ locale?: string | undefined;
8986
+ returnUrl?: string | undefined;
8987
+ }, {
8988
+ configurationId?: string | undefined;
8989
+ locale?: string | undefined;
8990
+ returnUrl?: string | undefined;
8991
+ }>;
8362
8992
  /**
8363
8993
  * Lists all subscriptions for a customer.
8364
8994
  * @summary List customer subscriptions
@@ -8968,8 +9598,10 @@ export declare const queryMeterParams: zod.ZodObject<{
8968
9598
  }>;
8969
9599
  export declare const queryMeterQueryClientIdMax = 36;
8970
9600
  export declare const queryMeterQueryWindowTimeZoneDefault = "UTC";
9601
+ export declare const queryMeterQueryFilterCustomerIdMax = 100;
8971
9602
  export declare const queryMeterQueryParams: zod.ZodObject<{
8972
9603
  clientId: zod.ZodOptional<zod.ZodString>;
9604
+ filterCustomerId: zod.ZodOptional<zod.ZodArray<zod.ZodString, "many">>;
8973
9605
  filterGroupBy: zod.ZodOptional<zod.ZodRecord<zod.ZodString, zod.ZodString>>;
8974
9606
  from: zod.ZodOptional<zod.ZodDate>;
8975
9607
  groupBy: zod.ZodOptional<zod.ZodArray<zod.ZodString, "many">>;
@@ -8985,6 +9617,7 @@ export declare const queryMeterQueryParams: zod.ZodObject<{
8985
9617
  windowSize?: "HOUR" | "DAY" | "MONTH" | "MINUTE" | undefined;
8986
9618
  groupBy?: string[] | undefined;
8987
9619
  clientId?: string | undefined;
9620
+ filterCustomerId?: string[] | undefined;
8988
9621
  filterGroupBy?: Record<string, string> | undefined;
8989
9622
  }, {
8990
9623
  subject?: string[] | undefined;
@@ -8994,6 +9627,7 @@ export declare const queryMeterQueryParams: zod.ZodObject<{
8994
9627
  windowTimeZone?: string | undefined;
8995
9628
  groupBy?: string[] | undefined;
8996
9629
  clientId?: string | undefined;
9630
+ filterCustomerId?: string[] | undefined;
8997
9631
  filterGroupBy?: Record<string, string> | undefined;
8998
9632
  }>;
8999
9633
  /**
@@ -9011,9 +9645,11 @@ export declare const queryMeterPostParams: zod.ZodObject<{
9011
9645
  export declare const queryMeterPostBodyClientIdMax = 36;
9012
9646
  export declare const queryMeterPostBodyWindowTimeZoneDefault = "UTC";
9013
9647
  export declare const queryMeterPostBodySubjectMax = 100;
9648
+ export declare const queryMeterPostBodyFilterCustomerIdMax = 100;
9014
9649
  export declare const queryMeterPostBodyGroupByMax = 100;
9015
9650
  export declare const queryMeterPostBody: zod.ZodObject<{
9016
9651
  clientId: zod.ZodOptional<zod.ZodString>;
9652
+ filterCustomerId: zod.ZodOptional<zod.ZodArray<zod.ZodString, "many">>;
9017
9653
  filterGroupBy: zod.ZodOptional<zod.ZodRecord<zod.ZodString, zod.ZodArray<zod.ZodString, "many">>>;
9018
9654
  from: zod.ZodOptional<zod.ZodDate>;
9019
9655
  groupBy: zod.ZodOptional<zod.ZodArray<zod.ZodString, "many">>;
@@ -9029,6 +9665,7 @@ export declare const queryMeterPostBody: zod.ZodObject<{
9029
9665
  windowSize?: "HOUR" | "DAY" | "MONTH" | "MINUTE" | undefined;
9030
9666
  groupBy?: string[] | undefined;
9031
9667
  clientId?: string | undefined;
9668
+ filterCustomerId?: string[] | undefined;
9032
9669
  filterGroupBy?: Record<string, string[]> | undefined;
9033
9670
  }, {
9034
9671
  subject?: string[] | undefined;
@@ -9038,6 +9675,7 @@ export declare const queryMeterPostBody: zod.ZodObject<{
9038
9675
  windowTimeZone?: string | undefined;
9039
9676
  groupBy?: string[] | undefined;
9040
9677
  clientId?: string | undefined;
9678
+ filterCustomerId?: string[] | undefined;
9041
9679
  filterGroupBy?: Record<string, string[]> | undefined;
9042
9680
  }>;
9043
9681
  /**
@@ -12374,8 +13012,10 @@ export declare const queryPortalMeterParams: zod.ZodObject<{
12374
13012
  }>;
12375
13013
  export declare const queryPortalMeterQueryClientIdMax = 36;
12376
13014
  export declare const queryPortalMeterQueryWindowTimeZoneDefault = "UTC";
13015
+ export declare const queryPortalMeterQueryFilterCustomerIdMax = 100;
12377
13016
  export declare const queryPortalMeterQueryParams: zod.ZodObject<{
12378
13017
  clientId: zod.ZodOptional<zod.ZodString>;
13018
+ filterCustomerId: zod.ZodOptional<zod.ZodArray<zod.ZodString, "many">>;
12379
13019
  filterGroupBy: zod.ZodOptional<zod.ZodRecord<zod.ZodString, zod.ZodString>>;
12380
13020
  from: zod.ZodOptional<zod.ZodDate>;
12381
13021
  groupBy: zod.ZodOptional<zod.ZodArray<zod.ZodString, "many">>;
@@ -12389,6 +13029,7 @@ export declare const queryPortalMeterQueryParams: zod.ZodObject<{
12389
13029
  windowSize?: "HOUR" | "DAY" | "MONTH" | "MINUTE" | undefined;
12390
13030
  groupBy?: string[] | undefined;
12391
13031
  clientId?: string | undefined;
13032
+ filterCustomerId?: string[] | undefined;
12392
13033
  filterGroupBy?: Record<string, string> | undefined;
12393
13034
  }, {
12394
13035
  from?: Date | undefined;
@@ -12397,6 +13038,7 @@ export declare const queryPortalMeterQueryParams: zod.ZodObject<{
12397
13038
  windowTimeZone?: string | undefined;
12398
13039
  groupBy?: string[] | undefined;
12399
13040
  clientId?: string | undefined;
13041
+ filterCustomerId?: string[] | undefined;
12400
13042
  filterGroupBy?: Record<string, string> | undefined;
12401
13043
  }>;
12402
13044
  /**
@@ -12673,6 +13315,7 @@ export declare const createStripeCheckoutSessionBody: zod.ZodObject<{
12673
13315
  }, "strip", zod.ZodTypeAny, {
12674
13316
  metadata?: Record<string, string> | undefined;
12675
13317
  currency?: string | undefined;
13318
+ locale?: string | undefined;
12676
13319
  billingAddressCollection?: "auto" | "required" | undefined;
12677
13320
  cancelURL?: string | undefined;
12678
13321
  clientReferenceID?: string | undefined;
@@ -12703,7 +13346,6 @@ export declare const createStripeCheckoutSessionBody: zod.ZodObject<{
12703
13346
  } | undefined;
12704
13347
  } | undefined;
12705
13348
  expiresAt?: number | undefined;
12706
- locale?: string | undefined;
12707
13349
  paymentMethodTypes?: string[] | undefined;
12708
13350
  redirectOnCompletion?: "never" | "always" | "if_required" | undefined;
12709
13351
  returnURL?: string | undefined;
@@ -12716,6 +13358,7 @@ export declare const createStripeCheckoutSessionBody: zod.ZodObject<{
12716
13358
  }, {
12717
13359
  metadata?: Record<string, string> | undefined;
12718
13360
  currency?: string | undefined;
13361
+ locale?: string | undefined;
12719
13362
  billingAddressCollection?: "auto" | "required" | undefined;
12720
13363
  cancelURL?: string | undefined;
12721
13364
  clientReferenceID?: string | undefined;
@@ -12746,7 +13389,6 @@ export declare const createStripeCheckoutSessionBody: zod.ZodObject<{
12746
13389
  } | undefined;
12747
13390
  } | undefined;
12748
13391
  expiresAt?: number | undefined;
12749
- locale?: string | undefined;
12750
13392
  paymentMethodTypes?: string[] | undefined;
12751
13393
  redirectOnCompletion?: "never" | "always" | "if_required" | undefined;
12752
13394
  returnURL?: string | undefined;
@@ -12786,6 +13428,7 @@ export declare const createStripeCheckoutSessionBody: zod.ZodObject<{
12786
13428
  options: {
12787
13429
  metadata?: Record<string, string> | undefined;
12788
13430
  currency?: string | undefined;
13431
+ locale?: string | undefined;
12789
13432
  billingAddressCollection?: "auto" | "required" | undefined;
12790
13433
  cancelURL?: string | undefined;
12791
13434
  clientReferenceID?: string | undefined;
@@ -12816,7 +13459,6 @@ export declare const createStripeCheckoutSessionBody: zod.ZodObject<{
12816
13459
  } | undefined;
12817
13460
  } | undefined;
12818
13461
  expiresAt?: number | undefined;
12819
- locale?: string | undefined;
12820
13462
  paymentMethodTypes?: string[] | undefined;
12821
13463
  redirectOnCompletion?: "never" | "always" | "if_required" | undefined;
12822
13464
  returnURL?: string | undefined;
@@ -12857,6 +13499,7 @@ export declare const createStripeCheckoutSessionBody: zod.ZodObject<{
12857
13499
  options: {
12858
13500
  metadata?: Record<string, string> | undefined;
12859
13501
  currency?: string | undefined;
13502
+ locale?: string | undefined;
12860
13503
  billingAddressCollection?: "auto" | "required" | undefined;
12861
13504
  cancelURL?: string | undefined;
12862
13505
  clientReferenceID?: string | undefined;
@@ -12887,7 +13530,6 @@ export declare const createStripeCheckoutSessionBody: zod.ZodObject<{
12887
13530
  } | undefined;
12888
13531
  } | undefined;
12889
13532
  expiresAt?: number | undefined;
12890
- locale?: string | undefined;
12891
13533
  paymentMethodTypes?: string[] | undefined;
12892
13534
  redirectOnCompletion?: "never" | "always" | "if_required" | undefined;
12893
13535
  returnURL?: string | undefined;