@cloudfleet/sdk 0.0.1-200be61 → 0.0.1-20bd5c1
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/README.md +26 -2
- package/dist/@tanstack/react-query.gen.d.ts +526 -574
- package/dist/@tanstack/react-query.gen.d.ts.map +1 -1
- package/dist/@tanstack/react-query.gen.js +534 -377
- package/dist/@tanstack/react-query.gen.js.map +1 -1
- package/dist/client/client.gen.d.ts.map +1 -1
- package/dist/client/client.gen.js +1 -4
- package/dist/client/client.gen.js.map +1 -1
- package/dist/client/types.gen.d.ts +1 -1
- package/dist/client/types.gen.d.ts.map +1 -1
- package/dist/client/utils.gen.d.ts +2 -2
- package/dist/client/utils.gen.d.ts.map +1 -1
- package/dist/client/utils.gen.js +3 -3
- package/dist/client/utils.gen.js.map +1 -1
- package/dist/core/params.gen.js +4 -4
- package/dist/core/params.gen.js.map +1 -1
- package/dist/schemas.gen.d.ts +913 -256
- package/dist/schemas.gen.d.ts.map +1 -1
- package/dist/schemas.gen.js +1869 -356
- package/dist/schemas.gen.js.map +1 -1
- package/dist/sdk.gen.d.ts +271 -208
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/sdk.gen.js +403 -310
- package/dist/sdk.gen.js.map +1 -1
- package/dist/types.gen.d.ts +1433 -805
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/zod.gen.d.ts +3588 -1446
- package/dist/zod.gen.d.ts.map +1 -1
- package/dist/zod.gen.js +1310 -348
- package/dist/zod.gen.js.map +1 -1
- package/package.json +10 -13
package/dist/sdk.gen.js
CHANGED
|
@@ -1,61 +1,33 @@
|
|
|
1
1
|
// This file is auto-generated by @hey-api/openapi-ts
|
|
2
2
|
import { formDataBodySerializer } from './client';
|
|
3
3
|
import { client } from './client.gen';
|
|
4
|
-
export class
|
|
5
|
-
/**
|
|
6
|
-
* Get billing usage information.
|
|
7
|
-
*
|
|
8
|
-
* Returns aggregated usage information for the organization with facets for filtering. For more information on billing and payments, see [Billing and pricing](https://cloudfleet.ai/docs/organization/billing/) section of documentaiton. This endpoint is available to all users in the organization.
|
|
9
|
-
*
|
|
10
|
-
*/
|
|
11
|
-
static getUsage(options) {
|
|
12
|
-
return (options?.client ?? client).get({ url: '/billing/usage', ...options });
|
|
13
|
-
}
|
|
14
|
-
/**
|
|
15
|
-
* Get organization payment method information.
|
|
16
|
-
*
|
|
17
|
-
* Returns the information about the payment card associated with the organization with sensitive information redacted. Payment details can be updated in the Cloudfleet console only, please visit https://console.cloudfleet.ai. This endpoint is available to all users in the organization.
|
|
18
|
-
*
|
|
19
|
-
*/
|
|
20
|
-
static getPaymentMethod(options) {
|
|
21
|
-
return (options?.client ?? client).get({ url: '/billing/payment-method', ...options });
|
|
22
|
-
}
|
|
4
|
+
export class UsersService {
|
|
23
5
|
/**
|
|
24
|
-
* Get
|
|
25
|
-
*
|
|
26
|
-
* Endpoint returns the Stripe secret key for the organization. This key is used to securely update the payment method in the Cloudfleet console only, please visit https://console.cloudfleet.ai. This endpoint is available to administrators of the organization only.
|
|
27
|
-
*
|
|
6
|
+
* Get a list of organizations the user belongs to. Used during authentication process.
|
|
28
7
|
*/
|
|
29
|
-
static
|
|
30
|
-
return (options
|
|
8
|
+
static listUserOrganizations(options) {
|
|
9
|
+
return (options.client ?? client).get({ url: '/users/organizations/{email}', ...options });
|
|
31
10
|
}
|
|
32
11
|
/**
|
|
33
|
-
* List
|
|
34
|
-
*
|
|
35
|
-
* Returns a list of invoices for the organization. For more information on billing and payments, see [Billing and pricing](https://cloudfleet.ai/docs/organization/billing/) section of documentaiton. This endpoint is available to all users in the organization.
|
|
12
|
+
* List users in organization.
|
|
36
13
|
*
|
|
37
|
-
|
|
38
|
-
static listInvoices(options) {
|
|
39
|
-
return (options?.client ?? client).get({ url: '/billing/invoices', ...options });
|
|
40
|
-
}
|
|
41
|
-
/**
|
|
42
|
-
* Get organization contact and billing address information.
|
|
14
|
+
* Returns a list of user details and their roles. For more information on identity access management, see [Users](https://cloudfleet.ai/docs/organization/users/) section of documentaiton.
|
|
43
15
|
*
|
|
44
|
-
*
|
|
16
|
+
* This endpoint is available to all users in the organization.
|
|
45
17
|
*
|
|
46
18
|
*/
|
|
47
|
-
static
|
|
48
|
-
return (options?.client ?? client).get({ url: '/
|
|
19
|
+
static listUsers(options) {
|
|
20
|
+
return (options?.client ?? client).get({ url: '/users', ...options });
|
|
49
21
|
}
|
|
50
22
|
/**
|
|
51
|
-
*
|
|
23
|
+
* Create a new user.
|
|
52
24
|
*
|
|
53
|
-
*
|
|
25
|
+
* Create a new user in your Cloudfleet organization. Requires a valid invite code generated by the `invites create` command. The invite code is a unique string that can be used only once to create a new user. The invite code is generated by the `POST /invites` endpoint.
|
|
54
26
|
*
|
|
55
27
|
*/
|
|
56
|
-
static
|
|
57
|
-
return (options.client ?? client).
|
|
58
|
-
url: '/
|
|
28
|
+
static createUser(options) {
|
|
29
|
+
return (options.client ?? client).post({
|
|
30
|
+
url: '/users',
|
|
59
31
|
...options,
|
|
60
32
|
headers: {
|
|
61
33
|
'Content-Type': 'application/json',
|
|
@@ -64,23 +36,34 @@ export class BillingService {
|
|
|
64
36
|
});
|
|
65
37
|
}
|
|
66
38
|
/**
|
|
67
|
-
*
|
|
39
|
+
* Delete user by id.
|
|
68
40
|
*
|
|
69
|
-
*
|
|
41
|
+
* Sets user status to `inactive`. Inactive users cannot log in and manage organization resources. This endpoint is available to administrators of the organization only.
|
|
70
42
|
*
|
|
71
43
|
*/
|
|
72
|
-
static
|
|
73
|
-
return (options
|
|
44
|
+
static deleteUser(options) {
|
|
45
|
+
return (options.client ?? client).delete({ url: '/users/{user_id}', ...options });
|
|
74
46
|
}
|
|
75
47
|
/**
|
|
76
|
-
*
|
|
48
|
+
* Get user profile information by id.
|
|
77
49
|
*
|
|
78
|
-
*
|
|
50
|
+
* Returns user details including their roles. For more information on identity access management, see [Users](https://cloudfleet.ai/docs/organization/users/) section of documentaiton.
|
|
51
|
+
*
|
|
52
|
+
* This endpoint is available to all users in the organization.
|
|
79
53
|
*
|
|
80
54
|
*/
|
|
81
|
-
static
|
|
82
|
-
return (options.client ?? client).
|
|
83
|
-
|
|
55
|
+
static getUser(options) {
|
|
56
|
+
return (options.client ?? client).get({ url: '/users/{user_id}', ...options });
|
|
57
|
+
}
|
|
58
|
+
/**
|
|
59
|
+
* Update user profile information.
|
|
60
|
+
*
|
|
61
|
+
* Update user profile information: email, first name, last name, role. This endpoint can be accessed by administrators and the user itself. Role and status can be changed by administrators only.
|
|
62
|
+
*
|
|
63
|
+
*/
|
|
64
|
+
static updateUser(options) {
|
|
65
|
+
return (options.client ?? client).put({
|
|
66
|
+
url: '/users/{user_id}',
|
|
84
67
|
...options,
|
|
85
68
|
headers: {
|
|
86
69
|
'Content-Type': 'application/json',
|
|
@@ -89,29 +72,27 @@ export class BillingService {
|
|
|
89
72
|
});
|
|
90
73
|
}
|
|
91
74
|
}
|
|
92
|
-
export class
|
|
75
|
+
export class TokensService {
|
|
93
76
|
/**
|
|
94
|
-
* List
|
|
95
|
-
*
|
|
96
|
-
* Returns a list of charts in the cluster.
|
|
77
|
+
* List access tokens in organization.
|
|
97
78
|
*
|
|
98
|
-
* This endpoint is available to all users in the organization.
|
|
79
|
+
* This endpoint allows you to get a list of all access tokens details in organization. For more information about identity access management and security, see [Service Accounts](https://cloudfleet.ai/docs/organization/api-tokens/) section of documentaiton. This endpoint is available to all users in the organization.
|
|
99
80
|
*
|
|
100
81
|
*/
|
|
101
|
-
static
|
|
102
|
-
return (options
|
|
82
|
+
static listTokens(options) {
|
|
83
|
+
return (options?.client ?? client).get({ url: '/tokens', ...options });
|
|
103
84
|
}
|
|
104
85
|
/**
|
|
105
|
-
* Create a new
|
|
86
|
+
* Create a new access token.
|
|
106
87
|
*
|
|
107
|
-
*
|
|
88
|
+
* This endpoint allows you to create a new access token. For more information about identity access management and security, see [Service Accounts](https://cloudfleet.ai/docs/organization/api-tokens/) section of documentaiton.
|
|
108
89
|
*
|
|
109
90
|
* This endpoint is available to administrators of the organization only.
|
|
110
91
|
*
|
|
111
92
|
*/
|
|
112
|
-
static
|
|
93
|
+
static createToken(options) {
|
|
113
94
|
return (options.client ?? client).post({
|
|
114
|
-
url: '/
|
|
95
|
+
url: '/tokens',
|
|
115
96
|
...options,
|
|
116
97
|
headers: {
|
|
117
98
|
'Content-Type': 'application/json',
|
|
@@ -120,38 +101,34 @@ export class ClustersService {
|
|
|
120
101
|
});
|
|
121
102
|
}
|
|
122
103
|
/**
|
|
123
|
-
* Permanently delete
|
|
124
|
-
*
|
|
125
|
-
* This endpoint will permanently delete chart. This operation cannot be undone.
|
|
104
|
+
* Permanently delete access token.
|
|
126
105
|
*
|
|
127
|
-
* This endpoint is available to administrators of the organization only.
|
|
106
|
+
* This endpoint allows you to delete an access token. For more information about identity access management and security, see [Service Accounts](https://cloudfleet.ai/docs/organization/api-tokens/) section of documentaiton. This endpoint is available to administrators of the organization only.
|
|
128
107
|
*
|
|
129
108
|
*/
|
|
130
|
-
static
|
|
131
|
-
return (options.client ?? client).delete({ url: '/
|
|
109
|
+
static deleteToken(options) {
|
|
110
|
+
return (options.client ?? client).delete({ url: '/tokens/{token_id}', ...options });
|
|
132
111
|
}
|
|
133
112
|
/**
|
|
134
|
-
* Get
|
|
135
|
-
*
|
|
136
|
-
* Returns the details of the chart deployment.
|
|
113
|
+
* Get access token information.
|
|
137
114
|
*
|
|
138
|
-
* This endpoint is available to all users in the organization.
|
|
115
|
+
* This endpoint allows you to get access token details. For more information about identity access management and security, see [Service Accounts](https://cloudfleet.ai/docs/organization/api-tokens/) section of documentaiton. This endpoint is available to all users in the organization.
|
|
139
116
|
*
|
|
140
117
|
*/
|
|
141
|
-
static
|
|
142
|
-
return (options.client ?? client).get({ url: '/
|
|
118
|
+
static getToken(options) {
|
|
119
|
+
return (options.client ?? client).get({ url: '/tokens/{token_id}', ...options });
|
|
143
120
|
}
|
|
144
121
|
/**
|
|
145
|
-
* Update
|
|
122
|
+
* Update access token information.
|
|
146
123
|
*
|
|
147
|
-
* This endpoint allows you to update
|
|
124
|
+
* This endpoint allows you to update access token details. For more information about identity access management and security, see [Service Accounts](https://cloudfleet.ai/docs/organization/api-tokens/) section of documentaiton.
|
|
148
125
|
*
|
|
149
126
|
* This endpoint is available to administrators of the organization only.
|
|
150
127
|
*
|
|
151
128
|
*/
|
|
152
|
-
static
|
|
129
|
+
static updateToken(options) {
|
|
153
130
|
return (options.client ?? client).put({
|
|
154
|
-
url: '/
|
|
131
|
+
url: '/tokens/{token_id}',
|
|
155
132
|
...options,
|
|
156
133
|
headers: {
|
|
157
134
|
'Content-Type': 'application/json',
|
|
@@ -160,108 +137,108 @@ export class ClustersService {
|
|
|
160
137
|
});
|
|
161
138
|
}
|
|
162
139
|
/**
|
|
163
|
-
*
|
|
140
|
+
* Regenerate access token secret key.
|
|
164
141
|
*
|
|
165
|
-
*
|
|
142
|
+
* Generates a new access token secret. Old secret will not be valid anymore.
|
|
143
|
+
*/
|
|
144
|
+
static regenerateToken(options) {
|
|
145
|
+
return (options.client ?? client).put({ url: '/tokens/{token_id}/secret', ...options });
|
|
146
|
+
}
|
|
147
|
+
}
|
|
148
|
+
export class TicketsService {
|
|
149
|
+
/**
|
|
150
|
+
* List tickets for the current organization.
|
|
166
151
|
*
|
|
167
|
-
*
|
|
152
|
+
* Returns all tickets belonging to the caller's organization, newest first.
|
|
168
153
|
*
|
|
169
154
|
*/
|
|
170
|
-
static
|
|
171
|
-
return (options
|
|
155
|
+
static listTickets(options) {
|
|
156
|
+
return (options?.client ?? client).get({ url: '/tickets', ...options });
|
|
172
157
|
}
|
|
173
158
|
/**
|
|
174
|
-
* Create a new
|
|
175
|
-
*
|
|
176
|
-
* Create a new fleet under the current organization. fleets allow you to to schedule workloads in cloud service provider accounts owned by you. For more information, see [Fleets](https://cloudfleet.ai/docs/cloud-infrastructure/fleets/) section of documentaiton.
|
|
159
|
+
* Create a new support ticket.
|
|
177
160
|
*
|
|
178
|
-
*
|
|
161
|
+
* Creates a new support ticket with an initial customer message. The request is `multipart/form-data` with a JSON-encoded `payload` field carrying `category`, `body`, and optional `properties` and `grant_support_access`, plus up to 3 `attachments` files (10 MB max each).
|
|
179
162
|
*
|
|
180
163
|
*/
|
|
181
|
-
static
|
|
164
|
+
static createTicket(options) {
|
|
182
165
|
return (options.client ?? client).post({
|
|
183
|
-
|
|
166
|
+
...formDataBodySerializer,
|
|
167
|
+
url: '/tickets',
|
|
184
168
|
...options,
|
|
185
169
|
headers: {
|
|
186
|
-
'Content-Type':
|
|
170
|
+
'Content-Type': null,
|
|
187
171
|
...options.headers
|
|
188
172
|
}
|
|
189
173
|
});
|
|
190
174
|
}
|
|
191
175
|
/**
|
|
192
|
-
*
|
|
193
|
-
*
|
|
194
|
-
* This endpoint will permanently delete fleet. This operation cannot be undone. Your subscription will end by the end of the current billing period and you will not be able to receive credit for unused time. If you want to keep using the Fleet until the end of the billing period, set the status to `cancelling`. For more information, see [Fleets](https://cloudfleet.ai/docs/cloud-infrastructure/fleets/) section of documentaiton.
|
|
176
|
+
* Close a ticket (soft close).
|
|
195
177
|
*
|
|
196
|
-
*
|
|
178
|
+
* Marks the ticket as closed. Closed is a terminal state — users cannot reply to a closed ticket; a new ticket must be opened instead.
|
|
197
179
|
*
|
|
198
180
|
*/
|
|
199
|
-
static
|
|
200
|
-
return (options.client ?? client).delete({ url: '/
|
|
181
|
+
static closeTicket(options) {
|
|
182
|
+
return (options.client ?? client).delete({ url: '/tickets/{ticket_id}', ...options });
|
|
201
183
|
}
|
|
202
184
|
/**
|
|
203
|
-
* Get
|
|
204
|
-
*
|
|
205
|
-
* Returns fleet details. For more information, see [Fleets](https://cloudfleet.ai/docs/cloud-infrastructure/fleets/) section of documentaiton.
|
|
206
|
-
*
|
|
207
|
-
* This endpoint is available to all users in the organization.
|
|
208
|
-
*
|
|
185
|
+
* Get a ticket and its messages.
|
|
209
186
|
*/
|
|
210
|
-
static
|
|
211
|
-
return (options.client ?? client).get({ url: '/
|
|
187
|
+
static getTicket(options) {
|
|
188
|
+
return (options.client ?? client).get({ url: '/tickets/{ticket_id}', ...options });
|
|
212
189
|
}
|
|
213
190
|
/**
|
|
214
|
-
*
|
|
191
|
+
* Grant Cloudfleet support access for a ticket.
|
|
215
192
|
*
|
|
216
|
-
*
|
|
217
|
-
*
|
|
218
|
-
* Setting status to `deleted` will permanently delete fleet. This operation cannot be undone. Your subscription will end by the end of the current billing period and you will not be able to receive credit for unused time. If you want to keep using the Fleet until the end of the billing period, set the status to `cancelling`.
|
|
193
|
+
* Grants Cloudfleet support staff access to the organization's resources while the ticket is open. Access cannot be revoked; it ends when the ticket is closed. Idempotent: granting again keeps the original grant. Returns 409 if the ticket is closed.
|
|
219
194
|
*
|
|
220
|
-
|
|
195
|
+
*/
|
|
196
|
+
static grantTicketSupportAccess(options) {
|
|
197
|
+
return (options.client ?? client).put({ url: '/tickets/{ticket_id}/support-access', ...options });
|
|
198
|
+
}
|
|
199
|
+
/**
|
|
200
|
+
* Append a customer reply to a ticket.
|
|
221
201
|
*
|
|
222
|
-
*
|
|
202
|
+
* Multipart form-data with a JSON-encoded `payload` field carrying `body`, plus up to 3 `attachments` files. Returns 409 if the ticket is closed.
|
|
223
203
|
*
|
|
224
204
|
*/
|
|
225
|
-
static
|
|
226
|
-
return (options.client ?? client).
|
|
227
|
-
|
|
205
|
+
static replyTicket(options) {
|
|
206
|
+
return (options.client ?? client).post({
|
|
207
|
+
...formDataBodySerializer,
|
|
208
|
+
url: '/tickets/{ticket_id}/messages',
|
|
228
209
|
...options,
|
|
229
210
|
headers: {
|
|
230
|
-
'Content-Type':
|
|
211
|
+
'Content-Type': null,
|
|
231
212
|
...options.headers
|
|
232
213
|
}
|
|
233
214
|
});
|
|
234
215
|
}
|
|
235
216
|
/**
|
|
236
|
-
*
|
|
237
|
-
*
|
|
238
|
-
* An API endpoint for directly querying a Kubernetes cluster API without requiring kubectl or other tools. This endpoint is ideal for automation and scripting, as well as for internal use in fetching data for the Cloudfleet Console. It acts as a passthrough to the Kubernetes API, allowing access to any valid Kubernetes API endpoint, including those not exposed in the Cloudfleet Console. The endpoint is strictly read-only, ensuring no modifications to the cluster state. It is accessible to all users within the organization and uses the same authentication mechanisms as other Cloudfleet API endpoints.
|
|
217
|
+
* Download a ticket attachment.
|
|
239
218
|
*/
|
|
240
|
-
static
|
|
241
|
-
return (options.client ?? client).get({ url: '/
|
|
219
|
+
static getTicketAttachment(options) {
|
|
220
|
+
return (options.client ?? client).get({ url: '/tickets/{ticket_id}/attachments/{attachment_id}', ...options });
|
|
242
221
|
}
|
|
222
|
+
}
|
|
223
|
+
export class RoadmapService {
|
|
243
224
|
/**
|
|
244
|
-
* List
|
|
225
|
+
* List roadmap items.
|
|
245
226
|
*
|
|
246
|
-
* Returns
|
|
247
|
-
*
|
|
248
|
-
* This endpoint is available to all users in the organization.
|
|
227
|
+
* Returns the published roadmap items, newest first, each with your own vote. Votes of other users are not returned.
|
|
249
228
|
*
|
|
250
229
|
*/
|
|
251
|
-
static
|
|
252
|
-
return (options?.client ?? client).get({ url: '/
|
|
230
|
+
static listRoadmap(options) {
|
|
231
|
+
return (options?.client ?? client).get({ url: '/roadmap', ...options });
|
|
253
232
|
}
|
|
254
233
|
/**
|
|
255
|
-
*
|
|
256
|
-
*
|
|
257
|
-
* Create a new cluster under the current organization. Clusters allow you to group resources and you can create multiple clusters under the same organization, with billing delegated to the parent organization.
|
|
234
|
+
* Suggest a new roadmap item.
|
|
258
235
|
*
|
|
259
|
-
*
|
|
236
|
+
* Submits a suggestion in one or two sentences, with your up vote on it. Suggestions are reviewed by the Cloudfleet team before they appear on the roadmap.
|
|
260
237
|
*
|
|
261
238
|
*/
|
|
262
|
-
static
|
|
239
|
+
static suggestRoadmap(options) {
|
|
263
240
|
return (options.client ?? client).post({
|
|
264
|
-
url: '/
|
|
241
|
+
url: '/roadmap',
|
|
265
242
|
...options,
|
|
266
243
|
headers: {
|
|
267
244
|
'Content-Type': 'application/json',
|
|
@@ -270,38 +247,20 @@ export class ClustersService {
|
|
|
270
247
|
});
|
|
271
248
|
}
|
|
272
249
|
/**
|
|
273
|
-
*
|
|
274
|
-
*
|
|
275
|
-
* This endpoint will permanently delete the cluster. This operation cannot be undone.
|
|
276
|
-
*
|
|
277
|
-
* This endpoint is available to administrators of the organization only.
|
|
278
|
-
*
|
|
279
|
-
*/
|
|
280
|
-
static deleteCluster(options) {
|
|
281
|
-
return (options.client ?? client).delete({ url: '/clusters/{cluster_id}', ...options });
|
|
282
|
-
}
|
|
283
|
-
/**
|
|
284
|
-
* Get cluster information.
|
|
285
|
-
*
|
|
286
|
-
* Returns cluster details including quota. Quota is a set of filters defined by the admin of the organization that will be applied to all resources created in the cluster. Quota information returned here does not take into account quota set on organization or platform level. For calculated quota applied to this account, use /clusters/{cluster_id}/quota endpoint. For more information about quotas, see [Quotas and limits](https://cloudfleet.ai/docs/organization/quotas/) section of documentaiton.
|
|
287
|
-
*
|
|
288
|
-
* This endpoint is available to all users in the organization.
|
|
289
|
-
*
|
|
250
|
+
* Remove your vote from a roadmap item.
|
|
290
251
|
*/
|
|
291
|
-
static
|
|
292
|
-
return (options.client ?? client).
|
|
252
|
+
static unvoteRoadmap(options) {
|
|
253
|
+
return (options.client ?? client).delete({ url: '/roadmap/{item_id}/vote', ...options });
|
|
293
254
|
}
|
|
294
255
|
/**
|
|
295
|
-
*
|
|
296
|
-
*
|
|
297
|
-
* This endpoint allows you to update cluster details, including quota and cluster status. For more information about clusters, see [Clusters](https://cloudfleet.ai/docs/cluster-management/cluster-types/) section of documentaiton.
|
|
256
|
+
* Vote on a roadmap item.
|
|
298
257
|
*
|
|
299
|
-
*
|
|
258
|
+
* Sets your vote on a roadmap item: -1 (down), 1 (up), or 2 (double up). Replaces any previous vote you cast on the item.
|
|
300
259
|
*
|
|
301
260
|
*/
|
|
302
|
-
static
|
|
261
|
+
static voteRoadmap(options) {
|
|
303
262
|
return (options.client ?? client).put({
|
|
304
|
-
url: '/
|
|
263
|
+
url: '/roadmap/{item_id}/vote',
|
|
305
264
|
...options,
|
|
306
265
|
headers: {
|
|
307
266
|
'Content-Type': 'application/json',
|
|
@@ -309,35 +268,66 @@ export class ClustersService {
|
|
|
309
268
|
}
|
|
310
269
|
});
|
|
311
270
|
}
|
|
271
|
+
}
|
|
272
|
+
export class RegistryService {
|
|
312
273
|
/**
|
|
313
|
-
*
|
|
274
|
+
* List repositories
|
|
314
275
|
*
|
|
315
|
-
* Returns
|
|
276
|
+
* Returns a list of repositories in the registry across all regions. This endpoint is available to all users in the organization.
|
|
316
277
|
*
|
|
317
278
|
*/
|
|
318
|
-
static
|
|
319
|
-
return (options
|
|
279
|
+
static listRepositories(options) {
|
|
280
|
+
return (options?.client ?? client).get({ url: '/registry', ...options });
|
|
320
281
|
}
|
|
321
|
-
}
|
|
322
|
-
export class InvitesService {
|
|
323
282
|
/**
|
|
324
|
-
* List
|
|
283
|
+
* List tags for a repository
|
|
325
284
|
*
|
|
326
|
-
* Returns a list of
|
|
285
|
+
* Returns a list of tags for a specific repository, including size and metadata for each tag. This endpoint is available to all users in the organization.
|
|
327
286
|
*
|
|
328
287
|
*/
|
|
329
|
-
static
|
|
330
|
-
return (options
|
|
288
|
+
static listTags(options) {
|
|
289
|
+
return (options.client ?? client).get({ url: '/registry/{region}/{repository}', ...options });
|
|
331
290
|
}
|
|
332
291
|
/**
|
|
333
|
-
*
|
|
292
|
+
* Delete tag
|
|
334
293
|
*
|
|
335
|
-
*
|
|
294
|
+
* Permanently deletes a specific tag from a repository. This endpoint is available to administrators of the organization only.
|
|
336
295
|
*
|
|
337
296
|
*/
|
|
338
|
-
static
|
|
297
|
+
static deleteTag(options) {
|
|
298
|
+
return (options.client ?? client).delete({ url: '/registry/{region}/{repository}/{tag}', ...options });
|
|
299
|
+
}
|
|
300
|
+
/**
|
|
301
|
+
* Get tag details
|
|
302
|
+
*
|
|
303
|
+
* Returns detailed information for a specific tag in a repository, including manifest details, size, and URI. This endpoint is available to all users in the organization.
|
|
304
|
+
*
|
|
305
|
+
*/
|
|
306
|
+
static getTag(options) {
|
|
307
|
+
return (options.client ?? client).get({ url: '/registry/{region}/{repository}/{tag}', ...options });
|
|
308
|
+
}
|
|
309
|
+
}
|
|
310
|
+
export class OrganizationService {
|
|
311
|
+
/**
|
|
312
|
+
* Get organization information.
|
|
313
|
+
*
|
|
314
|
+
* Returns organization details including quota. For more information about quotas, see [Quotas and limits](https://cloudfleet.ai/docs/organization/quotas/) section of documentaiton.
|
|
315
|
+
*
|
|
316
|
+
* This endpoint is available to all users in the organization.
|
|
317
|
+
*
|
|
318
|
+
*/
|
|
319
|
+
static getOrganization(options) {
|
|
320
|
+
return (options?.client ?? client).get({ url: '/organization', ...options });
|
|
321
|
+
}
|
|
322
|
+
/**
|
|
323
|
+
* Create a new organization / Cloudfleet account signup.
|
|
324
|
+
*
|
|
325
|
+
* This endpoint allows you to create a new Cloudfleet organization and an administrator user.
|
|
326
|
+
*
|
|
327
|
+
*/
|
|
328
|
+
static createOrganization(options) {
|
|
339
329
|
return (options.client ?? client).post({
|
|
340
|
-
url: '/
|
|
330
|
+
url: '/organization',
|
|
341
331
|
...options,
|
|
342
332
|
headers: {
|
|
343
333
|
'Content-Type': 'application/json',
|
|
@@ -345,23 +335,22 @@ export class InvitesService {
|
|
|
345
335
|
}
|
|
346
336
|
});
|
|
347
337
|
}
|
|
338
|
+
}
|
|
339
|
+
export class McpService {
|
|
348
340
|
/**
|
|
349
|
-
*
|
|
350
|
-
*
|
|
351
|
-
* Returns invite details.
|
|
352
|
-
*
|
|
353
|
-
*/
|
|
354
|
-
static getInvite(options) {
|
|
355
|
-
return (options.client ?? client).get({ url: '/invites/{code}', ...options });
|
|
356
|
-
}
|
|
357
|
-
/**
|
|
358
|
-
* Permanently delete invite.
|
|
359
|
-
*
|
|
360
|
-
* Permanently deletes invite from the organization. This endpoint is available to administrators of the organization only.
|
|
341
|
+
* MCP endpoint
|
|
361
342
|
*
|
|
343
|
+
* MCP endpoint for handling Model Context Protocol JSON-RPC 2.0 messages.
|
|
362
344
|
*/
|
|
363
|
-
static
|
|
364
|
-
return (options.client ?? client).
|
|
345
|
+
static postMcp(options) {
|
|
346
|
+
return (options.client ?? client).post({
|
|
347
|
+
url: '/mcp',
|
|
348
|
+
...options,
|
|
349
|
+
headers: {
|
|
350
|
+
'Content-Type': 'application/json',
|
|
351
|
+
...options.headers
|
|
352
|
+
}
|
|
353
|
+
});
|
|
365
354
|
}
|
|
366
355
|
}
|
|
367
356
|
export class ChartsMarketplaceService {
|
|
@@ -390,15 +379,25 @@ export class ChartsMarketplaceService {
|
|
|
390
379
|
return (options.client ?? client).get({ url: '/marketplace/{chart_name}/files/{version_channel}', ...options });
|
|
391
380
|
}
|
|
392
381
|
}
|
|
393
|
-
export class
|
|
382
|
+
export class InvitesService {
|
|
394
383
|
/**
|
|
395
|
-
*
|
|
384
|
+
* List invites.
|
|
385
|
+
*
|
|
386
|
+
* Returns a list of pending (non-expired) invites under the current organization. This endpoint is available to administrators of the organization only.
|
|
396
387
|
*
|
|
397
|
-
* MCP endpoint for handling Model Context Protocol JSON-RPC 2.0 messages.
|
|
398
388
|
*/
|
|
399
|
-
static
|
|
389
|
+
static listInvites(options) {
|
|
390
|
+
return (options?.client ?? client).get({ url: '/invites', ...options });
|
|
391
|
+
}
|
|
392
|
+
/**
|
|
393
|
+
* Create a new invite.
|
|
394
|
+
*
|
|
395
|
+
* Invite a new user to your Cloudfleet organization. The user will receive an email with a link to create a new account. This endpoint is available to administrators of the organization only.
|
|
396
|
+
*
|
|
397
|
+
*/
|
|
398
|
+
static createInvite(options) {
|
|
400
399
|
return (options.client ?? client).post({
|
|
401
|
-
url: '/
|
|
400
|
+
url: '/invites',
|
|
402
401
|
...options,
|
|
403
402
|
headers: {
|
|
404
403
|
'Content-Type': 'application/json',
|
|
@@ -406,28 +405,58 @@ export class McpService {
|
|
|
406
405
|
}
|
|
407
406
|
});
|
|
408
407
|
}
|
|
408
|
+
/**
|
|
409
|
+
* Get invite information.
|
|
410
|
+
*
|
|
411
|
+
* Validates an invitation code and returns the email address it was issued to (to pre-fill the signup form) and the organization it grants access to. This endpoint is unauthenticated, so no other invite details (such as the invited role) are disclosed.
|
|
412
|
+
*
|
|
413
|
+
*/
|
|
414
|
+
static getInvite(options) {
|
|
415
|
+
return (options.client ?? client).get({ url: '/invites/{code}', ...options });
|
|
416
|
+
}
|
|
417
|
+
/**
|
|
418
|
+
* Permanently delete invite.
|
|
419
|
+
*
|
|
420
|
+
* Permanently deletes invite from the organization. This endpoint is available to administrators of the organization only.
|
|
421
|
+
*
|
|
422
|
+
*/
|
|
423
|
+
static deleteInvite(options) {
|
|
424
|
+
return (options.client ?? client).delete({ url: '/invites/{email}', ...options });
|
|
425
|
+
}
|
|
409
426
|
}
|
|
410
|
-
export class
|
|
427
|
+
export class ClustersService {
|
|
411
428
|
/**
|
|
412
|
-
*
|
|
429
|
+
* Query Kubernetes cluster API
|
|
413
430
|
*
|
|
414
|
-
*
|
|
431
|
+
* An API endpoint for directly querying a Kubernetes cluster API without requiring kubectl or other tools. This endpoint is ideal for automation and scripting, as well as for internal use in fetching data for the Cloudfleet Console. It acts as a passthrough to the Kubernetes API, allowing access to any valid Kubernetes API endpoint, including those not exposed in the Cloudfleet Console. The endpoint is strictly read-only, ensuring no modifications to the cluster state. It is accessible to all users within the organization and uses the same authentication mechanisms as other Cloudfleet API endpoints.
|
|
432
|
+
*/
|
|
433
|
+
static queryCluster(options) {
|
|
434
|
+
return (options.client ?? client).get({ url: '/clusters/{cluster_id}/query', ...options });
|
|
435
|
+
}
|
|
436
|
+
/**
|
|
437
|
+
* List fleets.
|
|
438
|
+
*
|
|
439
|
+
* Returns a list of fleets belonging to the cluster. For more information, see [Fleets](https://cloudfleet.ai/docs/cloud-infrastructure/fleets/) section of documentaiton.
|
|
415
440
|
*
|
|
416
441
|
* This endpoint is available to all users in the organization.
|
|
417
442
|
*
|
|
418
443
|
*/
|
|
419
|
-
static
|
|
420
|
-
return (options
|
|
444
|
+
static listFleets(options) {
|
|
445
|
+
return (options.client ?? client).get({ url: '/clusters/{cluster_id}/fleets', ...options });
|
|
421
446
|
}
|
|
422
447
|
/**
|
|
423
|
-
* Create a new
|
|
448
|
+
* Create a new fleet.
|
|
424
449
|
*
|
|
425
|
-
*
|
|
450
|
+
* Create a new fleet under the current organization. fleets allow you to to schedule workloads in cloud service provider accounts owned by you. For more information, see [Fleets](https://cloudfleet.ai/docs/cloud-infrastructure/fleets/) section of documentaiton.
|
|
451
|
+
*
|
|
452
|
+
* The cluster must be ready (status `deployed`) before a fleet can be added. Adding a fleet while the cluster is still provisioning returns `409`.
|
|
453
|
+
*
|
|
454
|
+
* This endpoint is available to administrators of the organization only.
|
|
426
455
|
*
|
|
427
456
|
*/
|
|
428
|
-
static
|
|
457
|
+
static createFleet(options) {
|
|
429
458
|
return (options.client ?? client).post({
|
|
430
|
-
url: '/
|
|
459
|
+
url: '/clusters/{cluster_id}/fleets',
|
|
431
460
|
...options,
|
|
432
461
|
headers: {
|
|
433
462
|
'Content-Type': 'application/json',
|
|
@@ -435,132 +464,143 @@ export class OrganizationService {
|
|
|
435
464
|
}
|
|
436
465
|
});
|
|
437
466
|
}
|
|
438
|
-
}
|
|
439
|
-
export class RegistryService {
|
|
440
467
|
/**
|
|
441
|
-
*
|
|
468
|
+
* Permanently delete fleet.
|
|
442
469
|
*
|
|
443
|
-
*
|
|
470
|
+
* This endpoint will permanently delete fleet. This operation cannot be undone. Your subscription will end by the end of the current billing period and you will not be able to receive credit for unused time. For more information, see [Fleets](https://cloudfleet.ai/docs/cloud-infrastructure/fleets/) section of documentaiton.
|
|
444
471
|
*
|
|
445
|
-
|
|
446
|
-
static listRepositories(options) {
|
|
447
|
-
return (options?.client ?? client).get({ url: '/registry', ...options });
|
|
448
|
-
}
|
|
449
|
-
/**
|
|
450
|
-
* List tags for a repository
|
|
472
|
+
* Deleting a fleet does not deprovision the cloud infrastructure it provisioned: nodes and other resources keep running. Scale the cluster down first, or remove the infrastructure manually, to avoid orphaned resources.
|
|
451
473
|
*
|
|
452
|
-
*
|
|
474
|
+
* This endpoint is available to administrators of the organization only.
|
|
453
475
|
*
|
|
454
476
|
*/
|
|
455
|
-
static
|
|
456
|
-
return (options.client ?? client).
|
|
477
|
+
static deleteFleet(options) {
|
|
478
|
+
return (options.client ?? client).delete({ url: '/clusters/{cluster_id}/fleets/{fleet_name}', ...options });
|
|
457
479
|
}
|
|
458
480
|
/**
|
|
459
|
-
*
|
|
481
|
+
* Get fleet information.
|
|
460
482
|
*
|
|
461
|
-
*
|
|
483
|
+
* Returns fleet details. For more information, see [Fleets](https://cloudfleet.ai/docs/cloud-infrastructure/fleets/) section of documentaiton.
|
|
484
|
+
*
|
|
485
|
+
* This endpoint is available to all users in the organization.
|
|
462
486
|
*
|
|
463
487
|
*/
|
|
464
|
-
static
|
|
465
|
-
return (options.client ?? client).
|
|
488
|
+
static getFleet(options) {
|
|
489
|
+
return (options.client ?? client).get({ url: '/clusters/{cluster_id}/fleets/{fleet_name}', ...options });
|
|
466
490
|
}
|
|
467
491
|
/**
|
|
468
|
-
*
|
|
492
|
+
* Update fleet information.
|
|
469
493
|
*
|
|
470
|
-
*
|
|
494
|
+
* This endpoint allows you to update fleet details.
|
|
495
|
+
*
|
|
496
|
+
* For more information, see [Fleets](https://cloudfleet.ai/docs/cloud-infrastructure/fleets/) section of documentaiton.
|
|
497
|
+
*
|
|
498
|
+
* This is a full overwrite: any field omitted from the request is reset to its default rather than left unchanged. The Hetzner API key is the exception: it is kept when omitted (send a new value to rotate it).
|
|
499
|
+
*
|
|
500
|
+
* This endpoint is available to administrators of the organization only.
|
|
471
501
|
*
|
|
472
502
|
*/
|
|
473
|
-
static
|
|
474
|
-
return (options.client ?? client).
|
|
503
|
+
static updateFleet(options) {
|
|
504
|
+
return (options.client ?? client).put({
|
|
505
|
+
url: '/clusters/{cluster_id}/fleets/{fleet_name}',
|
|
506
|
+
...options,
|
|
507
|
+
headers: {
|
|
508
|
+
'Content-Type': 'application/json',
|
|
509
|
+
...options.headers
|
|
510
|
+
}
|
|
511
|
+
});
|
|
475
512
|
}
|
|
476
|
-
}
|
|
477
|
-
export class TicketsService {
|
|
478
513
|
/**
|
|
479
|
-
* List
|
|
514
|
+
* List charts.
|
|
480
515
|
*
|
|
481
|
-
* Returns
|
|
516
|
+
* Returns a list of charts in the cluster.
|
|
517
|
+
*
|
|
518
|
+
* This endpoint is available to all users in the organization.
|
|
482
519
|
*
|
|
483
520
|
*/
|
|
484
|
-
static
|
|
485
|
-
return (options
|
|
521
|
+
static listCharts(options) {
|
|
522
|
+
return (options.client ?? client).get({ url: '/clusters/{cluster_id}/charts', ...options });
|
|
486
523
|
}
|
|
487
524
|
/**
|
|
488
|
-
* Create a new
|
|
525
|
+
* Create a new chart.
|
|
526
|
+
*
|
|
527
|
+
* Create a new chart deployment.
|
|
489
528
|
*
|
|
490
|
-
*
|
|
529
|
+
* This endpoint is available to administrators of the organization only.
|
|
491
530
|
*
|
|
492
531
|
*/
|
|
493
|
-
static
|
|
532
|
+
static createChart(options) {
|
|
494
533
|
return (options.client ?? client).post({
|
|
495
|
-
|
|
496
|
-
url: '/tickets',
|
|
534
|
+
url: '/clusters/{cluster_id}/charts',
|
|
497
535
|
...options,
|
|
498
536
|
headers: {
|
|
499
|
-
'Content-Type':
|
|
537
|
+
'Content-Type': 'application/json',
|
|
500
538
|
...options.headers
|
|
501
539
|
}
|
|
502
540
|
});
|
|
503
541
|
}
|
|
504
542
|
/**
|
|
505
|
-
*
|
|
543
|
+
* Permanently delete the chart deployment from the cluster.
|
|
506
544
|
*
|
|
507
|
-
*
|
|
545
|
+
* This endpoint will permanently delete chart. This operation cannot be undone.
|
|
546
|
+
*
|
|
547
|
+
* This endpoint is available to administrators of the organization only.
|
|
508
548
|
*
|
|
509
549
|
*/
|
|
510
|
-
static
|
|
511
|
-
return (options.client ?? client).delete({ url: '/
|
|
550
|
+
static deleteChart(options) {
|
|
551
|
+
return (options.client ?? client).delete({ url: '/clusters/{cluster_id}/charts/{chart_name}', ...options });
|
|
512
552
|
}
|
|
513
553
|
/**
|
|
514
|
-
* Get
|
|
554
|
+
* Get chart information.
|
|
555
|
+
*
|
|
556
|
+
* Returns the details of the chart deployment.
|
|
557
|
+
*
|
|
558
|
+
* This endpoint is available to all users in the organization.
|
|
559
|
+
*
|
|
515
560
|
*/
|
|
516
|
-
static
|
|
517
|
-
return (options.client ?? client).get({ url: '/
|
|
561
|
+
static getChart(options) {
|
|
562
|
+
return (options.client ?? client).get({ url: '/clusters/{cluster_id}/charts/{chart_name}', ...options });
|
|
518
563
|
}
|
|
519
564
|
/**
|
|
520
|
-
*
|
|
565
|
+
* Update chart information.
|
|
521
566
|
*
|
|
522
|
-
*
|
|
567
|
+
* This endpoint allows you to update the values of a chart deployment.
|
|
568
|
+
*
|
|
569
|
+
* This endpoint is available to administrators of the organization only.
|
|
523
570
|
*
|
|
524
571
|
*/
|
|
525
|
-
static
|
|
526
|
-
return (options.client ?? client).
|
|
527
|
-
|
|
528
|
-
url: '/tickets/{ticket_id}/messages',
|
|
572
|
+
static updateChart(options) {
|
|
573
|
+
return (options.client ?? client).put({
|
|
574
|
+
url: '/clusters/{cluster_id}/charts/{chart_name}',
|
|
529
575
|
...options,
|
|
530
576
|
headers: {
|
|
531
|
-
'Content-Type':
|
|
577
|
+
'Content-Type': 'application/json',
|
|
532
578
|
...options.headers
|
|
533
579
|
}
|
|
534
580
|
});
|
|
535
581
|
}
|
|
536
582
|
/**
|
|
537
|
-
*
|
|
538
|
-
*/
|
|
539
|
-
static getTicketAttachment(options) {
|
|
540
|
-
return (options.client ?? client).get({ url: '/tickets/{ticket_id}/attachments/{attachment_id}', ...options });
|
|
541
|
-
}
|
|
542
|
-
}
|
|
543
|
-
export class TokensService {
|
|
544
|
-
/**
|
|
545
|
-
* List access tokens in organization.
|
|
583
|
+
* List clusters.
|
|
546
584
|
*
|
|
547
|
-
*
|
|
585
|
+
* Returns a list of clusters under the current organization.
|
|
586
|
+
*
|
|
587
|
+
* This endpoint is available to all users in the organization.
|
|
548
588
|
*
|
|
549
589
|
*/
|
|
550
|
-
static
|
|
551
|
-
return (options?.client ?? client).get({ url: '/
|
|
590
|
+
static listClusters(options) {
|
|
591
|
+
return (options?.client ?? client).get({ url: '/clusters', ...options });
|
|
552
592
|
}
|
|
553
593
|
/**
|
|
554
|
-
* Create a new
|
|
594
|
+
* Create a new cluster.
|
|
555
595
|
*
|
|
556
|
-
*
|
|
596
|
+
* Create a new cluster under the current organization. Clusters allow you to group resources and you can create multiple clusters under the same organization, with billing delegated to the parent organization.
|
|
557
597
|
*
|
|
558
598
|
* This endpoint is available to administrators of the organization only.
|
|
559
599
|
*
|
|
560
600
|
*/
|
|
561
|
-
static
|
|
601
|
+
static createCluster(options) {
|
|
562
602
|
return (options.client ?? client).post({
|
|
563
|
-
url: '/
|
|
603
|
+
url: '/clusters',
|
|
564
604
|
...options,
|
|
565
605
|
headers: {
|
|
566
606
|
'Content-Type': 'application/json',
|
|
@@ -569,34 +609,42 @@ export class TokensService {
|
|
|
569
609
|
});
|
|
570
610
|
}
|
|
571
611
|
/**
|
|
572
|
-
* Permanently delete
|
|
612
|
+
* Permanently delete cluster.
|
|
573
613
|
*
|
|
574
|
-
* This endpoint
|
|
614
|
+
* This endpoint will permanently delete the cluster. This operation cannot be undone.
|
|
615
|
+
*
|
|
616
|
+
* Deleting a cluster also deletes its fleets. This does not deprovision the cloud infrastructure those fleets provisioned: nodes and other resources keep running. Scale the cluster down first, or remove the infrastructure manually, to avoid orphaned resources.
|
|
617
|
+
*
|
|
618
|
+
* This endpoint is available to administrators of the organization only.
|
|
575
619
|
*
|
|
576
620
|
*/
|
|
577
|
-
static
|
|
578
|
-
return (options.client ?? client).delete({ url: '/
|
|
621
|
+
static deleteCluster(options) {
|
|
622
|
+
return (options.client ?? client).delete({ url: '/clusters/{cluster_id}', ...options });
|
|
579
623
|
}
|
|
580
624
|
/**
|
|
581
|
-
* Get
|
|
625
|
+
* Get cluster information.
|
|
582
626
|
*
|
|
583
|
-
*
|
|
627
|
+
* Returns cluster details.
|
|
628
|
+
*
|
|
629
|
+
* This endpoint is available to all users in the organization.
|
|
584
630
|
*
|
|
585
631
|
*/
|
|
586
|
-
static
|
|
587
|
-
return (options.client ?? client).get({ url: '/
|
|
632
|
+
static getCluster(options) {
|
|
633
|
+
return (options.client ?? client).get({ url: '/clusters/{cluster_id}', ...options });
|
|
588
634
|
}
|
|
589
635
|
/**
|
|
590
|
-
* Update
|
|
636
|
+
* Update cluster information.
|
|
591
637
|
*
|
|
592
|
-
* This endpoint allows you to update
|
|
638
|
+
* This endpoint allows you to update cluster details. For more information about clusters, see [Clusters](https://cloudfleet.ai/docs/cluster-management/cluster-types/) section of documentation.
|
|
639
|
+
*
|
|
640
|
+
* This is a full overwrite: any field omitted from the request is reset to its default rather than left unchanged.
|
|
593
641
|
*
|
|
594
642
|
* This endpoint is available to administrators of the organization only.
|
|
595
643
|
*
|
|
596
644
|
*/
|
|
597
|
-
static
|
|
645
|
+
static updateCluster(options) {
|
|
598
646
|
return (options.client ?? client).put({
|
|
599
|
-
url: '/
|
|
647
|
+
url: '/clusters/{cluster_id}',
|
|
600
648
|
...options,
|
|
601
649
|
headers: {
|
|
602
650
|
'Content-Type': 'application/json',
|
|
@@ -605,77 +653,122 @@ export class TokensService {
|
|
|
605
653
|
});
|
|
606
654
|
}
|
|
607
655
|
/**
|
|
608
|
-
*
|
|
656
|
+
* Node join information for the cluster
|
|
657
|
+
*
|
|
658
|
+
* Returns the join information for the cluster. This information is used to add a self-managed nodes to the CFKE cluster. This endpoint is available to only admins of the organization.
|
|
609
659
|
*
|
|
610
|
-
* Generates a new access token secret. Old secret will not be valid anymore.
|
|
611
660
|
*/
|
|
612
|
-
static
|
|
613
|
-
return (options.client ?? client).
|
|
661
|
+
static getJoinInformation(options) {
|
|
662
|
+
return (options.client ?? client).post({ url: '/clusters/{cluster_id}/join_information', ...options });
|
|
614
663
|
}
|
|
615
664
|
}
|
|
616
|
-
export class
|
|
665
|
+
export class BillingService {
|
|
617
666
|
/**
|
|
618
|
-
* Get
|
|
667
|
+
* Get billing usage information.
|
|
668
|
+
*
|
|
669
|
+
* Returns aggregated usage information for the organization with facets for filtering. For more information on billing and payments, see [Billing and pricing](https://cloudfleet.ai/docs/organization/billing/) section of documentaiton. This endpoint is available to all users in the organization.
|
|
670
|
+
*
|
|
619
671
|
*/
|
|
620
|
-
static
|
|
621
|
-
return (options
|
|
672
|
+
static getUsage(options) {
|
|
673
|
+
return (options?.client ?? client).get({ url: '/billing/usage', ...options });
|
|
622
674
|
}
|
|
623
675
|
/**
|
|
624
|
-
*
|
|
676
|
+
* Get Stripe client secret.
|
|
625
677
|
*
|
|
626
|
-
*
|
|
678
|
+
* Endpoint returns the Stripe secret key for the organization. This key is used to securely update the payment method in the Cloudfleet console only, please visit https://console.cloudfleet.ai. This endpoint is available to administrators of the organization only.
|
|
627
679
|
*
|
|
628
|
-
|
|
680
|
+
*/
|
|
681
|
+
static getPaymentMethodSecret(options) {
|
|
682
|
+
return (options?.client ?? client).put({ url: '/billing/payment-method', ...options });
|
|
683
|
+
}
|
|
684
|
+
/**
|
|
685
|
+
* List organization payment methods.
|
|
686
|
+
*
|
|
687
|
+
* Returns all payment methods (cards and SEPA Direct Debit) attached to the organization, most recently added first, with the default flagged. This endpoint is available to all users in the organization.
|
|
629
688
|
*
|
|
630
689
|
*/
|
|
631
|
-
static
|
|
632
|
-
return (options?.client ?? client).get({ url: '/
|
|
690
|
+
static listPaymentMethods(options) {
|
|
691
|
+
return (options?.client ?? client).get({ url: '/billing/payment-methods', ...options });
|
|
633
692
|
}
|
|
634
693
|
/**
|
|
635
|
-
*
|
|
694
|
+
* Set the default payment method.
|
|
636
695
|
*
|
|
637
|
-
*
|
|
696
|
+
* Sets the given payment method as the default used for invoices and active subscriptions. Requires the Administrator role.
|
|
638
697
|
*
|
|
639
698
|
*/
|
|
640
|
-
static
|
|
641
|
-
return (options.client ?? client).
|
|
642
|
-
url: '/users',
|
|
643
|
-
...options,
|
|
644
|
-
headers: {
|
|
645
|
-
'Content-Type': 'application/json',
|
|
646
|
-
...options.headers
|
|
647
|
-
}
|
|
648
|
-
});
|
|
699
|
+
static setDefaultPaymentMethod(options) {
|
|
700
|
+
return (options.client ?? client).put({ url: '/billing/payment-methods/{paymentMethodId}/default', ...options });
|
|
649
701
|
}
|
|
650
702
|
/**
|
|
651
|
-
* Delete
|
|
703
|
+
* Delete a payment method.
|
|
652
704
|
*
|
|
653
|
-
*
|
|
705
|
+
* Detaches the given payment method from the organization. Requires the Administrator role. An organization must keep at least one payment method, so deleting the only remaining method is rejected.
|
|
654
706
|
*
|
|
655
707
|
*/
|
|
656
|
-
static
|
|
657
|
-
return (options.client ?? client).delete({ url: '/
|
|
708
|
+
static deletePaymentMethod(options) {
|
|
709
|
+
return (options.client ?? client).delete({ url: '/billing/payment-methods/{paymentMethodId}', ...options });
|
|
658
710
|
}
|
|
659
711
|
/**
|
|
660
|
-
*
|
|
712
|
+
* List issued invoices.
|
|
661
713
|
*
|
|
662
|
-
* Returns
|
|
714
|
+
* Returns a list of invoices for the organization. For more information on billing and payments, see [Billing and pricing](https://cloudfleet.ai/docs/organization/billing/) section of documentaiton. This endpoint is available to all users in the organization.
|
|
663
715
|
*
|
|
664
|
-
|
|
716
|
+
*/
|
|
717
|
+
static listInvoices(options) {
|
|
718
|
+
return (options?.client ?? client).get({ url: '/billing/invoices', ...options });
|
|
719
|
+
}
|
|
720
|
+
/**
|
|
721
|
+
* Pay the organization's open invoices.
|
|
722
|
+
*
|
|
723
|
+
* Charges all open invoices of the organization against its default payment method. This endpoint is available to administrators of the organization only.
|
|
665
724
|
*
|
|
666
725
|
*/
|
|
667
|
-
static
|
|
668
|
-
return (options
|
|
726
|
+
static payOpenInvoices(options) {
|
|
727
|
+
return (options?.client ?? client).post({ url: '/billing/invoices/pay', ...options });
|
|
669
728
|
}
|
|
670
729
|
/**
|
|
671
|
-
*
|
|
730
|
+
* Get organization contact and billing address information.
|
|
672
731
|
*
|
|
673
|
-
*
|
|
732
|
+
* Returns the organization contact and billing address information. This endpoint is available to all users in the organization.
|
|
674
733
|
*
|
|
675
734
|
*/
|
|
676
|
-
static
|
|
735
|
+
static getContact(options) {
|
|
736
|
+
return (options?.client ?? client).get({ url: '/billing/contact', ...options });
|
|
737
|
+
}
|
|
738
|
+
/**
|
|
739
|
+
* Update organization contact information and billing address.
|
|
740
|
+
*
|
|
741
|
+
* This endpoint allows you to update organization details with its contact information. This endpoint is available to administrators of the organization only.
|
|
742
|
+
*
|
|
743
|
+
*/
|
|
744
|
+
static updateContact(options) {
|
|
677
745
|
return (options.client ?? client).put({
|
|
678
|
-
url: '/
|
|
746
|
+
url: '/billing/contact',
|
|
747
|
+
...options,
|
|
748
|
+
headers: {
|
|
749
|
+
'Content-Type': 'application/json',
|
|
750
|
+
...options.headers
|
|
751
|
+
}
|
|
752
|
+
});
|
|
753
|
+
}
|
|
754
|
+
/**
|
|
755
|
+
* Get applied promotional credits
|
|
756
|
+
*
|
|
757
|
+
* Returns applied promotional credits for the organization. For more information on billing and payments, see [Billing and pricing](https://cloudfleet.ai/docs/organization/billing/) section of documentaiton. This endpoint is available to all users in the organization.
|
|
758
|
+
*
|
|
759
|
+
*/
|
|
760
|
+
static getCredits(options) {
|
|
761
|
+
return (options?.client ?? client).get({ url: '/billing/credits', ...options });
|
|
762
|
+
}
|
|
763
|
+
/**
|
|
764
|
+
* Redeem promotional credits code.
|
|
765
|
+
*
|
|
766
|
+
* Applies promotional credits for the organization. For more information on billing and payments, see [Billing and pricing](https://cloudfleet.ai/docs/organization/billing/) section of documentaiton. This endpoint is available to all users in the organization.
|
|
767
|
+
*
|
|
768
|
+
*/
|
|
769
|
+
static redeemCredits(options) {
|
|
770
|
+
return (options.client ?? client).post({
|
|
771
|
+
url: '/billing/credits',
|
|
679
772
|
...options,
|
|
680
773
|
headers: {
|
|
681
774
|
'Content-Type': 'application/json',
|