@cloudfleet/sdk 0.0.1-76e2a56 → 0.0.1-79703f6
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 +1125 -0
- package/dist/@tanstack/react-query.gen.d.ts.map +1 -0
- package/dist/@tanstack/react-query.gen.js +1129 -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 +1505 -866
- package/dist/schemas.gen.d.ts.map +1 -1
- package/dist/schemas.gen.js +2809 -953
- package/dist/schemas.gen.js.map +1 -1
- package/dist/sdk.gen.d.ts +242 -142
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/sdk.gen.js +336 -225
- 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 +1373 -830
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/zod.gen.d.ts +3687 -2423
- package/dist/zod.gen.d.ts.map +1 -1
- package/dist/zod.gen.js +1523 -857
- 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, DeleteClusterResponses, DeleteFleetData, DeleteFleetResponses, DeleteInviteData, DeleteInviteResponses, 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, GetPaymentMethodData, GetPaymentMethodErrors, GetPaymentMethodResponses, 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, 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, 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,351 +16,451 @@ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends
|
|
|
16
16
|
export declare class BillingService {
|
|
17
17
|
/**
|
|
18
18
|
* Get billing usage information.
|
|
19
|
-
* 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.
|
|
20
19
|
*
|
|
21
|
-
|
|
22
|
-
static getUsage<ThrowOnError extends boolean = false>(options?: Options<GetUsageData, ThrowOnError>): import("@hey-api/client-fetch").RequestResult<import("./types.gen").Usage[], unknown, ThrowOnError>;
|
|
23
|
-
/**
|
|
24
|
-
* Get billing balance information.
|
|
25
|
-
* Returns the current balance of the organization in USD as a floating-point number. 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
|
+
* 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.
|
|
26
21
|
*
|
|
27
22
|
*/
|
|
28
|
-
static
|
|
23
|
+
static getUsage<ThrowOnError extends boolean = false>(options?: Options<GetUsageData, ThrowOnError>): import("./client").RequestResult<GetUsageResponses, GetUsageErrors, ThrowOnError, "fields">;
|
|
29
24
|
/**
|
|
30
25
|
* Get organization payment method information.
|
|
26
|
+
*
|
|
31
27
|
* Returns the information about the payment card associated with the organization with sensitive information redacted. Payment details can be updated in the Cloudfleet console only, please visit https://console.cloudfleet.ai. This endpoint is available to all users in the organization.
|
|
32
28
|
*
|
|
33
29
|
*/
|
|
34
|
-
static getPaymentMethod<ThrowOnError extends boolean = false>(options?: Options<GetPaymentMethodData, ThrowOnError>): import("
|
|
30
|
+
static getPaymentMethod<ThrowOnError extends boolean = false>(options?: Options<GetPaymentMethodData, ThrowOnError>): import("./client").RequestResult<GetPaymentMethodResponses, GetPaymentMethodErrors, ThrowOnError, "fields">;
|
|
35
31
|
/**
|
|
36
32
|
* Get Stripe client secret.
|
|
33
|
+
*
|
|
37
34
|
* 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.
|
|
38
35
|
*
|
|
39
36
|
*/
|
|
40
|
-
static getPaymentMethodSecret<ThrowOnError extends boolean = false>(options?: Options<GetPaymentMethodSecretData, ThrowOnError>): import("
|
|
41
|
-
id?: string;
|
|
42
|
-
}, unknown, ThrowOnError>;
|
|
37
|
+
static getPaymentMethodSecret<ThrowOnError extends boolean = false>(options?: Options<GetPaymentMethodSecretData, ThrowOnError>): import("./client").RequestResult<GetPaymentMethodSecretResponses, unknown, ThrowOnError, "fields">;
|
|
43
38
|
/**
|
|
44
39
|
* List issued invoices.
|
|
45
|
-
* 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.
|
|
46
40
|
*
|
|
47
|
-
|
|
48
|
-
static listInvoices<ThrowOnError extends boolean = false>(options: Options<ListInvoicesData, ThrowOnError>): import("@hey-api/client-fetch").RequestResult<import("./types.gen").Invoice[], unknown, ThrowOnError>;
|
|
49
|
-
/**
|
|
50
|
-
* Get invoice information.
|
|
51
|
-
* Returns a single Invoice as HTML referenced by id. This endpoint is available to all users in the organization.
|
|
41
|
+
* 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
42
|
*
|
|
53
43
|
*/
|
|
54
|
-
static
|
|
55
|
-
html?: string;
|
|
56
|
-
}, unknown, ThrowOnError>;
|
|
44
|
+
static listInvoices<ThrowOnError extends boolean = false>(options?: Options<ListInvoicesData, ThrowOnError>): import("./client").RequestResult<ListInvoicesResponses, ListInvoicesErrors, ThrowOnError, "fields">;
|
|
57
45
|
/**
|
|
58
46
|
* Get organization contact and billing address information.
|
|
47
|
+
*
|
|
59
48
|
* Returns the organization contact and billing address information. This endpoint is available to all users in the organization.
|
|
60
49
|
*
|
|
61
50
|
*/
|
|
62
|
-
static getContact<ThrowOnError extends boolean = false>(options?: Options<GetContactData, ThrowOnError>): import("
|
|
51
|
+
static getContact<ThrowOnError extends boolean = false>(options?: Options<GetContactData, ThrowOnError>): import("./client").RequestResult<GetContactResponses, unknown, ThrowOnError, "fields">;
|
|
63
52
|
/**
|
|
64
53
|
* Update organization contact information and billing address.
|
|
54
|
+
*
|
|
65
55
|
* This endpoint allows you to update organization details with its contact information. This endpoint is available to administrators of the organization only.
|
|
66
56
|
*
|
|
67
57
|
*/
|
|
68
|
-
static updateContact<ThrowOnError extends boolean = false>(options: Options<UpdateContactData, ThrowOnError>): import("
|
|
58
|
+
static updateContact<ThrowOnError extends boolean = false>(options: Options<UpdateContactData, ThrowOnError>): import("./client").RequestResult<UpdateContactResponses, unknown, ThrowOnError, "fields">;
|
|
59
|
+
/**
|
|
60
|
+
* Get applied promotional credits
|
|
61
|
+
*
|
|
62
|
+
* 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.
|
|
63
|
+
*
|
|
64
|
+
*/
|
|
65
|
+
static getCredits<ThrowOnError extends boolean = false>(options?: Options<GetCreditsData, ThrowOnError>): import("./client").RequestResult<GetCreditsResponses, GetCreditsErrors, ThrowOnError, "fields">;
|
|
66
|
+
/**
|
|
67
|
+
* Redeem promotional credits code.
|
|
68
|
+
*
|
|
69
|
+
* 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.
|
|
70
|
+
*
|
|
71
|
+
*/
|
|
72
|
+
static redeemCredits<ThrowOnError extends boolean = false>(options: Options<RedeemCreditsData, ThrowOnError>): import("./client").RequestResult<RedeemCreditsResponses, RedeemCreditsErrors, ThrowOnError, "fields">;
|
|
69
73
|
}
|
|
70
74
|
export declare class ClustersService {
|
|
75
|
+
/**
|
|
76
|
+
* List charts.
|
|
77
|
+
*
|
|
78
|
+
* Returns a list of charts in the cluster.
|
|
79
|
+
*
|
|
80
|
+
* This endpoint is available to all users in the organization.
|
|
81
|
+
*
|
|
82
|
+
*/
|
|
83
|
+
static listCharts<ThrowOnError extends boolean = false>(options: Options<ListChartsData, ThrowOnError>): import("./client").RequestResult<ListChartsResponses, ListChartsErrors, ThrowOnError, "fields">;
|
|
84
|
+
/**
|
|
85
|
+
* Create a new chart.
|
|
86
|
+
*
|
|
87
|
+
* Create a new chart deployment.
|
|
88
|
+
*
|
|
89
|
+
* This endpoint is available to administrators of the organization only.
|
|
90
|
+
*
|
|
91
|
+
*/
|
|
92
|
+
static createChart<ThrowOnError extends boolean = false>(options: Options<CreateChartData, ThrowOnError>): import("./client").RequestResult<CreateChartResponses, unknown, ThrowOnError, "fields">;
|
|
93
|
+
/**
|
|
94
|
+
* Permanently delete the chart deployment from the cluster.
|
|
95
|
+
*
|
|
96
|
+
* This endpoint will permanently delete chart. This operation cannot be undone.
|
|
97
|
+
*
|
|
98
|
+
* This endpoint is available to administrators of the organization only.
|
|
99
|
+
*
|
|
100
|
+
*/
|
|
101
|
+
static deleteChart<ThrowOnError extends boolean = false>(options: Options<DeleteChartData, ThrowOnError>): import("./client").RequestResult<DeleteChartResponses, unknown, ThrowOnError, "fields">;
|
|
102
|
+
/**
|
|
103
|
+
* Get chart information.
|
|
104
|
+
*
|
|
105
|
+
* Returns the details of the chart deployment.
|
|
106
|
+
*
|
|
107
|
+
* This endpoint is available to all users in the organization.
|
|
108
|
+
*
|
|
109
|
+
*/
|
|
110
|
+
static getChart<ThrowOnError extends boolean = false>(options: Options<GetChartData, ThrowOnError>): import("./client").RequestResult<GetChartResponses, unknown, ThrowOnError, "fields">;
|
|
111
|
+
/**
|
|
112
|
+
* Update chart information.
|
|
113
|
+
*
|
|
114
|
+
* This endpoint allows you to update the values of a chart deployment.
|
|
115
|
+
*
|
|
116
|
+
* This endpoint is available to administrators of the organization only.
|
|
117
|
+
*
|
|
118
|
+
*/
|
|
119
|
+
static updateChart<ThrowOnError extends boolean = false>(options: Options<UpdateChartData, ThrowOnError>): import("./client").RequestResult<UpdateChartResponses, unknown, ThrowOnError, "fields">;
|
|
71
120
|
/**
|
|
72
121
|
* List fleets.
|
|
73
|
-
*
|
|
122
|
+
*
|
|
123
|
+
* 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
124
|
*
|
|
75
125
|
* This endpoint is available to all users in the organization.
|
|
76
126
|
*
|
|
77
127
|
*/
|
|
78
|
-
static listFleets<ThrowOnError extends boolean = false>(options: Options<ListFleetsData, ThrowOnError>): import("
|
|
128
|
+
static listFleets<ThrowOnError extends boolean = false>(options: Options<ListFleetsData, ThrowOnError>): import("./client").RequestResult<ListFleetsResponses, ListFleetsErrors, ThrowOnError, "fields">;
|
|
79
129
|
/**
|
|
80
130
|
* Create a new fleet.
|
|
81
|
-
*
|
|
131
|
+
*
|
|
132
|
+
* 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
133
|
*
|
|
83
134
|
* This endpoint is available to administrators of the organization only.
|
|
84
135
|
*
|
|
85
136
|
*/
|
|
86
|
-
static createFleet<ThrowOnError extends boolean = false>(options: Options<CreateFleetData, ThrowOnError>): import("
|
|
137
|
+
static createFleet<ThrowOnError extends boolean = false>(options: Options<CreateFleetData, ThrowOnError>): import("./client").RequestResult<CreateFleetResponses, CreateFleetErrors, ThrowOnError, "fields">;
|
|
87
138
|
/**
|
|
88
139
|
* Permanently delete fleet.
|
|
89
|
-
*
|
|
140
|
+
*
|
|
141
|
+
* This endpoint will permanently delete fleet. This operation cannot be undone. Your subscription will end by the end of the current billing period and you will not be able to receive credit for unused time. If you want to keep using the Fleet until the end of the billing period, set the status to `cancelling`. For more information, see [Fleets](https://cloudfleet.ai/docs/cloud-infrastructure/fleets/) section of documentaiton.
|
|
90
142
|
*
|
|
91
143
|
* This endpoint is available to administrators of the organization only.
|
|
92
144
|
*
|
|
93
145
|
*/
|
|
94
|
-
static deleteFleet<ThrowOnError extends boolean = false>(options: Options<DeleteFleetData, ThrowOnError>): import("
|
|
146
|
+
static deleteFleet<ThrowOnError extends boolean = false>(options: Options<DeleteFleetData, ThrowOnError>): import("./client").RequestResult<DeleteFleetResponses, unknown, ThrowOnError, "fields">;
|
|
95
147
|
/**
|
|
96
148
|
* Get fleet information.
|
|
97
|
-
*
|
|
149
|
+
*
|
|
150
|
+
* Returns fleet details. For more information, see [Fleets](https://cloudfleet.ai/docs/cloud-infrastructure/fleets/) section of documentaiton.
|
|
98
151
|
*
|
|
99
152
|
* This endpoint is available to all users in the organization.
|
|
100
153
|
*
|
|
101
154
|
*/
|
|
102
|
-
static getFleet<ThrowOnError extends boolean = false>(options: Options<GetFleetData, ThrowOnError>): import("
|
|
155
|
+
static getFleet<ThrowOnError extends boolean = false>(options: Options<GetFleetData, ThrowOnError>): import("./client").RequestResult<GetFleetResponses, unknown, ThrowOnError, "fields">;
|
|
103
156
|
/**
|
|
104
157
|
* Update fleet information.
|
|
158
|
+
*
|
|
105
159
|
* This endpoint allows you to update fleet details.
|
|
106
160
|
*
|
|
107
|
-
* Setting status to `deleted` will permanently delete fleet. This operation cannot be undone. Your subscription will end by the end of the current billing period and you will not be able to receive credit for unused time. If you want to keep using the
|
|
161
|
+
* Setting status to `deleted` will permanently delete fleet. This operation cannot be undone. Your subscription will end by the end of the current billing period and you will not be able to receive credit for unused time. If you want to keep using the Fleet until the end of the billing period, set the status to `cancelling`.
|
|
108
162
|
*
|
|
109
|
-
* For more information, see [Fleets
|
|
163
|
+
* For more information, see [Fleets](https://cloudfleet.ai/docs/cloud-infrastructure/fleets/) section of documentaiton.
|
|
110
164
|
*
|
|
111
165
|
* This endpoint is available to administrators of the organization only.
|
|
112
166
|
*
|
|
113
167
|
*/
|
|
114
|
-
static updateFleet<ThrowOnError extends boolean = false>(options: Options<UpdateFleetData, ThrowOnError>): import("
|
|
168
|
+
static updateFleet<ThrowOnError extends boolean = false>(options: Options<UpdateFleetData, ThrowOnError>): import("./client").RequestResult<UpdateFleetResponses, UpdateFleetErrors, ThrowOnError, "fields">;
|
|
115
169
|
/**
|
|
116
170
|
* Query Kubernetes cluster API
|
|
171
|
+
*
|
|
117
172
|
* 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
173
|
*/
|
|
119
|
-
static queryCluster<ThrowOnError extends boolean = false>(options: Options<QueryClusterData, ThrowOnError>): import("
|
|
174
|
+
static queryCluster<ThrowOnError extends boolean = false>(options: Options<QueryClusterData, ThrowOnError>): import("./client").RequestResult<QueryClusterResponses, QueryClusterErrors, ThrowOnError, "fields">;
|
|
120
175
|
/**
|
|
121
176
|
* List clusters.
|
|
177
|
+
*
|
|
122
178
|
* Returns a list of clusters under the current organization, 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.
|
|
123
179
|
*
|
|
124
180
|
* This endpoint is available to all users in the organization.
|
|
125
181
|
*
|
|
126
182
|
*/
|
|
127
|
-
static listClusters<ThrowOnError extends boolean = false>(options?: Options<ListClustersData, ThrowOnError>): import("
|
|
183
|
+
static listClusters<ThrowOnError extends boolean = false>(options?: Options<ListClustersData, ThrowOnError>): import("./client").RequestResult<ListClustersResponses, ListClustersErrors, ThrowOnError, "fields">;
|
|
128
184
|
/**
|
|
129
185
|
* Create a new cluster.
|
|
186
|
+
*
|
|
130
187
|
* 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
188
|
*
|
|
132
189
|
* This endpoint is available to administrators of the organization only.
|
|
133
190
|
*
|
|
134
191
|
*/
|
|
135
|
-
static createCluster<ThrowOnError extends boolean = false>(options: Options<CreateClusterData, ThrowOnError>): import("
|
|
192
|
+
static createCluster<ThrowOnError extends boolean = false>(options: Options<CreateClusterData, ThrowOnError>): import("./client").RequestResult<CreateClusterResponses, CreateClusterErrors, ThrowOnError, "fields">;
|
|
136
193
|
/**
|
|
137
194
|
* Permanently delete cluster.
|
|
195
|
+
*
|
|
138
196
|
* This endpoint will permanently delete the cluster. This operation cannot be undone.
|
|
139
197
|
*
|
|
140
198
|
* This endpoint is available to administrators of the organization only.
|
|
141
199
|
*
|
|
142
200
|
*/
|
|
143
|
-
static deleteCluster<ThrowOnError extends boolean = false>(options: Options<DeleteClusterData, ThrowOnError>): import("
|
|
201
|
+
static deleteCluster<ThrowOnError extends boolean = false>(options: Options<DeleteClusterData, ThrowOnError>): import("./client").RequestResult<DeleteClusterResponses, unknown, ThrowOnError, "fields">;
|
|
144
202
|
/**
|
|
145
203
|
* Get cluster information.
|
|
204
|
+
*
|
|
146
205
|
* 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.
|
|
147
206
|
*
|
|
148
207
|
* This endpoint is available to all users in the organization.
|
|
149
208
|
*
|
|
150
209
|
*/
|
|
151
|
-
static getCluster<ThrowOnError extends boolean = false>(options: Options<GetClusterData, ThrowOnError>): import("
|
|
210
|
+
static getCluster<ThrowOnError extends boolean = false>(options: Options<GetClusterData, ThrowOnError>): import("./client").RequestResult<GetClusterResponses, unknown, ThrowOnError, "fields">;
|
|
152
211
|
/**
|
|
153
212
|
* Update cluster information.
|
|
213
|
+
*
|
|
154
214
|
* 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.
|
|
155
215
|
*
|
|
156
216
|
* This endpoint is available to administrators of the organization only.
|
|
157
217
|
*
|
|
158
218
|
*/
|
|
159
|
-
static updateCluster<ThrowOnError extends boolean = false>(options: Options<UpdateClusterData, ThrowOnError>): import("
|
|
219
|
+
static updateCluster<ThrowOnError extends boolean = false>(options: Options<UpdateClusterData, ThrowOnError>): import("./client").RequestResult<UpdateClusterResponses, unknown, ThrowOnError, "fields">;
|
|
160
220
|
/**
|
|
161
221
|
* Node join information for the cluster
|
|
162
|
-
*
|
|
222
|
+
*
|
|
223
|
+
* 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
224
|
*
|
|
164
225
|
*/
|
|
165
|
-
static getJoinInformation<ThrowOnError extends boolean = false>(options: Options<GetJoinInformationData, ThrowOnError>): import("
|
|
166
|
-
}
|
|
167
|
-
export declare class InfrastructureService {
|
|
168
|
-
/**
|
|
169
|
-
* Search infrastructure catalog.
|
|
170
|
-
* This endpoint is used to search the infrastructure catalog for the right virtual machine / instance type when creating a new task. The search is performed by specifying a set of filters. The filters are combined using the logical AND operator. For example, if you want to find all available instances with Nvidia A100 GPUs in the US, you would use the following query:
|
|
171
|
-
*
|
|
172
|
-
* `GET /infrastructure?accelerator_name=A100®ion=northamerica`
|
|
173
|
-
*
|
|
174
|
-
* Catalog is dynamic and updated regularly to reflect the latest changes in the cloud providers' offerings. Although we try to keep the catalog up to date, it is possible that some instances are missing or that some information is outdated. It is possible that the final price you will see in the billing section will be different from the price shown in the catalog. Additionally, catalog does not account for any limitaitons and quotas set by the cloud providers, as well as current availability of specific instance types.
|
|
175
|
-
*
|
|
176
|
-
* **Note:** This endpoint is available for both authenticated and unauthenticated users. However, unauthenticated users will only see limited results and will be rate limited. To get full access to the catalog, please create a Cloudfleet account and log in.
|
|
177
|
-
*
|
|
178
|
-
* For full documentation of the infrastructure catalog, see [Cloud providers and instance types](https://cloudfleet.ai/docs/cloud-infrastructure/) section of the documentation.
|
|
179
|
-
*
|
|
180
|
-
*/
|
|
181
|
-
static getInfrastructure<ThrowOnError extends boolean = false>(options?: Options<GetInfrastructureData, ThrowOnError>): import("@hey-api/client-fetch").RequestResult<import("./types.gen").InfrastructureInstance[], string, ThrowOnError>;
|
|
182
|
-
/**
|
|
183
|
-
* Infrastructure catalog facets.
|
|
184
|
-
* This endpoint returns calculated search facets from the infrastructure catalog.
|
|
185
|
-
*
|
|
186
|
-
*/
|
|
187
|
-
static getFacets<ThrowOnError extends boolean = false>(options?: Options<GetFacetsData, ThrowOnError>): import("@hey-api/client-fetch").RequestResult<{
|
|
188
|
-
provider?: Array<string>;
|
|
189
|
-
region?: Array<string>;
|
|
190
|
-
sub_region?: Array<string>;
|
|
191
|
-
csp_region?: Array<string>;
|
|
192
|
-
vcpu_min?: number;
|
|
193
|
-
vcpu_max?: number;
|
|
194
|
-
memory_min?: number;
|
|
195
|
-
memory_max?: number;
|
|
196
|
-
storage_local_min?: number;
|
|
197
|
-
storage_local_max?: number;
|
|
198
|
-
accelerator_name?: Array<string>;
|
|
199
|
-
accelerator_manufacturer?: Array<string>;
|
|
200
|
-
accelerator_count_min?: number;
|
|
201
|
-
accelerator_count_max?: number;
|
|
202
|
-
accelerator_memory_min?: number;
|
|
203
|
-
accelerator_memory_max?: number;
|
|
204
|
-
price_min?: number;
|
|
205
|
-
price_max?: number;
|
|
206
|
-
regions_struct?: Array<{
|
|
207
|
-
region?: string;
|
|
208
|
-
sub_region?: Array<string>;
|
|
209
|
-
}>;
|
|
210
|
-
accelerators_struct?: Array<{
|
|
211
|
-
accelerator_manufacturer?: string;
|
|
212
|
-
accelerator_name?: Array<string>;
|
|
213
|
-
}>;
|
|
214
|
-
count_total?: number;
|
|
215
|
-
count_accelerators?: number;
|
|
216
|
-
count_instance_types?: number;
|
|
217
|
-
count_accelerators_instance_types?: number;
|
|
218
|
-
}[], unknown, ThrowOnError>;
|
|
219
|
-
/**
|
|
220
|
-
* Available Cloudfleet regions and Kubernetes versions.
|
|
221
|
-
* Available Cloudfleet regions and Kubernetes versions.
|
|
222
|
-
*
|
|
223
|
-
*/
|
|
224
|
-
static getRegions<ThrowOnError extends boolean = false>(options?: Options<GetRegionsData, ThrowOnError>): import("@hey-api/client-fetch").RequestResult<{
|
|
225
|
-
[key: string]: unknown;
|
|
226
|
-
}, unknown, ThrowOnError>;
|
|
226
|
+
static getJoinInformation<ThrowOnError extends boolean = false>(options: Options<GetJoinInformationData, ThrowOnError>): import("./client").RequestResult<GetJoinInformationResponses, GetJoinInformationErrors, ThrowOnError, "fields">;
|
|
227
227
|
}
|
|
228
228
|
export declare class InvitesService {
|
|
229
229
|
/**
|
|
230
230
|
* List invites.
|
|
231
|
+
*
|
|
231
232
|
* Returns a list of invites under the current organization. This endpoint is available to all users in the organization.
|
|
232
233
|
*
|
|
233
234
|
*/
|
|
234
|
-
static listInvites<ThrowOnError extends boolean = false>(options?: Options<ListInvitesData, ThrowOnError>): import("
|
|
235
|
+
static listInvites<ThrowOnError extends boolean = false>(options?: Options<ListInvitesData, ThrowOnError>): import("./client").RequestResult<ListInvitesResponses, ListInvitesErrors, ThrowOnError, "fields">;
|
|
235
236
|
/**
|
|
236
237
|
* Create a new invite.
|
|
237
|
-
*
|
|
238
|
+
*
|
|
239
|
+
* 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.
|
|
238
240
|
*
|
|
239
241
|
*/
|
|
240
|
-
static createInvite<ThrowOnError extends boolean = false>(options: Options<CreateInviteData, ThrowOnError>): import("
|
|
242
|
+
static createInvite<ThrowOnError extends boolean = false>(options: Options<CreateInviteData, ThrowOnError>): import("./client").RequestResult<CreateInviteResponses, unknown, ThrowOnError, "fields">;
|
|
241
243
|
/**
|
|
242
244
|
* Get invite information.
|
|
245
|
+
*
|
|
243
246
|
* Returns invite details.
|
|
244
247
|
*
|
|
245
248
|
*/
|
|
246
|
-
static getInvite<ThrowOnError extends boolean = false>(options: Options<GetInviteData, ThrowOnError>): import("
|
|
249
|
+
static getInvite<ThrowOnError extends boolean = false>(options: Options<GetInviteData, ThrowOnError>): import("./client").RequestResult<GetInviteResponses, unknown, ThrowOnError, "fields">;
|
|
247
250
|
/**
|
|
248
251
|
* Permanently delete invite.
|
|
252
|
+
*
|
|
249
253
|
* Permanently deletes invite from the organization. This endpoint is available to administrators of the organization only.
|
|
250
254
|
*
|
|
251
255
|
*/
|
|
252
|
-
static deleteInvite<ThrowOnError extends boolean = false>(options: Options<DeleteInviteData, ThrowOnError>): import("
|
|
256
|
+
static deleteInvite<ThrowOnError extends boolean = false>(options: Options<DeleteInviteData, ThrowOnError>): import("./client").RequestResult<DeleteInviteResponses, unknown, ThrowOnError, "fields">;
|
|
257
|
+
}
|
|
258
|
+
export declare class ChartsMarketplaceService {
|
|
259
|
+
/**
|
|
260
|
+
* List chart listings available in the marketplace.
|
|
261
|
+
*
|
|
262
|
+
* Returns a list of available charts in the marketplace.
|
|
263
|
+
*
|
|
264
|
+
* This endpoint is available to all users in the organization.
|
|
265
|
+
*
|
|
266
|
+
*/
|
|
267
|
+
static listMarketplaceCharts<ThrowOnError extends boolean = false>(options?: Options<ListMarketplaceChartsData, ThrowOnError>): import("./client").RequestResult<ListMarketplaceChartsResponses, ListMarketplaceChartsErrors, ThrowOnError, "fields">;
|
|
268
|
+
/**
|
|
269
|
+
* Get chart files for a specific version channel.
|
|
270
|
+
*
|
|
271
|
+
* Returns the Chart.yaml, values.yaml, and values.schema.json files for the latest version matching the specified version channel.
|
|
272
|
+
*
|
|
273
|
+
* 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.
|
|
274
|
+
*
|
|
275
|
+
* This endpoint is available to all users in the organization.
|
|
276
|
+
*
|
|
277
|
+
*/
|
|
278
|
+
static getMarketplaceChartFiles<ThrowOnError extends boolean = false>(options: Options<GetMarketplaceChartFilesData, ThrowOnError>): import("./client").RequestResult<GetMarketplaceChartFilesResponses, GetMarketplaceChartFilesErrors, ThrowOnError, "fields">;
|
|
279
|
+
}
|
|
280
|
+
export declare class McpService {
|
|
281
|
+
/**
|
|
282
|
+
* MCP endpoint
|
|
283
|
+
*
|
|
284
|
+
* MCP endpoint for handling Model Context Protocol JSON-RPC 2.0 messages.
|
|
285
|
+
*/
|
|
286
|
+
static postMcp<ThrowOnError extends boolean = false>(options: Options<PostMcpData, ThrowOnError>): import("./client").RequestResult<PostMcpResponses, PostMcpErrors, ThrowOnError, "fields">;
|
|
253
287
|
}
|
|
254
288
|
export declare class OrganizationService {
|
|
255
289
|
/**
|
|
256
290
|
* Get organization information.
|
|
291
|
+
*
|
|
257
292
|
* Returns organization details including quota. For more information about quotas, see [Quotas and limits](https://cloudfleet.ai/docs/organization/quotas/) section of documentaiton.
|
|
258
293
|
*
|
|
259
294
|
* This endpoint is available to all users in the organization.
|
|
260
295
|
*
|
|
261
296
|
*/
|
|
262
|
-
static getOrganization<ThrowOnError extends boolean = false>(options?: Options<GetOrganizationData, ThrowOnError>): import("
|
|
297
|
+
static getOrganization<ThrowOnError extends boolean = false>(options?: Options<GetOrganizationData, ThrowOnError>): import("./client").RequestResult<GetOrganizationResponses, unknown, ThrowOnError, "fields">;
|
|
263
298
|
/**
|
|
264
299
|
* Create a new organization / Cloudfleet account signup.
|
|
300
|
+
*
|
|
265
301
|
* This endpoint allows you to create a new Cloudfleet organization and an administrator user.
|
|
266
302
|
*
|
|
267
303
|
*/
|
|
268
|
-
static createOrganization<ThrowOnError extends boolean = false>(options: Options<CreateOrganizationData, ThrowOnError>): import("
|
|
304
|
+
static createOrganization<ThrowOnError extends boolean = false>(options: Options<CreateOrganizationData, ThrowOnError>): import("./client").RequestResult<CreateOrganizationResponses, unknown, ThrowOnError, "fields">;
|
|
305
|
+
}
|
|
306
|
+
export declare class RegistryService {
|
|
307
|
+
/**
|
|
308
|
+
* List repositories
|
|
309
|
+
*
|
|
310
|
+
* Returns a list of repositories in the registry across all regions. This endpoint is available to all users in the organization.
|
|
311
|
+
*
|
|
312
|
+
*/
|
|
313
|
+
static listRepositories<ThrowOnError extends boolean = false>(options?: Options<ListRepositoriesData, ThrowOnError>): import("./client").RequestResult<ListRepositoriesResponses, ListRepositoriesErrors, ThrowOnError, "fields">;
|
|
314
|
+
/**
|
|
315
|
+
* List tags for a repository
|
|
316
|
+
*
|
|
317
|
+
* 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.
|
|
318
|
+
*
|
|
319
|
+
*/
|
|
320
|
+
static listTags<ThrowOnError extends boolean = false>(options: Options<ListTagsData, ThrowOnError>): import("./client").RequestResult<ListTagsResponses, ListTagsErrors, ThrowOnError, "fields">;
|
|
321
|
+
/**
|
|
322
|
+
* Delete tag
|
|
323
|
+
*
|
|
324
|
+
* Permanently deletes a specific tag from a repository. This endpoint is available to administrators of the organization only.
|
|
325
|
+
*
|
|
326
|
+
*/
|
|
327
|
+
static deleteTag<ThrowOnError extends boolean = false>(options: Options<DeleteTagData, ThrowOnError>): import("./client").RequestResult<DeleteTagResponses, DeleteTagErrors, ThrowOnError, "fields">;
|
|
328
|
+
/**
|
|
329
|
+
* Get tag details
|
|
330
|
+
*
|
|
331
|
+
* 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.
|
|
332
|
+
*
|
|
333
|
+
*/
|
|
334
|
+
static getTag<ThrowOnError extends boolean = false>(options: Options<GetTagData, ThrowOnError>): import("./client").RequestResult<GetTagResponses, GetTagErrors, ThrowOnError, "fields">;
|
|
335
|
+
}
|
|
336
|
+
export declare class TicketsService {
|
|
337
|
+
/**
|
|
338
|
+
* List tickets for the current organization.
|
|
339
|
+
*
|
|
340
|
+
* Returns all tickets belonging to the caller's organization, newest first.
|
|
341
|
+
*
|
|
342
|
+
*/
|
|
343
|
+
static listTickets<ThrowOnError extends boolean = false>(options?: Options<ListTicketsData, ThrowOnError>): import("./client").RequestResult<ListTicketsResponses, unknown, ThrowOnError, "fields">;
|
|
344
|
+
/**
|
|
345
|
+
* Create a new support ticket.
|
|
346
|
+
*
|
|
347
|
+
* 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).
|
|
348
|
+
*
|
|
349
|
+
*/
|
|
350
|
+
static createTicket<ThrowOnError extends boolean = false>(options: Options<CreateTicketData, ThrowOnError>): import("./client").RequestResult<CreateTicketResponses, unknown, ThrowOnError, "fields">;
|
|
351
|
+
/**
|
|
352
|
+
* Close a ticket (soft close).
|
|
353
|
+
*
|
|
354
|
+
* Marks the ticket as closed. Closed is a terminal state — users cannot reply to a closed ticket; a new ticket must be opened instead.
|
|
355
|
+
*
|
|
356
|
+
*/
|
|
357
|
+
static closeTicket<ThrowOnError extends boolean = false>(options: Options<CloseTicketData, ThrowOnError>): import("./client").RequestResult<CloseTicketResponses, unknown, ThrowOnError, "fields">;
|
|
358
|
+
/**
|
|
359
|
+
* Get a ticket and its messages.
|
|
360
|
+
*/
|
|
361
|
+
static getTicket<ThrowOnError extends boolean = false>(options: Options<GetTicketData, ThrowOnError>): import("./client").RequestResult<GetTicketResponses, unknown, ThrowOnError, "fields">;
|
|
362
|
+
/**
|
|
363
|
+
* Append a customer reply to a ticket.
|
|
364
|
+
*
|
|
365
|
+
* Multipart form-data with a JSON-encoded `payload` field carrying `body`, plus up to 3 `attachments` files. Returns 409 if the ticket is closed.
|
|
366
|
+
*
|
|
367
|
+
*/
|
|
368
|
+
static replyTicket<ThrowOnError extends boolean = false>(options: Options<ReplyTicketData, ThrowOnError>): import("./client").RequestResult<ReplyTicketResponses, ReplyTicketErrors, ThrowOnError, "fields">;
|
|
369
|
+
/**
|
|
370
|
+
* Download a ticket attachment.
|
|
371
|
+
*/
|
|
372
|
+
static getTicketAttachment<ThrowOnError extends boolean = false>(options: Options<GetTicketAttachmentData, ThrowOnError>): import("./client").RequestResult<GetTicketAttachmentResponses, unknown, ThrowOnError, "fields">;
|
|
269
373
|
}
|
|
270
374
|
export declare class TokensService {
|
|
271
375
|
/**
|
|
272
376
|
* List access tokens in organization.
|
|
377
|
+
*
|
|
273
378
|
* 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.
|
|
274
379
|
*
|
|
275
380
|
*/
|
|
276
|
-
static listTokens<ThrowOnError extends boolean = false>(options?: Options<ListTokensData, ThrowOnError>): import("
|
|
381
|
+
static listTokens<ThrowOnError extends boolean = false>(options?: Options<ListTokensData, ThrowOnError>): import("./client").RequestResult<ListTokensResponses, ListTokensErrors, ThrowOnError, "fields">;
|
|
277
382
|
/**
|
|
278
383
|
* Create a new access token.
|
|
384
|
+
*
|
|
279
385
|
* 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.
|
|
280
386
|
*
|
|
281
387
|
* This endpoint is available to administrators of the organization only.
|
|
282
388
|
*
|
|
283
389
|
*/
|
|
284
|
-
static createToken<ThrowOnError extends boolean = false>(options: Options<CreateTokenData, ThrowOnError>): import("
|
|
390
|
+
static createToken<ThrowOnError extends boolean = false>(options: Options<CreateTokenData, ThrowOnError>): import("./client").RequestResult<CreateTokenResponses, CreateTokenErrors, ThrowOnError, "fields">;
|
|
285
391
|
/**
|
|
286
392
|
* Permanently delete access token.
|
|
393
|
+
*
|
|
287
394
|
* 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.
|
|
288
395
|
*
|
|
289
396
|
*/
|
|
290
|
-
static deleteToken<ThrowOnError extends boolean = false>(options: Options<DeleteTokenData, ThrowOnError>): import("
|
|
397
|
+
static deleteToken<ThrowOnError extends boolean = false>(options: Options<DeleteTokenData, ThrowOnError>): import("./client").RequestResult<DeleteTokenResponses, unknown, ThrowOnError, "fields">;
|
|
291
398
|
/**
|
|
292
399
|
* Get access token information.
|
|
400
|
+
*
|
|
293
401
|
* 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.
|
|
294
402
|
*
|
|
295
403
|
*/
|
|
296
|
-
static getToken<ThrowOnError extends boolean = false>(options: Options<GetTokenData, ThrowOnError>): import("
|
|
404
|
+
static getToken<ThrowOnError extends boolean = false>(options: Options<GetTokenData, ThrowOnError>): import("./client").RequestResult<GetTokenResponses, GetTokenErrors, ThrowOnError, "fields">;
|
|
297
405
|
/**
|
|
298
406
|
* Update access token information.
|
|
407
|
+
*
|
|
299
408
|
* 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.
|
|
300
409
|
*
|
|
301
410
|
* This endpoint is available to administrators of the organization only.
|
|
302
411
|
*
|
|
303
412
|
*/
|
|
304
|
-
static updateToken<ThrowOnError extends boolean = false>(options: Options<UpdateTokenData, ThrowOnError>): import("
|
|
413
|
+
static updateToken<ThrowOnError extends boolean = false>(options: Options<UpdateTokenData, ThrowOnError>): import("./client").RequestResult<UpdateTokenResponses, UpdateTokenErrors, ThrowOnError, "fields">;
|
|
305
414
|
/**
|
|
306
415
|
* Regenerate access token secret key.
|
|
416
|
+
*
|
|
307
417
|
* Generates a new access token secret. Old secret will not be valid anymore.
|
|
308
418
|
*/
|
|
309
|
-
static regenerateToken<ThrowOnError extends boolean = false>(options: Options<RegenerateTokenData, ThrowOnError>): import("
|
|
419
|
+
static regenerateToken<ThrowOnError extends boolean = false>(options: Options<RegenerateTokenData, ThrowOnError>): import("./client").RequestResult<RegenerateTokenResponses, RegenerateTokenErrors, ThrowOnError, "fields">;
|
|
310
420
|
}
|
|
311
421
|
export declare class UsersService {
|
|
312
422
|
/**
|
|
313
423
|
* Get a list of organizations the user belongs to. Used during authentication process.
|
|
314
424
|
*/
|
|
315
|
-
static listUserOrganizations<ThrowOnError extends boolean = false>(options: Options<ListUserOrganizationsData, ThrowOnError>): import("
|
|
316
|
-
realm?: string;
|
|
317
|
-
displayName?: string;
|
|
318
|
-
}[], unknown, ThrowOnError>;
|
|
425
|
+
static listUserOrganizations<ThrowOnError extends boolean = false>(options: Options<ListUserOrganizationsData, ThrowOnError>): import("./client").RequestResult<ListUserOrganizationsResponses, unknown, ThrowOnError, "fields">;
|
|
319
426
|
/**
|
|
320
427
|
* List users in organization.
|
|
321
|
-
*
|
|
428
|
+
*
|
|
429
|
+
* 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.
|
|
322
430
|
*
|
|
323
431
|
* This endpoint is available to all users in the organization.
|
|
324
432
|
*
|
|
325
433
|
*/
|
|
326
|
-
static listUsers<ThrowOnError extends boolean = false>(options?: Options<ListUsersData, ThrowOnError>): import("
|
|
434
|
+
static listUsers<ThrowOnError extends boolean = false>(options?: Options<ListUsersData, ThrowOnError>): import("./client").RequestResult<ListUsersResponses, ListUsersErrors, ThrowOnError, "fields">;
|
|
327
435
|
/**
|
|
328
436
|
* Create a new user.
|
|
329
|
-
*
|
|
437
|
+
*
|
|
438
|
+
* 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.
|
|
330
439
|
*
|
|
331
440
|
*/
|
|
332
|
-
static createUser<ThrowOnError extends boolean = false>(options: Options<CreateUserData, ThrowOnError>): import("
|
|
441
|
+
static createUser<ThrowOnError extends boolean = false>(options: Options<CreateUserData, ThrowOnError>): import("./client").RequestResult<CreateUserResponses, unknown, ThrowOnError, "fields">;
|
|
333
442
|
/**
|
|
334
443
|
* Delete user by id.
|
|
444
|
+
*
|
|
335
445
|
* Sets user status to `inactive`. Inactive users cannot log in and manage organization resources. This endpoint is available to administrators of the organization only.
|
|
336
446
|
*
|
|
337
447
|
*/
|
|
338
|
-
static deleteUser<ThrowOnError extends boolean = false>(options: Options<DeleteUserData, ThrowOnError>): import("
|
|
448
|
+
static deleteUser<ThrowOnError extends boolean = false>(options: Options<DeleteUserData, ThrowOnError>): import("./client").RequestResult<DeleteUserResponses, DeleteUserErrors, ThrowOnError, "fields">;
|
|
339
449
|
/**
|
|
340
450
|
* Get user profile information by id.
|
|
341
|
-
*
|
|
451
|
+
*
|
|
452
|
+
* Returns user details including their roles. For more information on identity access management, see [Users](https://cloudfleet.ai/docs/organization/users/) section of documentaiton.
|
|
342
453
|
*
|
|
343
454
|
* This endpoint is available to all users in the organization.
|
|
344
455
|
*
|
|
345
456
|
*/
|
|
346
|
-
static getUser<ThrowOnError extends boolean = false>(options: Options<GetUserData, ThrowOnError>): import("
|
|
457
|
+
static getUser<ThrowOnError extends boolean = false>(options: Options<GetUserData, ThrowOnError>): import("./client").RequestResult<GetUserResponses, GetUserErrors, ThrowOnError, "fields">;
|
|
347
458
|
/**
|
|
348
459
|
* Update user profile information.
|
|
349
|
-
* 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.
|
|
350
|
-
*
|
|
351
|
-
*/
|
|
352
|
-
static updateUser<ThrowOnError extends boolean = false>(options: Options<UpdateUserData, ThrowOnError>): import("@hey-api/client-fetch").RequestResult<import("./types.gen").User, unknown, ThrowOnError>;
|
|
353
|
-
/**
|
|
354
|
-
* Remove user from cluster.
|
|
355
|
-
* 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.
|
|
356
460
|
*
|
|
357
|
-
|
|
358
|
-
static deleteClusterPermissions<ThrowOnError extends boolean = false>(options: Options<DeleteClusterPermissionsData, ThrowOnError>): import("@hey-api/client-fetch").RequestResult<import("./types.gen").User, unknown, ThrowOnError>;
|
|
359
|
-
/**
|
|
360
|
-
* Add user to cluster and set permissions.
|
|
361
|
-
* Add user to the cluster and set / update access permissions. This endpoint is available to administrators of the organization only.
|
|
461
|
+
* 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.
|
|
362
462
|
*
|
|
363
463
|
*/
|
|
364
|
-
static
|
|
464
|
+
static updateUser<ThrowOnError extends boolean = false>(options: Options<UpdateUserData, ThrowOnError>): import("./client").RequestResult<UpdateUserResponses, unknown, ThrowOnError, "fields">;
|
|
365
465
|
}
|
|
366
466
|
//# sourceMappingURL=sdk.gen.d.ts.map
|