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

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.
@@ -31,6 +31,7 @@ export declare class Customers {
31
31
  billingAddress?: import("./schemas.cjs").components["schemas"]["Address"];
32
32
  readonly currentSubscriptionId?: string;
33
33
  readonly subscriptions?: import("./schemas.cjs").components["schemas"]["Subscription"][];
34
+ readonly annotations?: import("./schemas.cjs").components["schemas"]["Annotations"];
34
35
  }>;
35
36
  /**
36
37
  * Get a customer by ID
@@ -53,6 +54,7 @@ export declare class Customers {
53
54
  billingAddress?: import("./schemas.cjs").components["schemas"]["Address"];
54
55
  readonly currentSubscriptionId?: string;
55
56
  readonly subscriptions?: import("./schemas.cjs").components["schemas"]["Subscription"][];
57
+ readonly annotations?: import("./schemas.cjs").components["schemas"]["Annotations"];
56
58
  }>;
57
59
  /**
58
60
  * Update a customer
@@ -76,6 +78,7 @@ export declare class Customers {
76
78
  billingAddress?: import("./schemas.cjs").components["schemas"]["Address"];
77
79
  readonly currentSubscriptionId?: string;
78
80
  readonly subscriptions?: import("./schemas.cjs").components["schemas"]["Subscription"][];
81
+ readonly annotations?: import("./schemas.cjs").components["schemas"]["Annotations"];
79
82
  }>;
80
83
  /**
81
84
  * Delete a customer
@@ -2350,10 +2350,16 @@ export interface components {
2350
2350
  /** @description Phone number. */
2351
2351
  phoneNumber?: string;
2352
2352
  };
2353
- /** @description Alignment configuration for a plan or subscription. */
2353
+ /**
2354
+ * @deprecated
2355
+ * @description Alignment configuration for a plan or subscription.
2356
+ */
2354
2357
  Alignment: {
2355
- /** @description Whether all Billable items and RateCards must align.
2356
- * Alignment means the Price's BillingCadence must align for both duration and anchor time. */
2358
+ /**
2359
+ * @deprecated
2360
+ * @description Whether all Billable items and RateCards must align.
2361
+ * Alignment means the Price's BillingCadence must align for both duration and anchor time.
2362
+ */
2357
2363
  billablesMustAlign?: boolean;
2358
2364
  };
2359
2365
  /**
@@ -3629,6 +3635,11 @@ export interface components {
3629
3635
  * Only with the `subscriptions` expand option.
3630
3636
  */
3631
3637
  readonly subscriptions?: components['schemas']['Subscription'][];
3638
+ /**
3639
+ * Annotations
3640
+ * @description Set of key-value pairs managed by the system. Cannot be modified by user.
3641
+ */
3642
+ readonly annotations?: components['schemas']['Annotations'];
3632
3643
  };
3633
3644
  /** @description CustomerAccess describes what features the customer has access to. */
3634
3645
  CustomerAccess: {
@@ -9238,8 +9249,11 @@ export interface components {
9238
9249
  };
9239
9250
  /** @description Alignment details enriched with the current billing period. */
9240
9251
  SubscriptionAlignment: {
9241
- /** @description Whether all Billable items and RateCards must align.
9242
- * Alignment means the Price's BillingCadence must align for both duration and anchor time. */
9252
+ /**
9253
+ * @deprecated
9254
+ * @description Whether all Billable items and RateCards must align.
9255
+ * Alignment means the Price's BillingCadence must align for both duration and anchor time.
9256
+ */
9243
9257
  billablesMustAlign?: boolean;
9244
9258
  /** @description The current billing period. Only has value if the subscription is aligned and active. */
9245
9259
  currentAlignedBillingPeriod?: components['schemas']['Period'];
@@ -9682,6 +9696,8 @@ export interface components {
9682
9696
  */
9683
9697
  maximumAmount?: components['schemas']['Numeric'];
9684
9698
  };
9699
+ /** @description ULID (Universally Unique Lexicographically Sortable Identifier) or external unique key. */
9700
+ ULIDOrExternalKey: string;
9685
9701
  /** @description The request has not been applied because it lacks valid authentication credentials for the target resource. */
9686
9702
  UnauthorizedProblemResponse: components['schemas']['UnexpectedProblemResponse'];
9687
9703
  /** @description A Problem Details object (RFC 7807).
@@ -9717,7 +9733,7 @@ export interface components {
9717
9733
  */
9718
9734
  instance: string;
9719
9735
  } & {
9720
- [key: string]: string | number;
9736
+ [key: string]: unknown;
9721
9737
  };
9722
9738
  /** @description Unit price. */
9723
9739
  UnitPrice: {
@@ -9749,7 +9765,7 @@ export interface components {
9749
9765
  */
9750
9766
  maximumAmount?: components['schemas']['Numeric'];
9751
9767
  };
9752
- /** @description Validation errors providing details about compatibility issues between a plan and its add-on. */
9768
+ /** @description Validation errors providing detailed description of the issue. */
9753
9769
  ValidationError: {
9754
9770
  /**
9755
9771
  * @description The path to the field.
@@ -9769,6 +9785,42 @@ export interface components {
9769
9785
  /** @description Additional attributes. */
9770
9786
  readonly attributes?: components['schemas']['Annotations'];
9771
9787
  };
9788
+ /** @description A BadRequestError with a validationErrors extension. */
9789
+ ValidationErrorProblemResponse: {
9790
+ /**
9791
+ * Format: uri
9792
+ * @description Type contains a URI that identifies the problem type.
9793
+ * @default about:blank
9794
+ * @example about:blank
9795
+ */
9796
+ type: string;
9797
+ /**
9798
+ * @description A a short, human-readable summary of the problem type.
9799
+ * @example Bad Request
9800
+ */
9801
+ title: string;
9802
+ /**
9803
+ * Format: int16
9804
+ * @description The HTTP status code generated by the origin server for this occurrence of the problem.
9805
+ * @example 400
9806
+ */
9807
+ status?: number;
9808
+ /**
9809
+ * @description A human-readable explanation specific to this occurrence of the problem.
9810
+ * @example The request body must be a JSON object.
9811
+ */
9812
+ detail: string;
9813
+ /**
9814
+ * Format: uri
9815
+ * @description A URI reference that identifies the specific occurrence of the problem.
9816
+ * @example urn:request:local/JMOlctsKV8-000001
9817
+ */
9818
+ instance: string;
9819
+ /** @description Validation issues. */
9820
+ readonly extensions?: {
9821
+ validationErrors?: components['schemas']['ValidationError'][];
9822
+ };
9823
+ };
9772
9824
  /** @description ValidationIssue captures any validation issues related to the invoice.
9773
9825
  *
9774
9826
  * Issues with severity "critical" will prevent the invoice from being issued. */
@@ -9934,6 +9986,8 @@ export interface components {
9934
9986
  'BillingProfileListCustomerOverridesParams.customerName': string;
9935
9987
  /** @description Filter by customer primary email */
9936
9988
  'BillingProfileListCustomerOverridesParams.customerPrimaryEmail': string;
9989
+ /** @description Only return customers without pinned billing profiles. This implicitly sets includeAllCustomers to true. */
9990
+ 'BillingProfileListCustomerOverridesParams.customersWithoutPinnedProfile': boolean;
9937
9991
  /** @description Expand the response with additional details. */
9938
9992
  'BillingProfileListCustomerOverridesParams.expand': components['schemas']['BillingProfileCustomerOverrideExpand'][];
9939
9993
  /** @description Include customers without customer overrides.
@@ -10475,11 +10529,13 @@ export type TaxBehavior = components['schemas']['TaxBehavior'];
10475
10529
  export type TaxConfig = components['schemas']['TaxConfig'];
10476
10530
  export type TieredPriceMode = components['schemas']['TieredPriceMode'];
10477
10531
  export type TieredPriceWithCommitments = components['schemas']['TieredPriceWithCommitments'];
10532
+ export type UlidOrExternalKey = components['schemas']['ULIDOrExternalKey'];
10478
10533
  export type UnauthorizedProblemResponse = components['schemas']['UnauthorizedProblemResponse'];
10479
10534
  export type UnexpectedProblemResponse = components['schemas']['UnexpectedProblemResponse'];
10480
10535
  export type UnitPrice = components['schemas']['UnitPrice'];
10481
10536
  export type UnitPriceWithCommitments = components['schemas']['UnitPriceWithCommitments'];
10482
10537
  export type ValidationError = components['schemas']['ValidationError'];
10538
+ export type ValidationErrorProblemResponse = components['schemas']['ValidationErrorProblemResponse'];
10483
10539
  export type ValidationIssue = components['schemas']['ValidationIssue'];
10484
10540
  export type ValidationIssueSeverity = components['schemas']['ValidationIssueSeverity'];
10485
10541
  export type VoidInvoiceActionCreate = components['schemas']['VoidInvoiceActionCreate'];
@@ -10502,6 +10558,7 @@ export type ParameterBillingProfileListCustomerOverridesParamsCustomerId = compo
10502
10558
  export type ParameterBillingProfileListCustomerOverridesParamsCustomerKey = components['parameters']['BillingProfileListCustomerOverridesParams.customerKey'];
10503
10559
  export type ParameterBillingProfileListCustomerOverridesParamsCustomerName = components['parameters']['BillingProfileListCustomerOverridesParams.customerName'];
10504
10560
  export type ParameterBillingProfileListCustomerOverridesParamsCustomerPrimaryEmail = components['parameters']['BillingProfileListCustomerOverridesParams.customerPrimaryEmail'];
10561
+ export type ParameterBillingProfileListCustomerOverridesParamsCustomersWithoutPinnedProfile = components['parameters']['BillingProfileListCustomerOverridesParams.customersWithoutPinnedProfile'];
10505
10562
  export type ParameterBillingProfileListCustomerOverridesParamsExpand = components['parameters']['BillingProfileListCustomerOverridesParams.expand'];
10506
10563
  export type ParameterBillingProfileListCustomerOverridesParamsIncludeAllCustomers = components['parameters']['BillingProfileListCustomerOverridesParams.includeAllCustomers'];
10507
10564
  export type ParameterBillingProfileOrderByOrderingOrder = components['parameters']['BillingProfileOrderByOrdering.order'];
@@ -12081,6 +12138,8 @@ export interface operations {
12081
12138
  query?: {
12082
12139
  /** @description Filter by billing profile. */
12083
12140
  billingProfile?: components['parameters']['BillingProfileListCustomerOverridesParams.billingProfile'];
12141
+ /** @description Only return customers without pinned billing profiles. This implicitly sets includeAllCustomers to true. */
12142
+ customersWithoutPinnedProfile?: components['parameters']['BillingProfileListCustomerOverridesParams.customersWithoutPinnedProfile'];
12084
12143
  /** @description Include customers without customer overrides.
12085
12144
  *
12086
12145
  * If set to false only the customers specifically associated with a billing profile will be returned.
@@ -14400,7 +14459,7 @@ export interface operations {
14400
14459
  };
14401
14460
  header?: never;
14402
14461
  path: {
14403
- customerIdOrKey: string;
14462
+ customerIdOrKey: components['schemas']['ULIDOrExternalKey'];
14404
14463
  };
14405
14464
  cookie?: never;
14406
14465
  };
@@ -14494,7 +14553,7 @@ export interface operations {
14494
14553
  query?: never;
14495
14554
  header?: never;
14496
14555
  path: {
14497
- customerIdOrKey: string;
14556
+ customerIdOrKey: components['schemas']['ULIDOrExternalKey'];
14498
14557
  };
14499
14558
  cookie?: never;
14500
14559
  };
@@ -14592,7 +14651,7 @@ export interface operations {
14592
14651
  query?: never;
14593
14652
  header?: never;
14594
14653
  path: {
14595
- customerIdOrKey: string;
14654
+ customerIdOrKey: components['schemas']['ULIDOrExternalKey'];
14596
14655
  };
14597
14656
  cookie?: never;
14598
14657
  };
@@ -14684,7 +14743,7 @@ export interface operations {
14684
14743
  query?: never;
14685
14744
  header?: never;
14686
14745
  path: {
14687
- customerIdOrKey: string;
14746
+ customerIdOrKey: components['schemas']['ULIDOrExternalKey'];
14688
14747
  };
14689
14748
  cookie?: never;
14690
14749
  };
@@ -14789,7 +14848,7 @@ export interface operations {
14789
14848
  };
14790
14849
  header?: never;
14791
14850
  path: {
14792
- customerIdOrKey: string;
14851
+ customerIdOrKey: components['schemas']['ULIDOrExternalKey'];
14793
14852
  };
14794
14853
  cookie?: never;
14795
14854
  };
@@ -14883,7 +14942,7 @@ export interface operations {
14883
14942
  query?: never;
14884
14943
  header?: never;
14885
14944
  path: {
14886
- customerIdOrKey: string;
14945
+ customerIdOrKey: components['schemas']['ULIDOrExternalKey'];
14887
14946
  };
14888
14947
  cookie?: never;
14889
14948
  };
@@ -14981,7 +15040,7 @@ export interface operations {
14981
15040
  query?: never;
14982
15041
  header?: never;
14983
15042
  path: {
14984
- customerIdOrKey: string;
15043
+ customerIdOrKey: components['schemas']['ULIDOrExternalKey'];
14985
15044
  appId: string;
14986
15045
  };
14987
15046
  cookie?: never;
@@ -15076,7 +15135,7 @@ export interface operations {
15076
15135
  };
15077
15136
  header?: never;
15078
15137
  path: {
15079
- customerIdOrKey: string;
15138
+ customerIdOrKey: components['schemas']['ULIDOrExternalKey'];
15080
15139
  featureKey: string;
15081
15140
  };
15082
15141
  cookie?: never;
@@ -15180,7 +15239,7 @@ export interface operations {
15180
15239
  };
15181
15240
  header?: never;
15182
15241
  path: {
15183
- customerIdOrKey: string;
15242
+ customerIdOrKey: components['schemas']['ULIDOrExternalKey'];
15184
15243
  };
15185
15244
  cookie?: never;
15186
15245
  };
@@ -22240,13 +22299,13 @@ export interface operations {
22240
22299
  'application/json': components['schemas']['Subscription'];
22241
22300
  };
22242
22301
  };
22243
- /** @description The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). */
22302
+ /** @description A BadRequestError with a validationErrors extension. */
22244
22303
  400: {
22245
22304
  headers: {
22246
22305
  [name: string]: unknown;
22247
22306
  };
22248
22307
  content: {
22249
- 'application/problem+json': components['schemas']['BadRequestProblemResponse'];
22308
+ 'application/problem+json': components['schemas']['ValidationErrorProblemResponse'];
22250
22309
  };
22251
22310
  };
22252
22311
  /** @description The request has not been applied because it lacks valid authentication credentials for the target resource. */
@@ -22429,13 +22488,13 @@ export interface operations {
22429
22488
  };
22430
22489
  content?: never;
22431
22490
  };
22432
- /** @description The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). */
22491
+ /** @description A BadRequestError with a validationErrors extension. */
22433
22492
  400: {
22434
22493
  headers: {
22435
22494
  [name: string]: unknown;
22436
22495
  };
22437
22496
  content: {
22438
- 'application/problem+json': components['schemas']['BadRequestProblemResponse'];
22497
+ 'application/problem+json': components['schemas']['ValidationErrorProblemResponse'];
22439
22498
  };
22440
22499
  };
22441
22500
  /** @description The request has not been applied because it lacks valid authentication credentials for the target resource. */
@@ -22527,13 +22586,13 @@ export interface operations {
22527
22586
  'application/json': components['schemas']['Subscription'];
22528
22587
  };
22529
22588
  };
22530
- /** @description The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). */
22589
+ /** @description A BadRequestError with a validationErrors extension. */
22531
22590
  400: {
22532
22591
  headers: {
22533
22592
  [name: string]: unknown;
22534
22593
  };
22535
22594
  content: {
22536
- 'application/problem+json': components['schemas']['BadRequestProblemResponse'];
22595
+ 'application/problem+json': components['schemas']['ValidationErrorProblemResponse'];
22537
22596
  };
22538
22597
  };
22539
22598
  /** @description The request has not been applied because it lacks valid authentication credentials for the target resource. */
@@ -23032,13 +23091,13 @@ export interface operations {
23032
23091
  'application/json': components['schemas']['Subscription'];
23033
23092
  };
23034
23093
  };
23035
- /** @description The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). */
23094
+ /** @description A BadRequestError with a validationErrors extension. */
23036
23095
  400: {
23037
23096
  headers: {
23038
23097
  [name: string]: unknown;
23039
23098
  };
23040
23099
  content: {
23041
- 'application/problem+json': components['schemas']['BadRequestProblemResponse'];
23100
+ 'application/problem+json': components['schemas']['ValidationErrorProblemResponse'];
23042
23101
  };
23043
23102
  };
23044
23103
  /** @description The request has not been applied because it lacks valid authentication credentials for the target resource. */
@@ -23139,13 +23198,13 @@ export interface operations {
23139
23198
  'application/json': components['schemas']['SubscriptionChangeResponseBody'];
23140
23199
  };
23141
23200
  };
23142
- /** @description The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). */
23201
+ /** @description A BadRequestError with a validationErrors extension. */
23143
23202
  400: {
23144
23203
  headers: {
23145
23204
  [name: string]: unknown;
23146
23205
  };
23147
23206
  content: {
23148
- 'application/problem+json': components['schemas']['BadRequestProblemResponse'];
23207
+ 'application/problem+json': components['schemas']['ValidationErrorProblemResponse'];
23149
23208
  };
23150
23209
  };
23151
23210
  /** @description The request has not been applied because it lacks valid authentication credentials for the target resource. */
@@ -23265,13 +23324,13 @@ export interface operations {
23265
23324
  'application/json': components['schemas']['SubscriptionChangeResponseBody'];
23266
23325
  };
23267
23326
  };
23268
- /** @description The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). */
23327
+ /** @description A BadRequestError with a validationErrors extension. */
23269
23328
  400: {
23270
23329
  headers: {
23271
23330
  [name: string]: unknown;
23272
23331
  };
23273
23332
  content: {
23274
- 'application/problem+json': components['schemas']['BadRequestProblemResponse'];
23333
+ 'application/problem+json': components['schemas']['ValidationErrorProblemResponse'];
23275
23334
  };
23276
23335
  };
23277
23336
  /** @description The request has not been applied because it lacks valid authentication credentials for the target resource. */
@@ -23462,13 +23521,13 @@ export interface operations {
23462
23521
  'application/json': components['schemas']['Subscription'];
23463
23522
  };
23464
23523
  };
23465
- /** @description The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). */
23524
+ /** @description A BadRequestError with a validationErrors extension. */
23466
23525
  400: {
23467
23526
  headers: {
23468
23527
  [name: string]: unknown;
23469
23528
  };
23470
23529
  content: {
23471
- 'application/problem+json': components['schemas']['BadRequestProblemResponse'];
23530
+ 'application/problem+json': components['schemas']['ValidationErrorProblemResponse'];
23472
23531
  };
23473
23532
  };
23474
23533
  /** @description The request has not been applied because it lacks valid authentication credentials for the target resource. */