@cloudfleet/sdk 0.0.1-b9e1348 → 0.0.1-bbca6e3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/@tanstack/react-query.gen.d.ts +1151 -0
- package/dist/@tanstack/react-query.gen.d.ts.map +1 -0
- package/dist/@tanstack/react-query.gen.js +1167 -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 +220 -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/index.d.ts +3 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +3 -0
- package/dist/index.js.map +1 -1
- package/dist/schemas.gen.d.ts +1601 -626
- package/dist/schemas.gen.d.ts.map +1 -1
- package/dist/schemas.gen.js +2875 -694
- package/dist/schemas.gen.js.map +1 -1
- package/dist/sdk.gen.d.ts +263 -88
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/sdk.gen.js +361 -189
- package/dist/sdk.gen.js.map +1 -1
- package/dist/services/kubernetes/api.d.ts +196 -0
- package/dist/services/kubernetes/api.d.ts.map +1 -0
- package/dist/services/kubernetes/api.js +140 -0
- package/dist/services/kubernetes/api.js.map +1 -0
- package/dist/services/kubernetes/index.d.ts +44 -0
- package/dist/services/kubernetes/index.d.ts.map +1 -0
- package/dist/services/kubernetes/index.js +68 -0
- package/dist/services/kubernetes/index.js.map +1 -0
- package/dist/services/kubernetes/types.d.ts +1335 -0
- package/dist/services/kubernetes/types.d.ts.map +1 -0
- package/dist/services/kubernetes/types.js +2 -0
- package/dist/services/kubernetes/types.js.map +1 -0
- package/dist/types.gen.d.ts +1498 -408
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/zod.gen.d.ts +3667 -2121
- package/dist/zod.gen.d.ts.map +1 -1
- package/dist/zod.gen.js +1542 -794
- package/dist/zod.gen.js.map +1 -1
- package/package.json +31 -5
package/dist/sdk.gen.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import type
|
|
2
|
-
import type {
|
|
3
|
-
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> =
|
|
1
|
+
import { type Client, type Options as Options2, type TDataShape } from './client';
|
|
2
|
+
import type { CloseTicketData, CloseTicketResponses, CreateChartData, CreateChartResponses, CreateClusterData, CreateClusterErrors, CreateClusterResponses, CreateFleetData, CreateFleetErrors, CreateFleetResponses, CreateInviteData, CreateInviteResponses, CreateOrganizationData, CreateOrganizationResponses, CreateTicketData, CreateTicketResponses, CreateTokenData, CreateTokenErrors, CreateTokenResponses, CreateUserData, CreateUserResponses, DeleteChartData, DeleteChartResponses, DeleteClusterData, DeleteClusterErrors, DeleteClusterResponses, DeleteFleetData, DeleteFleetResponses, DeleteInviteData, DeleteInviteResponses, DeletePaymentMethodData, DeletePaymentMethodErrors, DeletePaymentMethodResponses, DeleteTagData, DeleteTagErrors, DeleteTagResponses, DeleteTokenData, DeleteTokenResponses, DeleteUserData, DeleteUserErrors, DeleteUserResponses, GetChartData, GetChartResponses, GetClusterData, GetClusterResponses, GetContactData, GetContactResponses, GetCreditsData, GetCreditsErrors, GetCreditsResponses, GetFleetData, GetFleetResponses, GetInviteData, GetInviteResponses, GetJoinInformationData, GetJoinInformationErrors, GetJoinInformationResponses, GetMarketplaceChartFilesData, GetMarketplaceChartFilesErrors, GetMarketplaceChartFilesResponses, GetOrganizationData, GetOrganizationResponses, GetPaymentMethodSecretData, GetPaymentMethodSecretResponses, GetTagData, GetTagErrors, GetTagResponses, GetTicketAttachmentData, GetTicketAttachmentResponses, GetTicketData, GetTicketResponses, GetTokenData, GetTokenErrors, GetTokenResponses, GetUsageData, GetUsageErrors, GetUsageResponses, GetUserData, GetUserErrors, GetUserResponses, ListChartsData, ListChartsErrors, ListChartsResponses, ListClustersData, ListClustersErrors, ListClustersResponses, ListFleetsData, ListFleetsErrors, ListFleetsResponses, ListInvitesData, ListInvitesErrors, ListInvitesResponses, ListInvoicesData, ListInvoicesErrors, ListInvoicesResponses, ListMarketplaceChartsData, ListMarketplaceChartsErrors, ListMarketplaceChartsResponses, ListPaymentMethodsData, ListPaymentMethodsErrors, ListPaymentMethodsResponses, ListRepositoriesData, ListRepositoriesErrors, ListRepositoriesResponses, ListTagsData, ListTagsErrors, ListTagsResponses, ListTicketsData, ListTicketsResponses, ListTokensData, ListTokensErrors, ListTokensResponses, ListUserOrganizationsData, ListUserOrganizationsResponses, ListUsersData, ListUsersErrors, ListUsersResponses, PostMcpData, PostMcpErrors, PostMcpResponses, QueryClusterData, QueryClusterErrors, QueryClusterResponses, RedeemCreditsData, RedeemCreditsErrors, RedeemCreditsResponses, RegenerateTokenData, RegenerateTokenErrors, RegenerateTokenResponses, ReplyTicketData, ReplyTicketErrors, ReplyTicketResponses, SetDefaultPaymentMethodData, SetDefaultPaymentMethodErrors, SetDefaultPaymentMethodResponses, UpdateChartData, UpdateChartResponses, UpdateClusterData, UpdateClusterResponses, UpdateContactData, UpdateContactResponses, UpdateFleetData, UpdateFleetErrors, UpdateFleetResponses, UpdateTokenData, UpdateTokenErrors, UpdateTokenResponses, UpdateUserData, UpdateUserResponses } from './types.gen';
|
|
3
|
+
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
|
|
4
4
|
/**
|
|
5
5
|
* You can provide a client instance returned by `createClient()` instead of
|
|
6
6
|
* individual options. This might be also useful if you want to implement a
|
|
@@ -16,290 +16,465 @@ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends
|
|
|
16
16
|
export declare class BillingService {
|
|
17
17
|
/**
|
|
18
18
|
* Get billing usage information.
|
|
19
|
-
*
|
|
19
|
+
*
|
|
20
|
+
* 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.
|
|
20
21
|
*
|
|
21
22
|
*/
|
|
22
|
-
static getUsage<ThrowOnError extends boolean = false>(options?: Options<GetUsageData, ThrowOnError>): import("
|
|
23
|
+
static getUsage<ThrowOnError extends boolean = false>(options?: Options<GetUsageData, ThrowOnError>): import("./client").RequestResult<GetUsageResponses, GetUsageErrors, ThrowOnError, "fields">;
|
|
23
24
|
/**
|
|
24
|
-
* Get
|
|
25
|
-
*
|
|
25
|
+
* Get Stripe client secret.
|
|
26
|
+
*
|
|
27
|
+
* 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.
|
|
26
28
|
*
|
|
27
29
|
*/
|
|
28
|
-
static
|
|
30
|
+
static getPaymentMethodSecret<ThrowOnError extends boolean = false>(options?: Options<GetPaymentMethodSecretData, ThrowOnError>): import("./client").RequestResult<GetPaymentMethodSecretResponses, unknown, ThrowOnError, "fields">;
|
|
29
31
|
/**
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
+
* List organization payment methods.
|
|
33
|
+
*
|
|
34
|
+
* 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.
|
|
32
35
|
*
|
|
33
36
|
*/
|
|
34
|
-
static
|
|
37
|
+
static listPaymentMethods<ThrowOnError extends boolean = false>(options?: Options<ListPaymentMethodsData, ThrowOnError>): import("./client").RequestResult<ListPaymentMethodsResponses, ListPaymentMethodsErrors, ThrowOnError, "fields">;
|
|
35
38
|
/**
|
|
36
|
-
*
|
|
37
|
-
*
|
|
39
|
+
* Set the default payment method.
|
|
40
|
+
*
|
|
41
|
+
* Sets the given payment method as the default used for invoices and active subscriptions. Requires the Administrator role.
|
|
38
42
|
*
|
|
39
43
|
*/
|
|
40
|
-
static
|
|
41
|
-
id?: string;
|
|
42
|
-
}, unknown, ThrowOnError>;
|
|
44
|
+
static setDefaultPaymentMethod<ThrowOnError extends boolean = false>(options: Options<SetDefaultPaymentMethodData, ThrowOnError>): import("./client").RequestResult<SetDefaultPaymentMethodResponses, SetDefaultPaymentMethodErrors, ThrowOnError, "fields">;
|
|
43
45
|
/**
|
|
44
|
-
*
|
|
45
|
-
*
|
|
46
|
+
* Delete a payment method.
|
|
47
|
+
*
|
|
48
|
+
* 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.
|
|
46
49
|
*
|
|
47
50
|
*/
|
|
48
|
-
static
|
|
51
|
+
static deletePaymentMethod<ThrowOnError extends boolean = false>(options: Options<DeletePaymentMethodData, ThrowOnError>): import("./client").RequestResult<DeletePaymentMethodResponses, DeletePaymentMethodErrors, ThrowOnError, "fields">;
|
|
49
52
|
/**
|
|
50
|
-
*
|
|
51
|
-
*
|
|
53
|
+
* List issued invoices.
|
|
54
|
+
*
|
|
55
|
+
* 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.
|
|
52
56
|
*
|
|
53
57
|
*/
|
|
54
|
-
static
|
|
55
|
-
html?: string;
|
|
56
|
-
}, unknown, ThrowOnError>;
|
|
58
|
+
static listInvoices<ThrowOnError extends boolean = false>(options?: Options<ListInvoicesData, ThrowOnError>): import("./client").RequestResult<ListInvoicesResponses, ListInvoicesErrors, ThrowOnError, "fields">;
|
|
57
59
|
/**
|
|
58
60
|
* Get organization contact and billing address information.
|
|
61
|
+
*
|
|
59
62
|
* Returns the organization contact and billing address information. This endpoint is available to all users in the organization.
|
|
60
63
|
*
|
|
61
64
|
*/
|
|
62
|
-
static getContact<ThrowOnError extends boolean = false>(options?: Options<GetContactData, ThrowOnError>): import("
|
|
65
|
+
static getContact<ThrowOnError extends boolean = false>(options?: Options<GetContactData, ThrowOnError>): import("./client").RequestResult<GetContactResponses, unknown, ThrowOnError, "fields">;
|
|
63
66
|
/**
|
|
64
67
|
* Update organization contact information and billing address.
|
|
68
|
+
*
|
|
65
69
|
* This endpoint allows you to update organization details with its contact information. This endpoint is available to administrators of the organization only.
|
|
66
70
|
*
|
|
67
71
|
*/
|
|
68
|
-
static updateContact<ThrowOnError extends boolean = false>(options: Options<UpdateContactData, ThrowOnError>): import("
|
|
72
|
+
static updateContact<ThrowOnError extends boolean = false>(options: Options<UpdateContactData, ThrowOnError>): import("./client").RequestResult<UpdateContactResponses, unknown, ThrowOnError, "fields">;
|
|
73
|
+
/**
|
|
74
|
+
* Get applied promotional credits
|
|
75
|
+
*
|
|
76
|
+
* 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.
|
|
77
|
+
*
|
|
78
|
+
*/
|
|
79
|
+
static getCredits<ThrowOnError extends boolean = false>(options?: Options<GetCreditsData, ThrowOnError>): import("./client").RequestResult<GetCreditsResponses, GetCreditsErrors, ThrowOnError, "fields">;
|
|
80
|
+
/**
|
|
81
|
+
* Redeem promotional credits code.
|
|
82
|
+
*
|
|
83
|
+
* 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.
|
|
84
|
+
*
|
|
85
|
+
*/
|
|
86
|
+
static redeemCredits<ThrowOnError extends boolean = false>(options: Options<RedeemCreditsData, ThrowOnError>): import("./client").RequestResult<RedeemCreditsResponses, RedeemCreditsErrors, ThrowOnError, "fields">;
|
|
69
87
|
}
|
|
70
88
|
export declare class ClustersService {
|
|
89
|
+
/**
|
|
90
|
+
* List charts.
|
|
91
|
+
*
|
|
92
|
+
* Returns a list of charts in the cluster.
|
|
93
|
+
*
|
|
94
|
+
* This endpoint is available to all users in the organization.
|
|
95
|
+
*
|
|
96
|
+
*/
|
|
97
|
+
static listCharts<ThrowOnError extends boolean = false>(options: Options<ListChartsData, ThrowOnError>): import("./client").RequestResult<ListChartsResponses, ListChartsErrors, ThrowOnError, "fields">;
|
|
98
|
+
/**
|
|
99
|
+
* Create a new chart.
|
|
100
|
+
*
|
|
101
|
+
* Create a new chart deployment.
|
|
102
|
+
*
|
|
103
|
+
* This endpoint is available to administrators of the organization only.
|
|
104
|
+
*
|
|
105
|
+
*/
|
|
106
|
+
static createChart<ThrowOnError extends boolean = false>(options: Options<CreateChartData, ThrowOnError>): import("./client").RequestResult<CreateChartResponses, unknown, ThrowOnError, "fields">;
|
|
107
|
+
/**
|
|
108
|
+
* Permanently delete the chart deployment from the cluster.
|
|
109
|
+
*
|
|
110
|
+
* This endpoint will permanently delete chart. This operation cannot be undone.
|
|
111
|
+
*
|
|
112
|
+
* This endpoint is available to administrators of the organization only.
|
|
113
|
+
*
|
|
114
|
+
*/
|
|
115
|
+
static deleteChart<ThrowOnError extends boolean = false>(options: Options<DeleteChartData, ThrowOnError>): import("./client").RequestResult<DeleteChartResponses, unknown, ThrowOnError, "fields">;
|
|
116
|
+
/**
|
|
117
|
+
* Get chart information.
|
|
118
|
+
*
|
|
119
|
+
* Returns the details of the chart deployment.
|
|
120
|
+
*
|
|
121
|
+
* This endpoint is available to all users in the organization.
|
|
122
|
+
*
|
|
123
|
+
*/
|
|
124
|
+
static getChart<ThrowOnError extends boolean = false>(options: Options<GetChartData, ThrowOnError>): import("./client").RequestResult<GetChartResponses, unknown, ThrowOnError, "fields">;
|
|
125
|
+
/**
|
|
126
|
+
* Update chart information.
|
|
127
|
+
*
|
|
128
|
+
* This endpoint allows you to update the values of a chart deployment.
|
|
129
|
+
*
|
|
130
|
+
* This endpoint is available to administrators of the organization only.
|
|
131
|
+
*
|
|
132
|
+
*/
|
|
133
|
+
static updateChart<ThrowOnError extends boolean = false>(options: Options<UpdateChartData, ThrowOnError>): import("./client").RequestResult<UpdateChartResponses, unknown, ThrowOnError, "fields">;
|
|
71
134
|
/**
|
|
72
135
|
* List fleets.
|
|
73
|
-
*
|
|
136
|
+
*
|
|
137
|
+
* Returns a list of fleets belonging to the cluster. For more information, see [Fleets](https://cloudfleet.ai/docs/cloud-infrastructure/fleets/) section of documentaiton.
|
|
74
138
|
*
|
|
75
139
|
* This endpoint is available to all users in the organization.
|
|
76
140
|
*
|
|
77
141
|
*/
|
|
78
|
-
static listFleets<ThrowOnError extends boolean = false>(options: Options<ListFleetsData, ThrowOnError>): import("
|
|
142
|
+
static listFleets<ThrowOnError extends boolean = false>(options: Options<ListFleetsData, ThrowOnError>): import("./client").RequestResult<ListFleetsResponses, ListFleetsErrors, ThrowOnError, "fields">;
|
|
79
143
|
/**
|
|
80
144
|
* Create a new fleet.
|
|
81
|
-
*
|
|
145
|
+
*
|
|
146
|
+
* 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.
|
|
82
147
|
*
|
|
83
148
|
* This endpoint is available to administrators of the organization only.
|
|
84
149
|
*
|
|
85
150
|
*/
|
|
86
|
-
static createFleet<ThrowOnError extends boolean = false>(options: Options<CreateFleetData, ThrowOnError>): import("
|
|
151
|
+
static createFleet<ThrowOnError extends boolean = false>(options: Options<CreateFleetData, ThrowOnError>): import("./client").RequestResult<CreateFleetResponses, CreateFleetErrors, ThrowOnError, "fields">;
|
|
87
152
|
/**
|
|
88
153
|
* Permanently delete fleet.
|
|
89
|
-
*
|
|
154
|
+
*
|
|
155
|
+
* 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.
|
|
90
156
|
*
|
|
91
157
|
* This endpoint is available to administrators of the organization only.
|
|
92
158
|
*
|
|
93
159
|
*/
|
|
94
|
-
static deleteFleet<ThrowOnError extends boolean = false>(options: Options<DeleteFleetData, ThrowOnError>): import("
|
|
160
|
+
static deleteFleet<ThrowOnError extends boolean = false>(options: Options<DeleteFleetData, ThrowOnError>): import("./client").RequestResult<DeleteFleetResponses, unknown, ThrowOnError, "fields">;
|
|
95
161
|
/**
|
|
96
162
|
* Get fleet information.
|
|
97
|
-
*
|
|
163
|
+
*
|
|
164
|
+
* Returns fleet details. For more information, see [Fleets](https://cloudfleet.ai/docs/cloud-infrastructure/fleets/) section of documentaiton.
|
|
98
165
|
*
|
|
99
166
|
* This endpoint is available to all users in the organization.
|
|
100
167
|
*
|
|
101
168
|
*/
|
|
102
|
-
static getFleet<ThrowOnError extends boolean = false>(options: Options<GetFleetData, ThrowOnError>): import("
|
|
169
|
+
static getFleet<ThrowOnError extends boolean = false>(options: Options<GetFleetData, ThrowOnError>): import("./client").RequestResult<GetFleetResponses, unknown, ThrowOnError, "fields">;
|
|
103
170
|
/**
|
|
104
171
|
* Update fleet information.
|
|
105
|
-
* This endpoint allows you to update fleet details.
|
|
106
172
|
*
|
|
107
|
-
*
|
|
173
|
+
* This endpoint allows you to update fleet details.
|
|
108
174
|
*
|
|
109
|
-
* For more information, see [Fleets
|
|
175
|
+
* For more information, see [Fleets](https://cloudfleet.ai/docs/cloud-infrastructure/fleets/) section of documentaiton.
|
|
110
176
|
*
|
|
111
177
|
* This endpoint is available to administrators of the organization only.
|
|
112
178
|
*
|
|
113
179
|
*/
|
|
114
|
-
static updateFleet<ThrowOnError extends boolean = false>(options: Options<UpdateFleetData, ThrowOnError>): import("
|
|
180
|
+
static updateFleet<ThrowOnError extends boolean = false>(options: Options<UpdateFleetData, ThrowOnError>): import("./client").RequestResult<UpdateFleetResponses, UpdateFleetErrors, ThrowOnError, "fields">;
|
|
115
181
|
/**
|
|
116
182
|
* Query Kubernetes cluster API
|
|
183
|
+
*
|
|
117
184
|
* 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.
|
|
118
185
|
*/
|
|
119
|
-
static queryCluster<ThrowOnError extends boolean = false>(options: Options<QueryClusterData, ThrowOnError>): import("
|
|
186
|
+
static queryCluster<ThrowOnError extends boolean = false>(options: Options<QueryClusterData, ThrowOnError>): import("./client").RequestResult<QueryClusterResponses, QueryClusterErrors, ThrowOnError, "fields">;
|
|
120
187
|
/**
|
|
121
188
|
* List clusters.
|
|
122
|
-
*
|
|
189
|
+
*
|
|
190
|
+
* Returns a list of clusters under the current organization.
|
|
123
191
|
*
|
|
124
192
|
* This endpoint is available to all users in the organization.
|
|
125
193
|
*
|
|
126
194
|
*/
|
|
127
|
-
static listClusters<ThrowOnError extends boolean = false>(options?: Options<ListClustersData, ThrowOnError>): import("
|
|
195
|
+
static listClusters<ThrowOnError extends boolean = false>(options?: Options<ListClustersData, ThrowOnError>): import("./client").RequestResult<ListClustersResponses, ListClustersErrors, ThrowOnError, "fields">;
|
|
128
196
|
/**
|
|
129
197
|
* Create a new cluster.
|
|
198
|
+
*
|
|
130
199
|
* 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.
|
|
131
200
|
*
|
|
132
201
|
* This endpoint is available to administrators of the organization only.
|
|
133
202
|
*
|
|
134
203
|
*/
|
|
135
|
-
static createCluster<ThrowOnError extends boolean = false>(options: Options<CreateClusterData, ThrowOnError>): import("
|
|
204
|
+
static createCluster<ThrowOnError extends boolean = false>(options: Options<CreateClusterData, ThrowOnError>): import("./client").RequestResult<CreateClusterResponses, CreateClusterErrors, ThrowOnError, "fields">;
|
|
136
205
|
/**
|
|
137
206
|
* Permanently delete cluster.
|
|
207
|
+
*
|
|
138
208
|
* This endpoint will permanently delete the cluster. This operation cannot be undone.
|
|
139
209
|
*
|
|
210
|
+
* Deletion is synchronous: a `200` response means the cluster has been torn down (this can take some time for larger clusters). Deleting a cluster that does not exist or has already been deleted returns `404`.
|
|
211
|
+
*
|
|
140
212
|
* This endpoint is available to administrators of the organization only.
|
|
141
213
|
*
|
|
142
214
|
*/
|
|
143
|
-
static deleteCluster<ThrowOnError extends boolean = false>(options: Options<DeleteClusterData, ThrowOnError>): import("
|
|
215
|
+
static deleteCluster<ThrowOnError extends boolean = false>(options: Options<DeleteClusterData, ThrowOnError>): import("./client").RequestResult<DeleteClusterResponses, DeleteClusterErrors, ThrowOnError, "fields">;
|
|
144
216
|
/**
|
|
145
217
|
* Get cluster information.
|
|
146
|
-
*
|
|
218
|
+
*
|
|
219
|
+
* Returns cluster details.
|
|
147
220
|
*
|
|
148
221
|
* This endpoint is available to all users in the organization.
|
|
149
222
|
*
|
|
150
223
|
*/
|
|
151
|
-
static getCluster<ThrowOnError extends boolean = false>(options: Options<GetClusterData, ThrowOnError>): import("
|
|
224
|
+
static getCluster<ThrowOnError extends boolean = false>(options: Options<GetClusterData, ThrowOnError>): import("./client").RequestResult<GetClusterResponses, unknown, ThrowOnError, "fields">;
|
|
152
225
|
/**
|
|
153
226
|
* Update cluster information.
|
|
154
|
-
*
|
|
227
|
+
*
|
|
228
|
+
* This endpoint allows you to update cluster details such as name, tier, and Kubernetes version. For more information about clusters, see [Clusters](https://cloudfleet.ai/docs/cluster-management/cluster-types/) section of documentation.
|
|
155
229
|
*
|
|
156
230
|
* This endpoint is available to administrators of the organization only.
|
|
157
231
|
*
|
|
158
232
|
*/
|
|
159
|
-
static updateCluster<ThrowOnError extends boolean = false>(options: Options<UpdateClusterData, ThrowOnError>): import("
|
|
233
|
+
static updateCluster<ThrowOnError extends boolean = false>(options: Options<UpdateClusterData, ThrowOnError>): import("./client").RequestResult<UpdateClusterResponses, unknown, ThrowOnError, "fields">;
|
|
160
234
|
/**
|
|
161
235
|
* Node join information for the cluster
|
|
162
|
-
*
|
|
236
|
+
*
|
|
237
|
+
* 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.
|
|
163
238
|
*
|
|
164
239
|
*/
|
|
165
|
-
static getJoinInformation<ThrowOnError extends boolean = false>(options: Options<GetJoinInformationData, ThrowOnError>): import("
|
|
240
|
+
static getJoinInformation<ThrowOnError extends boolean = false>(options: Options<GetJoinInformationData, ThrowOnError>): import("./client").RequestResult<GetJoinInformationResponses, GetJoinInformationErrors, ThrowOnError, "fields">;
|
|
166
241
|
}
|
|
167
242
|
export declare class InvitesService {
|
|
168
243
|
/**
|
|
169
244
|
* List invites.
|
|
170
|
-
*
|
|
245
|
+
*
|
|
246
|
+
* Returns a list of pending (non-expired) invites under the current organization. This endpoint is available to administrators of the organization only.
|
|
171
247
|
*
|
|
172
248
|
*/
|
|
173
|
-
static listInvites<ThrowOnError extends boolean = false>(options?: Options<ListInvitesData, ThrowOnError>): import("
|
|
249
|
+
static listInvites<ThrowOnError extends boolean = false>(options?: Options<ListInvitesData, ThrowOnError>): import("./client").RequestResult<ListInvitesResponses, ListInvitesErrors, ThrowOnError, "fields">;
|
|
174
250
|
/**
|
|
175
251
|
* Create a new invite.
|
|
176
|
-
*
|
|
252
|
+
*
|
|
253
|
+
* 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.
|
|
177
254
|
*
|
|
178
255
|
*/
|
|
179
|
-
static createInvite<ThrowOnError extends boolean = false>(options: Options<CreateInviteData, ThrowOnError>): import("
|
|
256
|
+
static createInvite<ThrowOnError extends boolean = false>(options: Options<CreateInviteData, ThrowOnError>): import("./client").RequestResult<CreateInviteResponses, unknown, ThrowOnError, "fields">;
|
|
180
257
|
/**
|
|
181
258
|
* Get invite information.
|
|
182
|
-
*
|
|
259
|
+
*
|
|
260
|
+
* 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.
|
|
183
261
|
*
|
|
184
262
|
*/
|
|
185
|
-
static getInvite<ThrowOnError extends boolean = false>(options: Options<GetInviteData, ThrowOnError>): import("
|
|
263
|
+
static getInvite<ThrowOnError extends boolean = false>(options: Options<GetInviteData, ThrowOnError>): import("./client").RequestResult<GetInviteResponses, unknown, ThrowOnError, "fields">;
|
|
186
264
|
/**
|
|
187
265
|
* Permanently delete invite.
|
|
266
|
+
*
|
|
188
267
|
* Permanently deletes invite from the organization. This endpoint is available to administrators of the organization only.
|
|
189
268
|
*
|
|
190
269
|
*/
|
|
191
|
-
static deleteInvite<ThrowOnError extends boolean = false>(options: Options<DeleteInviteData, ThrowOnError>): import("
|
|
270
|
+
static deleteInvite<ThrowOnError extends boolean = false>(options: Options<DeleteInviteData, ThrowOnError>): import("./client").RequestResult<DeleteInviteResponses, unknown, ThrowOnError, "fields">;
|
|
271
|
+
}
|
|
272
|
+
export declare class ChartsMarketplaceService {
|
|
273
|
+
/**
|
|
274
|
+
* List chart listings available in the marketplace.
|
|
275
|
+
*
|
|
276
|
+
* Returns a list of available charts in the marketplace.
|
|
277
|
+
*
|
|
278
|
+
* This endpoint is available to all users in the organization.
|
|
279
|
+
*
|
|
280
|
+
*/
|
|
281
|
+
static listMarketplaceCharts<ThrowOnError extends boolean = false>(options?: Options<ListMarketplaceChartsData, ThrowOnError>): import("./client").RequestResult<ListMarketplaceChartsResponses, ListMarketplaceChartsErrors, ThrowOnError, "fields">;
|
|
282
|
+
/**
|
|
283
|
+
* Get chart files for a specific version channel.
|
|
284
|
+
*
|
|
285
|
+
* Returns the Chart.yaml, values.yaml, and values.schema.json files for the latest version matching the specified version channel.
|
|
286
|
+
*
|
|
287
|
+
* 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.
|
|
288
|
+
*
|
|
289
|
+
* This endpoint is available to all users in the organization.
|
|
290
|
+
*
|
|
291
|
+
*/
|
|
292
|
+
static getMarketplaceChartFiles<ThrowOnError extends boolean = false>(options: Options<GetMarketplaceChartFilesData, ThrowOnError>): import("./client").RequestResult<GetMarketplaceChartFilesResponses, GetMarketplaceChartFilesErrors, ThrowOnError, "fields">;
|
|
293
|
+
}
|
|
294
|
+
export declare class McpService {
|
|
295
|
+
/**
|
|
296
|
+
* MCP endpoint
|
|
297
|
+
*
|
|
298
|
+
* MCP endpoint for handling Model Context Protocol JSON-RPC 2.0 messages.
|
|
299
|
+
*/
|
|
300
|
+
static postMcp<ThrowOnError extends boolean = false>(options: Options<PostMcpData, ThrowOnError>): import("./client").RequestResult<PostMcpResponses, PostMcpErrors, ThrowOnError, "fields">;
|
|
192
301
|
}
|
|
193
302
|
export declare class OrganizationService {
|
|
194
303
|
/**
|
|
195
304
|
* Get organization information.
|
|
305
|
+
*
|
|
196
306
|
* Returns organization details including quota. For more information about quotas, see [Quotas and limits](https://cloudfleet.ai/docs/organization/quotas/) section of documentaiton.
|
|
197
307
|
*
|
|
198
308
|
* This endpoint is available to all users in the organization.
|
|
199
309
|
*
|
|
200
310
|
*/
|
|
201
|
-
static getOrganization<ThrowOnError extends boolean = false>(options?: Options<GetOrganizationData, ThrowOnError>): import("
|
|
311
|
+
static getOrganization<ThrowOnError extends boolean = false>(options?: Options<GetOrganizationData, ThrowOnError>): import("./client").RequestResult<GetOrganizationResponses, unknown, ThrowOnError, "fields">;
|
|
202
312
|
/**
|
|
203
313
|
* Create a new organization / Cloudfleet account signup.
|
|
314
|
+
*
|
|
204
315
|
* This endpoint allows you to create a new Cloudfleet organization and an administrator user.
|
|
205
316
|
*
|
|
206
317
|
*/
|
|
207
|
-
static createOrganization<ThrowOnError extends boolean = false>(options: Options<CreateOrganizationData, ThrowOnError>): import("
|
|
318
|
+
static createOrganization<ThrowOnError extends boolean = false>(options: Options<CreateOrganizationData, ThrowOnError>): import("./client").RequestResult<CreateOrganizationResponses, unknown, ThrowOnError, "fields">;
|
|
319
|
+
}
|
|
320
|
+
export declare class RegistryService {
|
|
321
|
+
/**
|
|
322
|
+
* List repositories
|
|
323
|
+
*
|
|
324
|
+
* Returns a list of repositories in the registry across all regions. This endpoint is available to all users in the organization.
|
|
325
|
+
*
|
|
326
|
+
*/
|
|
327
|
+
static listRepositories<ThrowOnError extends boolean = false>(options?: Options<ListRepositoriesData, ThrowOnError>): import("./client").RequestResult<ListRepositoriesResponses, ListRepositoriesErrors, ThrowOnError, "fields">;
|
|
328
|
+
/**
|
|
329
|
+
* List tags for a repository
|
|
330
|
+
*
|
|
331
|
+
* 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.
|
|
332
|
+
*
|
|
333
|
+
*/
|
|
334
|
+
static listTags<ThrowOnError extends boolean = false>(options: Options<ListTagsData, ThrowOnError>): import("./client").RequestResult<ListTagsResponses, ListTagsErrors, ThrowOnError, "fields">;
|
|
335
|
+
/**
|
|
336
|
+
* Delete tag
|
|
337
|
+
*
|
|
338
|
+
* Permanently deletes a specific tag from a repository. This endpoint is available to administrators of the organization only.
|
|
339
|
+
*
|
|
340
|
+
*/
|
|
341
|
+
static deleteTag<ThrowOnError extends boolean = false>(options: Options<DeleteTagData, ThrowOnError>): import("./client").RequestResult<DeleteTagResponses, DeleteTagErrors, ThrowOnError, "fields">;
|
|
342
|
+
/**
|
|
343
|
+
* Get tag details
|
|
344
|
+
*
|
|
345
|
+
* 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.
|
|
346
|
+
*
|
|
347
|
+
*/
|
|
348
|
+
static getTag<ThrowOnError extends boolean = false>(options: Options<GetTagData, ThrowOnError>): import("./client").RequestResult<GetTagResponses, GetTagErrors, ThrowOnError, "fields">;
|
|
349
|
+
}
|
|
350
|
+
export declare class TicketsService {
|
|
351
|
+
/**
|
|
352
|
+
* List tickets for the current organization.
|
|
353
|
+
*
|
|
354
|
+
* Returns all tickets belonging to the caller's organization, newest first.
|
|
355
|
+
*
|
|
356
|
+
*/
|
|
357
|
+
static listTickets<ThrowOnError extends boolean = false>(options?: Options<ListTicketsData, ThrowOnError>): import("./client").RequestResult<ListTicketsResponses, unknown, ThrowOnError, "fields">;
|
|
358
|
+
/**
|
|
359
|
+
* Create a new support ticket.
|
|
360
|
+
*
|
|
361
|
+
* 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).
|
|
362
|
+
*
|
|
363
|
+
*/
|
|
364
|
+
static createTicket<ThrowOnError extends boolean = false>(options: Options<CreateTicketData, ThrowOnError>): import("./client").RequestResult<CreateTicketResponses, unknown, ThrowOnError, "fields">;
|
|
365
|
+
/**
|
|
366
|
+
* Close a ticket (soft close).
|
|
367
|
+
*
|
|
368
|
+
* Marks the ticket as closed. Closed is a terminal state — users cannot reply to a closed ticket; a new ticket must be opened instead.
|
|
369
|
+
*
|
|
370
|
+
*/
|
|
371
|
+
static closeTicket<ThrowOnError extends boolean = false>(options: Options<CloseTicketData, ThrowOnError>): import("./client").RequestResult<CloseTicketResponses, unknown, ThrowOnError, "fields">;
|
|
372
|
+
/**
|
|
373
|
+
* Get a ticket and its messages.
|
|
374
|
+
*/
|
|
375
|
+
static getTicket<ThrowOnError extends boolean = false>(options: Options<GetTicketData, ThrowOnError>): import("./client").RequestResult<GetTicketResponses, unknown, ThrowOnError, "fields">;
|
|
376
|
+
/**
|
|
377
|
+
* Append a customer reply to a ticket.
|
|
378
|
+
*
|
|
379
|
+
* Multipart form-data with a JSON-encoded `payload` field carrying `body`, plus up to 3 `attachments` files. Returns 409 if the ticket is closed.
|
|
380
|
+
*
|
|
381
|
+
*/
|
|
382
|
+
static replyTicket<ThrowOnError extends boolean = false>(options: Options<ReplyTicketData, ThrowOnError>): import("./client").RequestResult<ReplyTicketResponses, ReplyTicketErrors, ThrowOnError, "fields">;
|
|
383
|
+
/**
|
|
384
|
+
* Download a ticket attachment.
|
|
385
|
+
*/
|
|
386
|
+
static getTicketAttachment<ThrowOnError extends boolean = false>(options: Options<GetTicketAttachmentData, ThrowOnError>): import("./client").RequestResult<GetTicketAttachmentResponses, unknown, ThrowOnError, "fields">;
|
|
208
387
|
}
|
|
209
388
|
export declare class TokensService {
|
|
210
389
|
/**
|
|
211
390
|
* List access tokens in organization.
|
|
391
|
+
*
|
|
212
392
|
* 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.
|
|
213
393
|
*
|
|
214
394
|
*/
|
|
215
|
-
static listTokens<ThrowOnError extends boolean = false>(options?: Options<ListTokensData, ThrowOnError>): import("
|
|
395
|
+
static listTokens<ThrowOnError extends boolean = false>(options?: Options<ListTokensData, ThrowOnError>): import("./client").RequestResult<ListTokensResponses, ListTokensErrors, ThrowOnError, "fields">;
|
|
216
396
|
/**
|
|
217
397
|
* Create a new access token.
|
|
398
|
+
*
|
|
218
399
|
* 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.
|
|
219
400
|
*
|
|
220
401
|
* This endpoint is available to administrators of the organization only.
|
|
221
402
|
*
|
|
222
403
|
*/
|
|
223
|
-
static createToken<ThrowOnError extends boolean = false>(options: Options<CreateTokenData, ThrowOnError>): import("
|
|
404
|
+
static createToken<ThrowOnError extends boolean = false>(options: Options<CreateTokenData, ThrowOnError>): import("./client").RequestResult<CreateTokenResponses, CreateTokenErrors, ThrowOnError, "fields">;
|
|
224
405
|
/**
|
|
225
406
|
* Permanently delete access token.
|
|
407
|
+
*
|
|
226
408
|
* 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.
|
|
227
409
|
*
|
|
228
410
|
*/
|
|
229
|
-
static deleteToken<ThrowOnError extends boolean = false>(options: Options<DeleteTokenData, ThrowOnError>): import("
|
|
411
|
+
static deleteToken<ThrowOnError extends boolean = false>(options: Options<DeleteTokenData, ThrowOnError>): import("./client").RequestResult<DeleteTokenResponses, unknown, ThrowOnError, "fields">;
|
|
230
412
|
/**
|
|
231
413
|
* Get access token information.
|
|
414
|
+
*
|
|
232
415
|
* 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.
|
|
233
416
|
*
|
|
234
417
|
*/
|
|
235
|
-
static getToken<ThrowOnError extends boolean = false>(options: Options<GetTokenData, ThrowOnError>): import("
|
|
418
|
+
static getToken<ThrowOnError extends boolean = false>(options: Options<GetTokenData, ThrowOnError>): import("./client").RequestResult<GetTokenResponses, GetTokenErrors, ThrowOnError, "fields">;
|
|
236
419
|
/**
|
|
237
420
|
* Update access token information.
|
|
421
|
+
*
|
|
238
422
|
* 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.
|
|
239
423
|
*
|
|
240
424
|
* This endpoint is available to administrators of the organization only.
|
|
241
425
|
*
|
|
242
426
|
*/
|
|
243
|
-
static updateToken<ThrowOnError extends boolean = false>(options: Options<UpdateTokenData, ThrowOnError>): import("
|
|
427
|
+
static updateToken<ThrowOnError extends boolean = false>(options: Options<UpdateTokenData, ThrowOnError>): import("./client").RequestResult<UpdateTokenResponses, UpdateTokenErrors, ThrowOnError, "fields">;
|
|
244
428
|
/**
|
|
245
429
|
* Regenerate access token secret key.
|
|
430
|
+
*
|
|
246
431
|
* Generates a new access token secret. Old secret will not be valid anymore.
|
|
247
432
|
*/
|
|
248
|
-
static regenerateToken<ThrowOnError extends boolean = false>(options: Options<RegenerateTokenData, ThrowOnError>): import("
|
|
433
|
+
static regenerateToken<ThrowOnError extends boolean = false>(options: Options<RegenerateTokenData, ThrowOnError>): import("./client").RequestResult<RegenerateTokenResponses, RegenerateTokenErrors, ThrowOnError, "fields">;
|
|
249
434
|
}
|
|
250
435
|
export declare class UsersService {
|
|
251
436
|
/**
|
|
252
437
|
* Get a list of organizations the user belongs to. Used during authentication process.
|
|
253
438
|
*/
|
|
254
|
-
static listUserOrganizations<ThrowOnError extends boolean = false>(options: Options<ListUserOrganizationsData, ThrowOnError>): import("
|
|
255
|
-
realm?: string;
|
|
256
|
-
displayName?: string;
|
|
257
|
-
}[], unknown, ThrowOnError>;
|
|
439
|
+
static listUserOrganizations<ThrowOnError extends boolean = false>(options: Options<ListUserOrganizationsData, ThrowOnError>): import("./client").RequestResult<ListUserOrganizationsResponses, unknown, ThrowOnError, "fields">;
|
|
258
440
|
/**
|
|
259
441
|
* List users in organization.
|
|
260
|
-
*
|
|
442
|
+
*
|
|
443
|
+
* 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.
|
|
261
444
|
*
|
|
262
445
|
* This endpoint is available to all users in the organization.
|
|
263
446
|
*
|
|
264
447
|
*/
|
|
265
|
-
static listUsers<ThrowOnError extends boolean = false>(options?: Options<ListUsersData, ThrowOnError>): import("
|
|
448
|
+
static listUsers<ThrowOnError extends boolean = false>(options?: Options<ListUsersData, ThrowOnError>): import("./client").RequestResult<ListUsersResponses, ListUsersErrors, ThrowOnError, "fields">;
|
|
266
449
|
/**
|
|
267
450
|
* Create a new user.
|
|
268
|
-
*
|
|
451
|
+
*
|
|
452
|
+
* 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.
|
|
269
453
|
*
|
|
270
454
|
*/
|
|
271
|
-
static createUser<ThrowOnError extends boolean = false>(options: Options<CreateUserData, ThrowOnError>): import("
|
|
455
|
+
static createUser<ThrowOnError extends boolean = false>(options: Options<CreateUserData, ThrowOnError>): import("./client").RequestResult<CreateUserResponses, unknown, ThrowOnError, "fields">;
|
|
272
456
|
/**
|
|
273
457
|
* Delete user by id.
|
|
458
|
+
*
|
|
274
459
|
* Sets user status to `inactive`. Inactive users cannot log in and manage organization resources. This endpoint is available to administrators of the organization only.
|
|
275
460
|
*
|
|
276
461
|
*/
|
|
277
|
-
static deleteUser<ThrowOnError extends boolean = false>(options: Options<DeleteUserData, ThrowOnError>): import("
|
|
462
|
+
static deleteUser<ThrowOnError extends boolean = false>(options: Options<DeleteUserData, ThrowOnError>): import("./client").RequestResult<DeleteUserResponses, DeleteUserErrors, ThrowOnError, "fields">;
|
|
278
463
|
/**
|
|
279
464
|
* Get user profile information by id.
|
|
280
|
-
*
|
|
465
|
+
*
|
|
466
|
+
* Returns user details including their roles. For more information on identity access management, see [Users](https://cloudfleet.ai/docs/organization/users/) section of documentaiton.
|
|
281
467
|
*
|
|
282
468
|
* This endpoint is available to all users in the organization.
|
|
283
469
|
*
|
|
284
470
|
*/
|
|
285
|
-
static getUser<ThrowOnError extends boolean = false>(options: Options<GetUserData, ThrowOnError>): import("
|
|
471
|
+
static getUser<ThrowOnError extends boolean = false>(options: Options<GetUserData, ThrowOnError>): import("./client").RequestResult<GetUserResponses, GetUserErrors, ThrowOnError, "fields">;
|
|
286
472
|
/**
|
|
287
473
|
* Update user profile information.
|
|
288
|
-
* 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.
|
|
289
474
|
*
|
|
290
|
-
|
|
291
|
-
static updateUser<ThrowOnError extends boolean = false>(options: Options<UpdateUserData, ThrowOnError>): import("@hey-api/client-fetch").RequestResult<import("./types.gen").User, unknown, ThrowOnError>;
|
|
292
|
-
/**
|
|
293
|
-
* Remove user from cluster.
|
|
294
|
-
* Removes user from the cluster. The user will no longer be able to access the cluster and all its resources. This endpoint is available to administrators of the organization only.
|
|
295
|
-
*
|
|
296
|
-
*/
|
|
297
|
-
static deleteClusterPermissions<ThrowOnError extends boolean = false>(options: Options<DeleteClusterPermissionsData, ThrowOnError>): import("@hey-api/client-fetch").RequestResult<import("./types.gen").User, unknown, ThrowOnError>;
|
|
298
|
-
/**
|
|
299
|
-
* Add user to cluster and set permissions.
|
|
300
|
-
* Add user to the cluster and set / update access permissions. This endpoint is available to administrators of the organization only.
|
|
475
|
+
* 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.
|
|
301
476
|
*
|
|
302
477
|
*/
|
|
303
|
-
static
|
|
478
|
+
static updateUser<ThrowOnError extends boolean = false>(options: Options<UpdateUserData, ThrowOnError>): import("./client").RequestResult<UpdateUserResponses, unknown, ThrowOnError, "fields">;
|
|
304
479
|
}
|
|
305
480
|
//# sourceMappingURL=sdk.gen.d.ts.map
|