@cloudfleet/sdk 0.0.1-bbb5ebb → 0.0.1-bc3dfb7
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 +3 -0
- package/dist/client/client.gen.d.ts.map +1 -0
- package/dist/client/client.gen.js +217 -0
- package/dist/client/client.gen.js.map +1 -0
- package/dist/client/index.d.ts +9 -0
- package/dist/client/index.d.ts.map +1 -0
- package/dist/client/index.js +7 -0
- package/dist/client/index.js.map +1 -0
- package/dist/client/types.gen.d.ts +121 -0
- package/dist/client/types.gen.d.ts.map +1 -0
- package/dist/client/types.gen.js +3 -0
- package/dist/client/types.gen.js.map +1 -0
- package/dist/client/utils.gen.d.ts +38 -0
- package/dist/client/utils.gen.d.ts.map +1 -0
- package/dist/client/utils.gen.js +229 -0
- package/dist/client/utils.gen.js.map +1 -0
- package/dist/client.gen.d.ts +4 -4
- package/dist/client.gen.d.ts.map +1 -1
- package/dist/client.gen.js +2 -4
- package/dist/client.gen.js.map +1 -1
- package/dist/core/auth.gen.d.ts +19 -0
- package/dist/core/auth.gen.d.ts.map +1 -0
- package/dist/core/auth.gen.js +15 -0
- package/dist/core/auth.gen.js.map +1 -0
- package/dist/core/bodySerializer.gen.d.ts +26 -0
- package/dist/core/bodySerializer.gen.d.ts.map +1 -0
- package/dist/core/bodySerializer.gen.js +58 -0
- package/dist/core/bodySerializer.gen.js.map +1 -0
- package/dist/core/params.gen.d.ts +44 -0
- package/dist/core/params.gen.d.ts.map +1 -0
- package/dist/core/params.gen.js +101 -0
- package/dist/core/params.gen.js.map +1 -0
- package/dist/core/pathSerializer.gen.d.ts +34 -0
- package/dist/core/pathSerializer.gen.d.ts.map +1 -0
- package/dist/core/pathSerializer.gen.js +107 -0
- package/dist/core/pathSerializer.gen.js.map +1 -0
- package/dist/core/queryKeySerializer.gen.d.ts +19 -0
- package/dist/core/queryKeySerializer.gen.d.ts.map +1 -0
- package/dist/core/queryKeySerializer.gen.js +93 -0
- package/dist/core/queryKeySerializer.gen.js.map +1 -0
- package/dist/core/serverSentEvents.gen.d.ts +72 -0
- package/dist/core/serverSentEvents.gen.d.ts.map +1 -0
- package/dist/core/serverSentEvents.gen.js +133 -0
- package/dist/core/serverSentEvents.gen.js.map +1 -0
- package/dist/core/types.gen.d.ts +79 -0
- package/dist/core/types.gen.d.ts.map +1 -0
- package/dist/core/types.gen.js +3 -0
- package/dist/core/types.gen.js.map +1 -0
- package/dist/core/utils.gen.d.ts +20 -0
- package/dist/core/utils.gen.d.ts.map +1 -0
- package/dist/core/utils.gen.js +88 -0
- package/dist/core/utils.gen.js.map +1 -0
- package/dist/schemas.gen.d.ts +1774 -594
- package/dist/schemas.gen.d.ts.map +1 -1
- package/dist/schemas.gen.js +3133 -666
- package/dist/schemas.gen.js.map +1 -1
- package/dist/sdk.gen.d.ts +346 -135
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/sdk.gen.js +492 -259
- package/dist/sdk.gen.js.map +1 -1
- package/dist/services/kubernetes/api.d.ts +20 -20
- package/dist/types.gen.d.ts +2044 -708
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/zod.gen.d.ts +3982 -1998
- package/dist/zod.gen.d.ts.map +1 -1
- package/dist/zod.gen.js +1713 -805
- package/dist/zod.gen.js.map +1 -1
- package/package.json +28 -9
package/dist/sdk.gen.js
CHANGED
|
@@ -1,505 +1,738 @@
|
|
|
1
1
|
// This file is auto-generated by @hey-api/openapi-ts
|
|
2
|
-
import {
|
|
3
|
-
|
|
2
|
+
import { formDataBodySerializer } from './client';
|
|
3
|
+
import { client } from './client.gen';
|
|
4
|
+
export class UsersService {
|
|
4
5
|
/**
|
|
5
|
-
* Get
|
|
6
|
-
* 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.
|
|
7
|
-
*
|
|
6
|
+
* Get a list of organizations the user belongs to. Used during authentication process.
|
|
8
7
|
*/
|
|
9
|
-
static
|
|
10
|
-
return (options
|
|
11
|
-
url: '/billing/usage',
|
|
12
|
-
...options
|
|
13
|
-
});
|
|
8
|
+
static listUserOrganizations(options) {
|
|
9
|
+
return (options.client ?? client).get({ url: '/users/organizations/{email}', ...options });
|
|
14
10
|
}
|
|
15
11
|
/**
|
|
16
|
-
*
|
|
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.
|
|
15
|
+
*
|
|
16
|
+
* This endpoint is available to all users in the organization.
|
|
18
17
|
*
|
|
19
18
|
*/
|
|
20
|
-
static
|
|
21
|
-
return (options?.client ??
|
|
22
|
-
url: '/billing/balance',
|
|
23
|
-
...options
|
|
24
|
-
});
|
|
19
|
+
static listUsers(options) {
|
|
20
|
+
return (options?.client ?? client).get({ url: '/users', ...options });
|
|
25
21
|
}
|
|
26
22
|
/**
|
|
27
|
-
*
|
|
28
|
-
*
|
|
23
|
+
* Create a new user.
|
|
24
|
+
*
|
|
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.
|
|
29
26
|
*
|
|
30
27
|
*/
|
|
31
|
-
static
|
|
32
|
-
return (options
|
|
33
|
-
url: '/
|
|
34
|
-
...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
|
+
}
|
|
35
36
|
});
|
|
36
37
|
}
|
|
37
38
|
/**
|
|
38
|
-
*
|
|
39
|
-
*
|
|
39
|
+
* Delete user by id.
|
|
40
|
+
*
|
|
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.
|
|
40
42
|
*
|
|
41
43
|
*/
|
|
42
|
-
static
|
|
43
|
-
return (options
|
|
44
|
-
url: '/billing/payment-method',
|
|
45
|
-
...options
|
|
46
|
-
});
|
|
44
|
+
static deleteUser(options) {
|
|
45
|
+
return (options.client ?? client).delete({ url: '/users/{user_id}', ...options });
|
|
47
46
|
}
|
|
48
47
|
/**
|
|
49
|
-
*
|
|
50
|
-
*
|
|
48
|
+
* Get user profile information by id.
|
|
49
|
+
*
|
|
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.
|
|
51
53
|
*
|
|
52
54
|
*/
|
|
53
|
-
static
|
|
54
|
-
return (options.client ??
|
|
55
|
-
url: '/billing/invoices',
|
|
56
|
-
...options
|
|
57
|
-
});
|
|
55
|
+
static getUser(options) {
|
|
56
|
+
return (options.client ?? client).get({ url: '/users/{user_id}', ...options });
|
|
58
57
|
}
|
|
59
58
|
/**
|
|
60
|
-
*
|
|
61
|
-
*
|
|
59
|
+
* Update user profile information.
|
|
60
|
+
*
|
|
61
|
+
* Update user profile information: email, first name, last name, role. This endpoint can be accessed by administrators and the user itself. Role and status can be changed by administrators only.
|
|
62
62
|
*
|
|
63
63
|
*/
|
|
64
|
-
static
|
|
65
|
-
return (options.client ??
|
|
66
|
-
url: '/
|
|
67
|
-
...options
|
|
64
|
+
static updateUser(options) {
|
|
65
|
+
return (options.client ?? client).put({
|
|
66
|
+
url: '/users/{user_id}',
|
|
67
|
+
...options,
|
|
68
|
+
headers: {
|
|
69
|
+
'Content-Type': 'application/json',
|
|
70
|
+
...options.headers
|
|
71
|
+
}
|
|
68
72
|
});
|
|
69
73
|
}
|
|
74
|
+
}
|
|
75
|
+
export class TokensService {
|
|
70
76
|
/**
|
|
71
|
-
*
|
|
72
|
-
*
|
|
77
|
+
* List access tokens in organization.
|
|
78
|
+
*
|
|
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.
|
|
73
80
|
*
|
|
74
81
|
*/
|
|
75
|
-
static
|
|
76
|
-
return (options?.client ??
|
|
77
|
-
url: '/billing/contact',
|
|
78
|
-
...options
|
|
79
|
-
});
|
|
82
|
+
static listTokens(options) {
|
|
83
|
+
return (options?.client ?? client).get({ url: '/tokens', ...options });
|
|
80
84
|
}
|
|
81
85
|
/**
|
|
82
|
-
*
|
|
83
|
-
*
|
|
86
|
+
* Create a new access token.
|
|
87
|
+
*
|
|
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.
|
|
84
91
|
*
|
|
85
92
|
*/
|
|
86
|
-
static
|
|
87
|
-
return (options.client ??
|
|
88
|
-
url: '/
|
|
93
|
+
static createToken(options) {
|
|
94
|
+
return (options.client ?? client).post({
|
|
95
|
+
url: '/tokens',
|
|
89
96
|
...options,
|
|
90
97
|
headers: {
|
|
91
98
|
'Content-Type': 'application/json',
|
|
92
|
-
...options
|
|
99
|
+
...options.headers
|
|
93
100
|
}
|
|
94
101
|
});
|
|
95
102
|
}
|
|
96
|
-
}
|
|
97
|
-
export class ClustersService {
|
|
98
103
|
/**
|
|
99
|
-
*
|
|
100
|
-
* Returns a list of fleets belonging to the cluster. For more information, see [Fleets and fleet types](https://cloudfleet.ai/docs/cloud-infrastructure/fleets-and-fleet-types/) section of documentaiton.
|
|
104
|
+
* Permanently delete access token.
|
|
101
105
|
*
|
|
102
|
-
* This endpoint is available to
|
|
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.
|
|
103
107
|
*
|
|
104
108
|
*/
|
|
105
|
-
static
|
|
106
|
-
return (options.client ??
|
|
107
|
-
url: '/clusters/{cluster_id}/fleets',
|
|
108
|
-
...options
|
|
109
|
-
});
|
|
109
|
+
static deleteToken(options) {
|
|
110
|
+
return (options.client ?? client).delete({ url: '/tokens/{token_id}', ...options });
|
|
110
111
|
}
|
|
111
112
|
/**
|
|
112
|
-
*
|
|
113
|
-
*
|
|
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
|
+
*
|
|
117
|
+
*/
|
|
118
|
+
static getToken(options) {
|
|
119
|
+
return (options.client ?? client).get({ url: '/tokens/{token_id}', ...options });
|
|
120
|
+
}
|
|
121
|
+
/**
|
|
122
|
+
* Update access token information.
|
|
123
|
+
*
|
|
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.
|
|
114
125
|
*
|
|
115
126
|
* This endpoint is available to administrators of the organization only.
|
|
116
127
|
*
|
|
117
128
|
*/
|
|
118
|
-
static
|
|
119
|
-
return (options.client ??
|
|
120
|
-
url: '/
|
|
129
|
+
static updateToken(options) {
|
|
130
|
+
return (options.client ?? client).put({
|
|
131
|
+
url: '/tokens/{token_id}',
|
|
121
132
|
...options,
|
|
122
133
|
headers: {
|
|
123
134
|
'Content-Type': 'application/json',
|
|
124
|
-
...options
|
|
135
|
+
...options.headers
|
|
125
136
|
}
|
|
126
137
|
});
|
|
127
138
|
}
|
|
128
139
|
/**
|
|
129
|
-
*
|
|
130
|
-
* 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 Connected Fleet until the end of the billing period, set the status to `cancelling`. For more information, see [Fleets and fleet types](https://cloudfleet.ai/docs/cloud-infrastructure/fleets-and-fleet-types/) section of documentaiton.
|
|
140
|
+
* Regenerate access token secret key.
|
|
131
141
|
*
|
|
132
|
-
*
|
|
142
|
+
* Generates a new access token secret. Old secret will not be valid anymore.
|
|
143
|
+
*/
|
|
144
|
+
static regenerateToken(options) {
|
|
145
|
+
return (options.client ?? client).put({ url: '/tokens/{token_id}/secret', ...options });
|
|
146
|
+
}
|
|
147
|
+
}
|
|
148
|
+
export class TicketsService {
|
|
149
|
+
/**
|
|
150
|
+
* List tickets for the current organization.
|
|
151
|
+
*
|
|
152
|
+
* Returns all tickets belonging to the caller's organization, newest first.
|
|
133
153
|
*
|
|
134
154
|
*/
|
|
135
|
-
static
|
|
136
|
-
return (options
|
|
137
|
-
url: '/clusters/{cluster_id}/fleets/{fleet_name}',
|
|
138
|
-
...options
|
|
139
|
-
});
|
|
155
|
+
static listTickets(options) {
|
|
156
|
+
return (options?.client ?? client).get({ url: '/tickets', ...options });
|
|
140
157
|
}
|
|
141
158
|
/**
|
|
142
|
-
*
|
|
143
|
-
* Returns fleet details. For more information, see [Fleets and fleet types](https://cloudfleet.ai/docs/cloud-infrastructure/fleets-and-fleet-types/) section of documentaiton.
|
|
159
|
+
* Create a new support ticket.
|
|
144
160
|
*
|
|
145
|
-
*
|
|
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).
|
|
146
162
|
*
|
|
147
163
|
*/
|
|
148
|
-
static
|
|
149
|
-
return (options.client ??
|
|
150
|
-
|
|
151
|
-
|
|
164
|
+
static createTicket(options) {
|
|
165
|
+
return (options.client ?? client).post({
|
|
166
|
+
...formDataBodySerializer,
|
|
167
|
+
url: '/tickets',
|
|
168
|
+
...options,
|
|
169
|
+
headers: {
|
|
170
|
+
'Content-Type': null,
|
|
171
|
+
...options.headers
|
|
172
|
+
}
|
|
152
173
|
});
|
|
153
174
|
}
|
|
154
175
|
/**
|
|
155
|
-
*
|
|
156
|
-
* This endpoint allows you to update fleet details.
|
|
176
|
+
* Close a ticket (soft close).
|
|
157
177
|
*
|
|
158
|
-
*
|
|
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.
|
|
159
179
|
*
|
|
160
|
-
|
|
180
|
+
*/
|
|
181
|
+
static closeTicket(options) {
|
|
182
|
+
return (options.client ?? client).delete({ url: '/tickets/{ticket_id}', ...options });
|
|
183
|
+
}
|
|
184
|
+
/**
|
|
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.
|
|
161
192
|
*
|
|
162
|
-
*
|
|
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.
|
|
163
194
|
*
|
|
164
195
|
*/
|
|
165
|
-
static
|
|
166
|
-
return (options.client ??
|
|
167
|
-
|
|
196
|
+
static replyTicket(options) {
|
|
197
|
+
return (options.client ?? client).post({
|
|
198
|
+
...formDataBodySerializer,
|
|
199
|
+
url: '/tickets/{ticket_id}/messages',
|
|
168
200
|
...options,
|
|
169
201
|
headers: {
|
|
170
|
-
'Content-Type':
|
|
171
|
-
...options
|
|
202
|
+
'Content-Type': null,
|
|
203
|
+
...options.headers
|
|
172
204
|
}
|
|
173
205
|
});
|
|
174
206
|
}
|
|
175
207
|
/**
|
|
176
|
-
*
|
|
177
|
-
* 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.
|
|
208
|
+
* Download a ticket attachment.
|
|
178
209
|
*/
|
|
179
|
-
static
|
|
180
|
-
return (options.client ??
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
210
|
+
static getTicketAttachment(options) {
|
|
211
|
+
return (options.client ?? client).get({ url: '/tickets/{ticket_id}/attachments/{attachment_id}', ...options });
|
|
212
|
+
}
|
|
213
|
+
}
|
|
214
|
+
export class RegistryService {
|
|
215
|
+
/**
|
|
216
|
+
* List repositories
|
|
217
|
+
*
|
|
218
|
+
* Returns a list of repositories in the registry across all regions. This endpoint is available to all users in the organization.
|
|
219
|
+
*
|
|
220
|
+
*/
|
|
221
|
+
static listRepositories(options) {
|
|
222
|
+
return (options?.client ?? client).get({ url: '/registry', ...options });
|
|
184
223
|
}
|
|
185
224
|
/**
|
|
186
|
-
* List
|
|
187
|
-
*
|
|
225
|
+
* List tags for a repository
|
|
226
|
+
*
|
|
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.
|
|
228
|
+
*
|
|
229
|
+
*/
|
|
230
|
+
static listTags(options) {
|
|
231
|
+
return (options.client ?? client).get({ url: '/registry/{region}/{repository}', ...options });
|
|
232
|
+
}
|
|
233
|
+
/**
|
|
234
|
+
* Delete tag
|
|
235
|
+
*
|
|
236
|
+
* Permanently deletes a specific tag from a repository. This endpoint is available to administrators of the organization only.
|
|
237
|
+
*
|
|
238
|
+
*/
|
|
239
|
+
static deleteTag(options) {
|
|
240
|
+
return (options.client ?? client).delete({ url: '/registry/{region}/{repository}/{tag}', ...options });
|
|
241
|
+
}
|
|
242
|
+
/**
|
|
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.
|
|
246
|
+
*
|
|
247
|
+
*/
|
|
248
|
+
static getTag(options) {
|
|
249
|
+
return (options.client ?? client).get({ url: '/registry/{region}/{repository}/{tag}', ...options });
|
|
250
|
+
}
|
|
251
|
+
}
|
|
252
|
+
export class OrganizationService {
|
|
253
|
+
/**
|
|
254
|
+
* Get organization information.
|
|
255
|
+
*
|
|
256
|
+
* Returns organization details including quota. For more information about quotas, see [Quotas and limits](https://cloudfleet.ai/docs/organization/quotas/) section of documentaiton.
|
|
188
257
|
*
|
|
189
258
|
* This endpoint is available to all users in the organization.
|
|
190
259
|
*
|
|
191
260
|
*/
|
|
192
|
-
static
|
|
193
|
-
return (options?.client ??
|
|
194
|
-
url: '/clusters',
|
|
195
|
-
...options
|
|
196
|
-
});
|
|
261
|
+
static getOrganization(options) {
|
|
262
|
+
return (options?.client ?? client).get({ url: '/organization', ...options });
|
|
197
263
|
}
|
|
198
264
|
/**
|
|
199
|
-
* Create a new
|
|
200
|
-
* 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.
|
|
201
266
|
*
|
|
202
|
-
* This endpoint
|
|
267
|
+
* This endpoint allows you to create a new Cloudfleet organization and an administrator user.
|
|
203
268
|
*
|
|
204
269
|
*/
|
|
205
|
-
static
|
|
206
|
-
return (options.client ??
|
|
207
|
-
url: '/
|
|
270
|
+
static createOrganization(options) {
|
|
271
|
+
return (options.client ?? client).post({
|
|
272
|
+
url: '/organization',
|
|
208
273
|
...options,
|
|
209
274
|
headers: {
|
|
210
275
|
'Content-Type': 'application/json',
|
|
211
|
-
...options
|
|
276
|
+
...options.headers
|
|
212
277
|
}
|
|
213
278
|
});
|
|
214
279
|
}
|
|
215
280
|
/**
|
|
216
|
-
*
|
|
217
|
-
* This endpoint will permanently delete the cluster. This operation cannot be undone.
|
|
281
|
+
* Get the organization's consent status for the new Basic price.
|
|
218
282
|
*
|
|
219
|
-
*
|
|
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.
|
|
284
|
+
*
|
|
285
|
+
* This endpoint is available to all users in the organization and drives the consent dialog in the console.
|
|
220
286
|
*
|
|
221
287
|
*/
|
|
222
|
-
static
|
|
223
|
-
return (options
|
|
224
|
-
url: '/clusters/{cluster_id}',
|
|
225
|
-
...options
|
|
226
|
-
});
|
|
288
|
+
static getBasicPriceConsent(options) {
|
|
289
|
+
return (options?.client ?? client).get({ url: '/organization/basic-price-consent', ...options });
|
|
227
290
|
}
|
|
228
291
|
/**
|
|
229
|
-
*
|
|
230
|
-
* Returns cluster details including quota. Quota is a set of filters defined by the admin of the organization that will be applied to all resources created in the cluster. Quota information returned here does not take into account quota set on organization or platform level. For calculated quota applied to this account, use /clusters/{cluster_id}/quota endpoint. For more information about quotas, see [Quotas and limits](https://cloudfleet.ai/docs/organization/quotas/) section of documentaiton.
|
|
292
|
+
* Record an administrator's decision on the new Basic price.
|
|
231
293
|
*
|
|
232
|
-
* This
|
|
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.
|
|
233
295
|
*
|
|
234
296
|
*/
|
|
235
|
-
static
|
|
236
|
-
return (options.client ??
|
|
237
|
-
url: '/
|
|
238
|
-
...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
|
+
}
|
|
239
305
|
});
|
|
240
306
|
}
|
|
307
|
+
}
|
|
308
|
+
export class McpService {
|
|
241
309
|
/**
|
|
242
|
-
*
|
|
243
|
-
* 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.
|
|
244
|
-
*
|
|
245
|
-
* This endpoint is available to administrators of the organization only.
|
|
310
|
+
* MCP endpoint
|
|
246
311
|
*
|
|
312
|
+
* MCP endpoint for handling Model Context Protocol JSON-RPC 2.0 messages.
|
|
247
313
|
*/
|
|
248
|
-
static
|
|
249
|
-
return (options.client ??
|
|
250
|
-
url: '/
|
|
314
|
+
static postMcp(options) {
|
|
315
|
+
return (options.client ?? client).post({
|
|
316
|
+
url: '/mcp',
|
|
251
317
|
...options,
|
|
252
318
|
headers: {
|
|
253
319
|
'Content-Type': 'application/json',
|
|
254
|
-
...options
|
|
320
|
+
...options.headers
|
|
255
321
|
}
|
|
256
322
|
});
|
|
257
323
|
}
|
|
324
|
+
}
|
|
325
|
+
export class ChartsMarketplaceService {
|
|
258
326
|
/**
|
|
259
|
-
*
|
|
260
|
-
*
|
|
327
|
+
* List chart listings available in the marketplace.
|
|
328
|
+
*
|
|
329
|
+
* Returns a list of available charts in the marketplace.
|
|
330
|
+
*
|
|
331
|
+
* This endpoint is available to all users in the organization.
|
|
261
332
|
*
|
|
262
333
|
*/
|
|
263
|
-
static
|
|
264
|
-
return (options
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
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 });
|
|
268
349
|
}
|
|
269
350
|
}
|
|
270
351
|
export class InvitesService {
|
|
271
352
|
/**
|
|
272
353
|
* List invites.
|
|
273
|
-
*
|
|
354
|
+
*
|
|
355
|
+
* Returns a list of pending (non-expired) invites under the current organization. This endpoint is available to administrators of the organization only.
|
|
274
356
|
*
|
|
275
357
|
*/
|
|
276
358
|
static listInvites(options) {
|
|
277
|
-
return (options?.client ??
|
|
278
|
-
url: '/invites',
|
|
279
|
-
...options
|
|
280
|
-
});
|
|
359
|
+
return (options?.client ?? client).get({ url: '/invites', ...options });
|
|
281
360
|
}
|
|
282
361
|
/**
|
|
283
362
|
* Create a new invite.
|
|
363
|
+
*
|
|
284
364
|
* Invite a new user to your Cloudfleet organization. The user will receive an email with a link to create a new account. This endpoint is available to administrators of the organization only.
|
|
285
365
|
*
|
|
286
366
|
*/
|
|
287
367
|
static createInvite(options) {
|
|
288
|
-
return (options.client ??
|
|
368
|
+
return (options.client ?? client).post({
|
|
289
369
|
url: '/invites',
|
|
290
370
|
...options,
|
|
291
371
|
headers: {
|
|
292
372
|
'Content-Type': 'application/json',
|
|
293
|
-
...options
|
|
373
|
+
...options.headers
|
|
294
374
|
}
|
|
295
375
|
});
|
|
296
376
|
}
|
|
297
377
|
/**
|
|
298
378
|
* Get invite information.
|
|
299
|
-
*
|
|
379
|
+
*
|
|
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.
|
|
300
381
|
*
|
|
301
382
|
*/
|
|
302
383
|
static getInvite(options) {
|
|
303
|
-
return (options.client ??
|
|
304
|
-
url: '/invites/{code}',
|
|
305
|
-
...options
|
|
306
|
-
});
|
|
384
|
+
return (options.client ?? client).get({ url: '/invites/{code}', ...options });
|
|
307
385
|
}
|
|
308
386
|
/**
|
|
309
387
|
* Permanently delete invite.
|
|
388
|
+
*
|
|
310
389
|
* Permanently deletes invite from the organization. This endpoint is available to administrators of the organization only.
|
|
311
390
|
*
|
|
312
391
|
*/
|
|
313
392
|
static deleteInvite(options) {
|
|
314
|
-
return (options.client ??
|
|
315
|
-
url: '/invites/{email}',
|
|
316
|
-
...options
|
|
317
|
-
});
|
|
393
|
+
return (options.client ?? client).delete({ url: '/invites/{email}', ...options });
|
|
318
394
|
}
|
|
319
395
|
}
|
|
320
|
-
export class
|
|
396
|
+
export class ClustersService {
|
|
321
397
|
/**
|
|
322
|
-
*
|
|
323
|
-
*
|
|
398
|
+
* Query Kubernetes cluster API
|
|
399
|
+
*
|
|
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.
|
|
324
409
|
*
|
|
325
410
|
* This endpoint is available to all users in the organization.
|
|
326
411
|
*
|
|
327
412
|
*/
|
|
328
|
-
static
|
|
329
|
-
return (options
|
|
330
|
-
url: '/organization',
|
|
331
|
-
...options
|
|
332
|
-
});
|
|
413
|
+
static listFleets(options) {
|
|
414
|
+
return (options.client ?? client).get({ url: '/clusters/{cluster_id}/fleets', ...options });
|
|
333
415
|
}
|
|
334
416
|
/**
|
|
335
|
-
* Create a new
|
|
336
|
-
*
|
|
417
|
+
* Create a new fleet.
|
|
418
|
+
*
|
|
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.
|
|
420
|
+
*
|
|
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.
|
|
337
424
|
*
|
|
338
425
|
*/
|
|
339
|
-
static
|
|
340
|
-
return (options.client ??
|
|
341
|
-
url: '/
|
|
426
|
+
static createFleet(options) {
|
|
427
|
+
return (options.client ?? client).post({
|
|
428
|
+
url: '/clusters/{cluster_id}/fleets',
|
|
342
429
|
...options,
|
|
343
430
|
headers: {
|
|
344
431
|
'Content-Type': 'application/json',
|
|
345
|
-
...options
|
|
432
|
+
...options.headers
|
|
346
433
|
}
|
|
347
434
|
});
|
|
348
435
|
}
|
|
349
|
-
}
|
|
350
|
-
export class TokensService {
|
|
351
436
|
/**
|
|
352
|
-
*
|
|
353
|
-
*
|
|
437
|
+
* Permanently delete fleet.
|
|
438
|
+
*
|
|
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.
|
|
354
444
|
*
|
|
355
445
|
*/
|
|
356
|
-
static
|
|
357
|
-
return (options
|
|
358
|
-
url: '/tokens',
|
|
359
|
-
...options
|
|
360
|
-
});
|
|
446
|
+
static deleteFleet(options) {
|
|
447
|
+
return (options.client ?? client).delete({ url: '/clusters/{cluster_id}/fleets/{fleet_name}', ...options });
|
|
361
448
|
}
|
|
362
449
|
/**
|
|
363
|
-
*
|
|
364
|
-
*
|
|
450
|
+
* Get fleet information.
|
|
451
|
+
*
|
|
452
|
+
* Returns fleet details. For more information, see [Fleets](https://cloudfleet.ai/docs/cloud-infrastructure/fleets/) section of documentaiton.
|
|
453
|
+
*
|
|
454
|
+
* This endpoint is available to all users in the organization.
|
|
455
|
+
*
|
|
456
|
+
*/
|
|
457
|
+
static getFleet(options) {
|
|
458
|
+
return (options.client ?? client).get({ url: '/clusters/{cluster_id}/fleets/{fleet_name}', ...options });
|
|
459
|
+
}
|
|
460
|
+
/**
|
|
461
|
+
* Update fleet information.
|
|
462
|
+
*
|
|
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).
|
|
365
468
|
*
|
|
366
469
|
* This endpoint is available to administrators of the organization only.
|
|
367
470
|
*
|
|
368
471
|
*/
|
|
369
|
-
static
|
|
370
|
-
return (options.client ??
|
|
371
|
-
url: '/
|
|
472
|
+
static updateFleet(options) {
|
|
473
|
+
return (options.client ?? client).put({
|
|
474
|
+
url: '/clusters/{cluster_id}/fleets/{fleet_name}',
|
|
372
475
|
...options,
|
|
373
476
|
headers: {
|
|
374
477
|
'Content-Type': 'application/json',
|
|
375
|
-
...options
|
|
478
|
+
...options.headers
|
|
376
479
|
}
|
|
377
480
|
});
|
|
378
481
|
}
|
|
379
482
|
/**
|
|
380
|
-
*
|
|
381
|
-
*
|
|
483
|
+
* List charts.
|
|
484
|
+
*
|
|
485
|
+
* Returns a list of charts in the cluster.
|
|
486
|
+
*
|
|
487
|
+
* This endpoint is available to all users in the organization.
|
|
382
488
|
*
|
|
383
489
|
*/
|
|
384
|
-
static
|
|
385
|
-
return (options.client ??
|
|
386
|
-
url: '/tokens/{token_id}',
|
|
387
|
-
...options
|
|
388
|
-
});
|
|
490
|
+
static listCharts(options) {
|
|
491
|
+
return (options.client ?? client).get({ url: '/clusters/{cluster_id}/charts', ...options });
|
|
389
492
|
}
|
|
390
493
|
/**
|
|
391
|
-
*
|
|
392
|
-
*
|
|
494
|
+
* Create a new chart.
|
|
495
|
+
*
|
|
496
|
+
* Create a new chart deployment.
|
|
497
|
+
*
|
|
498
|
+
* This endpoint is available to administrators of the organization only.
|
|
393
499
|
*
|
|
394
500
|
*/
|
|
395
|
-
static
|
|
396
|
-
return (options.client ??
|
|
397
|
-
url: '/
|
|
398
|
-
...options
|
|
501
|
+
static createChart(options) {
|
|
502
|
+
return (options.client ?? client).post({
|
|
503
|
+
url: '/clusters/{cluster_id}/charts',
|
|
504
|
+
...options,
|
|
505
|
+
headers: {
|
|
506
|
+
'Content-Type': 'application/json',
|
|
507
|
+
...options.headers
|
|
508
|
+
}
|
|
399
509
|
});
|
|
400
510
|
}
|
|
401
511
|
/**
|
|
402
|
-
*
|
|
403
|
-
*
|
|
512
|
+
* Permanently delete the chart deployment from the cluster.
|
|
513
|
+
*
|
|
514
|
+
* This endpoint will permanently delete chart. This operation cannot be undone.
|
|
404
515
|
*
|
|
405
516
|
* This endpoint is available to administrators of the organization only.
|
|
406
517
|
*
|
|
407
518
|
*/
|
|
408
|
-
static
|
|
409
|
-
return (options.client ??
|
|
410
|
-
|
|
519
|
+
static deleteChart(options) {
|
|
520
|
+
return (options.client ?? client).delete({ url: '/clusters/{cluster_id}/charts/{chart_name}', ...options });
|
|
521
|
+
}
|
|
522
|
+
/**
|
|
523
|
+
* Get chart information.
|
|
524
|
+
*
|
|
525
|
+
* Returns the details of the chart deployment.
|
|
526
|
+
*
|
|
527
|
+
* This endpoint is available to all users in the organization.
|
|
528
|
+
*
|
|
529
|
+
*/
|
|
530
|
+
static getChart(options) {
|
|
531
|
+
return (options.client ?? client).get({ url: '/clusters/{cluster_id}/charts/{chart_name}', ...options });
|
|
532
|
+
}
|
|
533
|
+
/**
|
|
534
|
+
* Update chart information.
|
|
535
|
+
*
|
|
536
|
+
* This endpoint allows you to update the values of a chart deployment.
|
|
537
|
+
*
|
|
538
|
+
* This endpoint is available to administrators of the organization only.
|
|
539
|
+
*
|
|
540
|
+
*/
|
|
541
|
+
static updateChart(options) {
|
|
542
|
+
return (options.client ?? client).put({
|
|
543
|
+
url: '/clusters/{cluster_id}/charts/{chart_name}',
|
|
411
544
|
...options,
|
|
412
545
|
headers: {
|
|
413
546
|
'Content-Type': 'application/json',
|
|
414
|
-
...options
|
|
547
|
+
...options.headers
|
|
415
548
|
}
|
|
416
549
|
});
|
|
417
550
|
}
|
|
418
551
|
/**
|
|
419
|
-
*
|
|
420
|
-
*
|
|
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.
|
|
557
|
+
*
|
|
421
558
|
*/
|
|
422
|
-
static
|
|
423
|
-
return (options
|
|
424
|
-
url: '/tokens/{token_id}/secret',
|
|
425
|
-
...options
|
|
426
|
-
});
|
|
559
|
+
static listClusters(options) {
|
|
560
|
+
return (options?.client ?? client).get({ url: '/clusters', ...options });
|
|
427
561
|
}
|
|
428
|
-
}
|
|
429
|
-
export class UsersService {
|
|
430
562
|
/**
|
|
431
|
-
*
|
|
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
|
+
*
|
|
432
569
|
*/
|
|
433
|
-
static
|
|
434
|
-
return (options.client ??
|
|
435
|
-
url: '/
|
|
436
|
-
...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
|
+
}
|
|
437
578
|
});
|
|
438
579
|
}
|
|
439
580
|
/**
|
|
440
|
-
*
|
|
441
|
-
*
|
|
581
|
+
* Permanently delete cluster.
|
|
582
|
+
*
|
|
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.
|
|
442
597
|
*
|
|
443
598
|
* This endpoint is available to all users in the organization.
|
|
444
599
|
*
|
|
445
600
|
*/
|
|
446
|
-
static
|
|
447
|
-
return (options
|
|
448
|
-
url: '/users',
|
|
449
|
-
...options
|
|
450
|
-
});
|
|
601
|
+
static getCluster(options) {
|
|
602
|
+
return (options.client ?? client).get({ url: '/clusters/{cluster_id}', ...options });
|
|
451
603
|
}
|
|
452
604
|
/**
|
|
453
|
-
*
|
|
454
|
-
*
|
|
605
|
+
* Update cluster information.
|
|
606
|
+
*
|
|
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.
|
|
455
612
|
*
|
|
456
613
|
*/
|
|
457
|
-
static
|
|
458
|
-
return (options.client ??
|
|
459
|
-
url: '/
|
|
614
|
+
static updateCluster(options) {
|
|
615
|
+
return (options.client ?? client).put({
|
|
616
|
+
url: '/clusters/{cluster_id}',
|
|
460
617
|
...options,
|
|
461
618
|
headers: {
|
|
462
619
|
'Content-Type': 'application/json',
|
|
463
|
-
...options
|
|
620
|
+
...options.headers
|
|
464
621
|
}
|
|
465
622
|
});
|
|
466
623
|
}
|
|
467
624
|
/**
|
|
468
|
-
*
|
|
469
|
-
*
|
|
625
|
+
* Node join information for the cluster
|
|
626
|
+
*
|
|
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.
|
|
470
628
|
*
|
|
471
629
|
*/
|
|
472
|
-
static
|
|
473
|
-
return (options.client ??
|
|
474
|
-
url: '/users/{user_id}',
|
|
475
|
-
...options
|
|
476
|
-
});
|
|
630
|
+
static getJoinInformation(options) {
|
|
631
|
+
return (options.client ?? client).post({ url: '/clusters/{cluster_id}/join_information', ...options });
|
|
477
632
|
}
|
|
633
|
+
}
|
|
634
|
+
export class BillingService {
|
|
478
635
|
/**
|
|
479
|
-
* Get
|
|
480
|
-
* Returns user details including their roles. For more information on identity access management, see [Users](https://cloudfleet.ai/docs/organization/users/) section of documentaiton.
|
|
636
|
+
* Get billing usage information.
|
|
481
637
|
*
|
|
482
|
-
* This endpoint is available to all users in the organization.
|
|
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.
|
|
483
639
|
*
|
|
484
640
|
*/
|
|
485
|
-
static
|
|
486
|
-
return (options
|
|
487
|
-
|
|
488
|
-
|
|
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.
|
|
648
|
+
*
|
|
649
|
+
*/
|
|
650
|
+
static getPaymentMethodSecret(options) {
|
|
651
|
+
return (options?.client ?? client).put({ url: '/billing/payment-method', ...options });
|
|
652
|
+
}
|
|
653
|
+
/**
|
|
654
|
+
* List organization payment methods.
|
|
655
|
+
*
|
|
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.
|
|
657
|
+
*
|
|
658
|
+
*/
|
|
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) {
|
|
705
|
+
return (options.client ?? client).put({
|
|
706
|
+
url: '/billing/contact',
|
|
707
|
+
...options,
|
|
708
|
+
headers: {
|
|
709
|
+
'Content-Type': 'application/json',
|
|
710
|
+
...options.headers
|
|
711
|
+
}
|
|
489
712
|
});
|
|
490
713
|
}
|
|
491
714
|
/**
|
|
492
|
-
*
|
|
493
|
-
*
|
|
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.
|
|
494
718
|
*
|
|
495
719
|
*/
|
|
496
|
-
static
|
|
497
|
-
return (options
|
|
498
|
-
|
|
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',
|
|
499
732
|
...options,
|
|
500
733
|
headers: {
|
|
501
734
|
'Content-Type': 'application/json',
|
|
502
|
-
...options
|
|
735
|
+
...options.headers
|
|
503
736
|
}
|
|
504
737
|
});
|
|
505
738
|
}
|