@openmeter/sdk 1.0.0-beta.204 → 1.0.0-beta.205

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.
@@ -1,4 +1,114 @@
1
1
  export interface paths {
2
+ '/api/v1/addons': {
3
+ parameters: {
4
+ query?: never;
5
+ header?: never;
6
+ path?: never;
7
+ cookie?: never;
8
+ };
9
+ /**
10
+ * List add-ons
11
+ * @description List all add-ons.
12
+ */
13
+ get: operations['listAddons'];
14
+ put?: never;
15
+ /**
16
+ * Create an add-on
17
+ * @description Create a new add-on.
18
+ */
19
+ post: operations['createAddon'];
20
+ delete?: never;
21
+ options?: never;
22
+ head?: never;
23
+ patch?: never;
24
+ trace?: never;
25
+ };
26
+ '/api/v1/addons/{addonIdOrKey}': {
27
+ parameters: {
28
+ query?: never;
29
+ header?: never;
30
+ path?: never;
31
+ cookie?: never;
32
+ };
33
+ /**
34
+ * Get add-on
35
+ * @description Get add-on by id or key. The latest published version is returned if latter is used.
36
+ */
37
+ get: operations['getAddon'];
38
+ put?: never;
39
+ post?: never;
40
+ delete?: never;
41
+ options?: never;
42
+ head?: never;
43
+ patch?: never;
44
+ trace?: never;
45
+ };
46
+ '/api/v1/addons/{addonId}': {
47
+ parameters: {
48
+ query?: never;
49
+ header?: never;
50
+ path?: never;
51
+ cookie?: never;
52
+ };
53
+ get?: never;
54
+ /**
55
+ * Update add-on
56
+ * @description Update add-on by id.
57
+ */
58
+ put: operations['updateAddon'];
59
+ post?: never;
60
+ /**
61
+ * Delete add-on
62
+ * @description Soft delete add-on by id.
63
+ *
64
+ * Once a add-on is deleted it cannot be undeleted.
65
+ */
66
+ delete: operations['deleteAddon'];
67
+ options?: never;
68
+ head?: never;
69
+ patch?: never;
70
+ trace?: never;
71
+ };
72
+ '/api/v1/addons/{addonId}/archive': {
73
+ parameters: {
74
+ query?: never;
75
+ header?: never;
76
+ path?: never;
77
+ cookie?: never;
78
+ };
79
+ get?: never;
80
+ put?: never;
81
+ /**
82
+ * Archive add-on version
83
+ * @description Archive a add-on version.
84
+ */
85
+ post: operations['archiveAddon'];
86
+ delete?: never;
87
+ options?: never;
88
+ head?: never;
89
+ patch?: never;
90
+ trace?: never;
91
+ };
92
+ '/api/v1/addons/{addonId}/publish': {
93
+ parameters: {
94
+ query?: never;
95
+ header?: never;
96
+ path?: never;
97
+ cookie?: never;
98
+ };
99
+ get?: never;
100
+ put?: never;
101
+ /**
102
+ * Publish add-on
103
+ * @description Publish a add-on version.
104
+ */
105
+ post: operations['publishAddon'];
106
+ delete?: never;
107
+ options?: never;
108
+ head?: never;
109
+ patch?: never;
110
+ trace?: never;
111
+ };
2
112
  '/api/v1/apps': {
3
113
  parameters: {
4
114
  query?: never;
@@ -463,7 +573,35 @@ export interface paths {
463
573
  patch?: never;
464
574
  trace?: never;
465
575
  };
466
- '/api/v1/customers/{customerId}/apps': {
576
+ '/api/v1/customers/{customerIdOrKey}': {
577
+ parameters: {
578
+ query?: never;
579
+ header?: never;
580
+ path?: never;
581
+ cookie?: never;
582
+ };
583
+ /**
584
+ * Get customer
585
+ * @description Get a customer by ID or key.
586
+ */
587
+ get: operations['getCustomer'];
588
+ /**
589
+ * Update customer
590
+ * @description Update a customer by ID.
591
+ */
592
+ put: operations['updateCustomer'];
593
+ post?: never;
594
+ /**
595
+ * Delete customer
596
+ * @description Delete a customer by ID.
597
+ */
598
+ delete: operations['deleteCustomer'];
599
+ options?: never;
600
+ head?: never;
601
+ patch?: never;
602
+ trace?: never;
603
+ };
604
+ '/api/v1/customers/{customerIdOrKey}/apps': {
467
605
  parameters: {
468
606
  query?: never;
469
607
  header?: never;
@@ -487,7 +625,7 @@ export interface paths {
487
625
  patch?: never;
488
626
  trace?: never;
489
627
  };
490
- '/api/v1/customers/{customerId}/apps/{appId}': {
628
+ '/api/v1/customers/{customerIdOrKey}/apps/{appId}': {
491
629
  parameters: {
492
630
  query?: never;
493
631
  header?: never;
@@ -507,7 +645,7 @@ export interface paths {
507
645
  patch?: never;
508
646
  trace?: never;
509
647
  };
510
- '/api/v1/customers/{customerId}/entitlements/{featureKey}/value': {
648
+ '/api/v1/customers/{customerIdOrKey}/entitlements/{featureKey}/value': {
511
649
  parameters: {
512
650
  query?: never;
513
651
  header?: never;
@@ -527,7 +665,7 @@ export interface paths {
527
665
  patch?: never;
528
666
  trace?: never;
529
667
  };
530
- '/api/v1/customers/{customerId}/subscriptions': {
668
+ '/api/v1/customers/{customerIdOrKey}/subscriptions': {
531
669
  parameters: {
532
670
  query?: never;
533
671
  header?: never;
@@ -547,34 +685,6 @@ export interface paths {
547
685
  patch?: never;
548
686
  trace?: never;
549
687
  };
550
- '/api/v1/customers/{id}': {
551
- parameters: {
552
- query?: never;
553
- header?: never;
554
- path?: never;
555
- cookie?: never;
556
- };
557
- /**
558
- * Get customer
559
- * @description Get a customer by ID.
560
- */
561
- get: operations['getCustomer'];
562
- /**
563
- * Update customer
564
- * @description Update a customer by ID.
565
- */
566
- put: operations['updateCustomer'];
567
- post?: never;
568
- /**
569
- * Delete customer
570
- * @description Delete a customer by ID.
571
- */
572
- delete: operations['deleteCustomer'];
573
- options?: never;
574
- head?: never;
575
- patch?: never;
576
- trace?: never;
577
- };
578
688
  '/api/v1/debug/metrics': {
579
689
  parameters: {
580
690
  query?: never;
@@ -964,8 +1074,8 @@ export interface paths {
964
1074
  cookie?: never;
965
1075
  };
966
1076
  /**
967
- * Query meter Query meter
968
- * @description Query meter for usage. Query meter for usage.
1077
+ * Query meter
1078
+ * @description Query meter for usage.
969
1079
  */
970
1080
  get: operations['queryMeter'];
971
1081
  put?: never;
@@ -1219,6 +1329,7 @@ export interface paths {
1219
1329
  put?: never;
1220
1330
  /**
1221
1331
  * New draft plan
1332
+ * @deprecated
1222
1333
  * @description Create a new draft version from plan.
1223
1334
  * It returns error if there is already a plan in draft or planId does not reference the latest published version.
1224
1335
  */
@@ -1643,7 +1754,11 @@ export interface paths {
1643
1754
  get: operations['getSubscription'];
1644
1755
  put?: never;
1645
1756
  post?: never;
1646
- delete?: never;
1757
+ /**
1758
+ * Delete subscription
1759
+ * @description Deletes a subscription. Only scheduled subscriptions can be deleted.
1760
+ */
1761
+ delete: operations['deleteSubscription'];
1647
1762
  options?: never;
1648
1763
  head?: never;
1649
1764
  /**
@@ -1783,43 +1898,14 @@ export interface paths {
1783
1898
  export type webhooks = Record<string, never>;
1784
1899
  export interface components {
1785
1900
  schemas: {
1786
- /** @description Address */
1787
- Address: {
1788
- /** @description Country code in [ISO 3166-1](https://www.iso.org/iso-3166-country-codes.html) alpha-2 format. */
1789
- country?: components['schemas']['CountryCode'];
1790
- /** @description Postal code. */
1791
- postalCode?: string;
1792
- /** @description State or province. */
1793
- state?: string;
1794
- /** @description City. */
1795
- city?: string;
1796
- /** @description First line of the address. */
1797
- line1?: string;
1798
- /** @description Second line of the address. */
1799
- line2?: string;
1800
- /** @description Phone number. */
1801
- phoneNumber?: string;
1802
- };
1803
- /** @description Alignment configuration for a plan or subscription. */
1804
- Alignment: {
1805
- /** @description Whether all Billable items and RateCards must align.
1806
- * Alignment means the Price's BillingCadence must align for both duration and anchor time. */
1807
- billablesMustAlign?: boolean;
1808
- };
1809
- /**
1810
- * @description Set of key-value pairs managed by the system. Cannot be modified by user.
1811
- * @example {
1812
- * "externalId": "019142cc-a016-796a-8113-1a942fecd26d"
1813
- * }
1814
- */
1815
- Annotations: {
1816
- [key: string]: unknown;
1817
- };
1818
- /** @description App.
1819
- * One of: stripe */
1820
- App: components['schemas']['StripeApp'] | components['schemas']['SandboxApp'];
1821
- /** @description Resource update operation model. */
1822
- AppBaseReplaceUpdate: {
1901
+ /** @description Add-on allows extending subscriptions with compatible plans with additional ratecards. */
1902
+ Addon: {
1903
+ /**
1904
+ * ID
1905
+ * @description A unique identifier for the resource.
1906
+ * @example 01G65Z755AFWAKHE12NY0CQ9FH
1907
+ */
1908
+ readonly id: string;
1823
1909
  /**
1824
1910
  * Display name
1825
1911
  * @description Human-readable name for the resource. Between 1 and 256 characters.
@@ -1835,71 +1921,303 @@ export interface components {
1835
1921
  * @description Additional metadata for the resource.
1836
1922
  */
1837
1923
  metadata?: components['schemas']['Metadata'] | null;
1838
- /** @description Default for the app type
1839
- * Only one app of each type can be default. */
1840
- default: boolean;
1841
- };
1842
- /**
1843
- * @description App capability.
1844
- *
1845
- * Capabilities only exist in config so they don't extend the Resource model.
1846
- * @example {
1847
- * "type": "collectPayments",
1848
- * "key": "stripe_collect_payment",
1849
- * "name": "Collect Payments",
1850
- * "description": "Stripe payments collects outstanding revenue with Stripe customer's default payment method."
1851
- * }
1852
- */
1853
- AppCapability: {
1854
- /** @description The capability type. */
1855
- type: components['schemas']['AppCapabilityType'];
1856
- /** @description Key */
1857
- key: string;
1858
- /** @description The capability name. */
1859
- name: string;
1860
- /** @description The capability description. */
1861
- description: string;
1862
- };
1863
- /**
1864
- * @description App capability type.
1865
- * @enum {string}
1866
- */
1867
- AppCapabilityType: 'reportUsage' | 'reportEvents' | 'calculateTax' | 'invoiceCustomers' | 'collectPayments';
1868
- /** @description Paginated response */
1869
- AppPaginatedResponse: {
1870
1924
  /**
1871
- * @description The total number of items.
1872
- * @example 500
1925
+ * Creation Time
1926
+ * Format: date-time
1927
+ * @description Timestamp of when the resource was created.
1928
+ * @example 2024-01-01T01:01:01.001Z
1873
1929
  */
1874
- totalCount: number;
1930
+ readonly createdAt: Date;
1875
1931
  /**
1876
- * @description The page index.
1877
- * @example 1
1932
+ * Last Update Time
1933
+ * Format: date-time
1934
+ * @description Timestamp of when the resource was last updated.
1935
+ * @example 2024-01-01T01:01:01.001Z
1878
1936
  */
1879
- page: number;
1937
+ readonly updatedAt: Date;
1880
1938
  /**
1881
- * @description The maximum number of items per page.
1882
- * @example 100
1939
+ * Deletion Time
1940
+ * Format: date-time
1941
+ * @description Timestamp of when the resource was permanently deleted.
1942
+ * @example 2024-01-01T01:01:01.001Z
1883
1943
  */
1884
- pageSize: number;
1885
- /** @description The items in the current page. */
1886
- items: components['schemas']['App'][];
1887
- };
1888
- /** @description App reference
1889
- *
1890
- * Can be used as a short reference to an app if the full app object is not needed. */
1891
- AppReference: {
1944
+ readonly deletedAt?: Date;
1892
1945
  /**
1893
- * @description The ID of the app.
1894
- * @example 01G65Z755AFWAKHE12NY0CQ9FH
1946
+ * Key
1947
+ * @description A semi-unique identifier for the resource.
1895
1948
  */
1896
- id: string;
1897
- };
1898
- /**
1899
- * @description App installed status.
1900
- * @enum {string}
1901
- */
1902
- AppStatus: 'ready' | 'unauthorized';
1949
+ key: string;
1950
+ /**
1951
+ * Annotations
1952
+ * @description Set of key-value pairs managed by the system. Cannot be modified by user.
1953
+ */
1954
+ readonly annotations?: components['schemas']['Annotations'];
1955
+ /**
1956
+ * Version
1957
+ * @description Version of the add-on. Incremented when the add-on is updated.
1958
+ * @default 1
1959
+ */
1960
+ readonly version: number;
1961
+ /**
1962
+ * InstanceType
1963
+ * @description The instanceType of the add-ons. Can be "single" or "multiple".
1964
+ */
1965
+ instanceType: components['schemas']['AddonInstanceType'];
1966
+ /**
1967
+ * Currency
1968
+ * @description The currency code of the add-on.
1969
+ * @default USD
1970
+ */
1971
+ currency: components['schemas']['CurrencyCode'];
1972
+ /**
1973
+ * Effective start date
1974
+ * Format: date-time
1975
+ * @description The date and time when the add-on becomes effective. When not specified, the add-on is a draft.
1976
+ * @example 2023-01-01T01:01:01.001Z
1977
+ */
1978
+ readonly effectiveFrom?: Date;
1979
+ /**
1980
+ * Effective end date
1981
+ * Format: date-time
1982
+ * @description The date and time when the add-on is no longer effective. When not specified, the add-on is effective indefinitely.
1983
+ * @example 2023-01-01T01:01:01.001Z
1984
+ */
1985
+ readonly effectiveTo?: Date;
1986
+ /**
1987
+ * Status
1988
+ * @description The status of the add-on.
1989
+ * Computed based on the effective start and end dates:
1990
+ * - draft = no effectiveFrom
1991
+ * - active = effectiveFrom <= now < effectiveTo
1992
+ * - archived = effectiveTo <= now
1993
+ */
1994
+ readonly status: components['schemas']['AddonStatus'];
1995
+ /**
1996
+ * Rate cards
1997
+ * @description The rate cards of the add-on.
1998
+ */
1999
+ rateCards: components['schemas']['RateCard'][];
2000
+ };
2001
+ /** @description Resource create operation model. */
2002
+ AddonCreate: {
2003
+ /**
2004
+ * Display name
2005
+ * @description Human-readable name for the resource. Between 1 and 256 characters.
2006
+ */
2007
+ name: string;
2008
+ /**
2009
+ * Description
2010
+ * @description Optional description of the resource. Maximum 1024 characters.
2011
+ */
2012
+ description?: string;
2013
+ /**
2014
+ * Metadata
2015
+ * @description Additional metadata for the resource.
2016
+ */
2017
+ metadata?: components['schemas']['Metadata'] | null;
2018
+ /**
2019
+ * Key
2020
+ * @description A semi-unique identifier for the resource.
2021
+ */
2022
+ key: string;
2023
+ /**
2024
+ * InstanceType
2025
+ * @description The instanceType of the add-ons. Can be "single" or "multiple".
2026
+ */
2027
+ instanceType: components['schemas']['AddonInstanceType'];
2028
+ /**
2029
+ * Currency
2030
+ * @description The currency code of the add-on.
2031
+ * @default USD
2032
+ */
2033
+ currency: components['schemas']['CurrencyCode'];
2034
+ /**
2035
+ * Rate cards
2036
+ * @description The rate cards of the add-on.
2037
+ */
2038
+ rateCards: components['schemas']['RateCard'][];
2039
+ };
2040
+ /**
2041
+ * @description The instanceType of the add-on.
2042
+ * Single instance add-ons can be added to subscription only once while add-ons with multiple type can be added more then once.
2043
+ * @enum {string}
2044
+ */
2045
+ AddonInstanceType: 'single' | 'multiple';
2046
+ /**
2047
+ * @description Order by options for add-ons.
2048
+ * @enum {string}
2049
+ */
2050
+ AddonOrderBy: 'id' | 'key' | 'version' | 'created_at' | 'updated_at';
2051
+ /** @description Paginated response */
2052
+ AddonPaginatedResponse: {
2053
+ /**
2054
+ * @description The total number of items.
2055
+ * @example 500
2056
+ */
2057
+ totalCount: number;
2058
+ /**
2059
+ * @description The page index.
2060
+ * @example 1
2061
+ */
2062
+ page: number;
2063
+ /**
2064
+ * @description The maximum number of items per page.
2065
+ * @example 100
2066
+ */
2067
+ pageSize: number;
2068
+ /** @description The items in the current page. */
2069
+ items: components['schemas']['Addon'][];
2070
+ };
2071
+ /** @description Resource update operation model. */
2072
+ AddonReplaceUpdate: {
2073
+ /**
2074
+ * Display name
2075
+ * @description Human-readable name for the resource. Between 1 and 256 characters.
2076
+ */
2077
+ name: string;
2078
+ /**
2079
+ * Description
2080
+ * @description Optional description of the resource. Maximum 1024 characters.
2081
+ */
2082
+ description?: string;
2083
+ /**
2084
+ * Metadata
2085
+ * @description Additional metadata for the resource.
2086
+ */
2087
+ metadata?: components['schemas']['Metadata'] | null;
2088
+ /**
2089
+ * InstanceType
2090
+ * @description The instanceType of the add-ons. Can be "single" or "multiple".
2091
+ */
2092
+ instanceType: components['schemas']['AddonInstanceType'];
2093
+ /**
2094
+ * Rate cards
2095
+ * @description The rate cards of the add-on.
2096
+ */
2097
+ rateCards: components['schemas']['RateCard'][];
2098
+ };
2099
+ /**
2100
+ * @description The status of the add-on defined by the effectiveFrom and effectiveTo properties.
2101
+ * @enum {string}
2102
+ */
2103
+ AddonStatus: 'draft' | 'active' | 'archived';
2104
+ /** @description Address */
2105
+ Address: {
2106
+ /** @description Country code in [ISO 3166-1](https://www.iso.org/iso-3166-country-codes.html) alpha-2 format. */
2107
+ country?: components['schemas']['CountryCode'];
2108
+ /** @description Postal code. */
2109
+ postalCode?: string;
2110
+ /** @description State or province. */
2111
+ state?: string;
2112
+ /** @description City. */
2113
+ city?: string;
2114
+ /** @description First line of the address. */
2115
+ line1?: string;
2116
+ /** @description Second line of the address. */
2117
+ line2?: string;
2118
+ /** @description Phone number. */
2119
+ phoneNumber?: string;
2120
+ };
2121
+ /** @description Alignment configuration for a plan or subscription. */
2122
+ Alignment: {
2123
+ /** @description Whether all Billable items and RateCards must align.
2124
+ * Alignment means the Price's BillingCadence must align for both duration and anchor time. */
2125
+ billablesMustAlign?: boolean;
2126
+ };
2127
+ /**
2128
+ * @description Set of key-value pairs managed by the system. Cannot be modified by user.
2129
+ * @example {
2130
+ * "externalId": "019142cc-a016-796a-8113-1a942fecd26d"
2131
+ * }
2132
+ */
2133
+ Annotations: {
2134
+ [key: string]: unknown;
2135
+ };
2136
+ /** @description App.
2137
+ * One of: stripe */
2138
+ App: components['schemas']['StripeApp'] | components['schemas']['SandboxApp'];
2139
+ /** @description Resource update operation model. */
2140
+ AppBaseReplaceUpdate: {
2141
+ /**
2142
+ * Display name
2143
+ * @description Human-readable name for the resource. Between 1 and 256 characters.
2144
+ */
2145
+ name: string;
2146
+ /**
2147
+ * Description
2148
+ * @description Optional description of the resource. Maximum 1024 characters.
2149
+ */
2150
+ description?: string;
2151
+ /**
2152
+ * Metadata
2153
+ * @description Additional metadata for the resource.
2154
+ */
2155
+ metadata?: components['schemas']['Metadata'] | null;
2156
+ /** @description Default for the app type
2157
+ * Only one app of each type can be default. */
2158
+ default: boolean;
2159
+ };
2160
+ /**
2161
+ * @description App capability.
2162
+ *
2163
+ * Capabilities only exist in config so they don't extend the Resource model.
2164
+ * @example {
2165
+ * "type": "collectPayments",
2166
+ * "key": "stripe_collect_payment",
2167
+ * "name": "Collect Payments",
2168
+ * "description": "Stripe payments collects outstanding revenue with Stripe customer's default payment method."
2169
+ * }
2170
+ */
2171
+ AppCapability: {
2172
+ /** @description The capability type. */
2173
+ type: components['schemas']['AppCapabilityType'];
2174
+ /** @description Key */
2175
+ key: string;
2176
+ /** @description The capability name. */
2177
+ name: string;
2178
+ /** @description The capability description. */
2179
+ description: string;
2180
+ };
2181
+ /**
2182
+ * @description App capability type.
2183
+ * @enum {string}
2184
+ */
2185
+ AppCapabilityType: 'reportUsage' | 'reportEvents' | 'calculateTax' | 'invoiceCustomers' | 'collectPayments';
2186
+ /** @description Paginated response */
2187
+ AppPaginatedResponse: {
2188
+ /**
2189
+ * @description The total number of items.
2190
+ * @example 500
2191
+ */
2192
+ totalCount: number;
2193
+ /**
2194
+ * @description The page index.
2195
+ * @example 1
2196
+ */
2197
+ page: number;
2198
+ /**
2199
+ * @description The maximum number of items per page.
2200
+ * @example 100
2201
+ */
2202
+ pageSize: number;
2203
+ /** @description The items in the current page. */
2204
+ items: components['schemas']['App'][];
2205
+ };
2206
+ /** @description App reference
2207
+ *
2208
+ * Can be used as a short reference to an app if the full app object is not needed. */
2209
+ AppReference: {
2210
+ /**
2211
+ * @description The ID of the app.
2212
+ * @example 01G65Z755AFWAKHE12NY0CQ9FH
2213
+ */
2214
+ id: string;
2215
+ };
2216
+ /**
2217
+ * @description App installed status.
2218
+ * @enum {string}
2219
+ */
2220
+ AppStatus: 'ready' | 'unauthorized';
1903
2221
  /**
1904
2222
  * @description Type of the app.
1905
2223
  * @enum {string}
@@ -2976,14 +3294,12 @@ export interface components {
2976
3294
  */
2977
3295
  subjectKeys: string[];
2978
3296
  };
2979
- /** @description A discount on a price.
2980
- * One of: percentage, amount, or usage. */
2981
- Discount: components['schemas']['DiscountPercentage'];
3297
+ /** @description A discount on a price. */
3298
+ Discount: components['schemas']['DiscountPercentage'] | components['schemas']['DiscountUsage'];
2982
3299
  /** @description Percentage discount. */
2983
3300
  DiscountPercentage: {
2984
3301
  /**
2985
- * Type
2986
- * @description The type of the discount.
3302
+ * @description The type of the discount. (enum property replaced by openapi-typescript)
2987
3303
  * @enum {string}
2988
3304
  */
2989
3305
  type: 'percentage';
@@ -2992,22 +3308,65 @@ export interface components {
2992
3308
  * @description The percentage of the discount.
2993
3309
  */
2994
3310
  percentage: components['schemas']['Percentage'];
3311
+ };
3312
+ /** @description Usage discount.
3313
+ *
3314
+ * Usage discount means that the first N items are free. From billing perspective
3315
+ * this means that any usage on a specific feature is considered 0 until this discount
3316
+ * is exhausted. */
3317
+ DiscountUsage: {
2995
3318
  /**
2996
- * Discounted RateCards
2997
- * @description The rate cards that the discount applies to.
2998
- * When not specified, the discount applies to all rate cards.
3319
+ * @description The type of the discount. (enum property replaced by openapi-typescript)
3320
+ * @enum {string}
3321
+ */
3322
+ type: 'usage';
3323
+ /**
3324
+ * Usage
3325
+ * @description The quantity of the usage discount.
3326
+ *
3327
+ * Must be positive.
2999
3328
  */
3000
- rateCards?: string[];
3329
+ quantity: components['schemas']['Numeric'];
3001
3330
  };
3002
- /** @description Add a new item to a phase. */
3003
- EditSubscriptionAddItem: {
3331
+ /** @description Dynamic price with spend commitments. */
3332
+ DynamicPriceWithCommitments: {
3004
3333
  /**
3005
- * @description discriminator enum property added by openapi-typescript
3334
+ * @description The type of the price. (enum property replaced by openapi-typescript)
3006
3335
  * @enum {string}
3007
3336
  */
3008
- op: 'add_item';
3009
- phaseKey: string;
3010
- rateCard: components['schemas']['RateCard'];
3337
+ type: 'dynamic';
3338
+ /**
3339
+ * The rate to apply to the base price to get the dynamic price
3340
+ * @description The rate to apply to the base price to get the dynamic price.
3341
+ *
3342
+ * Examples:
3343
+ * - 0.0: the price is zero
3344
+ * - 0.5: the price is 50% of the base price
3345
+ * - 1.0: the price is the same as the base price
3346
+ * - 1.5: the price is 150% of the base price
3347
+ * @default 1
3348
+ */
3349
+ markupRate?: components['schemas']['Numeric'];
3350
+ /**
3351
+ * Minimum amount
3352
+ * @description The customer is committed to spend at least the amount.
3353
+ */
3354
+ minimumAmount?: components['schemas']['Numeric'];
3355
+ /**
3356
+ * Maximum amount
3357
+ * @description The customer is limited to spend at most the amount.
3358
+ */
3359
+ maximumAmount?: components['schemas']['Numeric'];
3360
+ };
3361
+ /** @description Add a new item to a phase. */
3362
+ EditSubscriptionAddItem: {
3363
+ /**
3364
+ * @description discriminator enum property added by openapi-typescript
3365
+ * @enum {string}
3366
+ */
3367
+ op: 'add_item';
3368
+ phaseKey: string;
3369
+ rateCard: components['schemas']['RateCard'];
3011
3370
  };
3012
3371
  /** @description Add a new phase */
3013
3372
  EditSubscriptionAddPhase: {
@@ -3097,6 +3456,13 @@ export interface components {
3097
3456
  * @example 2023-01-01T01:01:01.001Z
3098
3457
  */
3099
3458
  activeTo?: Date;
3459
+ /**
3460
+ * @description The annotations of the entitlement.
3461
+ * @example {
3462
+ * "subscription.id": "sub_123"
3463
+ * }
3464
+ */
3465
+ readonly annotations?: components['schemas']['Annotations'];
3100
3466
  /**
3101
3467
  * @description Readonly unique ULID identifier.
3102
3468
  * @example 01ARZ3NDEKTSV4RRFFQ69G5FAV
@@ -3166,6 +3532,13 @@ export interface components {
3166
3532
  * @example 2023-01-01T01:01:01.001Z
3167
3533
  */
3168
3534
  activeTo?: Date;
3535
+ /**
3536
+ * @description The annotations of the entitlement.
3537
+ * @example {
3538
+ * "subscription.id": "sub_123"
3539
+ * }
3540
+ */
3541
+ readonly annotations?: components['schemas']['Annotations'];
3169
3542
  /**
3170
3543
  * @description Readonly unique ULID identifier.
3171
3544
  * @example 01ARZ3NDEKTSV4RRFFQ69G5FAV
@@ -3190,7 +3563,13 @@ export interface components {
3190
3563
  currentUsagePeriod?: components['schemas']['Period'];
3191
3564
  /** @description The defined usage period of the entitlement */
3192
3565
  usagePeriod?: components['schemas']['RecurringPeriod'];
3193
- } & WithRequired<components['schemas']['EntitlementBaseTemplate'], 'type' | 'createdAt' | 'updatedAt' | 'activeFrom' | 'id' | 'subjectKey' | 'featureKey' | 'featureId'>;
3566
+ } & (WithRequired<components['schemas']['EntitlementBaseTemplate'], 'type' | 'createdAt' | 'updatedAt' | 'activeFrom' | 'id' | 'subjectKey' | 'featureKey' | 'featureId'> & {
3567
+ /**
3568
+ * @description discriminator enum property added by openapi-typescript
3569
+ * @enum {string}
3570
+ */
3571
+ type: 'boolean';
3572
+ });
3194
3573
  /** @description Create inputs for boolean entitlement */
3195
3574
  EntitlementBooleanCreateInputs: {
3196
3575
  /**
@@ -3209,7 +3588,10 @@ export interface components {
3209
3588
  metadata?: components['schemas']['Metadata'];
3210
3589
  /** @description The usage period associated with the entitlement. */
3211
3590
  usagePeriod?: components['schemas']['RecurringPeriodCreateInput'];
3212
- /** @enum {string} */
3591
+ /**
3592
+ * @description discriminator enum property added by openapi-typescript
3593
+ * @enum {string}
3594
+ */
3213
3595
  type: 'boolean';
3214
3596
  };
3215
3597
  /** @description Create inputs for entitlement */
@@ -3372,7 +3754,10 @@ export interface components {
3372
3754
  /** @description Metered entitlements are useful for many different use cases, from setting up usage based access to implementing complex credit systems.
3373
3755
  * Access is determined based on feature usage using a balance calculation (the "usage allowance" provided by the issued grants is "burnt down" by the usage). */
3374
3756
  EntitlementMetered: {
3375
- /** @enum {string} */
3757
+ /**
3758
+ * @description discriminator enum property added by openapi-typescript
3759
+ * @enum {string}
3760
+ */
3376
3761
  type: 'metered';
3377
3762
  /**
3378
3763
  * Soft limit
@@ -3443,6 +3828,13 @@ export interface components {
3443
3828
  * @example 2023-01-01T01:01:01.001Z
3444
3829
  */
3445
3830
  activeTo?: Date;
3831
+ /**
3832
+ * @description The annotations of the entitlement.
3833
+ * @example {
3834
+ * "subscription.id": "sub_123"
3835
+ * }
3836
+ */
3837
+ readonly annotations?: components['schemas']['Annotations'];
3446
3838
  /**
3447
3839
  * @description Readonly unique ULID identifier.
3448
3840
  * @example 01ARZ3NDEKTSV4RRFFQ69G5FAV
@@ -3496,7 +3888,10 @@ export interface components {
3496
3888
  featureId?: string;
3497
3889
  /** @description Additional metadata for the feature. */
3498
3890
  metadata?: components['schemas']['Metadata'];
3499
- /** @enum {string} */
3891
+ /**
3892
+ * @description discriminator enum property added by openapi-typescript
3893
+ * @enum {string}
3894
+ */
3500
3895
  type: 'metered';
3501
3896
  /**
3502
3897
  * Soft limit
@@ -3564,7 +3959,10 @@ export interface components {
3564
3959
  };
3565
3960
  /** @description A static entitlement. */
3566
3961
  EntitlementStatic: {
3567
- /** @enum {string} */
3962
+ /**
3963
+ * @description discriminator enum property added by openapi-typescript
3964
+ * @enum {string}
3965
+ */
3568
3966
  type: 'static';
3569
3967
  /**
3570
3968
  * Format: json
@@ -3607,6 +4005,13 @@ export interface components {
3607
4005
  * @example 2023-01-01T01:01:01.001Z
3608
4006
  */
3609
4007
  activeTo?: Date;
4008
+ /**
4009
+ * @description The annotations of the entitlement.
4010
+ * @example {
4011
+ * "subscription.id": "sub_123"
4012
+ * }
4013
+ */
4014
+ readonly annotations?: components['schemas']['Annotations'];
3610
4015
  /**
3611
4016
  * @description Readonly unique ULID identifier.
3612
4017
  * @example 01ARZ3NDEKTSV4RRFFQ69G5FAV
@@ -3650,7 +4055,10 @@ export interface components {
3650
4055
  metadata?: components['schemas']['Metadata'];
3651
4056
  /** @description The usage period associated with the entitlement. */
3652
4057
  usagePeriod?: components['schemas']['RecurringPeriodCreateInput'];
3653
- /** @enum {string} */
4058
+ /**
4059
+ * @description discriminator enum property added by openapi-typescript
4060
+ * @enum {string}
4061
+ */
3654
4062
  type: 'static';
3655
4063
  /**
3656
4064
  * Format: json
@@ -3904,7 +4312,7 @@ export interface components {
3904
4312
  * @description Order by options for features.
3905
4313
  * @enum {string}
3906
4314
  */
3907
- FeatureOrderBy: 'id' | 'createdAt' | 'updatedAt';
4315
+ FeatureOrderBy: 'id' | 'key' | 'name' | 'createdAt' | 'updatedAt';
3908
4316
  /** @description Paginated response */
3909
4317
  FeaturePaginatedResponse: {
3910
4318
  /**
@@ -4430,7 +4838,7 @@ export interface components {
4430
4838
  /** @description Subscription are the references to the subscritpions that this line is related to. */
4431
4839
  readonly subscriptions?: components['schemas']['InvoiceLineSubscriptionReference'];
4432
4840
  /**
4433
- * @description Type of the line.
4841
+ * @description Type of the line. (enum property replaced by openapi-typescript)
4434
4842
  * @enum {string}
4435
4843
  */
4436
4844
  type: 'flat_fee';
@@ -4481,7 +4889,7 @@ export interface components {
4481
4889
  */
4482
4890
  invoiceAt: Date;
4483
4891
  /**
4484
- * @description Type of the line.
4892
+ * @description Type of the line. (enum property replaced by openapi-typescript)
4485
4893
  * @enum {string}
4486
4894
  */
4487
4895
  type: 'flat_fee';
@@ -4537,7 +4945,7 @@ export interface components {
4537
4945
  */
4538
4946
  invoiceAt: Date;
4539
4947
  /**
4540
- * @description Type of the line.
4948
+ * @description Type of the line. (enum property replaced by openapi-typescript)
4541
4949
  * @enum {string}
4542
4950
  */
4543
4951
  type: 'flat_fee';
@@ -4810,7 +5218,7 @@ export interface components {
4810
5218
  */
4811
5219
  invoiceAt: Date;
4812
5220
  /**
4813
- * @description Type of the line.
5221
+ * @description Type of the line. (enum property replaced by openapi-typescript)
4814
5222
  * @enum {string}
4815
5223
  */
4816
5224
  type: 'flat_fee';
@@ -4879,7 +5287,7 @@ export interface components {
4879
5287
  */
4880
5288
  invoiceAt: Date;
4881
5289
  /**
4882
- * @description Type of the line.
5290
+ * @description Type of the line. (enum property replaced by openapi-typescript)
4883
5291
  * @enum {string}
4884
5292
  */
4885
5293
  type: 'usage_based';
@@ -5029,7 +5437,7 @@ export interface components {
5029
5437
  /** @description Subscription are the references to the subscritpions that this line is related to. */
5030
5438
  readonly subscriptions?: components['schemas']['InvoiceLineSubscriptionReference'];
5031
5439
  /**
5032
- * @description Type of the line.
5440
+ * @description Type of the line. (enum property replaced by openapi-typescript)
5033
5441
  * @enum {string}
5034
5442
  */
5035
5443
  type: 'usage_based';
@@ -5076,7 +5484,7 @@ export interface components {
5076
5484
  */
5077
5485
  invoiceAt: Date;
5078
5486
  /**
5079
- * @description Type of the line.
5487
+ * @description Type of the line. (enum property replaced by openapi-typescript)
5080
5488
  * @enum {string}
5081
5489
  */
5082
5490
  type: 'usage_based';
@@ -5122,7 +5530,7 @@ export interface components {
5122
5530
  */
5123
5531
  invoiceAt: Date;
5124
5532
  /**
5125
- * @description Type of the line.
5533
+ * @description Type of the line. (enum property replaced by openapi-typescript)
5126
5534
  * @enum {string}
5127
5535
  */
5128
5536
  type: 'usage_based';
@@ -5482,6 +5890,11 @@ export interface components {
5482
5890
  [key: string]: string;
5483
5891
  };
5484
5892
  };
5893
+ /**
5894
+ * @description Order by options for meters.
5895
+ * @enum {string}
5896
+ */
5897
+ MeterOrderBy: 'key' | 'name' | 'aggregation' | 'createdAt' | 'updatedAt';
5485
5898
  /**
5486
5899
  * @description The result of a meter query.
5487
5900
  * @example {
@@ -5628,7 +6041,7 @@ export interface components {
5628
6041
  * Channel Type
5629
6042
  * @description Notification channel type.
5630
6043
  */
5631
- readonly type: components['schemas']['NotificationChannelType'];
6044
+ type: components['schemas']['NotificationChannelType'];
5632
6045
  };
5633
6046
  /**
5634
6047
  * @description Order by options for notification channels.
@@ -6070,6 +6483,34 @@ export interface components {
6070
6483
  * @enum {string}
6071
6484
  */
6072
6485
  OAuth2AuthorizationCodeGrantErrorType: 'invalid_request' | 'unauthorized_client' | 'access_denied' | 'unsupported_response_type' | 'invalid_scope' | 'server_error' | 'temporarily_unavailable';
6486
+ /** @description Package price with spend commitments. */
6487
+ PackagePriceWithCommitments: {
6488
+ /**
6489
+ * @description The type of the price. (enum property replaced by openapi-typescript)
6490
+ * @enum {string}
6491
+ */
6492
+ type: 'package';
6493
+ /**
6494
+ * Amount
6495
+ * @description The price of one package.
6496
+ */
6497
+ amount: components['schemas']['Numeric'];
6498
+ /**
6499
+ * Quantity per package
6500
+ * @description The quantity per package.
6501
+ */
6502
+ quantityPerPackage: components['schemas']['Numeric'];
6503
+ /**
6504
+ * Minimum amount
6505
+ * @description The customer is committed to spend at least the amount.
6506
+ */
6507
+ minimumAmount?: components['schemas']['Numeric'];
6508
+ /**
6509
+ * Maximum amount
6510
+ * @description The customer is limited to spend at most the amount.
6511
+ */
6512
+ maximumAmount?: components['schemas']['Numeric'];
6513
+ };
6073
6514
  /** @description PaymentDueDate contains an amount that should be paid by the given date. */
6074
6515
  PaymentDueDate: {
6075
6516
  /**
@@ -6273,7 +6714,7 @@ export interface components {
6273
6714
  * @description Order by options for plans.
6274
6715
  * @enum {string}
6275
6716
  */
6276
- PlanOrderBy: 'id' | 'key' | 'version' | 'create_at' | 'updated_at';
6717
+ PlanOrderBy: 'id' | 'key' | 'version' | 'created_at' | 'updated_at';
6277
6718
  /** @description Paginated response */
6278
6719
  PlanPaginatedResponse: {
6279
6720
  /**
@@ -6328,11 +6769,6 @@ export interface components {
6328
6769
  * @description The rate cards of the plan.
6329
6770
  */
6330
6771
  rateCards: components['schemas']['RateCard'][];
6331
- /**
6332
- * Discounts
6333
- * @description The discounts on the plan.
6334
- */
6335
- discounts?: components['schemas']['Discount'][];
6336
6772
  };
6337
6773
  /** @description References an exact plan. */
6338
6774
  PlanReference: {
@@ -6522,7 +6958,10 @@ export interface components {
6522
6958
  RateCardBooleanEntitlement: {
6523
6959
  /** @description Additional metadata for the feature. */
6524
6960
  metadata?: components['schemas']['Metadata'];
6525
- /** @enum {string} */
6961
+ /**
6962
+ * @description discriminator enum property added by openapi-typescript
6963
+ * @enum {string}
6964
+ */
6526
6965
  type: 'boolean';
6527
6966
  };
6528
6967
  /** @description Entitlement templates are used to define the entitlements of a plan.
@@ -6587,12 +7026,21 @@ export interface components {
6587
7026
  * }
6588
7027
  */
6589
7028
  price: components['schemas']['FlatPriceWithPaymentTerm'] | null;
7029
+ /**
7030
+ * Discounts
7031
+ * @description The discount of the rate card. For flat fee rate cards only percentage discounts are supported.
7032
+ * Only available when price is set.
7033
+ */
7034
+ discounts?: components['schemas']['DiscountPercentage'][];
6590
7035
  };
6591
7036
  /** @description The entitlement template with a metered entitlement. */
6592
7037
  RateCardMeteredEntitlement: {
6593
7038
  /** @description Additional metadata for the feature. */
6594
7039
  metadata?: components['schemas']['Metadata'];
6595
- /** @enum {string} */
7040
+ /**
7041
+ * @description discriminator enum property added by openapi-typescript
7042
+ * @enum {string}
7043
+ */
6596
7044
  type: 'metered';
6597
7045
  /**
6598
7046
  * Soft limit
@@ -6634,7 +7082,10 @@ export interface components {
6634
7082
  RateCardStaticEntitlement: {
6635
7083
  /** @description Additional metadata for the feature. */
6636
7084
  metadata?: components['schemas']['Metadata'];
6637
- /** @enum {string} */
7085
+ /**
7086
+ * @description discriminator enum property added by openapi-typescript
7087
+ * @enum {string}
7088
+ */
6638
7089
  type: 'static';
6639
7090
  /**
6640
7091
  * Format: json
@@ -6693,9 +7144,16 @@ export interface components {
6693
7144
  /** @description The price of the rate card.
6694
7145
  * When null, the feature or service is free. */
6695
7146
  price: components['schemas']['RateCardUsageBasedPrice'] | null;
7147
+ /**
7148
+ * Discounts
7149
+ * @description The discounts of the rate card.
7150
+ *
7151
+ * Flat fee rate cards only support percentage discounts.
7152
+ */
7153
+ discounts?: components['schemas']['Discount'][];
6696
7154
  };
6697
7155
  /** @description The price of the usage based rate card. */
6698
- RateCardUsageBasedPrice: components['schemas']['FlatPriceWithPaymentTerm'] | components['schemas']['UnitPriceWithCommitments'] | components['schemas']['TieredPriceWithCommitments'];
7156
+ RateCardUsageBasedPrice: components['schemas']['FlatPriceWithPaymentTerm'] | components['schemas']['UnitPriceWithCommitments'] | components['schemas']['TieredPriceWithCommitments'] | components['schemas']['DynamicPriceWithCommitments'] | components['schemas']['PackagePriceWithCommitments'];
6699
7157
  /**
6700
7158
  * @description Recurring period with an interval and an anchor.
6701
7159
  * @example {
@@ -6829,7 +7287,7 @@ export interface components {
6829
7287
  * Only one app of each type can be default. */
6830
7288
  default: boolean;
6831
7289
  /**
6832
- * @description The app's type is Sandbox.
7290
+ * @description The app's type is Sandbox. (enum property replaced by openapi-typescript)
6833
7291
  * @enum {string}
6834
7292
  */
6835
7293
  type: 'sandbox';
@@ -6846,8 +7304,7 @@ export interface components {
6846
7304
  */
6847
7305
  id?: string;
6848
7306
  /**
6849
- * App Type
6850
- * @description The app name.
7307
+ * @description The app name. (enum property replaced by openapi-typescript)
6851
7308
  * @enum {string}
6852
7309
  */
6853
7310
  type: 'sandbox';
@@ -6955,7 +7412,7 @@ export interface components {
6955
7412
  * Only one app of each type can be default. */
6956
7413
  default: boolean;
6957
7414
  /**
6958
- * @description The app's type is Stripe.
7415
+ * @description The app's type is Stripe. (enum property replaced by openapi-typescript)
6959
7416
  * @enum {string}
6960
7417
  */
6961
7418
  type: 'stripe';
@@ -6988,8 +7445,7 @@ export interface components {
6988
7445
  */
6989
7446
  id?: string;
6990
7447
  /**
6991
- * App Type
6992
- * @description The app name.
7448
+ * @description The app name. (enum property replaced by openapi-typescript)
6993
7449
  * @enum {string}
6994
7450
  */
6995
7451
  type: 'stripe';
@@ -7414,6 +7870,11 @@ export interface components {
7414
7870
  * @example {}
7415
7871
  */
7416
7872
  price: components['schemas']['RateCardUsageBasedPrice'] | null;
7873
+ /**
7874
+ * Discounts
7875
+ * @description The discounts applied to the rate card.
7876
+ */
7877
+ discounts?: components['schemas']['Discount'][];
7417
7878
  /** @description Describes what access is gained via the SubscriptionItem */
7418
7879
  included?: components['schemas']['SubscriptionItemIncluded'];
7419
7880
  /**
@@ -7805,7 +8266,7 @@ export interface components {
7805
8266
  /** @description VoidInvoiceLineDiscardAction describes how to handle the voidied line item in the invoice. */
7806
8267
  VoidInvoiceLineDiscardAction: {
7807
8268
  /**
7808
- * @description The action to take on the line item.
8269
+ * @description The action to take on the line item. (enum property replaced by openapi-typescript)
7809
8270
  * @enum {string}
7810
8271
  */
7811
8272
  type: 'discard';
@@ -7813,7 +8274,7 @@ export interface components {
7813
8274
  /** @description VoidInvoiceLinePendingAction describes how to handle the voidied line item in the invoice. */
7814
8275
  VoidInvoiceLinePendingActionCreate: {
7815
8276
  /**
7816
- * @description The action to take on the line item.
8277
+ * @description The action to take on the line item. (enum property replaced by openapi-typescript)
7817
8278
  * @enum {string}
7818
8279
  */
7819
8280
  type: 'pending';
@@ -7829,7 +8290,7 @@ export interface components {
7829
8290
  /** @description VoidInvoiceLinePendingAction describes how to handle the voidied line item in the invoice. */
7830
8291
  VoidInvoiceLinePendingActionCreateItem: {
7831
8292
  /**
7832
- * @description The action to take on the line item.
8293
+ * @description The action to take on the line item. (enum property replaced by openapi-typescript)
7833
8294
  * @enum {string}
7834
8295
  */
7835
8296
  type: 'pending';
@@ -7860,6 +8321,10 @@ export interface components {
7860
8321
  };
7861
8322
  responses: never;
7862
8323
  parameters: {
8324
+ /** @description The order direction. */
8325
+ 'AddonOrderByOrdering.order': components['schemas']['SortOrder'];
8326
+ /** @description The order by field. */
8327
+ 'AddonOrderByOrdering.orderBy': components['schemas']['AddonOrderBy'];
7863
8328
  /** @description The order direction. */
7864
8329
  'BillingProfileCustomerOverrideOrderByOrdering.order': components['schemas']['SortOrder'];
7865
8330
  /** @description The order by field. */
@@ -7936,30 +8401,48 @@ export interface components {
7936
8401
  'MarketplaceApiKeyInstallRequest.type': components['schemas']['AppType'];
7937
8402
  /** @description The type of the app to install. */
7938
8403
  'MarketplaceOAuth2InstallAuthorizeRequest.type': components['schemas']['AppType'];
8404
+ /** @description The order direction. */
8405
+ 'MeterOrderByOrdering.order': components['schemas']['SortOrder'];
8406
+ /** @description The order by field. */
8407
+ 'MeterOrderByOrdering.orderBy': components['schemas']['MeterOrderBy'];
7939
8408
  /** @description Client ID
7940
8409
  * Useful to track progress of a query. */
7941
8410
  'MeterQuery.clientId': string;
7942
- /** @description Simple filter for group bys with exact match. */
8411
+ /** @description Simple filter for group bys with exact match.
8412
+ *
8413
+ * For example: ?filterGroupBy[vendor]=openai&filterGroupBy[model]=gpt-4-turbo */
7943
8414
  'MeterQuery.filterGroupBy': {
7944
8415
  [key: string]: string;
7945
8416
  };
7946
8417
  /** @description Start date-time in RFC 3339 format.
7947
8418
  *
7948
- * Inclusive. */
8419
+ * Inclusive.
8420
+ *
8421
+ * For example: ?from=2025-01-01T00%3A00%3A00.000Z */
7949
8422
  'MeterQuery.from': Date | string;
7950
8423
  /** @description If not specified a single aggregate will be returned for each subject and time window.
7951
- * `subject` is a reserved group by value. */
8424
+ * `subject` is a reserved group by value.
8425
+ *
8426
+ * For example: ?groupBy=subject&groupBy=model */
7952
8427
  'MeterQuery.groupBy': string[];
7953
- /** @description Filtering by multiple subjects. */
8428
+ /** @description Filtering by multiple subjects.
8429
+ *
8430
+ * For example: ?subject=customer-1&subject=customer-2 */
7954
8431
  'MeterQuery.subject': string[];
7955
8432
  /** @description End date-time in RFC 3339 format.
7956
8433
  *
7957
- * Inclusive. */
8434
+ * Inclusive.
8435
+ *
8436
+ * For example: ?to=2025-02-01T00%3A00%3A00.000Z */
7958
8437
  'MeterQuery.to': Date | string;
7959
- /** @description If not specified, a single usage aggregate will be returned for the entirety of the specified period for each subject and group. */
8438
+ /** @description If not specified, a single usage aggregate will be returned for the entirety of the specified period for each subject and group.
8439
+ *
8440
+ * For example: ?windowSize=DAY */
7960
8441
  'MeterQuery.windowSize': components['schemas']['WindowSize'];
7961
8442
  /** @description The value is the name of the time zone as defined in the IANA Time Zone Database (http://www.iana.org/time-zones).
7962
- * If not specified, the UTC timezone will be used. */
8443
+ * If not specified, the UTC timezone will be used.
8444
+ *
8445
+ * For example: ?windowTimeZone=UTC */
7963
8446
  'MeterQuery.windowTimeZone': string;
7964
8447
  /** @description The order direction. */
7965
8448
  'NotificationChannelOrderByOrdering.order': components['schemas']['SortOrder'];
@@ -8022,11 +8505,20 @@ export interface components {
8022
8505
  'queryCustomerList.subject': string;
8023
8506
  /** @description Filter customer data by app type. */
8024
8507
  'queryCustomerList.type': components['schemas']['AppType'];
8508
+ /** @description Include deleted meters. */
8509
+ 'queryMeterList.includeDeleted': boolean;
8025
8510
  };
8026
8511
  requestBodies: never;
8027
8512
  headers: never;
8028
8513
  pathItems: never;
8029
8514
  }
8515
+ export type Addon = components['schemas']['Addon'];
8516
+ export type AddonCreate = components['schemas']['AddonCreate'];
8517
+ export type AddonInstanceType = components['schemas']['AddonInstanceType'];
8518
+ export type AddonOrderBy = components['schemas']['AddonOrderBy'];
8519
+ export type AddonPaginatedResponse = components['schemas']['AddonPaginatedResponse'];
8520
+ export type AddonReplaceUpdate = components['schemas']['AddonReplaceUpdate'];
8521
+ export type AddonStatus = components['schemas']['AddonStatus'];
8030
8522
  export type Address = components['schemas']['Address'];
8031
8523
  export type Alignment = components['schemas']['Alignment'];
8032
8524
  export type Annotations = components['schemas']['Annotations'];
@@ -8107,6 +8599,8 @@ export type CustomerReplaceUpdate = components['schemas']['CustomerReplaceUpdate
8107
8599
  export type CustomerUsageAttribution = components['schemas']['CustomerUsageAttribution'];
8108
8600
  export type Discount = components['schemas']['Discount'];
8109
8601
  export type DiscountPercentage = components['schemas']['DiscountPercentage'];
8602
+ export type DiscountUsage = components['schemas']['DiscountUsage'];
8603
+ export type DynamicPriceWithCommitments = components['schemas']['DynamicPriceWithCommitments'];
8110
8604
  export type EditSubscriptionAddItem = components['schemas']['EditSubscriptionAddItem'];
8111
8605
  export type EditSubscriptionAddPhase = components['schemas']['EditSubscriptionAddPhase'];
8112
8606
  export type EditSubscriptionRemoveItem = components['schemas']['EditSubscriptionRemoveItem'];
@@ -8209,6 +8703,7 @@ export type Metadata = components['schemas']['Metadata'];
8209
8703
  export type Meter = components['schemas']['Meter'];
8210
8704
  export type MeterAggregation = components['schemas']['MeterAggregation'];
8211
8705
  export type MeterCreate = components['schemas']['MeterCreate'];
8706
+ export type MeterOrderBy = components['schemas']['MeterOrderBy'];
8212
8707
  export type MeterQueryResult = components['schemas']['MeterQueryResult'];
8213
8708
  export type MeterQueryRow = components['schemas']['MeterQueryRow'];
8214
8709
  export type MeterUpdate = components['schemas']['MeterUpdate'];
@@ -8241,6 +8736,7 @@ export type NotificationRuleOrderBy = components['schemas']['NotificationRuleOrd
8241
8736
  export type NotificationRulePaginatedResponse = components['schemas']['NotificationRulePaginatedResponse'];
8242
8737
  export type Numeric = components['schemas']['Numeric'];
8243
8738
  export type OAuth2AuthorizationCodeGrantErrorType = components['schemas']['OAuth2AuthorizationCodeGrantErrorType'];
8739
+ export type PackagePriceWithCommitments = components['schemas']['PackagePriceWithCommitments'];
8244
8740
  export type PaymentDueDate = components['schemas']['PaymentDueDate'];
8245
8741
  export type PaymentTermDueDate = components['schemas']['PaymentTermDueDate'];
8246
8742
  export type PaymentTermInstant = components['schemas']['PaymentTermInstant'];
@@ -8328,6 +8824,8 @@ export type VoidInvoiceLinePendingActionCreate = components['schemas']['VoidInvo
8328
8824
  export type VoidInvoiceLinePendingActionCreateItem = components['schemas']['VoidInvoiceLinePendingActionCreateItem'];
8329
8825
  export type WindowSize = components['schemas']['WindowSize'];
8330
8826
  export type WindowedBalanceHistory = components['schemas']['WindowedBalanceHistory'];
8827
+ export type ParameterAddonOrderByOrderingOrder = components['parameters']['AddonOrderByOrdering.order'];
8828
+ export type ParameterAddonOrderByOrderingOrderBy = components['parameters']['AddonOrderByOrdering.orderBy'];
8331
8829
  export type ParameterBillingProfileCustomerOverrideOrderByOrderingOrder = components['parameters']['BillingProfileCustomerOverrideOrderByOrdering.order'];
8332
8830
  export type ParameterBillingProfileCustomerOverrideOrderByOrderingOrderBy = components['parameters']['BillingProfileCustomerOverrideOrderByOrdering.orderBy'];
8333
8831
  export type ParameterBillingProfileListCustomerOverridesParamsBillingProfile = components['parameters']['BillingProfileListCustomerOverridesParams.billingProfile'];
@@ -8362,6 +8860,8 @@ export type ParameterLimitOffsetLimit = components['parameters']['LimitOffset.li
8362
8860
  export type ParameterLimitOffsetOffset = components['parameters']['LimitOffset.offset'];
8363
8861
  export type ParameterMarketplaceApiKeyInstallRequestType = components['parameters']['MarketplaceApiKeyInstallRequest.type'];
8364
8862
  export type ParameterMarketplaceOAuth2InstallAuthorizeRequestType = components['parameters']['MarketplaceOAuth2InstallAuthorizeRequest.type'];
8863
+ export type ParameterMeterOrderByOrderingOrder = components['parameters']['MeterOrderByOrdering.order'];
8864
+ export type ParameterMeterOrderByOrderingOrderBy = components['parameters']['MeterOrderByOrdering.orderBy'];
8365
8865
  export type ParameterMeterQueryClientId = components['parameters']['MeterQuery.clientId'];
8366
8866
  export type ParameterMeterQueryFilterGroupBy = components['parameters']['MeterQuery.filterGroupBy'];
8367
8867
  export type ParameterMeterQueryFrom = components['parameters']['MeterQuery.from'];
@@ -8392,8 +8892,690 @@ export type ParameterQueryCustomerListPlanKey = components['parameters']['queryC
8392
8892
  export type ParameterQueryCustomerListPrimaryEmail = components['parameters']['queryCustomerList.primaryEmail'];
8393
8893
  export type ParameterQueryCustomerListSubject = components['parameters']['queryCustomerList.subject'];
8394
8894
  export type ParameterQueryCustomerListType = components['parameters']['queryCustomerList.type'];
8895
+ export type ParameterQueryMeterListIncludeDeleted = components['parameters']['queryMeterList.includeDeleted'];
8395
8896
  export type $defs = Record<string, never>;
8396
8897
  export interface operations {
8898
+ listAddons: {
8899
+ parameters: {
8900
+ query?: {
8901
+ /** @description Include deleted add-ons in response.
8902
+ *
8903
+ * Usage: `?includeDeleted=true` */
8904
+ includeDeleted?: boolean;
8905
+ /** @description Filter by addon.id attribute */
8906
+ id?: string[];
8907
+ /** @description Filter by addon.key attribute */
8908
+ key?: string[];
8909
+ /** @description Filter by addon.key and addon.version attributes */
8910
+ keyVersion?: {
8911
+ [key: string]: number[];
8912
+ };
8913
+ /** @description Only return add-ons with the given status.
8914
+ *
8915
+ * Usage:
8916
+ * - `?status=active`: return only the currently active add-ons
8917
+ * - `?status=draft`: return only the draft add-ons
8918
+ * - `?status=archived`: return only the archived add-ons */
8919
+ status?: components['schemas']['AddonStatus'][];
8920
+ /** @description Filter by addon.currency attribute */
8921
+ currency?: components['schemas']['CurrencyCode'][];
8922
+ /** @description Page index.
8923
+ *
8924
+ * Default is 1. */
8925
+ page?: components['parameters']['Pagination.page'];
8926
+ /** @description The maximum number of items per page.
8927
+ *
8928
+ * Default is 100. */
8929
+ pageSize?: components['parameters']['Pagination.pageSize'];
8930
+ /** @description The order direction. */
8931
+ order?: components['parameters']['AddonOrderByOrdering.order'];
8932
+ /** @description The order by field. */
8933
+ orderBy?: components['parameters']['AddonOrderByOrdering.orderBy'];
8934
+ };
8935
+ header?: never;
8936
+ path?: never;
8937
+ cookie?: never;
8938
+ };
8939
+ requestBody?: never;
8940
+ responses: {
8941
+ /** @description The request has succeeded. */
8942
+ 200: {
8943
+ headers: {
8944
+ [name: string]: unknown;
8945
+ };
8946
+ content: {
8947
+ 'application/json': components['schemas']['AddonPaginatedResponse'];
8948
+ };
8949
+ };
8950
+ /** @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). */
8951
+ 400: {
8952
+ headers: {
8953
+ [name: string]: unknown;
8954
+ };
8955
+ content: {
8956
+ 'application/problem+json': components['schemas']['BadRequestProblemResponse'];
8957
+ };
8958
+ };
8959
+ /** @description The request has not been applied because it lacks valid authentication credentials for the target resource. */
8960
+ 401: {
8961
+ headers: {
8962
+ [name: string]: unknown;
8963
+ };
8964
+ content: {
8965
+ 'application/problem+json': components['schemas']['UnauthorizedProblemResponse'];
8966
+ };
8967
+ };
8968
+ /** @description The server understood the request but refuses to authorize it. */
8969
+ 403: {
8970
+ headers: {
8971
+ [name: string]: unknown;
8972
+ };
8973
+ content: {
8974
+ 'application/problem+json': components['schemas']['ForbiddenProblemResponse'];
8975
+ };
8976
+ };
8977
+ /** @description One or more conditions given in the request header fields evaluated to false when tested on the server. */
8978
+ 412: {
8979
+ headers: {
8980
+ [name: string]: unknown;
8981
+ };
8982
+ content: {
8983
+ 'application/problem+json': components['schemas']['PreconditionFailedProblemResponse'];
8984
+ };
8985
+ };
8986
+ /** @description The server encountered an unexpected condition that prevented it from fulfilling the request. */
8987
+ 500: {
8988
+ headers: {
8989
+ [name: string]: unknown;
8990
+ };
8991
+ content: {
8992
+ 'application/problem+json': components['schemas']['InternalServerErrorProblemResponse'];
8993
+ };
8994
+ };
8995
+ /** @description The server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay. */
8996
+ 503: {
8997
+ headers: {
8998
+ [name: string]: unknown;
8999
+ };
9000
+ content: {
9001
+ 'application/problem+json': components['schemas']['ServiceUnavailableProblemResponse'];
9002
+ };
9003
+ };
9004
+ /** @description An unexpected error response. */
9005
+ default: {
9006
+ headers: {
9007
+ [name: string]: unknown;
9008
+ };
9009
+ content: {
9010
+ 'application/problem+json': components['schemas']['UnexpectedProblemResponse'];
9011
+ };
9012
+ };
9013
+ };
9014
+ };
9015
+ createAddon: {
9016
+ parameters: {
9017
+ query?: never;
9018
+ header?: never;
9019
+ path?: never;
9020
+ cookie?: never;
9021
+ };
9022
+ requestBody: {
9023
+ content: {
9024
+ 'application/json': components['schemas']['AddonCreate'];
9025
+ };
9026
+ };
9027
+ responses: {
9028
+ /** @description The request has succeeded and a new resource has been created as a result. */
9029
+ 201: {
9030
+ headers: {
9031
+ [name: string]: unknown;
9032
+ };
9033
+ content: {
9034
+ 'application/json': components['schemas']['Addon'];
9035
+ };
9036
+ };
9037
+ /** @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). */
9038
+ 400: {
9039
+ headers: {
9040
+ [name: string]: unknown;
9041
+ };
9042
+ content: {
9043
+ 'application/problem+json': components['schemas']['BadRequestProblemResponse'];
9044
+ };
9045
+ };
9046
+ /** @description The request has not been applied because it lacks valid authentication credentials for the target resource. */
9047
+ 401: {
9048
+ headers: {
9049
+ [name: string]: unknown;
9050
+ };
9051
+ content: {
9052
+ 'application/problem+json': components['schemas']['UnauthorizedProblemResponse'];
9053
+ };
9054
+ };
9055
+ /** @description The server understood the request but refuses to authorize it. */
9056
+ 403: {
9057
+ headers: {
9058
+ [name: string]: unknown;
9059
+ };
9060
+ content: {
9061
+ 'application/problem+json': components['schemas']['ForbiddenProblemResponse'];
9062
+ };
9063
+ };
9064
+ /** @description One or more conditions given in the request header fields evaluated to false when tested on the server. */
9065
+ 412: {
9066
+ headers: {
9067
+ [name: string]: unknown;
9068
+ };
9069
+ content: {
9070
+ 'application/problem+json': components['schemas']['PreconditionFailedProblemResponse'];
9071
+ };
9072
+ };
9073
+ /** @description The server encountered an unexpected condition that prevented it from fulfilling the request. */
9074
+ 500: {
9075
+ headers: {
9076
+ [name: string]: unknown;
9077
+ };
9078
+ content: {
9079
+ 'application/problem+json': components['schemas']['InternalServerErrorProblemResponse'];
9080
+ };
9081
+ };
9082
+ /** @description The server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay. */
9083
+ 503: {
9084
+ headers: {
9085
+ [name: string]: unknown;
9086
+ };
9087
+ content: {
9088
+ 'application/problem+json': components['schemas']['ServiceUnavailableProblemResponse'];
9089
+ };
9090
+ };
9091
+ /** @description An unexpected error response. */
9092
+ default: {
9093
+ headers: {
9094
+ [name: string]: unknown;
9095
+ };
9096
+ content: {
9097
+ 'application/problem+json': components['schemas']['UnexpectedProblemResponse'];
9098
+ };
9099
+ };
9100
+ };
9101
+ };
9102
+ getAddon: {
9103
+ parameters: {
9104
+ query?: {
9105
+ /** @description Include latest version of the add-on instead of the version in active state.
9106
+ *
9107
+ * Usage: `?includeLatest=true` */
9108
+ includeLatest?: boolean;
9109
+ };
9110
+ header?: never;
9111
+ path: {
9112
+ addonIdOrKey: string;
9113
+ };
9114
+ cookie?: never;
9115
+ };
9116
+ requestBody?: never;
9117
+ responses: {
9118
+ /** @description The request has succeeded. */
9119
+ 200: {
9120
+ headers: {
9121
+ [name: string]: unknown;
9122
+ };
9123
+ content: {
9124
+ 'application/json': components['schemas']['Addon'];
9125
+ };
9126
+ };
9127
+ /** @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). */
9128
+ 400: {
9129
+ headers: {
9130
+ [name: string]: unknown;
9131
+ };
9132
+ content: {
9133
+ 'application/problem+json': components['schemas']['BadRequestProblemResponse'];
9134
+ };
9135
+ };
9136
+ /** @description The request has not been applied because it lacks valid authentication credentials for the target resource. */
9137
+ 401: {
9138
+ headers: {
9139
+ [name: string]: unknown;
9140
+ };
9141
+ content: {
9142
+ 'application/problem+json': components['schemas']['UnauthorizedProblemResponse'];
9143
+ };
9144
+ };
9145
+ /** @description The server understood the request but refuses to authorize it. */
9146
+ 403: {
9147
+ headers: {
9148
+ [name: string]: unknown;
9149
+ };
9150
+ content: {
9151
+ 'application/problem+json': components['schemas']['ForbiddenProblemResponse'];
9152
+ };
9153
+ };
9154
+ /** @description The origin server did not find a current representation for the target resource or is not willing to disclose that one exists. */
9155
+ 404: {
9156
+ headers: {
9157
+ [name: string]: unknown;
9158
+ };
9159
+ content: {
9160
+ 'application/problem+json': components['schemas']['NotFoundProblemResponse'];
9161
+ };
9162
+ };
9163
+ /** @description One or more conditions given in the request header fields evaluated to false when tested on the server. */
9164
+ 412: {
9165
+ headers: {
9166
+ [name: string]: unknown;
9167
+ };
9168
+ content: {
9169
+ 'application/problem+json': components['schemas']['PreconditionFailedProblemResponse'];
9170
+ };
9171
+ };
9172
+ /** @description The server encountered an unexpected condition that prevented it from fulfilling the request. */
9173
+ 500: {
9174
+ headers: {
9175
+ [name: string]: unknown;
9176
+ };
9177
+ content: {
9178
+ 'application/problem+json': components['schemas']['InternalServerErrorProblemResponse'];
9179
+ };
9180
+ };
9181
+ /** @description The server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay. */
9182
+ 503: {
9183
+ headers: {
9184
+ [name: string]: unknown;
9185
+ };
9186
+ content: {
9187
+ 'application/problem+json': components['schemas']['ServiceUnavailableProblemResponse'];
9188
+ };
9189
+ };
9190
+ /** @description An unexpected error response. */
9191
+ default: {
9192
+ headers: {
9193
+ [name: string]: unknown;
9194
+ };
9195
+ content: {
9196
+ 'application/problem+json': components['schemas']['UnexpectedProblemResponse'];
9197
+ };
9198
+ };
9199
+ };
9200
+ };
9201
+ updateAddon: {
9202
+ parameters: {
9203
+ query?: never;
9204
+ header?: never;
9205
+ path: {
9206
+ addonId: string;
9207
+ };
9208
+ cookie?: never;
9209
+ };
9210
+ requestBody: {
9211
+ content: {
9212
+ 'application/json': components['schemas']['AddonReplaceUpdate'];
9213
+ };
9214
+ };
9215
+ responses: {
9216
+ /** @description The request has succeeded. */
9217
+ 200: {
9218
+ headers: {
9219
+ [name: string]: unknown;
9220
+ };
9221
+ content: {
9222
+ 'application/json': components['schemas']['Addon'];
9223
+ };
9224
+ };
9225
+ /** @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). */
9226
+ 400: {
9227
+ headers: {
9228
+ [name: string]: unknown;
9229
+ };
9230
+ content: {
9231
+ 'application/problem+json': components['schemas']['BadRequestProblemResponse'];
9232
+ };
9233
+ };
9234
+ /** @description The request has not been applied because it lacks valid authentication credentials for the target resource. */
9235
+ 401: {
9236
+ headers: {
9237
+ [name: string]: unknown;
9238
+ };
9239
+ content: {
9240
+ 'application/problem+json': components['schemas']['UnauthorizedProblemResponse'];
9241
+ };
9242
+ };
9243
+ /** @description The server understood the request but refuses to authorize it. */
9244
+ 403: {
9245
+ headers: {
9246
+ [name: string]: unknown;
9247
+ };
9248
+ content: {
9249
+ 'application/problem+json': components['schemas']['ForbiddenProblemResponse'];
9250
+ };
9251
+ };
9252
+ /** @description The origin server did not find a current representation for the target resource or is not willing to disclose that one exists. */
9253
+ 404: {
9254
+ headers: {
9255
+ [name: string]: unknown;
9256
+ };
9257
+ content: {
9258
+ 'application/problem+json': components['schemas']['NotFoundProblemResponse'];
9259
+ };
9260
+ };
9261
+ /** @description One or more conditions given in the request header fields evaluated to false when tested on the server. */
9262
+ 412: {
9263
+ headers: {
9264
+ [name: string]: unknown;
9265
+ };
9266
+ content: {
9267
+ 'application/problem+json': components['schemas']['PreconditionFailedProblemResponse'];
9268
+ };
9269
+ };
9270
+ /** @description The server encountered an unexpected condition that prevented it from fulfilling the request. */
9271
+ 500: {
9272
+ headers: {
9273
+ [name: string]: unknown;
9274
+ };
9275
+ content: {
9276
+ 'application/problem+json': components['schemas']['InternalServerErrorProblemResponse'];
9277
+ };
9278
+ };
9279
+ /** @description The server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay. */
9280
+ 503: {
9281
+ headers: {
9282
+ [name: string]: unknown;
9283
+ };
9284
+ content: {
9285
+ 'application/problem+json': components['schemas']['ServiceUnavailableProblemResponse'];
9286
+ };
9287
+ };
9288
+ /** @description An unexpected error response. */
9289
+ default: {
9290
+ headers: {
9291
+ [name: string]: unknown;
9292
+ };
9293
+ content: {
9294
+ 'application/problem+json': components['schemas']['UnexpectedProblemResponse'];
9295
+ };
9296
+ };
9297
+ };
9298
+ };
9299
+ deleteAddon: {
9300
+ parameters: {
9301
+ query?: never;
9302
+ header?: never;
9303
+ path: {
9304
+ addonId: string;
9305
+ };
9306
+ cookie?: never;
9307
+ };
9308
+ requestBody?: never;
9309
+ responses: {
9310
+ /** @description There is no content to send for this request, but the headers may be useful. */
9311
+ 204: {
9312
+ headers: {
9313
+ [name: string]: unknown;
9314
+ };
9315
+ content?: never;
9316
+ };
9317
+ /** @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). */
9318
+ 400: {
9319
+ headers: {
9320
+ [name: string]: unknown;
9321
+ };
9322
+ content: {
9323
+ 'application/problem+json': components['schemas']['BadRequestProblemResponse'];
9324
+ };
9325
+ };
9326
+ /** @description The request has not been applied because it lacks valid authentication credentials for the target resource. */
9327
+ 401: {
9328
+ headers: {
9329
+ [name: string]: unknown;
9330
+ };
9331
+ content: {
9332
+ 'application/problem+json': components['schemas']['UnauthorizedProblemResponse'];
9333
+ };
9334
+ };
9335
+ /** @description The server understood the request but refuses to authorize it. */
9336
+ 403: {
9337
+ headers: {
9338
+ [name: string]: unknown;
9339
+ };
9340
+ content: {
9341
+ 'application/problem+json': components['schemas']['ForbiddenProblemResponse'];
9342
+ };
9343
+ };
9344
+ /** @description The origin server did not find a current representation for the target resource or is not willing to disclose that one exists. */
9345
+ 404: {
9346
+ headers: {
9347
+ [name: string]: unknown;
9348
+ };
9349
+ content: {
9350
+ 'application/problem+json': components['schemas']['NotFoundProblemResponse'];
9351
+ };
9352
+ };
9353
+ /** @description One or more conditions given in the request header fields evaluated to false when tested on the server. */
9354
+ 412: {
9355
+ headers: {
9356
+ [name: string]: unknown;
9357
+ };
9358
+ content: {
9359
+ 'application/problem+json': components['schemas']['PreconditionFailedProblemResponse'];
9360
+ };
9361
+ };
9362
+ /** @description The server encountered an unexpected condition that prevented it from fulfilling the request. */
9363
+ 500: {
9364
+ headers: {
9365
+ [name: string]: unknown;
9366
+ };
9367
+ content: {
9368
+ 'application/problem+json': components['schemas']['InternalServerErrorProblemResponse'];
9369
+ };
9370
+ };
9371
+ /** @description The server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay. */
9372
+ 503: {
9373
+ headers: {
9374
+ [name: string]: unknown;
9375
+ };
9376
+ content: {
9377
+ 'application/problem+json': components['schemas']['ServiceUnavailableProblemResponse'];
9378
+ };
9379
+ };
9380
+ /** @description An unexpected error response. */
9381
+ default: {
9382
+ headers: {
9383
+ [name: string]: unknown;
9384
+ };
9385
+ content: {
9386
+ 'application/problem+json': components['schemas']['UnexpectedProblemResponse'];
9387
+ };
9388
+ };
9389
+ };
9390
+ };
9391
+ archiveAddon: {
9392
+ parameters: {
9393
+ query?: never;
9394
+ header?: never;
9395
+ path: {
9396
+ addonId: string;
9397
+ };
9398
+ cookie?: never;
9399
+ };
9400
+ requestBody?: never;
9401
+ responses: {
9402
+ /** @description The request has succeeded. */
9403
+ 200: {
9404
+ headers: {
9405
+ [name: string]: unknown;
9406
+ };
9407
+ content: {
9408
+ 'application/json': components['schemas']['Addon'];
9409
+ };
9410
+ };
9411
+ /** @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). */
9412
+ 400: {
9413
+ headers: {
9414
+ [name: string]: unknown;
9415
+ };
9416
+ content: {
9417
+ 'application/problem+json': components['schemas']['BadRequestProblemResponse'];
9418
+ };
9419
+ };
9420
+ /** @description The request has not been applied because it lacks valid authentication credentials for the target resource. */
9421
+ 401: {
9422
+ headers: {
9423
+ [name: string]: unknown;
9424
+ };
9425
+ content: {
9426
+ 'application/problem+json': components['schemas']['UnauthorizedProblemResponse'];
9427
+ };
9428
+ };
9429
+ /** @description The server understood the request but refuses to authorize it. */
9430
+ 403: {
9431
+ headers: {
9432
+ [name: string]: unknown;
9433
+ };
9434
+ content: {
9435
+ 'application/problem+json': components['schemas']['ForbiddenProblemResponse'];
9436
+ };
9437
+ };
9438
+ /** @description The origin server did not find a current representation for the target resource or is not willing to disclose that one exists. */
9439
+ 404: {
9440
+ headers: {
9441
+ [name: string]: unknown;
9442
+ };
9443
+ content: {
9444
+ 'application/problem+json': components['schemas']['NotFoundProblemResponse'];
9445
+ };
9446
+ };
9447
+ /** @description One or more conditions given in the request header fields evaluated to false when tested on the server. */
9448
+ 412: {
9449
+ headers: {
9450
+ [name: string]: unknown;
9451
+ };
9452
+ content: {
9453
+ 'application/problem+json': components['schemas']['PreconditionFailedProblemResponse'];
9454
+ };
9455
+ };
9456
+ /** @description The server encountered an unexpected condition that prevented it from fulfilling the request. */
9457
+ 500: {
9458
+ headers: {
9459
+ [name: string]: unknown;
9460
+ };
9461
+ content: {
9462
+ 'application/problem+json': components['schemas']['InternalServerErrorProblemResponse'];
9463
+ };
9464
+ };
9465
+ /** @description The server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay. */
9466
+ 503: {
9467
+ headers: {
9468
+ [name: string]: unknown;
9469
+ };
9470
+ content: {
9471
+ 'application/problem+json': components['schemas']['ServiceUnavailableProblemResponse'];
9472
+ };
9473
+ };
9474
+ /** @description An unexpected error response. */
9475
+ default: {
9476
+ headers: {
9477
+ [name: string]: unknown;
9478
+ };
9479
+ content: {
9480
+ 'application/problem+json': components['schemas']['UnexpectedProblemResponse'];
9481
+ };
9482
+ };
9483
+ };
9484
+ };
9485
+ publishAddon: {
9486
+ parameters: {
9487
+ query?: never;
9488
+ header?: never;
9489
+ path: {
9490
+ addonId: string;
9491
+ };
9492
+ cookie?: never;
9493
+ };
9494
+ requestBody?: never;
9495
+ responses: {
9496
+ /** @description The request has succeeded. */
9497
+ 200: {
9498
+ headers: {
9499
+ [name: string]: unknown;
9500
+ };
9501
+ content: {
9502
+ 'application/json': components['schemas']['Addon'];
9503
+ };
9504
+ };
9505
+ /** @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). */
9506
+ 400: {
9507
+ headers: {
9508
+ [name: string]: unknown;
9509
+ };
9510
+ content: {
9511
+ 'application/problem+json': components['schemas']['BadRequestProblemResponse'];
9512
+ };
9513
+ };
9514
+ /** @description The request has not been applied because it lacks valid authentication credentials for the target resource. */
9515
+ 401: {
9516
+ headers: {
9517
+ [name: string]: unknown;
9518
+ };
9519
+ content: {
9520
+ 'application/problem+json': components['schemas']['UnauthorizedProblemResponse'];
9521
+ };
9522
+ };
9523
+ /** @description The server understood the request but refuses to authorize it. */
9524
+ 403: {
9525
+ headers: {
9526
+ [name: string]: unknown;
9527
+ };
9528
+ content: {
9529
+ 'application/problem+json': components['schemas']['ForbiddenProblemResponse'];
9530
+ };
9531
+ };
9532
+ /** @description The origin server did not find a current representation for the target resource or is not willing to disclose that one exists. */
9533
+ 404: {
9534
+ headers: {
9535
+ [name: string]: unknown;
9536
+ };
9537
+ content: {
9538
+ 'application/problem+json': components['schemas']['NotFoundProblemResponse'];
9539
+ };
9540
+ };
9541
+ /** @description One or more conditions given in the request header fields evaluated to false when tested on the server. */
9542
+ 412: {
9543
+ headers: {
9544
+ [name: string]: unknown;
9545
+ };
9546
+ content: {
9547
+ 'application/problem+json': components['schemas']['PreconditionFailedProblemResponse'];
9548
+ };
9549
+ };
9550
+ /** @description The server encountered an unexpected condition that prevented it from fulfilling the request. */
9551
+ 500: {
9552
+ headers: {
9553
+ [name: string]: unknown;
9554
+ };
9555
+ content: {
9556
+ 'application/problem+json': components['schemas']['InternalServerErrorProblemResponse'];
9557
+ };
9558
+ };
9559
+ /** @description The server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay. */
9560
+ 503: {
9561
+ headers: {
9562
+ [name: string]: unknown;
9563
+ };
9564
+ content: {
9565
+ 'application/problem+json': components['schemas']['ServiceUnavailableProblemResponse'];
9566
+ };
9567
+ };
9568
+ /** @description An unexpected error response. */
9569
+ default: {
9570
+ headers: {
9571
+ [name: string]: unknown;
9572
+ };
9573
+ content: {
9574
+ 'application/problem+json': components['schemas']['UnexpectedProblemResponse'];
9575
+ };
9576
+ };
9577
+ };
9578
+ };
8397
9579
  listApps: {
8398
9580
  parameters: {
8399
9581
  query?: {
@@ -11159,23 +12341,12 @@ export interface operations {
11159
12341
  };
11160
12342
  };
11161
12343
  };
11162
- listCustomerAppData: {
12344
+ getCustomer: {
11163
12345
  parameters: {
11164
- query?: {
11165
- /** @description Page index.
11166
- *
11167
- * Default is 1. */
11168
- page?: components['parameters']['Pagination.page'];
11169
- /** @description The maximum number of items per page.
11170
- *
11171
- * Default is 100. */
11172
- pageSize?: components['parameters']['Pagination.pageSize'];
11173
- /** @description Filter customer data by app type. */
11174
- type?: components['parameters']['queryCustomerList.type'];
11175
- };
12346
+ query?: never;
11176
12347
  header?: never;
11177
12348
  path: {
11178
- customerId: string;
12349
+ customerIdOrKey: string;
11179
12350
  };
11180
12351
  cookie?: never;
11181
12352
  };
@@ -11187,7 +12358,7 @@ export interface operations {
11187
12358
  [name: string]: unknown;
11188
12359
  };
11189
12360
  content: {
11190
- 'application/json': components['schemas']['CustomerAppDataPaginatedResponse'];
12361
+ 'application/json': components['schemas']['Customer'];
11191
12362
  };
11192
12363
  };
11193
12364
  /** @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). */
@@ -11264,18 +12435,18 @@ export interface operations {
11264
12435
  };
11265
12436
  };
11266
12437
  };
11267
- upsertCustomerAppData: {
12438
+ updateCustomer: {
11268
12439
  parameters: {
11269
12440
  query?: never;
11270
12441
  header?: never;
11271
12442
  path: {
11272
- customerId: string;
12443
+ customerIdOrKey: string;
11273
12444
  };
11274
12445
  cookie?: never;
11275
12446
  };
11276
12447
  requestBody: {
11277
12448
  content: {
11278
- 'application/json': components['schemas']['CustomerAppData'][];
12449
+ 'application/json': components['schemas']['CustomerReplaceUpdate'];
11279
12450
  };
11280
12451
  };
11281
12452
  responses: {
@@ -11285,7 +12456,7 @@ export interface operations {
11285
12456
  [name: string]: unknown;
11286
12457
  };
11287
12458
  content: {
11288
- 'application/json': components['schemas']['CustomerAppData'][];
12459
+ 'application/json': components['schemas']['Customer'];
11289
12460
  };
11290
12461
  };
11291
12462
  /** @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). */
@@ -11362,13 +12533,12 @@ export interface operations {
11362
12533
  };
11363
12534
  };
11364
12535
  };
11365
- deleteCustomerAppData: {
12536
+ deleteCustomer: {
11366
12537
  parameters: {
11367
12538
  query?: never;
11368
12539
  header?: never;
11369
12540
  path: {
11370
- customerId: string;
11371
- appId: string;
12541
+ customerIdOrKey: string;
11372
12542
  };
11373
12543
  cookie?: never;
11374
12544
  };
@@ -11455,15 +12625,23 @@ export interface operations {
11455
12625
  };
11456
12626
  };
11457
12627
  };
11458
- getCustomerEntitlementValue: {
12628
+ listCustomerAppData: {
11459
12629
  parameters: {
11460
12630
  query?: {
11461
- time?: Date | string;
12631
+ /** @description Page index.
12632
+ *
12633
+ * Default is 1. */
12634
+ page?: components['parameters']['Pagination.page'];
12635
+ /** @description The maximum number of items per page.
12636
+ *
12637
+ * Default is 100. */
12638
+ pageSize?: components['parameters']['Pagination.pageSize'];
12639
+ /** @description Filter customer data by app type. */
12640
+ type?: components['parameters']['queryCustomerList.type'];
11462
12641
  };
11463
12642
  header?: never;
11464
12643
  path: {
11465
- customerId: string;
11466
- featureKey: string;
12644
+ customerIdOrKey: string;
11467
12645
  };
11468
12646
  cookie?: never;
11469
12647
  };
@@ -11475,7 +12653,7 @@ export interface operations {
11475
12653
  [name: string]: unknown;
11476
12654
  };
11477
12655
  content: {
11478
- 'application/json': components['schemas']['EntitlementValue'];
12656
+ 'application/json': components['schemas']['CustomerAppDataPaginatedResponse'];
11479
12657
  };
11480
12658
  };
11481
12659
  /** @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). */
@@ -11552,25 +12730,20 @@ export interface operations {
11552
12730
  };
11553
12731
  };
11554
12732
  };
11555
- listCustomerSubscriptions: {
12733
+ upsertCustomerAppData: {
11556
12734
  parameters: {
11557
- query?: {
11558
- /** @description Page index.
11559
- *
11560
- * Default is 1. */
11561
- page?: components['parameters']['Pagination.page'];
11562
- /** @description The maximum number of items per page.
11563
- *
11564
- * Default is 100. */
11565
- pageSize?: components['parameters']['Pagination.pageSize'];
11566
- };
12735
+ query?: never;
11567
12736
  header?: never;
11568
12737
  path: {
11569
- customerId: string;
12738
+ customerIdOrKey: string;
11570
12739
  };
11571
12740
  cookie?: never;
11572
12741
  };
11573
- requestBody?: never;
12742
+ requestBody: {
12743
+ content: {
12744
+ 'application/json': components['schemas']['CustomerAppData'][];
12745
+ };
12746
+ };
11574
12747
  responses: {
11575
12748
  /** @description The request has succeeded. */
11576
12749
  200: {
@@ -11578,7 +12751,7 @@ export interface operations {
11578
12751
  [name: string]: unknown;
11579
12752
  };
11580
12753
  content: {
11581
- 'application/json': components['schemas']['SubscriptionPaginatedResponse'];
12754
+ 'application/json': components['schemas']['CustomerAppData'][];
11582
12755
  };
11583
12756
  };
11584
12757
  /** @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). */
@@ -11655,25 +12828,24 @@ export interface operations {
11655
12828
  };
11656
12829
  };
11657
12830
  };
11658
- getCustomer: {
12831
+ deleteCustomerAppData: {
11659
12832
  parameters: {
11660
12833
  query?: never;
11661
12834
  header?: never;
11662
12835
  path: {
11663
- id: string;
12836
+ customerIdOrKey: string;
12837
+ appId: string;
11664
12838
  };
11665
12839
  cookie?: never;
11666
12840
  };
11667
12841
  requestBody?: never;
11668
12842
  responses: {
11669
- /** @description The request has succeeded. */
11670
- 200: {
12843
+ /** @description There is no content to send for this request, but the headers may be useful. */
12844
+ 204: {
11671
12845
  headers: {
11672
12846
  [name: string]: unknown;
11673
12847
  };
11674
- content: {
11675
- 'application/json': components['schemas']['Customer'];
11676
- };
12848
+ content?: never;
11677
12849
  };
11678
12850
  /** @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). */
11679
12851
  400: {
@@ -11749,20 +12921,19 @@ export interface operations {
11749
12921
  };
11750
12922
  };
11751
12923
  };
11752
- updateCustomer: {
12924
+ getCustomerEntitlementValue: {
11753
12925
  parameters: {
11754
- query?: never;
12926
+ query?: {
12927
+ time?: Date | string;
12928
+ };
11755
12929
  header?: never;
11756
12930
  path: {
11757
- id: string;
12931
+ customerIdOrKey: string;
12932
+ featureKey: string;
11758
12933
  };
11759
12934
  cookie?: never;
11760
12935
  };
11761
- requestBody: {
11762
- content: {
11763
- 'application/json': components['schemas']['CustomerReplaceUpdate'];
11764
- };
11765
- };
12936
+ requestBody?: never;
11766
12937
  responses: {
11767
12938
  /** @description The request has succeeded. */
11768
12939
  200: {
@@ -11770,7 +12941,7 @@ export interface operations {
11770
12941
  [name: string]: unknown;
11771
12942
  };
11772
12943
  content: {
11773
- 'application/json': components['schemas']['Customer'];
12944
+ 'application/json': components['schemas']['EntitlementValue'];
11774
12945
  };
11775
12946
  };
11776
12947
  /** @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). */
@@ -11847,23 +13018,34 @@ export interface operations {
11847
13018
  };
11848
13019
  };
11849
13020
  };
11850
- deleteCustomer: {
13021
+ listCustomerSubscriptions: {
11851
13022
  parameters: {
11852
- query?: never;
13023
+ query?: {
13024
+ /** @description Page index.
13025
+ *
13026
+ * Default is 1. */
13027
+ page?: components['parameters']['Pagination.page'];
13028
+ /** @description The maximum number of items per page.
13029
+ *
13030
+ * Default is 100. */
13031
+ pageSize?: components['parameters']['Pagination.pageSize'];
13032
+ };
11853
13033
  header?: never;
11854
13034
  path: {
11855
- id: string;
13035
+ customerIdOrKey: string;
11856
13036
  };
11857
13037
  cookie?: never;
11858
13038
  };
11859
13039
  requestBody?: never;
11860
13040
  responses: {
11861
- /** @description There is no content to send for this request, but the headers may be useful. */
11862
- 204: {
13041
+ /** @description The request has succeeded. */
13042
+ 200: {
11863
13043
  headers: {
11864
13044
  [name: string]: unknown;
11865
13045
  };
11866
- content?: never;
13046
+ content: {
13047
+ 'application/json': components['schemas']['SubscriptionPaginatedResponse'];
13048
+ };
11867
13049
  };
11868
13050
  /** @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). */
11869
13051
  400: {
@@ -13673,7 +14855,22 @@ export interface operations {
13673
14855
  };
13674
14856
  listMeters: {
13675
14857
  parameters: {
13676
- query?: never;
14858
+ query?: {
14859
+ /** @description Page index.
14860
+ *
14861
+ * Default is 1. */
14862
+ page?: components['parameters']['Pagination.page'];
14863
+ /** @description The maximum number of items per page.
14864
+ *
14865
+ * Default is 100. */
14866
+ pageSize?: components['parameters']['Pagination.pageSize'];
14867
+ /** @description The order direction. */
14868
+ order?: components['parameters']['MeterOrderByOrdering.order'];
14869
+ /** @description The order by field. */
14870
+ orderBy?: components['parameters']['MeterOrderByOrdering.orderBy'];
14871
+ /** @description Include deleted meters. */
14872
+ includeDeleted?: components['parameters']['queryMeterList.includeDeleted'];
14873
+ };
13677
14874
  header?: never;
13678
14875
  path?: never;
13679
14876
  cookie?: never;
@@ -14115,23 +15312,37 @@ export interface operations {
14115
15312
  clientId?: components['parameters']['MeterQuery.clientId'];
14116
15313
  /** @description Start date-time in RFC 3339 format.
14117
15314
  *
14118
- * Inclusive. */
15315
+ * Inclusive.
15316
+ *
15317
+ * For example: ?from=2025-01-01T00%3A00%3A00.000Z */
14119
15318
  from?: components['parameters']['MeterQuery.from'];
14120
15319
  /** @description End date-time in RFC 3339 format.
14121
15320
  *
14122
- * Inclusive. */
15321
+ * Inclusive.
15322
+ *
15323
+ * For example: ?to=2025-02-01T00%3A00%3A00.000Z */
14123
15324
  to?: components['parameters']['MeterQuery.to'];
14124
- /** @description If not specified, a single usage aggregate will be returned for the entirety of the specified period for each subject and group. */
15325
+ /** @description If not specified, a single usage aggregate will be returned for the entirety of the specified period for each subject and group.
15326
+ *
15327
+ * For example: ?windowSize=DAY */
14125
15328
  windowSize?: components['parameters']['MeterQuery.windowSize'];
14126
15329
  /** @description The value is the name of the time zone as defined in the IANA Time Zone Database (http://www.iana.org/time-zones).
14127
- * If not specified, the UTC timezone will be used. */
15330
+ * If not specified, the UTC timezone will be used.
15331
+ *
15332
+ * For example: ?windowTimeZone=UTC */
14128
15333
  windowTimeZone?: components['parameters']['MeterQuery.windowTimeZone'];
14129
- /** @description Filtering by multiple subjects. */
15334
+ /** @description Filtering by multiple subjects.
15335
+ *
15336
+ * For example: ?subject=customer-1&subject=customer-2 */
14130
15337
  subject?: components['parameters']['MeterQuery.subject'];
14131
- /** @description Simple filter for group bys with exact match. */
15338
+ /** @description Simple filter for group bys with exact match.
15339
+ *
15340
+ * For example: ?filterGroupBy[vendor]=openai&filterGroupBy[model]=gpt-4-turbo */
14132
15341
  filterGroupBy?: components['parameters']['MeterQuery.filterGroupBy'];
14133
15342
  /** @description If not specified a single aggregate will be returned for each subject and time window.
14134
- * `subject` is a reserved group by value. */
15343
+ * `subject` is a reserved group by value.
15344
+ *
15345
+ * For example: ?groupBy=subject&groupBy=model */
14135
15346
  groupBy?: components['parameters']['MeterQuery.groupBy'];
14136
15347
  };
14137
15348
  header?: never;
@@ -16443,21 +17654,33 @@ export interface operations {
16443
17654
  clientId?: components['parameters']['MeterQuery.clientId'];
16444
17655
  /** @description Start date-time in RFC 3339 format.
16445
17656
  *
16446
- * Inclusive. */
17657
+ * Inclusive.
17658
+ *
17659
+ * For example: ?from=2025-01-01T00%3A00%3A00.000Z */
16447
17660
  from?: components['parameters']['MeterQuery.from'];
16448
17661
  /** @description End date-time in RFC 3339 format.
16449
17662
  *
16450
- * Inclusive. */
17663
+ * Inclusive.
17664
+ *
17665
+ * For example: ?to=2025-02-01T00%3A00%3A00.000Z */
16451
17666
  to?: components['parameters']['MeterQuery.to'];
16452
- /** @description If not specified, a single usage aggregate will be returned for the entirety of the specified period for each subject and group. */
17667
+ /** @description If not specified, a single usage aggregate will be returned for the entirety of the specified period for each subject and group.
17668
+ *
17669
+ * For example: ?windowSize=DAY */
16453
17670
  windowSize?: components['parameters']['MeterQuery.windowSize'];
16454
17671
  /** @description The value is the name of the time zone as defined in the IANA Time Zone Database (http://www.iana.org/time-zones).
16455
- * If not specified, the UTC timezone will be used. */
17672
+ * If not specified, the UTC timezone will be used.
17673
+ *
17674
+ * For example: ?windowTimeZone=UTC */
16456
17675
  windowTimeZone?: components['parameters']['MeterQuery.windowTimeZone'];
16457
- /** @description Simple filter for group bys with exact match. */
17676
+ /** @description Simple filter for group bys with exact match.
17677
+ *
17678
+ * For example: ?filterGroupBy[vendor]=openai&filterGroupBy[model]=gpt-4-turbo */
16458
17679
  filterGroupBy?: components['parameters']['MeterQuery.filterGroupBy'];
16459
17680
  /** @description If not specified a single aggregate will be returned for each subject and time window.
16460
- * `subject` is a reserved group by value. */
17681
+ * `subject` is a reserved group by value.
17682
+ *
17683
+ * For example: ?groupBy=subject&groupBy=model */
16461
17684
  groupBy?: components['parameters']['MeterQuery.groupBy'];
16462
17685
  };
16463
17686
  header?: never;
@@ -18418,6 +19641,98 @@ export interface operations {
18418
19641
  };
18419
19642
  };
18420
19643
  };
19644
+ deleteSubscription: {
19645
+ parameters: {
19646
+ query?: never;
19647
+ header?: never;
19648
+ path: {
19649
+ subscriptionId: string;
19650
+ };
19651
+ cookie?: never;
19652
+ };
19653
+ requestBody?: never;
19654
+ responses: {
19655
+ /** @description There is no content to send for this request, but the headers may be useful. */
19656
+ 204: {
19657
+ headers: {
19658
+ [name: string]: unknown;
19659
+ };
19660
+ content?: never;
19661
+ };
19662
+ /** @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). */
19663
+ 400: {
19664
+ headers: {
19665
+ [name: string]: unknown;
19666
+ };
19667
+ content: {
19668
+ 'application/problem+json': components['schemas']['BadRequestProblemResponse'];
19669
+ };
19670
+ };
19671
+ /** @description The request has not been applied because it lacks valid authentication credentials for the target resource. */
19672
+ 401: {
19673
+ headers: {
19674
+ [name: string]: unknown;
19675
+ };
19676
+ content: {
19677
+ 'application/problem+json': components['schemas']['UnauthorizedProblemResponse'];
19678
+ };
19679
+ };
19680
+ /** @description The server understood the request but refuses to authorize it. */
19681
+ 403: {
19682
+ headers: {
19683
+ [name: string]: unknown;
19684
+ };
19685
+ content: {
19686
+ 'application/problem+json': components['schemas']['ForbiddenProblemResponse'];
19687
+ };
19688
+ };
19689
+ /** @description The origin server did not find a current representation for the target resource or is not willing to disclose that one exists. */
19690
+ 404: {
19691
+ headers: {
19692
+ [name: string]: unknown;
19693
+ };
19694
+ content: {
19695
+ 'application/problem+json': components['schemas']['NotFoundProblemResponse'];
19696
+ };
19697
+ };
19698
+ /** @description One or more conditions given in the request header fields evaluated to false when tested on the server. */
19699
+ 412: {
19700
+ headers: {
19701
+ [name: string]: unknown;
19702
+ };
19703
+ content: {
19704
+ 'application/problem+json': components['schemas']['PreconditionFailedProblemResponse'];
19705
+ };
19706
+ };
19707
+ /** @description The server encountered an unexpected condition that prevented it from fulfilling the request. */
19708
+ 500: {
19709
+ headers: {
19710
+ [name: string]: unknown;
19711
+ };
19712
+ content: {
19713
+ 'application/problem+json': components['schemas']['InternalServerErrorProblemResponse'];
19714
+ };
19715
+ };
19716
+ /** @description The server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay. */
19717
+ 503: {
19718
+ headers: {
19719
+ [name: string]: unknown;
19720
+ };
19721
+ content: {
19722
+ 'application/problem+json': components['schemas']['ServiceUnavailableProblemResponse'];
19723
+ };
19724
+ };
19725
+ /** @description An unexpected error response. */
19726
+ default: {
19727
+ headers: {
19728
+ [name: string]: unknown;
19729
+ };
19730
+ content: {
19731
+ 'application/problem+json': components['schemas']['UnexpectedProblemResponse'];
19732
+ };
19733
+ };
19734
+ };
19735
+ };
18421
19736
  editSubscription: {
18422
19737
  parameters: {
18423
19738
  query?: never;
@@ -19058,24 +20373,8 @@ export interface operations {
19058
20373
  /** @description Client ID
19059
20374
  * Useful to track progress of a query. */
19060
20375
  clientId?: string;
19061
- /** @description The event ID filter.
19062
- * Example: `?id[$eq]=my-event-id` */
19063
- id?: components['schemas']['FilterString'];
19064
- /** @description The event source filter.
19065
- * Example: `?source[$eq]=my-event-source` */
19066
- source?: components['schemas']['FilterString'];
19067
- /** @description The event subject filter.
19068
- * Example: `?subject[$eq]=my-event-subject` */
19069
- subject?: components['schemas']['FilterString'];
19070
- /** @description The event type filter.
19071
- * Example: `?type[$eq]=my-event-type` */
19072
- type?: components['schemas']['FilterString'];
19073
- /** @description The event time filter.
19074
- * Example: `?time[$and][0][$gte]=2025-01-01T00:00:00Z&time[$and][1][$lte]=2025-01-02T00:00:00Z` */
19075
- time?: components['schemas']['FilterTime'];
19076
- /** @description The ingested at filter.
19077
- * Example: `?ingestedAt[$and][0][$gte]=2025-01-01T00:00:00Z&ingestedAt[$and][1][$lte]=2025-01-02T00:00:00Z` */
19078
- ingestedAt?: components['schemas']['FilterTime'];
20376
+ /** @description The filter for the events encoded as JSON string. */
20377
+ filter?: string;
19079
20378
  };
19080
20379
  header?: never;
19081
20380
  path?: never;