@openmeter/sdk 1.0.0-beta.201 → 1.0.0-beta.202
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.
- package/dist/cjs/src/client/billing.cjs +1 -1
- package/dist/cjs/src/client/billing.d.cts +9 -11
- package/dist/cjs/src/client/billing.js.map +1 -1
- package/dist/cjs/src/client/customers.cjs +7 -0
- package/dist/cjs/src/client/customers.d.cts +6 -0
- package/dist/cjs/src/client/customers.js.map +1 -1
- package/dist/cjs/src/client/entitlements.d.cts +1 -1
- package/dist/cjs/src/client/schemas.d.cts +349 -90
- package/dist/cjs/{tsconfig.177d1bd1.tsbuildinfo → tsconfig.28575395.tsbuildinfo} +1 -1
- package/dist/cjs/{tsconfig.ae2c6e83.tsbuildinfo → tsconfig.cf28eb87.tsbuildinfo} +1 -1
- package/dist/src/client/billing.d.ts +9 -11
- package/dist/src/client/billing.js +1 -1
- package/dist/src/client/billing.js.map +1 -1
- package/dist/src/client/customers.d.ts +6 -0
- package/dist/src/client/customers.js +7 -0
- package/dist/src/client/customers.js.map +1 -1
- package/dist/src/client/entitlements.d.ts +1 -1
- package/dist/src/client/schemas.d.ts +349 -90
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/package.json +1 -1
|
@@ -119,12 +119,12 @@ export interface paths {
|
|
|
119
119
|
* @description Get a customer override by customer id.
|
|
120
120
|
*/
|
|
121
121
|
get: operations['getBillingProfileCustomerOverride'];
|
|
122
|
-
put?: never;
|
|
123
122
|
/**
|
|
124
123
|
* Create a new or update a customer override
|
|
125
124
|
* @description Create a new or update an existing customer override.
|
|
126
125
|
*/
|
|
127
|
-
|
|
126
|
+
put: operations['upsertBillingProfileCustomerOverride'];
|
|
127
|
+
post?: never;
|
|
128
128
|
/**
|
|
129
129
|
* Delete a customer override
|
|
130
130
|
* @description Delete a customer override by customer id.
|
|
@@ -527,6 +527,26 @@ export interface paths {
|
|
|
527
527
|
patch?: never;
|
|
528
528
|
trace?: never;
|
|
529
529
|
};
|
|
530
|
+
'/api/v1/customers/{customerId}/subscriptions': {
|
|
531
|
+
parameters: {
|
|
532
|
+
query?: never;
|
|
533
|
+
header?: never;
|
|
534
|
+
path?: never;
|
|
535
|
+
cookie?: never;
|
|
536
|
+
};
|
|
537
|
+
/**
|
|
538
|
+
* List customer subscriptions
|
|
539
|
+
* @description Lists all subscriptions for a customer.
|
|
540
|
+
*/
|
|
541
|
+
get: operations['listCustomerSubscriptions'];
|
|
542
|
+
put?: never;
|
|
543
|
+
post?: never;
|
|
544
|
+
delete?: never;
|
|
545
|
+
options?: never;
|
|
546
|
+
head?: never;
|
|
547
|
+
patch?: never;
|
|
548
|
+
trace?: never;
|
|
549
|
+
};
|
|
530
550
|
'/api/v1/customers/{id}': {
|
|
531
551
|
parameters: {
|
|
532
552
|
query?: never;
|
|
@@ -1646,6 +1666,7 @@ export interface paths {
|
|
|
1646
1666
|
/**
|
|
1647
1667
|
* Cancel subscription
|
|
1648
1668
|
* @description Cancels the subscription.
|
|
1669
|
+
* Will result in a scheduling conflict if there are other subscriptions scheduled to start after the cancellation time.
|
|
1649
1670
|
*/
|
|
1650
1671
|
post: operations['cancelSubscription'];
|
|
1651
1672
|
delete?: never;
|
|
@@ -1697,6 +1718,27 @@ export interface paths {
|
|
|
1697
1718
|
patch?: never;
|
|
1698
1719
|
trace?: never;
|
|
1699
1720
|
};
|
|
1721
|
+
'/api/v1/subscriptions/{subscriptionId}/restore': {
|
|
1722
|
+
parameters: {
|
|
1723
|
+
query?: never;
|
|
1724
|
+
header?: never;
|
|
1725
|
+
path?: never;
|
|
1726
|
+
cookie?: never;
|
|
1727
|
+
};
|
|
1728
|
+
get?: never;
|
|
1729
|
+
put?: never;
|
|
1730
|
+
/**
|
|
1731
|
+
* Restore subscription
|
|
1732
|
+
* @description Restores a canceled subscription.
|
|
1733
|
+
* Any subscription scheduled to start later will be deleted and this subscription will be continued indefinitely.
|
|
1734
|
+
*/
|
|
1735
|
+
post: operations['restoreSubscription'];
|
|
1736
|
+
delete?: never;
|
|
1737
|
+
options?: never;
|
|
1738
|
+
head?: never;
|
|
1739
|
+
patch?: never;
|
|
1740
|
+
trace?: never;
|
|
1741
|
+
};
|
|
1700
1742
|
'/api/v1/subscriptions/{subscriptionId}/unschedule-cancelation': {
|
|
1701
1743
|
parameters: {
|
|
1702
1744
|
query?: never;
|
|
@@ -1852,6 +1894,21 @@ export interface components {
|
|
|
1852
1894
|
*/
|
|
1853
1895
|
readonly balanceAtStart: number;
|
|
1854
1896
|
};
|
|
1897
|
+
/** @description Customer specific merged profile.
|
|
1898
|
+
*
|
|
1899
|
+
* This profile is calculated from the customer override and the billing profile it references or the default.
|
|
1900
|
+
*
|
|
1901
|
+
* Thus this does not have any kind of resource fields, only the calculated values. */
|
|
1902
|
+
BillingCustomerProfile: {
|
|
1903
|
+
/** @description The name and contact information for the supplier this billing profile represents */
|
|
1904
|
+
readonly supplier: components['schemas']['BillingParty'];
|
|
1905
|
+
/** @description The billing workflow settings for this profile */
|
|
1906
|
+
readonly workflow: components['schemas']['BillingWorkflow'];
|
|
1907
|
+
/** @description The applications used by this billing profile.
|
|
1908
|
+
*
|
|
1909
|
+
* Expand settings govern if this includes the whole app object or just the ID references. */
|
|
1910
|
+
readonly apps: components['schemas']['BillingProfileAppsOrReference'];
|
|
1911
|
+
};
|
|
1855
1912
|
/** @description InvoiceLineCharge represents an amount added to the line, and will be applied before taxes. */
|
|
1856
1913
|
BillingLineCharge: {
|
|
1857
1914
|
/**
|
|
@@ -2027,7 +2084,7 @@ export interface components {
|
|
|
2027
2084
|
/** @description The apps used by this billing profile. */
|
|
2028
2085
|
apps: components['schemas']['BillingProfileAppsCreate'];
|
|
2029
2086
|
};
|
|
2030
|
-
/** @description Customer
|
|
2087
|
+
/** @description Customer override values. */
|
|
2031
2088
|
BillingProfileCustomerOverride: {
|
|
2032
2089
|
/**
|
|
2033
2090
|
* Creation Time
|
|
@@ -2043,27 +2100,21 @@ export interface components {
|
|
|
2043
2100
|
* @example 2024-01-01T01:01:01.001Z
|
|
2044
2101
|
*/
|
|
2045
2102
|
readonly updatedAt: Date;
|
|
2046
|
-
/**
|
|
2047
|
-
* Deletion Time
|
|
2048
|
-
* Format: date-time
|
|
2049
|
-
* @description Timestamp of when the resource was permanently deleted.
|
|
2050
|
-
* @example 2024-01-01T01:01:01.001Z
|
|
2051
|
-
*/
|
|
2052
|
-
readonly deletedAt?: Date;
|
|
2053
|
-
/** @description The details of the overrides active for this specific customer. */
|
|
2054
|
-
workflow?: components['schemas']['BillingProfileCustomerWorkflowOverride'];
|
|
2055
2103
|
/**
|
|
2056
2104
|
* @description The billing profile this override is associated with.
|
|
2057
2105
|
*
|
|
2058
|
-
* If
|
|
2106
|
+
* If empty the default profile is looked up dynamically.
|
|
2059
2107
|
* @example 01G65Z755AFWAKHE12NY0CQ9FH
|
|
2060
2108
|
*/
|
|
2061
|
-
|
|
2109
|
+
billingProfileId?: string;
|
|
2110
|
+
/**
|
|
2111
|
+
* @description The customer id this override is associated with.
|
|
2112
|
+
* @example 01G65Z755AFWAKHE12NY0CQ9FH
|
|
2113
|
+
*/
|
|
2114
|
+
customerId: string;
|
|
2062
2115
|
};
|
|
2063
2116
|
/** @description Payload for creating a new or updating an existing customer override. */
|
|
2064
2117
|
BillingProfileCustomerOverrideCreate: {
|
|
2065
|
-
/** @description The details of the overrides active for this specific customer. */
|
|
2066
|
-
workflow?: components['schemas']['BillingProfileCustomerWorkflowOverrideCreate'];
|
|
2067
2118
|
/**
|
|
2068
2119
|
* @description The billing profile this override is associated with.
|
|
2069
2120
|
*
|
|
@@ -2072,13 +2123,37 @@ export interface components {
|
|
|
2072
2123
|
*/
|
|
2073
2124
|
billingProfile?: string;
|
|
2074
2125
|
};
|
|
2126
|
+
/**
|
|
2127
|
+
* @description CustomerOverrideExpand specifies the parts of the profile to expand.
|
|
2128
|
+
* @enum {string}
|
|
2129
|
+
*/
|
|
2130
|
+
BillingProfileCustomerOverrideExpand: 'apps' | 'customer';
|
|
2075
2131
|
/**
|
|
2076
2132
|
* @description Order by options for customers.
|
|
2077
2133
|
* @enum {string}
|
|
2078
2134
|
*/
|
|
2079
|
-
BillingProfileCustomerOverrideOrderBy: '
|
|
2135
|
+
BillingProfileCustomerOverrideOrderBy: 'customerId' | 'customerName' | 'customerKey' | 'customerPrimaryEmail' | 'customerCreatedAt';
|
|
2136
|
+
/** @description Customer specific workflow overrides. */
|
|
2137
|
+
BillingProfileCustomerOverrideWithDetails: {
|
|
2138
|
+
/** @description The customer override values.
|
|
2139
|
+
*
|
|
2140
|
+
* If empty the merged values are calculated based on the default profile. */
|
|
2141
|
+
customerOverride?: components['schemas']['BillingProfileCustomerOverride'];
|
|
2142
|
+
/**
|
|
2143
|
+
* @description The billing profile the customerProfile is associated with at the time of query.
|
|
2144
|
+
*
|
|
2145
|
+
* customerOverride contains the explicit mapping set in the customer override object. If that is
|
|
2146
|
+
* empty, then the baseBillingProfileId is the default profile.
|
|
2147
|
+
* @example 01G65Z755AFWAKHE12NY0CQ9FH
|
|
2148
|
+
*/
|
|
2149
|
+
baseBillingProfileId: string;
|
|
2150
|
+
/** @description Merged billing profile with the customer specific overrides. */
|
|
2151
|
+
customerProfile?: components['schemas']['BillingCustomerProfile'];
|
|
2152
|
+
/** @description The customer this override belongs to. */
|
|
2153
|
+
customer?: components['schemas']['Customer'];
|
|
2154
|
+
};
|
|
2080
2155
|
/** @description Paginated response */
|
|
2081
|
-
|
|
2156
|
+
BillingProfileCustomerOverrideWithDetailsPaginatedResponse: {
|
|
2082
2157
|
/**
|
|
2083
2158
|
* @description The items in the current page.
|
|
2084
2159
|
* @example 500
|
|
@@ -2095,37 +2170,13 @@ export interface components {
|
|
|
2095
2170
|
*/
|
|
2096
2171
|
pageSize: number;
|
|
2097
2172
|
/** @description The items in the current page. */
|
|
2098
|
-
items: components['schemas']['
|
|
2099
|
-
};
|
|
2100
|
-
/** @description Customer specific workflow overrides. */
|
|
2101
|
-
BillingProfileCustomerWorkflowOverride: {
|
|
2102
|
-
/** @description The collection settings for this workflow */
|
|
2103
|
-
collection?: components['schemas']['BillingWorkflowCollectionSettings'];
|
|
2104
|
-
/** @description The invoicing settings for this workflow */
|
|
2105
|
-
invoicing?: components['schemas']['BillingWorkflowInvoicingSettings'];
|
|
2106
|
-
/** @description The payment settings for this workflow */
|
|
2107
|
-
payment?: components['schemas']['BillingWorkflowPaymentSettings'];
|
|
2108
|
-
/** @description The tax app used for this workflow */
|
|
2109
|
-
readonly taxApp: components['schemas']['App'];
|
|
2110
|
-
/** @description The invoicing app used for this workflow */
|
|
2111
|
-
readonly invoicingApp: components['schemas']['App'];
|
|
2112
|
-
/** @description The payment app used for this workflow */
|
|
2113
|
-
readonly paymentApp: components['schemas']['App'];
|
|
2114
|
-
};
|
|
2115
|
-
/** @description Resource create operation model. */
|
|
2116
|
-
BillingProfileCustomerWorkflowOverrideCreate: {
|
|
2117
|
-
/** @description The collection settings for this workflow */
|
|
2118
|
-
collection?: components['schemas']['BillingWorkflowCollectionSettings'];
|
|
2119
|
-
/** @description The invoicing settings for this workflow */
|
|
2120
|
-
invoicing?: components['schemas']['BillingWorkflowInvoicingSettings'];
|
|
2121
|
-
/** @description The payment settings for this workflow */
|
|
2122
|
-
payment?: components['schemas']['BillingWorkflowPaymentSettings'];
|
|
2173
|
+
items: components['schemas']['BillingProfileCustomerOverrideWithDetails'][];
|
|
2123
2174
|
};
|
|
2124
2175
|
/**
|
|
2125
2176
|
* @description BillingProfileExpand details what profile fields to expand
|
|
2126
2177
|
* @enum {string}
|
|
2127
2178
|
*/
|
|
2128
|
-
BillingProfileExpand: 'apps'
|
|
2179
|
+
BillingProfileExpand: 'apps';
|
|
2129
2180
|
/**
|
|
2130
2181
|
* @description BillingProfileOrderBy specifies the ordering options for profiles
|
|
2131
2182
|
* @enum {string}
|
|
@@ -4157,7 +4208,7 @@ export interface components {
|
|
|
4157
4208
|
* @description InvoiceExpand specifies the parts of the invoice to expand in the list output.
|
|
4158
4209
|
* @enum {string}
|
|
4159
4210
|
*/
|
|
4160
|
-
InvoiceExpand: '
|
|
4211
|
+
InvoiceExpand: 'lines' | 'preceding' | 'workflow.apps';
|
|
4161
4212
|
/**
|
|
4162
4213
|
* @description InvoiceFlatFeeCategory determines if the flat fee is a regular fee due to use due to a
|
|
4163
4214
|
* commitment.
|
|
@@ -7240,6 +7291,26 @@ export interface components {
|
|
|
7240
7291
|
/** @description The entitlement of the Subscription Item. */
|
|
7241
7292
|
entitlement?: components['schemas']['Entitlement'];
|
|
7242
7293
|
};
|
|
7294
|
+
/** @description Paginated response */
|
|
7295
|
+
SubscriptionPaginatedResponse: {
|
|
7296
|
+
/**
|
|
7297
|
+
* @description The items in the current page.
|
|
7298
|
+
* @example 500
|
|
7299
|
+
*/
|
|
7300
|
+
totalCount: number;
|
|
7301
|
+
/**
|
|
7302
|
+
* @description The items in the current page.
|
|
7303
|
+
* @example 1
|
|
7304
|
+
*/
|
|
7305
|
+
page: number;
|
|
7306
|
+
/**
|
|
7307
|
+
* @description The items in the current page.
|
|
7308
|
+
* @example 100
|
|
7309
|
+
*/
|
|
7310
|
+
pageSize: number;
|
|
7311
|
+
/** @description The items in the current page. */
|
|
7312
|
+
items: components['schemas']['Subscription'][];
|
|
7313
|
+
};
|
|
7243
7314
|
/** @description Subscription phase create input. */
|
|
7244
7315
|
SubscriptionPhaseCreate: {
|
|
7245
7316
|
/**
|
|
@@ -7654,6 +7725,24 @@ export interface components {
|
|
|
7654
7725
|
'BillingProfileCustomerOverrideOrderByOrdering.order': components['schemas']['SortOrder'];
|
|
7655
7726
|
/** @description The order by field. */
|
|
7656
7727
|
'BillingProfileCustomerOverrideOrderByOrdering.orderBy': components['schemas']['BillingProfileCustomerOverrideOrderBy'];
|
|
7728
|
+
/** @description Filter by billing profile. */
|
|
7729
|
+
'BillingProfileListCustomerOverridesParams.billingProfile': string[];
|
|
7730
|
+
/** @description Filter by customer id. */
|
|
7731
|
+
'BillingProfileListCustomerOverridesParams.customerId': string[];
|
|
7732
|
+
/** @description Filter by customer key */
|
|
7733
|
+
'BillingProfileListCustomerOverridesParams.customerKey': string;
|
|
7734
|
+
/** @description Filter by customer name. */
|
|
7735
|
+
'BillingProfileListCustomerOverridesParams.customerName': string;
|
|
7736
|
+
/** @description Filter by customer primary email */
|
|
7737
|
+
'BillingProfileListCustomerOverridesParams.customerPrimaryEmail': string;
|
|
7738
|
+
/** @description Expand the response with additional details. */
|
|
7739
|
+
'BillingProfileListCustomerOverridesParams.expand': components['schemas']['BillingProfileCustomerOverrideExpand'][];
|
|
7740
|
+
/** @description Include customers without customer overrides.
|
|
7741
|
+
*
|
|
7742
|
+
* If set to false only the customers specifically associated with a billing profile will be returned.
|
|
7743
|
+
*
|
|
7744
|
+
* If set to true, in case of the default billing profile, all customers will be returned. */
|
|
7745
|
+
'BillingProfileListCustomerOverridesParams.includeAllCustomers': boolean;
|
|
7657
7746
|
/** @description The order direction. */
|
|
7658
7747
|
'BillingProfileOrderByOrdering.order': components['schemas']['SortOrder'];
|
|
7659
7748
|
/** @description The order by field. */
|
|
@@ -7812,6 +7901,7 @@ export type AppStatus = components['schemas']['AppStatus'];
|
|
|
7812
7901
|
export type AppType = components['schemas']['AppType'];
|
|
7813
7902
|
export type BadRequestProblemResponse = components['schemas']['BadRequestProblemResponse'];
|
|
7814
7903
|
export type BalanceHistoryWindow = components['schemas']['BalanceHistoryWindow'];
|
|
7904
|
+
export type BillingCustomerProfile = components['schemas']['BillingCustomerProfile'];
|
|
7815
7905
|
export type BillingLineCharge = components['schemas']['BillingLineCharge'];
|
|
7816
7906
|
export type BillingParty = components['schemas']['BillingParty'];
|
|
7817
7907
|
export type BillingPartyReplaceUpdate = components['schemas']['BillingPartyReplaceUpdate'];
|
|
@@ -7824,10 +7914,10 @@ export type BillingProfileAppsOrReference = components['schemas']['BillingProfil
|
|
|
7824
7914
|
export type BillingProfileCreate = components['schemas']['BillingProfileCreate'];
|
|
7825
7915
|
export type BillingProfileCustomerOverride = components['schemas']['BillingProfileCustomerOverride'];
|
|
7826
7916
|
export type BillingProfileCustomerOverrideCreate = components['schemas']['BillingProfileCustomerOverrideCreate'];
|
|
7917
|
+
export type BillingProfileCustomerOverrideExpand = components['schemas']['BillingProfileCustomerOverrideExpand'];
|
|
7827
7918
|
export type BillingProfileCustomerOverrideOrderBy = components['schemas']['BillingProfileCustomerOverrideOrderBy'];
|
|
7828
|
-
export type
|
|
7829
|
-
export type
|
|
7830
|
-
export type BillingProfileCustomerWorkflowOverrideCreate = components['schemas']['BillingProfileCustomerWorkflowOverrideCreate'];
|
|
7919
|
+
export type BillingProfileCustomerOverrideWithDetails = components['schemas']['BillingProfileCustomerOverrideWithDetails'];
|
|
7920
|
+
export type BillingProfileCustomerOverrideWithDetailsPaginatedResponse = components['schemas']['BillingProfileCustomerOverrideWithDetailsPaginatedResponse'];
|
|
7831
7921
|
export type BillingProfileExpand = components['schemas']['BillingProfileExpand'];
|
|
7832
7922
|
export type BillingProfileOrderBy = components['schemas']['BillingProfileOrderBy'];
|
|
7833
7923
|
export type BillingProfilePaginatedResponse = components['schemas']['BillingProfilePaginatedResponse'];
|
|
@@ -8068,6 +8158,7 @@ export type SubscriptionEditOperation = components['schemas']['SubscriptionEditO
|
|
|
8068
8158
|
export type SubscriptionExpanded = components['schemas']['SubscriptionExpanded'];
|
|
8069
8159
|
export type SubscriptionItem = components['schemas']['SubscriptionItem'];
|
|
8070
8160
|
export type SubscriptionItemIncluded = components['schemas']['SubscriptionItemIncluded'];
|
|
8161
|
+
export type SubscriptionPaginatedResponse = components['schemas']['SubscriptionPaginatedResponse'];
|
|
8071
8162
|
export type SubscriptionPhaseCreate = components['schemas']['SubscriptionPhaseCreate'];
|
|
8072
8163
|
export type SubscriptionPhaseExpanded = components['schemas']['SubscriptionPhaseExpanded'];
|
|
8073
8164
|
export type SubscriptionStatus = components['schemas']['SubscriptionStatus'];
|
|
@@ -8097,6 +8188,13 @@ export type WindowSize = components['schemas']['WindowSize'];
|
|
|
8097
8188
|
export type WindowedBalanceHistory = components['schemas']['WindowedBalanceHistory'];
|
|
8098
8189
|
export type ParameterBillingProfileCustomerOverrideOrderByOrderingOrder = components['parameters']['BillingProfileCustomerOverrideOrderByOrdering.order'];
|
|
8099
8190
|
export type ParameterBillingProfileCustomerOverrideOrderByOrderingOrderBy = components['parameters']['BillingProfileCustomerOverrideOrderByOrdering.orderBy'];
|
|
8191
|
+
export type ParameterBillingProfileListCustomerOverridesParamsBillingProfile = components['parameters']['BillingProfileListCustomerOverridesParams.billingProfile'];
|
|
8192
|
+
export type ParameterBillingProfileListCustomerOverridesParamsCustomerId = components['parameters']['BillingProfileListCustomerOverridesParams.customerId'];
|
|
8193
|
+
export type ParameterBillingProfileListCustomerOverridesParamsCustomerKey = components['parameters']['BillingProfileListCustomerOverridesParams.customerKey'];
|
|
8194
|
+
export type ParameterBillingProfileListCustomerOverridesParamsCustomerName = components['parameters']['BillingProfileListCustomerOverridesParams.customerName'];
|
|
8195
|
+
export type ParameterBillingProfileListCustomerOverridesParamsCustomerPrimaryEmail = components['parameters']['BillingProfileListCustomerOverridesParams.customerPrimaryEmail'];
|
|
8196
|
+
export type ParameterBillingProfileListCustomerOverridesParamsExpand = components['parameters']['BillingProfileListCustomerOverridesParams.expand'];
|
|
8197
|
+
export type ParameterBillingProfileListCustomerOverridesParamsIncludeAllCustomers = components['parameters']['BillingProfileListCustomerOverridesParams.includeAllCustomers'];
|
|
8100
8198
|
export type ParameterBillingProfileOrderByOrderingOrder = components['parameters']['BillingProfileOrderByOrdering.order'];
|
|
8101
8199
|
export type ParameterBillingProfileOrderByOrderingOrderBy = components['parameters']['BillingProfileOrderByOrdering.orderBy'];
|
|
8102
8200
|
export type ParameterCustomerOrderByOrderingOrder = components['parameters']['CustomerOrderByOrdering.order'];
|
|
@@ -8660,7 +8758,28 @@ export interface operations {
|
|
|
8660
8758
|
listBillingProfileCustomerOverrides: {
|
|
8661
8759
|
parameters: {
|
|
8662
8760
|
query?: {
|
|
8663
|
-
|
|
8761
|
+
/** @description Filter by billing profile. */
|
|
8762
|
+
billingProfile?: components['parameters']['BillingProfileListCustomerOverridesParams.billingProfile'];
|
|
8763
|
+
/** @description Include customers without customer overrides.
|
|
8764
|
+
*
|
|
8765
|
+
* If set to false only the customers specifically associated with a billing profile will be returned.
|
|
8766
|
+
*
|
|
8767
|
+
* If set to true, in case of the default billing profile, all customers will be returned. */
|
|
8768
|
+
includeAllCustomers?: components['parameters']['BillingProfileListCustomerOverridesParams.includeAllCustomers'];
|
|
8769
|
+
/** @description Filter by customer id. */
|
|
8770
|
+
customerId?: components['parameters']['BillingProfileListCustomerOverridesParams.customerId'];
|
|
8771
|
+
/** @description Filter by customer name. */
|
|
8772
|
+
customerName?: components['parameters']['BillingProfileListCustomerOverridesParams.customerName'];
|
|
8773
|
+
/** @description Filter by customer key */
|
|
8774
|
+
customerKey?: components['parameters']['BillingProfileListCustomerOverridesParams.customerKey'];
|
|
8775
|
+
/** @description Filter by customer primary email */
|
|
8776
|
+
customerPrimaryEmail?: components['parameters']['BillingProfileListCustomerOverridesParams.customerPrimaryEmail'];
|
|
8777
|
+
/** @description Expand the response with additional details. */
|
|
8778
|
+
expand?: components['parameters']['BillingProfileListCustomerOverridesParams.expand'];
|
|
8779
|
+
/** @description The order direction. */
|
|
8780
|
+
order?: components['parameters']['BillingProfileCustomerOverrideOrderByOrdering.order'];
|
|
8781
|
+
/** @description The order by field. */
|
|
8782
|
+
orderBy?: components['parameters']['BillingProfileCustomerOverrideOrderByOrdering.orderBy'];
|
|
8664
8783
|
/** @description Start date-time in RFC 3339 format.
|
|
8665
8784
|
*
|
|
8666
8785
|
* Inclusive. */
|
|
@@ -8669,18 +8788,6 @@ export interface operations {
|
|
|
8669
8788
|
*
|
|
8670
8789
|
* Default is 100. */
|
|
8671
8790
|
pageSize?: components['parameters']['Pagination.pageSize'];
|
|
8672
|
-
/** @description Number of items to skip.
|
|
8673
|
-
*
|
|
8674
|
-
* Default is 0. */
|
|
8675
|
-
offset?: components['parameters']['LimitOffset.offset'];
|
|
8676
|
-
/** @description Number of items to return.
|
|
8677
|
-
*
|
|
8678
|
-
* Default is 100. */
|
|
8679
|
-
limit?: components['parameters']['LimitOffset.limit'];
|
|
8680
|
-
/** @description The order direction. */
|
|
8681
|
-
order?: components['parameters']['BillingProfileCustomerOverrideOrderByOrdering.order'];
|
|
8682
|
-
/** @description The order by field. */
|
|
8683
|
-
orderBy?: components['parameters']['BillingProfileCustomerOverrideOrderByOrdering.orderBy'];
|
|
8684
8791
|
};
|
|
8685
8792
|
header?: never;
|
|
8686
8793
|
path?: never;
|
|
@@ -8694,7 +8801,7 @@ export interface operations {
|
|
|
8694
8801
|
[name: string]: unknown;
|
|
8695
8802
|
};
|
|
8696
8803
|
content: {
|
|
8697
|
-
'application/json': components['schemas']['
|
|
8804
|
+
'application/json': components['schemas']['BillingProfileCustomerOverrideWithDetailsPaginatedResponse'];
|
|
8698
8805
|
};
|
|
8699
8806
|
};
|
|
8700
8807
|
/** @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). */
|
|
@@ -8755,7 +8862,9 @@ export interface operations {
|
|
|
8755
8862
|
};
|
|
8756
8863
|
getBillingProfileCustomerOverride: {
|
|
8757
8864
|
parameters: {
|
|
8758
|
-
query?:
|
|
8865
|
+
query?: {
|
|
8866
|
+
expand?: components['schemas']['BillingProfileCustomerOverrideExpand'][];
|
|
8867
|
+
};
|
|
8759
8868
|
header?: never;
|
|
8760
8869
|
path: {
|
|
8761
8870
|
customerId: string;
|
|
@@ -8770,7 +8879,7 @@ export interface operations {
|
|
|
8770
8879
|
[name: string]: unknown;
|
|
8771
8880
|
};
|
|
8772
8881
|
content: {
|
|
8773
|
-
'application/json': components['schemas']['
|
|
8882
|
+
'application/json': components['schemas']['BillingProfileCustomerOverrideWithDetails'];
|
|
8774
8883
|
};
|
|
8775
8884
|
};
|
|
8776
8885
|
/** @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). */
|
|
@@ -8859,16 +8968,7 @@ export interface operations {
|
|
|
8859
8968
|
[name: string]: unknown;
|
|
8860
8969
|
};
|
|
8861
8970
|
content: {
|
|
8862
|
-
'application/json': components['schemas']['
|
|
8863
|
-
};
|
|
8864
|
-
};
|
|
8865
|
-
/** @description The request has succeeded and a new resource has been created as a result. */
|
|
8866
|
-
201: {
|
|
8867
|
-
headers: {
|
|
8868
|
-
[name: string]: unknown;
|
|
8869
|
-
};
|
|
8870
|
-
content: {
|
|
8871
|
-
'application/json': components['schemas']['BillingProfileCustomerOverride'];
|
|
8971
|
+
'application/json': components['schemas']['BillingProfileCustomerOverrideWithDetails'];
|
|
8872
8972
|
};
|
|
8873
8973
|
};
|
|
8874
8974
|
/** @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). */
|
|
@@ -9124,14 +9224,6 @@ export interface operations {
|
|
|
9124
9224
|
*
|
|
9125
9225
|
* Default is 100. */
|
|
9126
9226
|
pageSize?: components['parameters']['Pagination.pageSize'];
|
|
9127
|
-
/** @description Number of items to skip.
|
|
9128
|
-
*
|
|
9129
|
-
* Default is 0. */
|
|
9130
|
-
offset?: components['parameters']['LimitOffset.offset'];
|
|
9131
|
-
/** @description Number of items to return.
|
|
9132
|
-
*
|
|
9133
|
-
* Default is 100. */
|
|
9134
|
-
limit?: components['parameters']['LimitOffset.limit'];
|
|
9135
9227
|
/** @description The order direction. */
|
|
9136
9228
|
order?: components['parameters']['InvoiceOrderByOrdering.order'];
|
|
9137
9229
|
/** @description The order by field. */
|
|
@@ -10066,14 +10158,6 @@ export interface operations {
|
|
|
10066
10158
|
*
|
|
10067
10159
|
* Default is 100. */
|
|
10068
10160
|
pageSize?: components['parameters']['Pagination.pageSize'];
|
|
10069
|
-
/** @description Number of items to skip.
|
|
10070
|
-
*
|
|
10071
|
-
* Default is 0. */
|
|
10072
|
-
offset?: components['parameters']['LimitOffset.offset'];
|
|
10073
|
-
/** @description Number of items to return.
|
|
10074
|
-
*
|
|
10075
|
-
* Default is 100. */
|
|
10076
|
-
limit?: components['parameters']['LimitOffset.limit'];
|
|
10077
10161
|
/** @description The order direction. */
|
|
10078
10162
|
order?: components['parameters']['BillingProfileOrderByOrdering.order'];
|
|
10079
10163
|
/** @description The order by field. */
|
|
@@ -11017,6 +11101,96 @@ export interface operations {
|
|
|
11017
11101
|
};
|
|
11018
11102
|
};
|
|
11019
11103
|
};
|
|
11104
|
+
listCustomerSubscriptions: {
|
|
11105
|
+
parameters: {
|
|
11106
|
+
query?: {
|
|
11107
|
+
/** @description The page number. */
|
|
11108
|
+
page?: components['parameters']['PaginatedQuery.page'];
|
|
11109
|
+
/** @description The number of items in the page. */
|
|
11110
|
+
pageSize?: components['parameters']['PaginatedQuery.pageSize'];
|
|
11111
|
+
};
|
|
11112
|
+
header?: never;
|
|
11113
|
+
path: {
|
|
11114
|
+
customerId: string;
|
|
11115
|
+
};
|
|
11116
|
+
cookie?: never;
|
|
11117
|
+
};
|
|
11118
|
+
requestBody?: never;
|
|
11119
|
+
responses: {
|
|
11120
|
+
/** @description The request has succeeded. */
|
|
11121
|
+
200: {
|
|
11122
|
+
headers: {
|
|
11123
|
+
[name: string]: unknown;
|
|
11124
|
+
};
|
|
11125
|
+
content: {
|
|
11126
|
+
'application/json': components['schemas']['SubscriptionPaginatedResponse'];
|
|
11127
|
+
};
|
|
11128
|
+
};
|
|
11129
|
+
/** @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). */
|
|
11130
|
+
400: {
|
|
11131
|
+
headers: {
|
|
11132
|
+
[name: string]: unknown;
|
|
11133
|
+
};
|
|
11134
|
+
content: {
|
|
11135
|
+
'application/problem+json': components['schemas']['BadRequestProblemResponse'];
|
|
11136
|
+
};
|
|
11137
|
+
};
|
|
11138
|
+
/** @description The request has not been applied because it lacks valid authentication credentials for the target resource. */
|
|
11139
|
+
401: {
|
|
11140
|
+
headers: {
|
|
11141
|
+
[name: string]: unknown;
|
|
11142
|
+
};
|
|
11143
|
+
content: {
|
|
11144
|
+
'application/problem+json': components['schemas']['UnauthorizedProblemResponse'];
|
|
11145
|
+
};
|
|
11146
|
+
};
|
|
11147
|
+
/** @description The server understood the request but refuses to authorize it. */
|
|
11148
|
+
403: {
|
|
11149
|
+
headers: {
|
|
11150
|
+
[name: string]: unknown;
|
|
11151
|
+
};
|
|
11152
|
+
content: {
|
|
11153
|
+
'application/problem+json': components['schemas']['ForbiddenProblemResponse'];
|
|
11154
|
+
};
|
|
11155
|
+
};
|
|
11156
|
+
/** @description The origin server did not find a current representation for the target resource or is not willing to disclose that one exists. */
|
|
11157
|
+
404: {
|
|
11158
|
+
headers: {
|
|
11159
|
+
[name: string]: unknown;
|
|
11160
|
+
};
|
|
11161
|
+
content: {
|
|
11162
|
+
'application/problem+json': components['schemas']['NotFoundProblemResponse'];
|
|
11163
|
+
};
|
|
11164
|
+
};
|
|
11165
|
+
/** @description The server encountered an unexpected condition that prevented it from fulfilling the request. */
|
|
11166
|
+
500: {
|
|
11167
|
+
headers: {
|
|
11168
|
+
[name: string]: unknown;
|
|
11169
|
+
};
|
|
11170
|
+
content: {
|
|
11171
|
+
'application/problem+json': components['schemas']['InternalServerErrorProblemResponse'];
|
|
11172
|
+
};
|
|
11173
|
+
};
|
|
11174
|
+
/** @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. */
|
|
11175
|
+
503: {
|
|
11176
|
+
headers: {
|
|
11177
|
+
[name: string]: unknown;
|
|
11178
|
+
};
|
|
11179
|
+
content: {
|
|
11180
|
+
'application/problem+json': components['schemas']['ServiceUnavailableProblemResponse'];
|
|
11181
|
+
};
|
|
11182
|
+
};
|
|
11183
|
+
/** @description An unexpected error response. */
|
|
11184
|
+
default: {
|
|
11185
|
+
headers: {
|
|
11186
|
+
[name: string]: unknown;
|
|
11187
|
+
};
|
|
11188
|
+
content: {
|
|
11189
|
+
'application/problem+json': components['schemas']['UnexpectedProblemResponse'];
|
|
11190
|
+
};
|
|
11191
|
+
};
|
|
11192
|
+
};
|
|
11193
|
+
};
|
|
11020
11194
|
getCustomer: {
|
|
11021
11195
|
parameters: {
|
|
11022
11196
|
query?: never;
|
|
@@ -17527,6 +17701,91 @@ export interface operations {
|
|
|
17527
17701
|
};
|
|
17528
17702
|
};
|
|
17529
17703
|
};
|
|
17704
|
+
restoreSubscription: {
|
|
17705
|
+
parameters: {
|
|
17706
|
+
query?: never;
|
|
17707
|
+
header?: never;
|
|
17708
|
+
path: {
|
|
17709
|
+
subscriptionId: string;
|
|
17710
|
+
};
|
|
17711
|
+
cookie?: never;
|
|
17712
|
+
};
|
|
17713
|
+
requestBody?: never;
|
|
17714
|
+
responses: {
|
|
17715
|
+
/** @description The request has succeeded. */
|
|
17716
|
+
200: {
|
|
17717
|
+
headers: {
|
|
17718
|
+
[name: string]: unknown;
|
|
17719
|
+
};
|
|
17720
|
+
content: {
|
|
17721
|
+
'application/json': components['schemas']['Subscription'];
|
|
17722
|
+
};
|
|
17723
|
+
};
|
|
17724
|
+
/** @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). */
|
|
17725
|
+
400: {
|
|
17726
|
+
headers: {
|
|
17727
|
+
[name: string]: unknown;
|
|
17728
|
+
};
|
|
17729
|
+
content: {
|
|
17730
|
+
'application/problem+json': components['schemas']['BadRequestProblemResponse'];
|
|
17731
|
+
};
|
|
17732
|
+
};
|
|
17733
|
+
/** @description The request has not been applied because it lacks valid authentication credentials for the target resource. */
|
|
17734
|
+
401: {
|
|
17735
|
+
headers: {
|
|
17736
|
+
[name: string]: unknown;
|
|
17737
|
+
};
|
|
17738
|
+
content: {
|
|
17739
|
+
'application/problem+json': components['schemas']['UnauthorizedProblemResponse'];
|
|
17740
|
+
};
|
|
17741
|
+
};
|
|
17742
|
+
/** @description The server understood the request but refuses to authorize it. */
|
|
17743
|
+
403: {
|
|
17744
|
+
headers: {
|
|
17745
|
+
[name: string]: unknown;
|
|
17746
|
+
};
|
|
17747
|
+
content: {
|
|
17748
|
+
'application/problem+json': components['schemas']['ForbiddenProblemResponse'];
|
|
17749
|
+
};
|
|
17750
|
+
};
|
|
17751
|
+
/** @description The origin server did not find a current representation for the target resource or is not willing to disclose that one exists. */
|
|
17752
|
+
404: {
|
|
17753
|
+
headers: {
|
|
17754
|
+
[name: string]: unknown;
|
|
17755
|
+
};
|
|
17756
|
+
content: {
|
|
17757
|
+
'application/problem+json': components['schemas']['NotFoundProblemResponse'];
|
|
17758
|
+
};
|
|
17759
|
+
};
|
|
17760
|
+
/** @description The server encountered an unexpected condition that prevented it from fulfilling the request. */
|
|
17761
|
+
500: {
|
|
17762
|
+
headers: {
|
|
17763
|
+
[name: string]: unknown;
|
|
17764
|
+
};
|
|
17765
|
+
content: {
|
|
17766
|
+
'application/problem+json': components['schemas']['InternalServerErrorProblemResponse'];
|
|
17767
|
+
};
|
|
17768
|
+
};
|
|
17769
|
+
/** @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. */
|
|
17770
|
+
503: {
|
|
17771
|
+
headers: {
|
|
17772
|
+
[name: string]: unknown;
|
|
17773
|
+
};
|
|
17774
|
+
content: {
|
|
17775
|
+
'application/problem+json': components['schemas']['ServiceUnavailableProblemResponse'];
|
|
17776
|
+
};
|
|
17777
|
+
};
|
|
17778
|
+
/** @description An unexpected error response. */
|
|
17779
|
+
default: {
|
|
17780
|
+
headers: {
|
|
17781
|
+
[name: string]: unknown;
|
|
17782
|
+
};
|
|
17783
|
+
content: {
|
|
17784
|
+
'application/problem+json': components['schemas']['UnexpectedProblemResponse'];
|
|
17785
|
+
};
|
|
17786
|
+
};
|
|
17787
|
+
};
|
|
17788
|
+
};
|
|
17530
17789
|
unscheduleCancelation: {
|
|
17531
17790
|
parameters: {
|
|
17532
17791
|
query?: never;
|