@cloudfleet/sdk 0.0.1-2791829 → 0.0.1-2854ca2
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 +1199 -0
- package/dist/@tanstack/react-query.gen.d.ts.map +1 -0
- package/dist/@tanstack/react-query.gen.js +1215 -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 +1471 -227
- package/dist/schemas.gen.d.ts.map +1 -1
- package/dist/schemas.gen.js +2877 -326
- package/dist/schemas.gen.js.map +1 -1
- package/dist/sdk.gen.d.ts +282 -166
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/sdk.gen.js +399 -315
- package/dist/sdk.gen.js.map +1 -1
- package/dist/services/kubernetes/api.d.ts +8 -8
- package/dist/types.gen.d.ts +1839 -601
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/zod.gen.d.ts +3550 -1367
- package/dist/zod.gen.d.ts.map +1 -1
- package/dist/zod.gen.js +1457 -573
- 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. 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
|
-
*
|
|
216
|
+
* List repositories
|
|
236
217
|
*
|
|
237
|
-
* Returns
|
|
238
|
-
*
|
|
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',
|
|
@@ -311,44 +278,42 @@ export class ClustersService {
|
|
|
311
278
|
});
|
|
312
279
|
}
|
|
313
280
|
/**
|
|
314
|
-
*
|
|
281
|
+
* Get the organization's consent status for the new Basic price.
|
|
315
282
|
*
|
|
316
|
-
*
|
|
283
|
+
* Returns the organization's consent status for the migration from the free tier to the paid Basic plan. `pending` means an administrator must opt in; `not_applicable` means the organization is not in scope for the migration; `accepted` / `rejected` reflect a recorded decision.
|
|
317
284
|
*
|
|
318
|
-
* This endpoint is available to
|
|
285
|
+
* This endpoint is available to all users in the organization and drives the consent dialog in the console.
|
|
319
286
|
*
|
|
320
287
|
*/
|
|
321
|
-
static
|
|
322
|
-
return (options
|
|
323
|
-
url: '/clusters/{cluster_id}',
|
|
324
|
-
...options
|
|
325
|
-
});
|
|
288
|
+
static getBasicPriceConsent(options) {
|
|
289
|
+
return (options?.client ?? client).get({ url: '/organization/basic-price-consent', ...options });
|
|
326
290
|
}
|
|
327
291
|
/**
|
|
328
|
-
*
|
|
292
|
+
* Record an administrator's decision on the new Basic price.
|
|
329
293
|
*
|
|
330
|
-
*
|
|
331
|
-
*
|
|
332
|
-
* This endpoint is available to all users in the organization.
|
|
294
|
+
* Records an affirmative decision to continue on the paid Basic plan (`accepted`) or to opt out (`rejected`). This is an organization-binding financial decision, so it is restricted to administrators. Each call appends an immutable audit entry (who and when) and sends a confirmation email to the acting administrator.
|
|
333
295
|
*
|
|
334
296
|
*/
|
|
335
|
-
static
|
|
336
|
-
return (options.client ?? client).
|
|
337
|
-
url: '/
|
|
338
|
-
...options
|
|
297
|
+
static setBasicPriceConsent(options) {
|
|
298
|
+
return (options.client ?? client).post({
|
|
299
|
+
url: '/organization/basic-price-consent',
|
|
300
|
+
...options,
|
|
301
|
+
headers: {
|
|
302
|
+
'Content-Type': 'application/json',
|
|
303
|
+
...options.headers
|
|
304
|
+
}
|
|
339
305
|
});
|
|
340
306
|
}
|
|
307
|
+
}
|
|
308
|
+
export class McpService {
|
|
341
309
|
/**
|
|
342
|
-
*
|
|
343
|
-
*
|
|
344
|
-
* 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.
|
|
345
|
-
*
|
|
346
|
-
* This endpoint is available to administrators of the organization only.
|
|
310
|
+
* MCP endpoint
|
|
347
311
|
*
|
|
312
|
+
* MCP endpoint for handling Model Context Protocol JSON-RPC 2.0 messages.
|
|
348
313
|
*/
|
|
349
|
-
static
|
|
350
|
-
return (options.client ?? client).
|
|
351
|
-
url: '/
|
|
314
|
+
static postMcp(options) {
|
|
315
|
+
return (options.client ?? client).post({
|
|
316
|
+
url: '/mcp',
|
|
352
317
|
...options,
|
|
353
318
|
headers: {
|
|
354
319
|
'Content-Type': 'application/json',
|
|
@@ -356,31 +321,42 @@ export class ClustersService {
|
|
|
356
321
|
}
|
|
357
322
|
});
|
|
358
323
|
}
|
|
324
|
+
}
|
|
325
|
+
export class ChartsMarketplaceService {
|
|
359
326
|
/**
|
|
360
|
-
*
|
|
327
|
+
* List chart listings available in the marketplace.
|
|
361
328
|
*
|
|
362
|
-
* Returns
|
|
329
|
+
* Returns a list of available charts in the marketplace.
|
|
330
|
+
*
|
|
331
|
+
* This endpoint is available to all users in the organization.
|
|
363
332
|
*
|
|
364
333
|
*/
|
|
365
|
-
static
|
|
366
|
-
return (options
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
334
|
+
static listMarketplaceCharts(options) {
|
|
335
|
+
return (options?.client ?? client).get({ url: '/marketplace', ...options });
|
|
336
|
+
}
|
|
337
|
+
/**
|
|
338
|
+
* Get chart files for a specific version channel.
|
|
339
|
+
*
|
|
340
|
+
* Returns the Chart.yaml, values.yaml, and values.schema.json files for the latest version matching the specified version channel.
|
|
341
|
+
*
|
|
342
|
+
* 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.
|
|
343
|
+
*
|
|
344
|
+
* This endpoint is available to all users in the organization.
|
|
345
|
+
*
|
|
346
|
+
*/
|
|
347
|
+
static getMarketplaceChartFiles(options) {
|
|
348
|
+
return (options.client ?? client).get({ url: '/marketplace/{chart_name}/files/{version_channel}', ...options });
|
|
370
349
|
}
|
|
371
350
|
}
|
|
372
351
|
export class InvitesService {
|
|
373
352
|
/**
|
|
374
353
|
* List invites.
|
|
375
354
|
*
|
|
376
|
-
* Returns a list of invites under the current organization. This endpoint is available to
|
|
355
|
+
* Returns a list of pending (non-expired) invites under the current organization. This endpoint is available to administrators of the organization only.
|
|
377
356
|
*
|
|
378
357
|
*/
|
|
379
358
|
static listInvites(options) {
|
|
380
|
-
return (options?.client ?? client).get({
|
|
381
|
-
url: '/invites',
|
|
382
|
-
...options
|
|
383
|
-
});
|
|
359
|
+
return (options?.client ?? client).get({ url: '/invites', ...options });
|
|
384
360
|
}
|
|
385
361
|
/**
|
|
386
362
|
* Create a new invite.
|
|
@@ -401,14 +377,11 @@ export class InvitesService {
|
|
|
401
377
|
/**
|
|
402
378
|
* Get invite information.
|
|
403
379
|
*
|
|
404
|
-
*
|
|
380
|
+
* 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
381
|
*
|
|
406
382
|
*/
|
|
407
383
|
static getInvite(options) {
|
|
408
|
-
return (options.client ?? client).get({
|
|
409
|
-
url: '/invites/{code}',
|
|
410
|
-
...options
|
|
411
|
-
});
|
|
384
|
+
return (options.client ?? client).get({ url: '/invites/{code}', ...options });
|
|
412
385
|
}
|
|
413
386
|
/**
|
|
414
387
|
* Permanently delete invite.
|
|
@@ -417,66 +390,88 @@ export class InvitesService {
|
|
|
417
390
|
*
|
|
418
391
|
*/
|
|
419
392
|
static deleteInvite(options) {
|
|
420
|
-
return (options.client ?? client).delete({
|
|
421
|
-
url: '/invites/{email}',
|
|
422
|
-
...options
|
|
423
|
-
});
|
|
393
|
+
return (options.client ?? client).delete({ url: '/invites/{email}', ...options });
|
|
424
394
|
}
|
|
425
395
|
}
|
|
426
|
-
export class
|
|
396
|
+
export class ClustersService {
|
|
427
397
|
/**
|
|
428
|
-
*
|
|
398
|
+
* Query Kubernetes cluster API
|
|
429
399
|
*
|
|
430
|
-
*
|
|
400
|
+
* 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.
|
|
401
|
+
*/
|
|
402
|
+
static queryCluster(options) {
|
|
403
|
+
return (options.client ?? client).get({ url: '/clusters/{cluster_id}/query', ...options });
|
|
404
|
+
}
|
|
405
|
+
/**
|
|
406
|
+
* List fleets.
|
|
407
|
+
*
|
|
408
|
+
* Returns a list of fleets belonging to the cluster. For more information, see [Fleets](https://cloudfleet.ai/docs/cloud-infrastructure/fleets/) section of documentaiton.
|
|
431
409
|
*
|
|
432
410
|
* This endpoint is available to all users in the organization.
|
|
433
411
|
*
|
|
434
412
|
*/
|
|
435
|
-
static
|
|
436
|
-
return (options
|
|
437
|
-
url: '/marketplace',
|
|
438
|
-
...options
|
|
439
|
-
});
|
|
413
|
+
static listFleets(options) {
|
|
414
|
+
return (options.client ?? client).get({ url: '/clusters/{cluster_id}/fleets', ...options });
|
|
440
415
|
}
|
|
441
416
|
/**
|
|
442
|
-
*
|
|
417
|
+
* Create a new fleet.
|
|
443
418
|
*
|
|
444
|
-
*
|
|
419
|
+
* 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.
|
|
445
420
|
*
|
|
446
|
-
*
|
|
421
|
+
* The cluster must be ready (status `deployed`) before a fleet can be added. Adding a fleet while the cluster is still provisioning returns `409`.
|
|
422
|
+
*
|
|
423
|
+
* This endpoint is available to administrators of the organization only.
|
|
447
424
|
*
|
|
448
425
|
*/
|
|
449
|
-
static
|
|
450
|
-
return (options.client ?? client).
|
|
451
|
-
url: '/
|
|
452
|
-
...options
|
|
426
|
+
static createFleet(options) {
|
|
427
|
+
return (options.client ?? client).post({
|
|
428
|
+
url: '/clusters/{cluster_id}/fleets',
|
|
429
|
+
...options,
|
|
430
|
+
headers: {
|
|
431
|
+
'Content-Type': 'application/json',
|
|
432
|
+
...options.headers
|
|
433
|
+
}
|
|
453
434
|
});
|
|
454
435
|
}
|
|
455
|
-
}
|
|
456
|
-
export class OrganizationService {
|
|
457
436
|
/**
|
|
458
|
-
*
|
|
437
|
+
* Permanently delete fleet.
|
|
459
438
|
*
|
|
460
|
-
*
|
|
439
|
+
* 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.
|
|
440
|
+
*
|
|
441
|
+
* 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.
|
|
442
|
+
*
|
|
443
|
+
* This endpoint is available to administrators of the organization only.
|
|
444
|
+
*
|
|
445
|
+
*/
|
|
446
|
+
static deleteFleet(options) {
|
|
447
|
+
return (options.client ?? client).delete({ url: '/clusters/{cluster_id}/fleets/{fleet_name}', ...options });
|
|
448
|
+
}
|
|
449
|
+
/**
|
|
450
|
+
* Get fleet information.
|
|
451
|
+
*
|
|
452
|
+
* Returns fleet details. For more information, see [Fleets](https://cloudfleet.ai/docs/cloud-infrastructure/fleets/) section of documentaiton.
|
|
461
453
|
*
|
|
462
454
|
* This endpoint is available to all users in the organization.
|
|
463
455
|
*
|
|
464
456
|
*/
|
|
465
|
-
static
|
|
466
|
-
return (options
|
|
467
|
-
url: '/organization',
|
|
468
|
-
...options
|
|
469
|
-
});
|
|
457
|
+
static getFleet(options) {
|
|
458
|
+
return (options.client ?? client).get({ url: '/clusters/{cluster_id}/fleets/{fleet_name}', ...options });
|
|
470
459
|
}
|
|
471
460
|
/**
|
|
472
|
-
*
|
|
461
|
+
* Update fleet information.
|
|
473
462
|
*
|
|
474
|
-
* This endpoint allows you to
|
|
463
|
+
* This endpoint allows you to update fleet details.
|
|
464
|
+
*
|
|
465
|
+
* For more information, see [Fleets](https://cloudfleet.ai/docs/cloud-infrastructure/fleets/) section of documentaiton.
|
|
466
|
+
*
|
|
467
|
+
* 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).
|
|
468
|
+
*
|
|
469
|
+
* This endpoint is available to administrators of the organization only.
|
|
475
470
|
*
|
|
476
471
|
*/
|
|
477
|
-
static
|
|
478
|
-
return (options.client ?? client).
|
|
479
|
-
url: '/
|
|
472
|
+
static updateFleet(options) {
|
|
473
|
+
return (options.client ?? client).put({
|
|
474
|
+
url: '/clusters/{cluster_id}/fleets/{fleet_name}',
|
|
480
475
|
...options,
|
|
481
476
|
headers: {
|
|
482
477
|
'Content-Type': 'application/json',
|
|
@@ -484,31 +479,28 @@ export class OrganizationService {
|
|
|
484
479
|
}
|
|
485
480
|
});
|
|
486
481
|
}
|
|
487
|
-
}
|
|
488
|
-
export class TokensService {
|
|
489
482
|
/**
|
|
490
|
-
* List
|
|
483
|
+
* List charts.
|
|
491
484
|
*
|
|
492
|
-
*
|
|
485
|
+
* Returns a list of charts in the cluster.
|
|
486
|
+
*
|
|
487
|
+
* This endpoint is available to all users in the organization.
|
|
493
488
|
*
|
|
494
489
|
*/
|
|
495
|
-
static
|
|
496
|
-
return (options
|
|
497
|
-
url: '/tokens',
|
|
498
|
-
...options
|
|
499
|
-
});
|
|
490
|
+
static listCharts(options) {
|
|
491
|
+
return (options.client ?? client).get({ url: '/clusters/{cluster_id}/charts', ...options });
|
|
500
492
|
}
|
|
501
493
|
/**
|
|
502
|
-
* Create a new
|
|
494
|
+
* Create a new chart.
|
|
503
495
|
*
|
|
504
|
-
*
|
|
496
|
+
* Create a new chart deployment.
|
|
505
497
|
*
|
|
506
498
|
* This endpoint is available to administrators of the organization only.
|
|
507
499
|
*
|
|
508
500
|
*/
|
|
509
|
-
static
|
|
501
|
+
static createChart(options) {
|
|
510
502
|
return (options.client ?? client).post({
|
|
511
|
-
url: '/
|
|
503
|
+
url: '/clusters/{cluster_id}/charts',
|
|
512
504
|
...options,
|
|
513
505
|
headers: {
|
|
514
506
|
'Content-Type': 'application/json',
|
|
@@ -517,40 +509,38 @@ export class TokensService {
|
|
|
517
509
|
});
|
|
518
510
|
}
|
|
519
511
|
/**
|
|
520
|
-
* Permanently delete
|
|
512
|
+
* Permanently delete the chart deployment from the cluster.
|
|
521
513
|
*
|
|
522
|
-
* This endpoint
|
|
514
|
+
* This endpoint will permanently delete chart. This operation cannot be undone.
|
|
515
|
+
*
|
|
516
|
+
* This endpoint is available to administrators of the organization only.
|
|
523
517
|
*
|
|
524
518
|
*/
|
|
525
|
-
static
|
|
526
|
-
return (options.client ?? client).delete({
|
|
527
|
-
url: '/tokens/{token_id}',
|
|
528
|
-
...options
|
|
529
|
-
});
|
|
519
|
+
static deleteChart(options) {
|
|
520
|
+
return (options.client ?? client).delete({ url: '/clusters/{cluster_id}/charts/{chart_name}', ...options });
|
|
530
521
|
}
|
|
531
522
|
/**
|
|
532
|
-
* Get
|
|
523
|
+
* Get chart information.
|
|
533
524
|
*
|
|
534
|
-
*
|
|
525
|
+
* Returns the details of the chart deployment.
|
|
526
|
+
*
|
|
527
|
+
* This endpoint is available to all users in the organization.
|
|
535
528
|
*
|
|
536
529
|
*/
|
|
537
|
-
static
|
|
538
|
-
return (options.client ?? client).get({
|
|
539
|
-
url: '/tokens/{token_id}',
|
|
540
|
-
...options
|
|
541
|
-
});
|
|
530
|
+
static getChart(options) {
|
|
531
|
+
return (options.client ?? client).get({ url: '/clusters/{cluster_id}/charts/{chart_name}', ...options });
|
|
542
532
|
}
|
|
543
533
|
/**
|
|
544
|
-
* Update
|
|
534
|
+
* Update chart information.
|
|
545
535
|
*
|
|
546
|
-
* This endpoint allows you to update
|
|
536
|
+
* This endpoint allows you to update the values of a chart deployment.
|
|
547
537
|
*
|
|
548
538
|
* This endpoint is available to administrators of the organization only.
|
|
549
539
|
*
|
|
550
540
|
*/
|
|
551
|
-
static
|
|
541
|
+
static updateChart(options) {
|
|
552
542
|
return (options.client ?? client).put({
|
|
553
|
-
url: '/
|
|
543
|
+
url: '/clusters/{cluster_id}/charts/{chart_name}',
|
|
554
544
|
...options,
|
|
555
545
|
headers: {
|
|
556
546
|
'Content-Type': 'application/json',
|
|
@@ -559,50 +549,71 @@ export class TokensService {
|
|
|
559
549
|
});
|
|
560
550
|
}
|
|
561
551
|
/**
|
|
562
|
-
*
|
|
552
|
+
* List clusters.
|
|
553
|
+
*
|
|
554
|
+
* Returns a list of clusters under the current organization.
|
|
555
|
+
*
|
|
556
|
+
* This endpoint is available to all users in the organization.
|
|
563
557
|
*
|
|
564
|
-
* Generates a new access token secret. Old secret will not be valid anymore.
|
|
565
558
|
*/
|
|
566
|
-
static
|
|
567
|
-
return (options
|
|
568
|
-
url: '/tokens/{token_id}/secret',
|
|
569
|
-
...options
|
|
570
|
-
});
|
|
559
|
+
static listClusters(options) {
|
|
560
|
+
return (options?.client ?? client).get({ url: '/clusters', ...options });
|
|
571
561
|
}
|
|
572
|
-
}
|
|
573
|
-
export class UsersService {
|
|
574
562
|
/**
|
|
575
|
-
*
|
|
563
|
+
* Create a new cluster.
|
|
564
|
+
*
|
|
565
|
+
* 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.
|
|
566
|
+
*
|
|
567
|
+
* This endpoint is available to administrators of the organization only.
|
|
568
|
+
*
|
|
576
569
|
*/
|
|
577
|
-
static
|
|
578
|
-
return (options.client ?? client).
|
|
579
|
-
url: '/
|
|
580
|
-
...options
|
|
570
|
+
static createCluster(options) {
|
|
571
|
+
return (options.client ?? client).post({
|
|
572
|
+
url: '/clusters',
|
|
573
|
+
...options,
|
|
574
|
+
headers: {
|
|
575
|
+
'Content-Type': 'application/json',
|
|
576
|
+
...options.headers
|
|
577
|
+
}
|
|
581
578
|
});
|
|
582
579
|
}
|
|
583
580
|
/**
|
|
584
|
-
*
|
|
581
|
+
* Permanently delete cluster.
|
|
585
582
|
*
|
|
586
|
-
*
|
|
583
|
+
* This endpoint will permanently delete the cluster. This operation cannot be undone.
|
|
584
|
+
*
|
|
585
|
+
* 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.
|
|
586
|
+
*
|
|
587
|
+
* This endpoint is available to administrators of the organization only.
|
|
588
|
+
*
|
|
589
|
+
*/
|
|
590
|
+
static deleteCluster(options) {
|
|
591
|
+
return (options.client ?? client).delete({ url: '/clusters/{cluster_id}', ...options });
|
|
592
|
+
}
|
|
593
|
+
/**
|
|
594
|
+
* Get cluster information.
|
|
595
|
+
*
|
|
596
|
+
* Returns cluster details.
|
|
587
597
|
*
|
|
588
598
|
* This endpoint is available to all users in the organization.
|
|
589
599
|
*
|
|
590
600
|
*/
|
|
591
|
-
static
|
|
592
|
-
return (options
|
|
593
|
-
url: '/users',
|
|
594
|
-
...options
|
|
595
|
-
});
|
|
601
|
+
static getCluster(options) {
|
|
602
|
+
return (options.client ?? client).get({ url: '/clusters/{cluster_id}', ...options });
|
|
596
603
|
}
|
|
597
604
|
/**
|
|
598
|
-
*
|
|
605
|
+
* Update cluster information.
|
|
599
606
|
*
|
|
600
|
-
*
|
|
607
|
+
* 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.
|
|
608
|
+
*
|
|
609
|
+
* This is a full overwrite: any field omitted from the request is reset to its default rather than left unchanged.
|
|
610
|
+
*
|
|
611
|
+
* This endpoint is available to administrators of the organization only.
|
|
601
612
|
*
|
|
602
613
|
*/
|
|
603
|
-
static
|
|
604
|
-
return (options.client ?? client).
|
|
605
|
-
url: '/
|
|
614
|
+
static updateCluster(options) {
|
|
615
|
+
return (options.client ?? client).put({
|
|
616
|
+
url: '/clusters/{cluster_id}',
|
|
606
617
|
...options,
|
|
607
618
|
headers: {
|
|
608
619
|
'Content-Type': 'application/json',
|
|
@@ -611,40 +622,113 @@ export class UsersService {
|
|
|
611
622
|
});
|
|
612
623
|
}
|
|
613
624
|
/**
|
|
614
|
-
*
|
|
625
|
+
* Node join information for the cluster
|
|
615
626
|
*
|
|
616
|
-
*
|
|
627
|
+
* 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.
|
|
617
628
|
*
|
|
618
629
|
*/
|
|
619
|
-
static
|
|
620
|
-
return (options.client ?? client).
|
|
621
|
-
url: '/users/{user_id}',
|
|
622
|
-
...options
|
|
623
|
-
});
|
|
630
|
+
static getJoinInformation(options) {
|
|
631
|
+
return (options.client ?? client).post({ url: '/clusters/{cluster_id}/join_information', ...options });
|
|
624
632
|
}
|
|
633
|
+
}
|
|
634
|
+
export class BillingService {
|
|
625
635
|
/**
|
|
626
|
-
* Get
|
|
636
|
+
* Get billing usage information.
|
|
627
637
|
*
|
|
628
|
-
* Returns
|
|
638
|
+
* 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.
|
|
629
639
|
*
|
|
630
|
-
|
|
640
|
+
*/
|
|
641
|
+
static getUsage(options) {
|
|
642
|
+
return (options?.client ?? client).get({ url: '/billing/usage', ...options });
|
|
643
|
+
}
|
|
644
|
+
/**
|
|
645
|
+
* Get Stripe client secret.
|
|
646
|
+
*
|
|
647
|
+
* 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.
|
|
631
648
|
*
|
|
632
649
|
*/
|
|
633
|
-
static
|
|
634
|
-
return (options
|
|
635
|
-
url: '/users/{user_id}',
|
|
636
|
-
...options
|
|
637
|
-
});
|
|
650
|
+
static getPaymentMethodSecret(options) {
|
|
651
|
+
return (options?.client ?? client).put({ url: '/billing/payment-method', ...options });
|
|
638
652
|
}
|
|
639
653
|
/**
|
|
640
|
-
*
|
|
654
|
+
* List organization payment methods.
|
|
641
655
|
*
|
|
642
|
-
*
|
|
656
|
+
* 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.
|
|
643
657
|
*
|
|
644
658
|
*/
|
|
645
|
-
static
|
|
659
|
+
static listPaymentMethods(options) {
|
|
660
|
+
return (options?.client ?? client).get({ url: '/billing/payment-methods', ...options });
|
|
661
|
+
}
|
|
662
|
+
/**
|
|
663
|
+
* Set the default payment method.
|
|
664
|
+
*
|
|
665
|
+
* Sets the given payment method as the default used for invoices and active subscriptions. Requires the Administrator role.
|
|
666
|
+
*
|
|
667
|
+
*/
|
|
668
|
+
static setDefaultPaymentMethod(options) {
|
|
669
|
+
return (options.client ?? client).put({ url: '/billing/payment-methods/{paymentMethodId}/default', ...options });
|
|
670
|
+
}
|
|
671
|
+
/**
|
|
672
|
+
* Delete a payment method.
|
|
673
|
+
*
|
|
674
|
+
* 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.
|
|
675
|
+
*
|
|
676
|
+
*/
|
|
677
|
+
static deletePaymentMethod(options) {
|
|
678
|
+
return (options.client ?? client).delete({ url: '/billing/payment-methods/{paymentMethodId}', ...options });
|
|
679
|
+
}
|
|
680
|
+
/**
|
|
681
|
+
* List issued invoices.
|
|
682
|
+
*
|
|
683
|
+
* 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.
|
|
684
|
+
*
|
|
685
|
+
*/
|
|
686
|
+
static listInvoices(options) {
|
|
687
|
+
return (options?.client ?? client).get({ url: '/billing/invoices', ...options });
|
|
688
|
+
}
|
|
689
|
+
/**
|
|
690
|
+
* Get organization contact and billing address information.
|
|
691
|
+
*
|
|
692
|
+
* Returns the organization contact and billing address information. This endpoint is available to all users in the organization.
|
|
693
|
+
*
|
|
694
|
+
*/
|
|
695
|
+
static getContact(options) {
|
|
696
|
+
return (options?.client ?? client).get({ url: '/billing/contact', ...options });
|
|
697
|
+
}
|
|
698
|
+
/**
|
|
699
|
+
* Update organization contact information and billing address.
|
|
700
|
+
*
|
|
701
|
+
* This endpoint allows you to update organization details with its contact information. This endpoint is available to administrators of the organization only.
|
|
702
|
+
*
|
|
703
|
+
*/
|
|
704
|
+
static updateContact(options) {
|
|
646
705
|
return (options.client ?? client).put({
|
|
647
|
-
url: '/
|
|
706
|
+
url: '/billing/contact',
|
|
707
|
+
...options,
|
|
708
|
+
headers: {
|
|
709
|
+
'Content-Type': 'application/json',
|
|
710
|
+
...options.headers
|
|
711
|
+
}
|
|
712
|
+
});
|
|
713
|
+
}
|
|
714
|
+
/**
|
|
715
|
+
* Get applied promotional credits
|
|
716
|
+
*
|
|
717
|
+
* 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.
|
|
718
|
+
*
|
|
719
|
+
*/
|
|
720
|
+
static getCredits(options) {
|
|
721
|
+
return (options?.client ?? client).get({ url: '/billing/credits', ...options });
|
|
722
|
+
}
|
|
723
|
+
/**
|
|
724
|
+
* Redeem promotional credits code.
|
|
725
|
+
*
|
|
726
|
+
* 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.
|
|
727
|
+
*
|
|
728
|
+
*/
|
|
729
|
+
static redeemCredits(options) {
|
|
730
|
+
return (options.client ?? client).post({
|
|
731
|
+
url: '/billing/credits',
|
|
648
732
|
...options,
|
|
649
733
|
headers: {
|
|
650
734
|
'Content-Type': 'application/json',
|