@cloudfleet/sdk 0.0.1-a0f38b2 → 0.0.1-a10877b
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 +1026 -0
- package/dist/@tanstack/react-query.gen.d.ts.map +1 -0
- package/dist/@tanstack/react-query.gen.js +1194 -0
- package/dist/@tanstack/react-query.gen.js.map +1 -0
- package/dist/client/client.gen.d.ts.map +1 -1
- package/dist/client/client.gen.js +114 -102
- package/dist/client/client.gen.js.map +1 -1
- package/dist/client/index.d.ts +1 -1
- package/dist/client/index.d.ts.map +1 -1
- package/dist/client/index.js.map +1 -1
- package/dist/client/types.gen.d.ts +9 -13
- package/dist/client/types.gen.d.ts.map +1 -1
- package/dist/client/utils.gen.d.ts +8 -4
- package/dist/client/utils.gen.d.ts.map +1 -1
- package/dist/client/utils.gen.js +13 -15
- package/dist/client/utils.gen.js.map +1 -1
- package/dist/client.gen.d.ts.map +1 -1
- package/dist/client.gen.js +1 -3
- package/dist/client.gen.js.map +1 -1
- package/dist/core/auth.gen.d.ts.map +1 -1
- package/dist/core/auth.gen.js.map +1 -1
- package/dist/core/bodySerializer.gen.d.ts +16 -8
- package/dist/core/bodySerializer.gen.d.ts.map +1 -1
- package/dist/core/bodySerializer.gen.js +1 -1
- package/dist/core/bodySerializer.gen.js.map +1 -1
- package/dist/core/params.gen.d.ts +10 -0
- package/dist/core/params.gen.d.ts.map +1 -1
- package/dist/core/params.gen.js +22 -10
- package/dist/core/params.gen.js.map +1 -1
- package/dist/core/pathSerializer.gen.d.ts.map +1 -1
- package/dist/core/pathSerializer.gen.js +3 -11
- package/dist/core/pathSerializer.gen.js.map +1 -1
- package/dist/core/queryKeySerializer.gen.d.ts.map +1 -1
- package/dist/core/queryKeySerializer.gen.js +4 -11
- package/dist/core/queryKeySerializer.gen.js.map +1 -1
- package/dist/core/serverSentEvents.gen.d.ts +1 -1
- package/dist/core/serverSentEvents.gen.d.ts.map +1 -1
- package/dist/core/serverSentEvents.gen.js +6 -9
- package/dist/core/serverSentEvents.gen.js.map +1 -1
- package/dist/core/types.gen.d.ts +1 -1
- package/dist/core/types.gen.d.ts.map +1 -1
- package/dist/core/utils.gen.d.ts.map +1 -1
- package/dist/core/utils.gen.js +1 -1
- package/dist/core/utils.gen.js.map +1 -1
- package/dist/schemas.gen.d.ts +1102 -145
- package/dist/schemas.gen.d.ts.map +1 -1
- package/dist/schemas.gen.js +2515 -215
- package/dist/schemas.gen.js.map +1 -1
- package/dist/sdk.gen.d.ts +258 -191
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/sdk.gen.js +367 -370
- package/dist/sdk.gen.js.map +1 -1
- package/dist/services/kubernetes/api.d.ts +8 -8
- package/dist/types.gen.d.ts +1547 -706
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/zod.gen.d.ts +3489 -1433
- package/dist/zod.gen.d.ts.map +1 -1
- package/dist/zod.gen.js +1411 -631
- package/dist/zod.gen.js.map +1 -1
- package/package.json +28 -8
package/dist/sdk.gen.js
CHANGED
|
@@ -1,75 +1,69 @@
|
|
|
1
1
|
// This file is auto-generated by @hey-api/openapi-ts
|
|
2
|
+
import { formDataBodySerializer } from './client';
|
|
2
3
|
import { client } from './client.gen';
|
|
3
|
-
export class
|
|
4
|
+
export class UsersService {
|
|
4
5
|
/**
|
|
5
|
-
* Get
|
|
6
|
-
*
|
|
7
|
-
* 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.
|
|
8
|
-
*
|
|
6
|
+
* Get a list of organizations the user belongs to. Used during authentication process.
|
|
9
7
|
*/
|
|
10
|
-
static
|
|
11
|
-
return (options
|
|
12
|
-
url: '/billing/usage',
|
|
13
|
-
...options
|
|
14
|
-
});
|
|
8
|
+
static listUserOrganizations(options) {
|
|
9
|
+
return (options.client ?? client).get({ url: '/users/organizations/{email}', ...options });
|
|
15
10
|
}
|
|
16
11
|
/**
|
|
17
|
-
*
|
|
12
|
+
* List users in organization.
|
|
13
|
+
*
|
|
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.
|
|
18
15
|
*
|
|
19
|
-
*
|
|
16
|
+
* This endpoint is available to all users in the organization.
|
|
20
17
|
*
|
|
21
18
|
*/
|
|
22
|
-
static
|
|
23
|
-
return (options?.client ?? client).get({
|
|
24
|
-
url: '/billing/payment-method',
|
|
25
|
-
...options
|
|
26
|
-
});
|
|
19
|
+
static listUsers(options) {
|
|
20
|
+
return (options?.client ?? client).get({ url: '/users', ...options });
|
|
27
21
|
}
|
|
28
22
|
/**
|
|
29
|
-
*
|
|
23
|
+
* Create a new user.
|
|
30
24
|
*
|
|
31
|
-
*
|
|
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.
|
|
32
26
|
*
|
|
33
27
|
*/
|
|
34
|
-
static
|
|
35
|
-
return (options
|
|
36
|
-
url: '/
|
|
37
|
-
...options
|
|
28
|
+
static createUser(options) {
|
|
29
|
+
return (options.client ?? client).post({
|
|
30
|
+
url: '/users',
|
|
31
|
+
...options,
|
|
32
|
+
headers: {
|
|
33
|
+
'Content-Type': 'application/json',
|
|
34
|
+
...options.headers
|
|
35
|
+
}
|
|
38
36
|
});
|
|
39
37
|
}
|
|
40
38
|
/**
|
|
41
|
-
*
|
|
39
|
+
* Delete user by id.
|
|
42
40
|
*
|
|
43
|
-
*
|
|
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.
|
|
44
42
|
*
|
|
45
43
|
*/
|
|
46
|
-
static
|
|
47
|
-
return (options
|
|
48
|
-
url: '/billing/invoices',
|
|
49
|
-
...options
|
|
50
|
-
});
|
|
44
|
+
static deleteUser(options) {
|
|
45
|
+
return (options.client ?? client).delete({ url: '/users/{user_id}', ...options });
|
|
51
46
|
}
|
|
52
47
|
/**
|
|
53
|
-
* Get
|
|
48
|
+
* Get user profile information by id.
|
|
54
49
|
*
|
|
55
|
-
* Returns
|
|
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.
|
|
56
53
|
*
|
|
57
54
|
*/
|
|
58
|
-
static
|
|
59
|
-
return (options
|
|
60
|
-
url: '/billing/contact',
|
|
61
|
-
...options
|
|
62
|
-
});
|
|
55
|
+
static getUser(options) {
|
|
56
|
+
return (options.client ?? client).get({ url: '/users/{user_id}', ...options });
|
|
63
57
|
}
|
|
64
58
|
/**
|
|
65
|
-
* Update
|
|
59
|
+
* Update user profile information.
|
|
66
60
|
*
|
|
67
|
-
*
|
|
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.
|
|
68
62
|
*
|
|
69
63
|
*/
|
|
70
|
-
static
|
|
64
|
+
static updateUser(options) {
|
|
71
65
|
return (options.client ?? client).put({
|
|
72
|
-
url: '/
|
|
66
|
+
url: '/users/{user_id}',
|
|
73
67
|
...options,
|
|
74
68
|
headers: {
|
|
75
69
|
'Content-Type': 'application/json',
|
|
@@ -77,27 +71,28 @@ export class BillingService {
|
|
|
77
71
|
}
|
|
78
72
|
});
|
|
79
73
|
}
|
|
74
|
+
}
|
|
75
|
+
export class TokensService {
|
|
80
76
|
/**
|
|
81
|
-
*
|
|
77
|
+
* List access tokens in organization.
|
|
82
78
|
*
|
|
83
|
-
*
|
|
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.
|
|
84
80
|
*
|
|
85
81
|
*/
|
|
86
|
-
static
|
|
87
|
-
return (options?.client ?? client).get({
|
|
88
|
-
url: '/billing/credits',
|
|
89
|
-
...options
|
|
90
|
-
});
|
|
82
|
+
static listTokens(options) {
|
|
83
|
+
return (options?.client ?? client).get({ url: '/tokens', ...options });
|
|
91
84
|
}
|
|
92
85
|
/**
|
|
93
|
-
*
|
|
86
|
+
* Create a new access token.
|
|
94
87
|
*
|
|
95
|
-
*
|
|
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.
|
|
89
|
+
*
|
|
90
|
+
* This endpoint is available to administrators of the organization only.
|
|
96
91
|
*
|
|
97
92
|
*/
|
|
98
|
-
static
|
|
93
|
+
static createToken(options) {
|
|
99
94
|
return (options.client ?? client).post({
|
|
100
|
-
url: '/
|
|
95
|
+
url: '/tokens',
|
|
101
96
|
...options,
|
|
102
97
|
headers: {
|
|
103
98
|
'Content-Type': 'application/json',
|
|
@@ -105,33 +100,35 @@ export class BillingService {
|
|
|
105
100
|
}
|
|
106
101
|
});
|
|
107
102
|
}
|
|
108
|
-
}
|
|
109
|
-
export class ClustersService {
|
|
110
103
|
/**
|
|
111
|
-
*
|
|
104
|
+
* Permanently delete access token.
|
|
112
105
|
*
|
|
113
|
-
*
|
|
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.
|
|
114
107
|
*
|
|
115
|
-
|
|
108
|
+
*/
|
|
109
|
+
static deleteToken(options) {
|
|
110
|
+
return (options.client ?? client).delete({ url: '/tokens/{token_id}', ...options });
|
|
111
|
+
}
|
|
112
|
+
/**
|
|
113
|
+
* Get access token information.
|
|
114
|
+
*
|
|
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.
|
|
116
116
|
*
|
|
117
117
|
*/
|
|
118
|
-
static
|
|
119
|
-
return (options.client ?? client).get({
|
|
120
|
-
url: '/clusters/{cluster_id}/charts',
|
|
121
|
-
...options
|
|
122
|
-
});
|
|
118
|
+
static getToken(options) {
|
|
119
|
+
return (options.client ?? client).get({ url: '/tokens/{token_id}', ...options });
|
|
123
120
|
}
|
|
124
121
|
/**
|
|
125
|
-
*
|
|
122
|
+
* Update access token information.
|
|
126
123
|
*
|
|
127
|
-
*
|
|
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.
|
|
128
125
|
*
|
|
129
126
|
* This endpoint is available to administrators of the organization only.
|
|
130
127
|
*
|
|
131
128
|
*/
|
|
132
|
-
static
|
|
133
|
-
return (options.client ?? client).
|
|
134
|
-
url: '/
|
|
129
|
+
static updateToken(options) {
|
|
130
|
+
return (options.client ?? client).put({
|
|
131
|
+
url: '/tokens/{token_id}',
|
|
135
132
|
...options,
|
|
136
133
|
headers: {
|
|
137
134
|
'Content-Type': 'application/json',
|
|
@@ -140,169 +137,139 @@ export class ClustersService {
|
|
|
140
137
|
});
|
|
141
138
|
}
|
|
142
139
|
/**
|
|
143
|
-
*
|
|
144
|
-
*
|
|
145
|
-
* This endpoint will permanently delete chart. This operation cannot be undone.
|
|
146
|
-
*
|
|
147
|
-
* This endpoint is available to administrators of the organization only.
|
|
140
|
+
* Regenerate access token secret key.
|
|
148
141
|
*
|
|
142
|
+
* Generates a new access token secret. Old secret will not be valid anymore.
|
|
149
143
|
*/
|
|
150
|
-
static
|
|
151
|
-
return (options.client ?? client).
|
|
152
|
-
url: '/clusters/{cluster_id}/charts/{chart_name}',
|
|
153
|
-
...options
|
|
154
|
-
});
|
|
144
|
+
static regenerateToken(options) {
|
|
145
|
+
return (options.client ?? client).put({ url: '/tokens/{token_id}/secret', ...options });
|
|
155
146
|
}
|
|
147
|
+
}
|
|
148
|
+
export class TicketsService {
|
|
156
149
|
/**
|
|
157
|
-
*
|
|
158
|
-
*
|
|
159
|
-
* Returns the details of the chart deployment.
|
|
150
|
+
* List tickets for the current organization.
|
|
160
151
|
*
|
|
161
|
-
*
|
|
152
|
+
* Returns all tickets belonging to the caller's organization, newest first.
|
|
162
153
|
*
|
|
163
154
|
*/
|
|
164
|
-
static
|
|
165
|
-
return (options
|
|
166
|
-
url: '/clusters/{cluster_id}/charts/{chart_name}',
|
|
167
|
-
...options
|
|
168
|
-
});
|
|
155
|
+
static listTickets(options) {
|
|
156
|
+
return (options?.client ?? client).get({ url: '/tickets', ...options });
|
|
169
157
|
}
|
|
170
158
|
/**
|
|
171
|
-
*
|
|
172
|
-
*
|
|
173
|
-
* This endpoint allows you to update the values of a chart deployment.
|
|
159
|
+
* Create a new support ticket.
|
|
174
160
|
*
|
|
175
|
-
*
|
|
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`, plus up to 3 `attachments` files (10 MB max each).
|
|
176
162
|
*
|
|
177
163
|
*/
|
|
178
|
-
static
|
|
179
|
-
return (options.client ?? client).
|
|
180
|
-
|
|
164
|
+
static createTicket(options) {
|
|
165
|
+
return (options.client ?? client).post({
|
|
166
|
+
...formDataBodySerializer,
|
|
167
|
+
url: '/tickets',
|
|
181
168
|
...options,
|
|
182
169
|
headers: {
|
|
183
|
-
'Content-Type':
|
|
170
|
+
'Content-Type': null,
|
|
184
171
|
...options.headers
|
|
185
172
|
}
|
|
186
173
|
});
|
|
187
174
|
}
|
|
188
175
|
/**
|
|
189
|
-
*
|
|
190
|
-
*
|
|
191
|
-
* Returns a list of fleets belonging to the cluster. For more information, see [Fleets](https://cloudfleet.ai/docs/cloud-infrastructure/fleets/) section of documentaiton.
|
|
176
|
+
* Close a ticket (soft close).
|
|
192
177
|
*
|
|
193
|
-
*
|
|
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.
|
|
194
179
|
*
|
|
195
180
|
*/
|
|
196
|
-
static
|
|
197
|
-
return (options.client ?? client).
|
|
198
|
-
url: '/clusters/{cluster_id}/fleets',
|
|
199
|
-
...options
|
|
200
|
-
});
|
|
181
|
+
static closeTicket(options) {
|
|
182
|
+
return (options.client ?? client).delete({ url: '/tickets/{ticket_id}', ...options });
|
|
201
183
|
}
|
|
202
184
|
/**
|
|
203
|
-
*
|
|
204
|
-
|
|
205
|
-
|
|
185
|
+
* Get a ticket and its messages.
|
|
186
|
+
*/
|
|
187
|
+
static getTicket(options) {
|
|
188
|
+
return (options.client ?? client).get({ url: '/tickets/{ticket_id}', ...options });
|
|
189
|
+
}
|
|
190
|
+
/**
|
|
191
|
+
* Append a customer reply to a ticket.
|
|
206
192
|
*
|
|
207
|
-
*
|
|
193
|
+
* Multipart form-data with a JSON-encoded `payload` field carrying `body`, plus up to 3 `attachments` files. Returns 409 if the ticket is closed.
|
|
208
194
|
*
|
|
209
195
|
*/
|
|
210
|
-
static
|
|
196
|
+
static replyTicket(options) {
|
|
211
197
|
return (options.client ?? client).post({
|
|
212
|
-
|
|
198
|
+
...formDataBodySerializer,
|
|
199
|
+
url: '/tickets/{ticket_id}/messages',
|
|
213
200
|
...options,
|
|
214
201
|
headers: {
|
|
215
|
-
'Content-Type':
|
|
202
|
+
'Content-Type': null,
|
|
216
203
|
...options.headers
|
|
217
204
|
}
|
|
218
205
|
});
|
|
219
206
|
}
|
|
220
207
|
/**
|
|
221
|
-
*
|
|
222
|
-
*
|
|
223
|
-
* 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.
|
|
224
|
-
*
|
|
225
|
-
* This endpoint is available to administrators of the organization only.
|
|
226
|
-
*
|
|
208
|
+
* Download a ticket attachment.
|
|
227
209
|
*/
|
|
228
|
-
static
|
|
229
|
-
return (options.client ?? client).
|
|
230
|
-
url: '/clusters/{cluster_id}/fleets/{fleet_name}',
|
|
231
|
-
...options
|
|
232
|
-
});
|
|
210
|
+
static getTicketAttachment(options) {
|
|
211
|
+
return (options.client ?? client).get({ url: '/tickets/{ticket_id}/attachments/{attachment_id}', ...options });
|
|
233
212
|
}
|
|
213
|
+
}
|
|
214
|
+
export class RegistryService {
|
|
234
215
|
/**
|
|
235
|
-
*
|
|
236
|
-
*
|
|
237
|
-
* Returns fleet details. For more information, see [Fleets](https://cloudfleet.ai/docs/cloud-infrastructure/fleets/) section of documentaiton.
|
|
216
|
+
* List repositories
|
|
238
217
|
*
|
|
239
|
-
* This endpoint is available to all users in the organization.
|
|
218
|
+
* Returns a list of repositories in the registry across all regions. This endpoint is available to all users in the organization.
|
|
240
219
|
*
|
|
241
220
|
*/
|
|
242
|
-
static
|
|
243
|
-
return (options
|
|
244
|
-
url: '/clusters/{cluster_id}/fleets/{fleet_name}',
|
|
245
|
-
...options
|
|
246
|
-
});
|
|
221
|
+
static listRepositories(options) {
|
|
222
|
+
return (options?.client ?? client).get({ url: '/registry', ...options });
|
|
247
223
|
}
|
|
248
224
|
/**
|
|
249
|
-
*
|
|
250
|
-
*
|
|
251
|
-
* This endpoint allows you to update fleet details.
|
|
225
|
+
* List tags for a repository
|
|
252
226
|
*
|
|
253
|
-
*
|
|
227
|
+
* 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.
|
|
254
228
|
*
|
|
255
|
-
|
|
229
|
+
*/
|
|
230
|
+
static listTags(options) {
|
|
231
|
+
return (options.client ?? client).get({ url: '/registry/{region}/{repository}', ...options });
|
|
232
|
+
}
|
|
233
|
+
/**
|
|
234
|
+
* Delete tag
|
|
256
235
|
*
|
|
257
|
-
* This endpoint is available to administrators of the organization only.
|
|
236
|
+
* Permanently deletes a specific tag from a repository. This endpoint is available to administrators of the organization only.
|
|
258
237
|
*
|
|
259
238
|
*/
|
|
260
|
-
static
|
|
261
|
-
return (options.client ?? client).
|
|
262
|
-
url: '/clusters/{cluster_id}/fleets/{fleet_name}',
|
|
263
|
-
...options,
|
|
264
|
-
headers: {
|
|
265
|
-
'Content-Type': 'application/json',
|
|
266
|
-
...options.headers
|
|
267
|
-
}
|
|
268
|
-
});
|
|
239
|
+
static deleteTag(options) {
|
|
240
|
+
return (options.client ?? client).delete({ url: '/registry/{region}/{repository}/{tag}', ...options });
|
|
269
241
|
}
|
|
270
242
|
/**
|
|
271
|
-
*
|
|
243
|
+
* Get tag details
|
|
244
|
+
*
|
|
245
|
+
* 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.
|
|
272
246
|
*
|
|
273
|
-
* 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.
|
|
274
247
|
*/
|
|
275
|
-
static
|
|
276
|
-
return (options.client ?? client).get({
|
|
277
|
-
url: '/clusters/{cluster_id}/query',
|
|
278
|
-
...options
|
|
279
|
-
});
|
|
248
|
+
static getTag(options) {
|
|
249
|
+
return (options.client ?? client).get({ url: '/registry/{region}/{repository}/{tag}', ...options });
|
|
280
250
|
}
|
|
251
|
+
}
|
|
252
|
+
export class OrganizationService {
|
|
281
253
|
/**
|
|
282
|
-
*
|
|
254
|
+
* Get organization information.
|
|
283
255
|
*
|
|
284
|
-
* Returns
|
|
256
|
+
* Returns organization details including quota. For more information about quotas, see [Quotas and limits](https://cloudfleet.ai/docs/organization/quotas/) section of documentaiton.
|
|
285
257
|
*
|
|
286
258
|
* This endpoint is available to all users in the organization.
|
|
287
259
|
*
|
|
288
260
|
*/
|
|
289
|
-
static
|
|
290
|
-
return (options?.client ?? client).get({
|
|
291
|
-
url: '/clusters',
|
|
292
|
-
...options
|
|
293
|
-
});
|
|
261
|
+
static getOrganization(options) {
|
|
262
|
+
return (options?.client ?? client).get({ url: '/organization', ...options });
|
|
294
263
|
}
|
|
295
264
|
/**
|
|
296
|
-
* Create a new
|
|
297
|
-
*
|
|
298
|
-
* 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.
|
|
265
|
+
* Create a new organization / Cloudfleet account signup.
|
|
299
266
|
*
|
|
300
|
-
* This endpoint
|
|
267
|
+
* This endpoint allows you to create a new Cloudfleet organization and an administrator user.
|
|
301
268
|
*
|
|
302
269
|
*/
|
|
303
|
-
static
|
|
270
|
+
static createOrganization(options) {
|
|
304
271
|
return (options.client ?? client).post({
|
|
305
|
-
url: '/
|
|
272
|
+
url: '/organization',
|
|
306
273
|
...options,
|
|
307
274
|
headers: {
|
|
308
275
|
'Content-Type': 'application/json',
|
|
@@ -310,77 +277,59 @@ export class ClustersService {
|
|
|
310
277
|
}
|
|
311
278
|
});
|
|
312
279
|
}
|
|
280
|
+
}
|
|
281
|
+
export class McpService {
|
|
313
282
|
/**
|
|
314
|
-
*
|
|
315
|
-
*
|
|
316
|
-
* This endpoint will permanently delete the cluster. This operation cannot be undone.
|
|
317
|
-
*
|
|
318
|
-
* This endpoint is available to administrators of the organization only.
|
|
283
|
+
* MCP endpoint
|
|
319
284
|
*
|
|
285
|
+
* MCP endpoint for handling Model Context Protocol JSON-RPC 2.0 messages.
|
|
320
286
|
*/
|
|
321
|
-
static
|
|
322
|
-
return (options.client ?? client).
|
|
323
|
-
url: '/
|
|
324
|
-
...options
|
|
287
|
+
static postMcp(options) {
|
|
288
|
+
return (options.client ?? client).post({
|
|
289
|
+
url: '/mcp',
|
|
290
|
+
...options,
|
|
291
|
+
headers: {
|
|
292
|
+
'Content-Type': 'application/json',
|
|
293
|
+
...options.headers
|
|
294
|
+
}
|
|
325
295
|
});
|
|
326
296
|
}
|
|
297
|
+
}
|
|
298
|
+
export class ChartsMarketplaceService {
|
|
327
299
|
/**
|
|
328
|
-
*
|
|
300
|
+
* List chart listings available in the marketplace.
|
|
329
301
|
*
|
|
330
|
-
* Returns
|
|
302
|
+
* Returns a list of available charts in the marketplace.
|
|
331
303
|
*
|
|
332
304
|
* This endpoint is available to all users in the organization.
|
|
333
305
|
*
|
|
334
306
|
*/
|
|
335
|
-
static
|
|
336
|
-
return (options
|
|
337
|
-
url: '/clusters/{cluster_id}',
|
|
338
|
-
...options
|
|
339
|
-
});
|
|
307
|
+
static listMarketplaceCharts(options) {
|
|
308
|
+
return (options?.client ?? client).get({ url: '/marketplace', ...options });
|
|
340
309
|
}
|
|
341
310
|
/**
|
|
342
|
-
*
|
|
311
|
+
* Get chart files for a specific version channel.
|
|
312
|
+
*
|
|
313
|
+
* Returns the Chart.yaml, values.yaml, and values.schema.json files for the latest version matching the specified version channel.
|
|
343
314
|
*
|
|
344
|
-
*
|
|
315
|
+
* Version channels use patterns like "1.31.x-cfke.x" to match the latest patch version, or "1.x.x-cfke.x" to match the latest minor version.
|
|
345
316
|
*
|
|
346
|
-
* This endpoint is available to
|
|
317
|
+
* This endpoint is available to all users in the organization.
|
|
347
318
|
*
|
|
348
319
|
*/
|
|
349
|
-
static
|
|
350
|
-
return (options.client ?? client).
|
|
351
|
-
url: '/clusters/{cluster_id}',
|
|
352
|
-
...options,
|
|
353
|
-
headers: {
|
|
354
|
-
'Content-Type': 'application/json',
|
|
355
|
-
...options.headers
|
|
356
|
-
}
|
|
357
|
-
});
|
|
358
|
-
}
|
|
359
|
-
/**
|
|
360
|
-
* Node join information for the cluster
|
|
361
|
-
*
|
|
362
|
-
* 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.
|
|
363
|
-
*
|
|
364
|
-
*/
|
|
365
|
-
static getJoinInformation(options) {
|
|
366
|
-
return (options.client ?? client).post({
|
|
367
|
-
url: '/clusters/{cluster_id}/join_information',
|
|
368
|
-
...options
|
|
369
|
-
});
|
|
320
|
+
static getMarketplaceChartFiles(options) {
|
|
321
|
+
return (options.client ?? client).get({ url: '/marketplace/{chart_name}/files/{version_channel}', ...options });
|
|
370
322
|
}
|
|
371
323
|
}
|
|
372
324
|
export class InvitesService {
|
|
373
325
|
/**
|
|
374
326
|
* List invites.
|
|
375
327
|
*
|
|
376
|
-
* Returns a list of invites under the current organization. This endpoint is available to
|
|
328
|
+
* Returns a list of pending (non-expired) invites under the current organization. This endpoint is available to administrators of the organization only.
|
|
377
329
|
*
|
|
378
330
|
*/
|
|
379
331
|
static listInvites(options) {
|
|
380
|
-
return (options?.client ?? client).get({
|
|
381
|
-
url: '/invites',
|
|
382
|
-
...options
|
|
383
|
-
});
|
|
332
|
+
return (options?.client ?? client).get({ url: '/invites', ...options });
|
|
384
333
|
}
|
|
385
334
|
/**
|
|
386
335
|
* Create a new invite.
|
|
@@ -401,14 +350,11 @@ export class InvitesService {
|
|
|
401
350
|
/**
|
|
402
351
|
* Get invite information.
|
|
403
352
|
*
|
|
404
|
-
*
|
|
353
|
+
* 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.
|
|
405
354
|
*
|
|
406
355
|
*/
|
|
407
356
|
static getInvite(options) {
|
|
408
|
-
return (options.client ?? client).get({
|
|
409
|
-
url: '/invites/{code}',
|
|
410
|
-
...options
|
|
411
|
-
});
|
|
357
|
+
return (options.client ?? client).get({ url: '/invites/{code}', ...options });
|
|
412
358
|
}
|
|
413
359
|
/**
|
|
414
360
|
* Permanently delete invite.
|
|
@@ -417,53 +363,42 @@ export class InvitesService {
|
|
|
417
363
|
*
|
|
418
364
|
*/
|
|
419
365
|
static deleteInvite(options) {
|
|
420
|
-
return (options.client ?? client).delete({
|
|
421
|
-
url: '/invites/{email}',
|
|
422
|
-
...options
|
|
423
|
-
});
|
|
366
|
+
return (options.client ?? client).delete({ url: '/invites/{email}', ...options });
|
|
424
367
|
}
|
|
425
368
|
}
|
|
426
|
-
export class
|
|
369
|
+
export class ClustersService {
|
|
427
370
|
/**
|
|
428
|
-
*
|
|
429
|
-
*
|
|
430
|
-
* Returns a list of available charts in the marketplace.
|
|
431
|
-
*
|
|
432
|
-
* This endpoint is available to all users in the organization.
|
|
371
|
+
* Query Kubernetes cluster API
|
|
433
372
|
*
|
|
373
|
+
* 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.
|
|
434
374
|
*/
|
|
435
|
-
static
|
|
436
|
-
return (options
|
|
437
|
-
url: '/marketplace',
|
|
438
|
-
...options
|
|
439
|
-
});
|
|
375
|
+
static queryCluster(options) {
|
|
376
|
+
return (options.client ?? client).get({ url: '/clusters/{cluster_id}/query', ...options });
|
|
440
377
|
}
|
|
441
378
|
/**
|
|
442
|
-
*
|
|
443
|
-
*
|
|
444
|
-
* Returns the Chart.yaml, values.yaml, and values.schema.json files for the latest version matching the specified version channel.
|
|
379
|
+
* List fleets.
|
|
445
380
|
*
|
|
446
|
-
*
|
|
381
|
+
* Returns a list of fleets belonging to the cluster. For more information, see [Fleets](https://cloudfleet.ai/docs/cloud-infrastructure/fleets/) section of documentaiton.
|
|
447
382
|
*
|
|
448
383
|
* This endpoint is available to all users in the organization.
|
|
449
384
|
*
|
|
450
385
|
*/
|
|
451
|
-
static
|
|
452
|
-
return (options.client ?? client).get({
|
|
453
|
-
url: '/marketplace/{chart_name}/files/{version_channel}',
|
|
454
|
-
...options
|
|
455
|
-
});
|
|
386
|
+
static listFleets(options) {
|
|
387
|
+
return (options.client ?? client).get({ url: '/clusters/{cluster_id}/fleets', ...options });
|
|
456
388
|
}
|
|
457
|
-
}
|
|
458
|
-
export class McpService {
|
|
459
389
|
/**
|
|
460
|
-
*
|
|
390
|
+
* Create a new fleet.
|
|
391
|
+
*
|
|
392
|
+
* 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.
|
|
393
|
+
*
|
|
394
|
+
* The cluster must be ready (status `deployed`) before a fleet can be added. Adding a fleet while the cluster is still provisioning returns `409`.
|
|
395
|
+
*
|
|
396
|
+
* This endpoint is available to administrators of the organization only.
|
|
461
397
|
*
|
|
462
|
-
* MCP endpoint for handling Model Context Protocol JSON-RPC 2.0 messages.
|
|
463
398
|
*/
|
|
464
|
-
static
|
|
399
|
+
static createFleet(options) {
|
|
465
400
|
return (options.client ?? client).post({
|
|
466
|
-
url: '/
|
|
401
|
+
url: '/clusters/{cluster_id}/fleets',
|
|
467
402
|
...options,
|
|
468
403
|
headers: {
|
|
469
404
|
'Content-Type': 'application/json',
|
|
@@ -471,31 +406,45 @@ export class McpService {
|
|
|
471
406
|
}
|
|
472
407
|
});
|
|
473
408
|
}
|
|
474
|
-
}
|
|
475
|
-
export class OrganizationService {
|
|
476
409
|
/**
|
|
477
|
-
*
|
|
410
|
+
* Permanently delete fleet.
|
|
478
411
|
*
|
|
479
|
-
*
|
|
412
|
+
* 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.
|
|
413
|
+
*
|
|
414
|
+
* 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.
|
|
415
|
+
*
|
|
416
|
+
* This endpoint is available to administrators of the organization only.
|
|
417
|
+
*
|
|
418
|
+
*/
|
|
419
|
+
static deleteFleet(options) {
|
|
420
|
+
return (options.client ?? client).delete({ url: '/clusters/{cluster_id}/fleets/{fleet_name}', ...options });
|
|
421
|
+
}
|
|
422
|
+
/**
|
|
423
|
+
* Get fleet information.
|
|
424
|
+
*
|
|
425
|
+
* Returns fleet details. For more information, see [Fleets](https://cloudfleet.ai/docs/cloud-infrastructure/fleets/) section of documentaiton.
|
|
480
426
|
*
|
|
481
427
|
* This endpoint is available to all users in the organization.
|
|
482
428
|
*
|
|
483
429
|
*/
|
|
484
|
-
static
|
|
485
|
-
return (options
|
|
486
|
-
url: '/organization',
|
|
487
|
-
...options
|
|
488
|
-
});
|
|
430
|
+
static getFleet(options) {
|
|
431
|
+
return (options.client ?? client).get({ url: '/clusters/{cluster_id}/fleets/{fleet_name}', ...options });
|
|
489
432
|
}
|
|
490
433
|
/**
|
|
491
|
-
*
|
|
434
|
+
* Update fleet information.
|
|
492
435
|
*
|
|
493
|
-
* This endpoint allows you to
|
|
436
|
+
* This endpoint allows you to update fleet details.
|
|
437
|
+
*
|
|
438
|
+
* For more information, see [Fleets](https://cloudfleet.ai/docs/cloud-infrastructure/fleets/) section of documentaiton.
|
|
439
|
+
*
|
|
440
|
+
* 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).
|
|
441
|
+
*
|
|
442
|
+
* This endpoint is available to administrators of the organization only.
|
|
494
443
|
*
|
|
495
444
|
*/
|
|
496
|
-
static
|
|
497
|
-
return (options.client ?? client).
|
|
498
|
-
url: '/
|
|
445
|
+
static updateFleet(options) {
|
|
446
|
+
return (options.client ?? client).put({
|
|
447
|
+
url: '/clusters/{cluster_id}/fleets/{fleet_name}',
|
|
499
448
|
...options,
|
|
500
449
|
headers: {
|
|
501
450
|
'Content-Type': 'application/json',
|
|
@@ -503,81 +452,97 @@ export class OrganizationService {
|
|
|
503
452
|
}
|
|
504
453
|
});
|
|
505
454
|
}
|
|
506
|
-
}
|
|
507
|
-
export class RegistryService {
|
|
508
455
|
/**
|
|
509
|
-
* List
|
|
456
|
+
* List charts.
|
|
510
457
|
*
|
|
511
|
-
* Returns a list of
|
|
458
|
+
* Returns a list of charts in the cluster.
|
|
459
|
+
*
|
|
460
|
+
* This endpoint is available to all users in the organization.
|
|
512
461
|
*
|
|
513
462
|
*/
|
|
514
|
-
static
|
|
515
|
-
return (options
|
|
516
|
-
url: '/registry',
|
|
517
|
-
...options
|
|
518
|
-
});
|
|
463
|
+
static listCharts(options) {
|
|
464
|
+
return (options.client ?? client).get({ url: '/clusters/{cluster_id}/charts', ...options });
|
|
519
465
|
}
|
|
520
466
|
/**
|
|
521
|
-
*
|
|
467
|
+
* Create a new chart.
|
|
522
468
|
*
|
|
523
|
-
*
|
|
469
|
+
* Create a new chart deployment.
|
|
470
|
+
*
|
|
471
|
+
* This endpoint is available to administrators of the organization only.
|
|
524
472
|
*
|
|
525
473
|
*/
|
|
526
|
-
static
|
|
527
|
-
return (options.client ?? client).
|
|
528
|
-
url: '/
|
|
529
|
-
...options
|
|
474
|
+
static createChart(options) {
|
|
475
|
+
return (options.client ?? client).post({
|
|
476
|
+
url: '/clusters/{cluster_id}/charts',
|
|
477
|
+
...options,
|
|
478
|
+
headers: {
|
|
479
|
+
'Content-Type': 'application/json',
|
|
480
|
+
...options.headers
|
|
481
|
+
}
|
|
530
482
|
});
|
|
531
483
|
}
|
|
532
484
|
/**
|
|
533
|
-
*
|
|
485
|
+
* Permanently delete the chart deployment from the cluster.
|
|
534
486
|
*
|
|
535
|
-
*
|
|
487
|
+
* This endpoint will permanently delete chart. This operation cannot be undone.
|
|
488
|
+
*
|
|
489
|
+
* This endpoint is available to administrators of the organization only.
|
|
536
490
|
*
|
|
537
491
|
*/
|
|
538
|
-
static
|
|
539
|
-
return (options.client ?? client).delete({
|
|
540
|
-
url: '/registry/{region}/{repository}/{tag}',
|
|
541
|
-
...options
|
|
542
|
-
});
|
|
492
|
+
static deleteChart(options) {
|
|
493
|
+
return (options.client ?? client).delete({ url: '/clusters/{cluster_id}/charts/{chart_name}', ...options });
|
|
543
494
|
}
|
|
544
495
|
/**
|
|
545
|
-
* Get
|
|
496
|
+
* Get chart information.
|
|
546
497
|
*
|
|
547
|
-
* Returns
|
|
498
|
+
* Returns the details of the chart deployment.
|
|
499
|
+
*
|
|
500
|
+
* This endpoint is available to all users in the organization.
|
|
548
501
|
*
|
|
549
502
|
*/
|
|
550
|
-
static
|
|
551
|
-
return (options.client ?? client).get({
|
|
552
|
-
url: '/registry/{region}/{repository}/{tag}',
|
|
553
|
-
...options
|
|
554
|
-
});
|
|
503
|
+
static getChart(options) {
|
|
504
|
+
return (options.client ?? client).get({ url: '/clusters/{cluster_id}/charts/{chart_name}', ...options });
|
|
555
505
|
}
|
|
556
|
-
}
|
|
557
|
-
export class TokensService {
|
|
558
506
|
/**
|
|
559
|
-
*
|
|
507
|
+
* Update chart information.
|
|
560
508
|
*
|
|
561
|
-
* This endpoint allows you to
|
|
509
|
+
* This endpoint allows you to update the values of a chart deployment.
|
|
510
|
+
*
|
|
511
|
+
* This endpoint is available to administrators of the organization only.
|
|
562
512
|
*
|
|
563
513
|
*/
|
|
564
|
-
static
|
|
565
|
-
return (options
|
|
566
|
-
url: '/
|
|
567
|
-
...options
|
|
514
|
+
static updateChart(options) {
|
|
515
|
+
return (options.client ?? client).put({
|
|
516
|
+
url: '/clusters/{cluster_id}/charts/{chart_name}',
|
|
517
|
+
...options,
|
|
518
|
+
headers: {
|
|
519
|
+
'Content-Type': 'application/json',
|
|
520
|
+
...options.headers
|
|
521
|
+
}
|
|
568
522
|
});
|
|
569
523
|
}
|
|
570
524
|
/**
|
|
571
|
-
*
|
|
525
|
+
* List clusters.
|
|
572
526
|
*
|
|
573
|
-
*
|
|
527
|
+
* Returns a list of clusters under the current organization.
|
|
528
|
+
*
|
|
529
|
+
* This endpoint is available to all users in the organization.
|
|
530
|
+
*
|
|
531
|
+
*/
|
|
532
|
+
static listClusters(options) {
|
|
533
|
+
return (options?.client ?? client).get({ url: '/clusters', ...options });
|
|
534
|
+
}
|
|
535
|
+
/**
|
|
536
|
+
* Create a new cluster.
|
|
537
|
+
*
|
|
538
|
+
* 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.
|
|
574
539
|
*
|
|
575
540
|
* This endpoint is available to administrators of the organization only.
|
|
576
541
|
*
|
|
577
542
|
*/
|
|
578
|
-
static
|
|
543
|
+
static createCluster(options) {
|
|
579
544
|
return (options.client ?? client).post({
|
|
580
|
-
url: '/
|
|
545
|
+
url: '/clusters',
|
|
581
546
|
...options,
|
|
582
547
|
headers: {
|
|
583
548
|
'Content-Type': 'application/json',
|
|
@@ -586,40 +551,42 @@ export class TokensService {
|
|
|
586
551
|
});
|
|
587
552
|
}
|
|
588
553
|
/**
|
|
589
|
-
* Permanently delete
|
|
554
|
+
* Permanently delete cluster.
|
|
590
555
|
*
|
|
591
|
-
* This endpoint
|
|
556
|
+
* This endpoint will permanently delete the cluster. This operation cannot be undone.
|
|
557
|
+
*
|
|
558
|
+
* 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.
|
|
559
|
+
*
|
|
560
|
+
* This endpoint is available to administrators of the organization only.
|
|
592
561
|
*
|
|
593
562
|
*/
|
|
594
|
-
static
|
|
595
|
-
return (options.client ?? client).delete({
|
|
596
|
-
url: '/tokens/{token_id}',
|
|
597
|
-
...options
|
|
598
|
-
});
|
|
563
|
+
static deleteCluster(options) {
|
|
564
|
+
return (options.client ?? client).delete({ url: '/clusters/{cluster_id}', ...options });
|
|
599
565
|
}
|
|
600
566
|
/**
|
|
601
|
-
* Get
|
|
567
|
+
* Get cluster information.
|
|
602
568
|
*
|
|
603
|
-
*
|
|
569
|
+
* Returns cluster details.
|
|
570
|
+
*
|
|
571
|
+
* This endpoint is available to all users in the organization.
|
|
604
572
|
*
|
|
605
573
|
*/
|
|
606
|
-
static
|
|
607
|
-
return (options.client ?? client).get({
|
|
608
|
-
url: '/tokens/{token_id}',
|
|
609
|
-
...options
|
|
610
|
-
});
|
|
574
|
+
static getCluster(options) {
|
|
575
|
+
return (options.client ?? client).get({ url: '/clusters/{cluster_id}', ...options });
|
|
611
576
|
}
|
|
612
577
|
/**
|
|
613
|
-
* Update
|
|
578
|
+
* Update cluster information.
|
|
614
579
|
*
|
|
615
|
-
* This endpoint allows you to update
|
|
580
|
+
* 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.
|
|
581
|
+
*
|
|
582
|
+
* This is a full overwrite: any field omitted from the request is reset to its default rather than left unchanged.
|
|
616
583
|
*
|
|
617
584
|
* This endpoint is available to administrators of the organization only.
|
|
618
585
|
*
|
|
619
586
|
*/
|
|
620
|
-
static
|
|
587
|
+
static updateCluster(options) {
|
|
621
588
|
return (options.client ?? client).put({
|
|
622
|
-
url: '/
|
|
589
|
+
url: '/clusters/{cluster_id}',
|
|
623
590
|
...options,
|
|
624
591
|
headers: {
|
|
625
592
|
'Content-Type': 'application/json',
|
|
@@ -628,92 +595,122 @@ export class TokensService {
|
|
|
628
595
|
});
|
|
629
596
|
}
|
|
630
597
|
/**
|
|
631
|
-
*
|
|
598
|
+
* Node join information for the cluster
|
|
599
|
+
*
|
|
600
|
+
* 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.
|
|
632
601
|
*
|
|
633
|
-
* Generates a new access token secret. Old secret will not be valid anymore.
|
|
634
602
|
*/
|
|
635
|
-
static
|
|
636
|
-
return (options.client ?? client).
|
|
637
|
-
url: '/tokens/{token_id}/secret',
|
|
638
|
-
...options
|
|
639
|
-
});
|
|
603
|
+
static getJoinInformation(options) {
|
|
604
|
+
return (options.client ?? client).post({ url: '/clusters/{cluster_id}/join_information', ...options });
|
|
640
605
|
}
|
|
641
606
|
}
|
|
642
|
-
export class
|
|
607
|
+
export class BillingService {
|
|
643
608
|
/**
|
|
644
|
-
* Get
|
|
609
|
+
* Get billing usage information.
|
|
610
|
+
*
|
|
611
|
+
* 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.
|
|
612
|
+
*
|
|
645
613
|
*/
|
|
646
|
-
static
|
|
647
|
-
return (options
|
|
648
|
-
url: '/users/organizations/{email}',
|
|
649
|
-
...options
|
|
650
|
-
});
|
|
614
|
+
static getUsage(options) {
|
|
615
|
+
return (options?.client ?? client).get({ url: '/billing/usage', ...options });
|
|
651
616
|
}
|
|
652
617
|
/**
|
|
653
|
-
*
|
|
618
|
+
* Get Stripe client secret.
|
|
654
619
|
*
|
|
655
|
-
*
|
|
620
|
+
* 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.
|
|
656
621
|
*
|
|
657
|
-
|
|
622
|
+
*/
|
|
623
|
+
static getPaymentMethodSecret(options) {
|
|
624
|
+
return (options?.client ?? client).put({ url: '/billing/payment-method', ...options });
|
|
625
|
+
}
|
|
626
|
+
/**
|
|
627
|
+
* List organization payment methods.
|
|
628
|
+
*
|
|
629
|
+
* 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.
|
|
658
630
|
*
|
|
659
631
|
*/
|
|
660
|
-
static
|
|
661
|
-
return (options?.client ?? client).get({
|
|
662
|
-
url: '/users',
|
|
663
|
-
...options
|
|
664
|
-
});
|
|
632
|
+
static listPaymentMethods(options) {
|
|
633
|
+
return (options?.client ?? client).get({ url: '/billing/payment-methods', ...options });
|
|
665
634
|
}
|
|
666
635
|
/**
|
|
667
|
-
*
|
|
636
|
+
* Set the default payment method.
|
|
668
637
|
*
|
|
669
|
-
*
|
|
638
|
+
* Sets the given payment method as the default used for invoices and active subscriptions. Requires the Administrator role.
|
|
670
639
|
*
|
|
671
640
|
*/
|
|
672
|
-
static
|
|
673
|
-
return (options.client ?? client).
|
|
674
|
-
url: '/users',
|
|
675
|
-
...options,
|
|
676
|
-
headers: {
|
|
677
|
-
'Content-Type': 'application/json',
|
|
678
|
-
...options.headers
|
|
679
|
-
}
|
|
680
|
-
});
|
|
641
|
+
static setDefaultPaymentMethod(options) {
|
|
642
|
+
return (options.client ?? client).put({ url: '/billing/payment-methods/{paymentMethodId}/default', ...options });
|
|
681
643
|
}
|
|
682
644
|
/**
|
|
683
|
-
* Delete
|
|
645
|
+
* Delete a payment method.
|
|
684
646
|
*
|
|
685
|
-
*
|
|
647
|
+
* 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.
|
|
686
648
|
*
|
|
687
649
|
*/
|
|
688
|
-
static
|
|
689
|
-
return (options.client ?? client).delete({
|
|
690
|
-
url: '/users/{user_id}',
|
|
691
|
-
...options
|
|
692
|
-
});
|
|
650
|
+
static deletePaymentMethod(options) {
|
|
651
|
+
return (options.client ?? client).delete({ url: '/billing/payment-methods/{paymentMethodId}', ...options });
|
|
693
652
|
}
|
|
694
653
|
/**
|
|
695
|
-
*
|
|
654
|
+
* List issued invoices.
|
|
696
655
|
*
|
|
697
|
-
* Returns
|
|
656
|
+
* 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.
|
|
698
657
|
*
|
|
699
|
-
|
|
658
|
+
*/
|
|
659
|
+
static listInvoices(options) {
|
|
660
|
+
return (options?.client ?? client).get({ url: '/billing/invoices', ...options });
|
|
661
|
+
}
|
|
662
|
+
/**
|
|
663
|
+
* Pay the organization's open invoices.
|
|
664
|
+
*
|
|
665
|
+
* Charges all open invoices of the organization against its default payment method. This endpoint is available to administrators of the organization only.
|
|
700
666
|
*
|
|
701
667
|
*/
|
|
702
|
-
static
|
|
703
|
-
return (options
|
|
704
|
-
url: '/users/{user_id}',
|
|
705
|
-
...options
|
|
706
|
-
});
|
|
668
|
+
static payOpenInvoices(options) {
|
|
669
|
+
return (options?.client ?? client).post({ url: '/billing/invoices/pay', ...options });
|
|
707
670
|
}
|
|
708
671
|
/**
|
|
709
|
-
*
|
|
672
|
+
* Get organization contact and billing address information.
|
|
710
673
|
*
|
|
711
|
-
*
|
|
674
|
+
* Returns the organization contact and billing address information. This endpoint is available to all users in the organization.
|
|
712
675
|
*
|
|
713
676
|
*/
|
|
714
|
-
static
|
|
677
|
+
static getContact(options) {
|
|
678
|
+
return (options?.client ?? client).get({ url: '/billing/contact', ...options });
|
|
679
|
+
}
|
|
680
|
+
/**
|
|
681
|
+
* Update organization contact information and billing address.
|
|
682
|
+
*
|
|
683
|
+
* This endpoint allows you to update organization details with its contact information. This endpoint is available to administrators of the organization only.
|
|
684
|
+
*
|
|
685
|
+
*/
|
|
686
|
+
static updateContact(options) {
|
|
715
687
|
return (options.client ?? client).put({
|
|
716
|
-
url: '/
|
|
688
|
+
url: '/billing/contact',
|
|
689
|
+
...options,
|
|
690
|
+
headers: {
|
|
691
|
+
'Content-Type': 'application/json',
|
|
692
|
+
...options.headers
|
|
693
|
+
}
|
|
694
|
+
});
|
|
695
|
+
}
|
|
696
|
+
/**
|
|
697
|
+
* Get applied promotional credits
|
|
698
|
+
*
|
|
699
|
+
* 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.
|
|
700
|
+
*
|
|
701
|
+
*/
|
|
702
|
+
static getCredits(options) {
|
|
703
|
+
return (options?.client ?? client).get({ url: '/billing/credits', ...options });
|
|
704
|
+
}
|
|
705
|
+
/**
|
|
706
|
+
* Redeem promotional credits code.
|
|
707
|
+
*
|
|
708
|
+
* 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.
|
|
709
|
+
*
|
|
710
|
+
*/
|
|
711
|
+
static redeemCredits(options) {
|
|
712
|
+
return (options.client ?? client).post({
|
|
713
|
+
url: '/billing/credits',
|
|
717
714
|
...options,
|
|
718
715
|
headers: {
|
|
719
716
|
'Content-Type': 'application/json',
|