@cloudfleet/sdk 0.12.3 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +26 -2
- package/dist/@tanstack/react-query.gen.d.ts +437 -387
- package/dist/@tanstack/react-query.gen.d.ts.map +1 -1
- package/dist/@tanstack/react-query.gen.js +458 -408
- package/dist/@tanstack/react-query.gen.js.map +1 -1
- package/dist/client/client.gen.d.ts.map +1 -1
- package/dist/client/client.gen.js +1 -4
- package/dist/client/client.gen.js.map +1 -1
- package/dist/client/types.gen.d.ts +1 -1
- package/dist/client/types.gen.d.ts.map +1 -1
- package/dist/client/utils.gen.d.ts +2 -2
- package/dist/client/utils.gen.d.ts.map +1 -1
- package/dist/client/utils.gen.js +3 -3
- package/dist/client/utils.gen.js.map +1 -1
- package/dist/core/params.gen.js +4 -4
- package/dist/core/params.gen.js.map +1 -1
- package/dist/schemas.gen.d.ts +360 -177
- package/dist/schemas.gen.d.ts.map +1 -1
- package/dist/schemas.gen.js +493 -229
- package/dist/schemas.gen.js.map +1 -1
- package/dist/sdk.gen.d.ts +244 -218
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/sdk.gen.js +353 -316
- package/dist/sdk.gen.js.map +1 -1
- package/dist/types.gen.d.ts +991 -803
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/zod.gen.d.ts +1560 -1316
- package/dist/zod.gen.d.ts.map +1 -1
- package/dist/zod.gen.js +465 -314
- package/dist/zod.gen.js.map +1 -1
- package/package.json +8 -11
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { type DefaultError, type UseMutationOptions } from '@tanstack/react-query';
|
|
2
2
|
import { type Options } from '../sdk.gen';
|
|
3
|
-
import type { CloseTicketData, CloseTicketResponse, CreateChartData, CreateChartResponse, CreateClusterData, CreateClusterError, CreateClusterResponse, CreateFleetData, CreateFleetError, CreateFleetResponse, CreateInviteData, CreateInviteResponse, CreateOrganizationData, CreateOrganizationResponse, CreateTicketData, CreateTicketResponse, CreateTokenData, CreateTokenResponse, CreateUserData, CreateUserResponse, DeleteChartData, DeleteChartResponse, DeleteClusterData, DeleteClusterResponse, DeleteFleetData, DeleteFleetResponse, DeleteInviteData, DeletePaymentMethodData, DeletePaymentMethodResponse, DeleteTagData, DeleteTokenData, DeleteUserData, DeleteUserResponse, GetChartData, GetClusterData, GetContactData, GetCreditsData, GetFleetData, GetInviteData, GetJoinInformationData, GetJoinInformationResponse, GetMarketplaceChartFilesData, GetOrganizationData, GetPaymentMethodSecretData, GetPaymentMethodSecretResponse, GetTagData, GetTicketAttachmentData, GetTicketData, GetTokenData, GetUsageData, GetUserData, ListChartsData, ListClustersData, ListFleetsData, ListInvitesData, ListInvoicesData, ListMarketplaceChartsData, ListPaymentMethodsData, ListRepositoriesData, ListTagsData, ListTicketsData, ListTokensData, ListUserOrganizationsData, ListUsersData, PostMcpData, PostMcpResponse, QueryClusterData, RedeemCreditsData, RegenerateTokenData, RegenerateTokenResponse, ReplyTicketData, ReplyTicketResponse, SetDefaultPaymentMethodData, SetDefaultPaymentMethodResponse, UpdateChartData, UpdateChartResponse, UpdateClusterData, UpdateClusterResponse, UpdateContactData, UpdateContactResponse, UpdateFleetData, UpdateFleetError, UpdateFleetResponse, UpdateTokenData, UpdateTokenResponse, UpdateUserData, UpdateUserResponse } from '../types.gen';
|
|
3
|
+
import type { CloseTicketData, CloseTicketResponse, CreateChartData, CreateChartError, CreateChartResponse, CreateClusterData, CreateClusterError, CreateClusterResponse, CreateFleetData, CreateFleetError, CreateFleetResponse, CreateInviteData, CreateInviteResponse, CreateOrganizationData, CreateOrganizationResponse, CreateTicketData, CreateTicketResponse, CreateTokenData, CreateTokenResponse, CreateUserData, CreateUserResponse, DeleteChartData, DeleteChartError, DeleteChartResponse, DeleteClusterData, DeleteClusterError, DeleteClusterResponse, DeleteFleetData, DeleteFleetError, DeleteFleetResponse, DeleteInviteData, DeletePaymentMethodData, DeletePaymentMethodResponse, DeleteTagData, DeleteTokenData, DeleteUserData, DeleteUserResponse, GetBasicPriceConsentData, GetChartData, GetClusterData, GetContactData, GetCreditsData, GetFleetData, GetInviteData, GetJoinInformationData, GetJoinInformationError, GetJoinInformationResponse, GetMarketplaceChartFilesData, GetOrganizationData, GetPaymentMethodSecretData, GetPaymentMethodSecretResponse, GetTagData, GetTicketAttachmentData, GetTicketData, GetTokenData, GetUsageData, GetUserData, ListChartsData, ListClustersData, ListFleetsData, ListInvitesData, ListInvoicesData, ListMarketplaceChartsData, ListPaymentMethodsData, ListRepositoriesData, ListTagsData, ListTicketsData, ListTokensData, ListUserOrganizationsData, ListUsersData, PostMcpData, PostMcpResponse, QueryClusterData, RedeemCreditsData, RegenerateTokenData, RegenerateTokenResponse, ReplyTicketData, ReplyTicketResponse, SetBasicPriceConsentData, SetBasicPriceConsentResponse, SetDefaultPaymentMethodData, SetDefaultPaymentMethodResponse, UpdateChartData, UpdateChartError, UpdateChartResponse, UpdateClusterData, UpdateClusterError, UpdateClusterResponse, UpdateContactData, UpdateContactResponse, UpdateFleetData, UpdateFleetError, UpdateFleetResponse, UpdateTokenData, UpdateTokenResponse, UpdateUserData, UpdateUserResponse } from '../types.gen';
|
|
4
4
|
export type QueryKey<TOptions extends Options> = [
|
|
5
5
|
Pick<TOptions, 'baseUrl' | 'body' | 'headers' | 'path' | 'query'> & {
|
|
6
6
|
_id: string;
|
|
@@ -8,514 +8,588 @@ export type QueryKey<TOptions extends Options> = [
|
|
|
8
8
|
tags?: ReadonlyArray<string>;
|
|
9
9
|
}
|
|
10
10
|
];
|
|
11
|
-
export declare const
|
|
11
|
+
export declare const listUserOrganizationsQueryKey: (options: Options<ListUserOrganizationsData>) => [Pick<Options<ListUserOrganizationsData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
12
12
|
_id: string;
|
|
13
13
|
_infinite?: boolean;
|
|
14
14
|
tags?: ReadonlyArray<string>;
|
|
15
15
|
}];
|
|
16
16
|
/**
|
|
17
|
-
* Get
|
|
18
|
-
*
|
|
19
|
-
* 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
|
-
*
|
|
17
|
+
* Get a list of organizations the user belongs to. Used during authentication process.
|
|
21
18
|
*/
|
|
22
|
-
export declare const
|
|
19
|
+
export declare const listUserOrganizationsOptions: (options: Options<ListUserOrganizationsData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<{
|
|
20
|
+
realm?: string;
|
|
21
|
+
displayName?: string;
|
|
22
|
+
}[], Error, {
|
|
23
|
+
realm?: string;
|
|
24
|
+
displayName?: string;
|
|
25
|
+
}[], [Pick<Options<ListUserOrganizationsData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
23
26
|
_id: string;
|
|
24
27
|
_infinite?: boolean;
|
|
25
28
|
tags?: ReadonlyArray<string>;
|
|
26
29
|
}]>, "queryFn"> & {
|
|
27
|
-
queryFn?: import("@tanstack/react-query").QueryFunction<
|
|
30
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<{
|
|
31
|
+
realm?: string;
|
|
32
|
+
displayName?: string;
|
|
33
|
+
}[], [Pick<Options<ListUserOrganizationsData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
28
34
|
_id: string;
|
|
29
35
|
_infinite?: boolean;
|
|
30
36
|
tags?: ReadonlyArray<string>;
|
|
31
37
|
}], never> | undefined;
|
|
32
38
|
} & {
|
|
33
|
-
queryKey: [Pick<Options<
|
|
39
|
+
queryKey: [Pick<Options<ListUserOrganizationsData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
34
40
|
_id: string;
|
|
35
41
|
_infinite?: boolean;
|
|
36
42
|
tags?: ReadonlyArray<string>;
|
|
37
43
|
}] & {
|
|
38
|
-
[dataTagSymbol]:
|
|
44
|
+
[dataTagSymbol]: {
|
|
45
|
+
realm?: string;
|
|
46
|
+
displayName?: string;
|
|
47
|
+
}[];
|
|
39
48
|
[dataTagErrorSymbol]: Error;
|
|
40
49
|
};
|
|
41
50
|
};
|
|
42
|
-
|
|
43
|
-
* Get Stripe client secret.
|
|
44
|
-
*
|
|
45
|
-
* 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.
|
|
46
|
-
*
|
|
47
|
-
*/
|
|
48
|
-
export declare const getPaymentMethodSecretMutation: (options?: Partial<Options<GetPaymentMethodSecretData>>) => UseMutationOptions<GetPaymentMethodSecretResponse, DefaultError, Options<GetPaymentMethodSecretData>>;
|
|
49
|
-
export declare const listPaymentMethodsQueryKey: (options?: Options<ListPaymentMethodsData>) => [Pick<Options<ListPaymentMethodsData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
51
|
+
export declare const listUsersQueryKey: (options?: Options<ListUsersData>) => [Pick<Options<ListUsersData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
50
52
|
_id: string;
|
|
51
53
|
_infinite?: boolean;
|
|
52
54
|
tags?: ReadonlyArray<string>;
|
|
53
55
|
}];
|
|
54
56
|
/**
|
|
55
|
-
* List
|
|
57
|
+
* List users in organization.
|
|
56
58
|
*
|
|
57
|
-
* Returns
|
|
59
|
+
* 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.
|
|
60
|
+
*
|
|
61
|
+
* This endpoint is available to all users in the organization.
|
|
58
62
|
*
|
|
59
63
|
*/
|
|
60
|
-
export declare const
|
|
64
|
+
export declare const listUsersOptions: (options?: Options<ListUsersData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen").User[], Error, import("../types.gen").User[], [Pick<Options<ListUsersData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
61
65
|
_id: string;
|
|
62
66
|
_infinite?: boolean;
|
|
63
67
|
tags?: ReadonlyArray<string>;
|
|
64
68
|
}]>, "queryFn"> & {
|
|
65
|
-
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").
|
|
69
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").User[], [Pick<Options<ListUsersData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
66
70
|
_id: string;
|
|
67
71
|
_infinite?: boolean;
|
|
68
72
|
tags?: ReadonlyArray<string>;
|
|
69
73
|
}], never> | undefined;
|
|
70
74
|
} & {
|
|
71
|
-
queryKey: [Pick<Options<
|
|
75
|
+
queryKey: [Pick<Options<ListUsersData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
72
76
|
_id: string;
|
|
73
77
|
_infinite?: boolean;
|
|
74
78
|
tags?: ReadonlyArray<string>;
|
|
75
79
|
}] & {
|
|
76
|
-
[dataTagSymbol]: import("../types.gen").
|
|
80
|
+
[dataTagSymbol]: import("../types.gen").User[];
|
|
77
81
|
[dataTagErrorSymbol]: Error;
|
|
78
82
|
};
|
|
79
83
|
};
|
|
80
84
|
/**
|
|
81
|
-
*
|
|
85
|
+
* Create a new user.
|
|
82
86
|
*
|
|
83
|
-
*
|
|
87
|
+
* 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.
|
|
84
88
|
*
|
|
85
89
|
*/
|
|
86
|
-
export declare const
|
|
90
|
+
export declare const createUserMutation: (options?: Partial<Options<CreateUserData>>) => UseMutationOptions<CreateUserResponse, DefaultError, Options<CreateUserData>>;
|
|
87
91
|
/**
|
|
88
|
-
* Delete
|
|
92
|
+
* Delete user by id.
|
|
89
93
|
*
|
|
90
|
-
*
|
|
94
|
+
* Sets user status to `inactive`. Inactive users cannot log in and manage organization resources. This endpoint is available to administrators of the organization only.
|
|
91
95
|
*
|
|
92
96
|
*/
|
|
93
|
-
export declare const
|
|
94
|
-
export declare const
|
|
97
|
+
export declare const deleteUserMutation: (options?: Partial<Options<DeleteUserData>>) => UseMutationOptions<DeleteUserResponse, DefaultError, Options<DeleteUserData>>;
|
|
98
|
+
export declare const getUserQueryKey: (options: Options<GetUserData>) => [Pick<Options<GetUserData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
95
99
|
_id: string;
|
|
96
100
|
_infinite?: boolean;
|
|
97
101
|
tags?: ReadonlyArray<string>;
|
|
98
102
|
}];
|
|
99
103
|
/**
|
|
100
|
-
*
|
|
104
|
+
* Get user profile information by id.
|
|
101
105
|
*
|
|
102
|
-
* Returns
|
|
106
|
+
* Returns user details including their roles. For more information on identity access management, see [Users](https://cloudfleet.ai/docs/organization/users/) section of documentaiton.
|
|
107
|
+
*
|
|
108
|
+
* This endpoint is available to all users in the organization.
|
|
103
109
|
*
|
|
104
110
|
*/
|
|
105
|
-
export declare const
|
|
111
|
+
export declare const getUserOptions: (options: Options<GetUserData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen").User, Error, import("../types.gen").User, [Pick<Options<GetUserData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
106
112
|
_id: string;
|
|
107
113
|
_infinite?: boolean;
|
|
108
114
|
tags?: ReadonlyArray<string>;
|
|
109
115
|
}]>, "queryFn"> & {
|
|
110
|
-
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").
|
|
116
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").User, [Pick<Options<GetUserData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
111
117
|
_id: string;
|
|
112
118
|
_infinite?: boolean;
|
|
113
119
|
tags?: ReadonlyArray<string>;
|
|
114
120
|
}], never> | undefined;
|
|
115
121
|
} & {
|
|
116
|
-
queryKey: [Pick<Options<
|
|
122
|
+
queryKey: [Pick<Options<GetUserData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
117
123
|
_id: string;
|
|
118
124
|
_infinite?: boolean;
|
|
119
125
|
tags?: ReadonlyArray<string>;
|
|
120
126
|
}] & {
|
|
121
|
-
[dataTagSymbol]: import("../types.gen").
|
|
127
|
+
[dataTagSymbol]: import("../types.gen").User;
|
|
122
128
|
[dataTagErrorSymbol]: Error;
|
|
123
129
|
};
|
|
124
130
|
};
|
|
125
|
-
|
|
131
|
+
/**
|
|
132
|
+
* Update user profile information.
|
|
133
|
+
*
|
|
134
|
+
* 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.
|
|
135
|
+
*
|
|
136
|
+
*/
|
|
137
|
+
export declare const updateUserMutation: (options?: Partial<Options<UpdateUserData>>) => UseMutationOptions<UpdateUserResponse, DefaultError, Options<UpdateUserData>>;
|
|
138
|
+
export declare const listTokensQueryKey: (options?: Options<ListTokensData>) => [Pick<Options<ListTokensData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
126
139
|
_id: string;
|
|
127
140
|
_infinite?: boolean;
|
|
128
141
|
tags?: ReadonlyArray<string>;
|
|
129
142
|
}];
|
|
130
143
|
/**
|
|
131
|
-
*
|
|
144
|
+
* List access tokens in organization.
|
|
132
145
|
*
|
|
133
|
-
*
|
|
146
|
+
* 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.
|
|
134
147
|
*
|
|
135
148
|
*/
|
|
136
|
-
export declare const
|
|
149
|
+
export declare const listTokensOptions: (options?: Options<ListTokensData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen").Token[], Error, import("../types.gen").Token[], [Pick<Options<ListTokensData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
137
150
|
_id: string;
|
|
138
151
|
_infinite?: boolean;
|
|
139
152
|
tags?: ReadonlyArray<string>;
|
|
140
153
|
}]>, "queryFn"> & {
|
|
141
|
-
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").
|
|
154
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").Token[], [Pick<Options<ListTokensData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
142
155
|
_id: string;
|
|
143
156
|
_infinite?: boolean;
|
|
144
157
|
tags?: ReadonlyArray<string>;
|
|
145
158
|
}], never> | undefined;
|
|
146
159
|
} & {
|
|
147
|
-
queryKey: [Pick<Options<
|
|
160
|
+
queryKey: [Pick<Options<ListTokensData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
148
161
|
_id: string;
|
|
149
162
|
_infinite?: boolean;
|
|
150
163
|
tags?: ReadonlyArray<string>;
|
|
151
164
|
}] & {
|
|
152
|
-
[dataTagSymbol]: import("../types.gen").
|
|
165
|
+
[dataTagSymbol]: import("../types.gen").Token[];
|
|
153
166
|
[dataTagErrorSymbol]: Error;
|
|
154
167
|
};
|
|
155
168
|
};
|
|
156
169
|
/**
|
|
157
|
-
*
|
|
170
|
+
* Create a new access token.
|
|
158
171
|
*
|
|
159
|
-
* This endpoint allows you to
|
|
172
|
+
* 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.
|
|
173
|
+
*
|
|
174
|
+
* This endpoint is available to administrators of the organization only.
|
|
160
175
|
*
|
|
161
176
|
*/
|
|
162
|
-
export declare const
|
|
163
|
-
|
|
177
|
+
export declare const createTokenMutation: (options?: Partial<Options<CreateTokenData>>) => UseMutationOptions<CreateTokenResponse, DefaultError, Options<CreateTokenData>>;
|
|
178
|
+
/**
|
|
179
|
+
* Permanently delete access token.
|
|
180
|
+
*
|
|
181
|
+
* 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.
|
|
182
|
+
*
|
|
183
|
+
*/
|
|
184
|
+
export declare const deleteTokenMutation: (options?: Partial<Options<DeleteTokenData>>) => UseMutationOptions<unknown, DefaultError, Options<DeleteTokenData>>;
|
|
185
|
+
export declare const getTokenQueryKey: (options: Options<GetTokenData>) => [Pick<Options<GetTokenData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
164
186
|
_id: string;
|
|
165
187
|
_infinite?: boolean;
|
|
166
188
|
tags?: ReadonlyArray<string>;
|
|
167
189
|
}];
|
|
168
190
|
/**
|
|
169
|
-
* Get
|
|
191
|
+
* Get access token information.
|
|
170
192
|
*
|
|
171
|
-
*
|
|
193
|
+
* 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.
|
|
172
194
|
*
|
|
173
195
|
*/
|
|
174
|
-
export declare const
|
|
196
|
+
export declare const getTokenOptions: (options: Options<GetTokenData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen").Token, Error, import("../types.gen").Token, [Pick<Options<GetTokenData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
175
197
|
_id: string;
|
|
176
198
|
_infinite?: boolean;
|
|
177
199
|
tags?: ReadonlyArray<string>;
|
|
178
200
|
}]>, "queryFn"> & {
|
|
179
|
-
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").
|
|
201
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").Token, [Pick<Options<GetTokenData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
180
202
|
_id: string;
|
|
181
203
|
_infinite?: boolean;
|
|
182
204
|
tags?: ReadonlyArray<string>;
|
|
183
205
|
}], never> | undefined;
|
|
184
206
|
} & {
|
|
185
|
-
queryKey: [Pick<Options<
|
|
207
|
+
queryKey: [Pick<Options<GetTokenData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
186
208
|
_id: string;
|
|
187
209
|
_infinite?: boolean;
|
|
188
210
|
tags?: ReadonlyArray<string>;
|
|
189
211
|
}] & {
|
|
190
|
-
[dataTagSymbol]: import("../types.gen").
|
|
212
|
+
[dataTagSymbol]: import("../types.gen").Token;
|
|
191
213
|
[dataTagErrorSymbol]: Error;
|
|
192
214
|
};
|
|
193
215
|
};
|
|
194
216
|
/**
|
|
195
|
-
*
|
|
217
|
+
* Update access token information.
|
|
196
218
|
*
|
|
197
|
-
*
|
|
219
|
+
* 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.
|
|
220
|
+
*
|
|
221
|
+
* This endpoint is available to administrators of the organization only.
|
|
198
222
|
*
|
|
199
223
|
*/
|
|
200
|
-
export declare const
|
|
201
|
-
|
|
224
|
+
export declare const updateTokenMutation: (options?: Partial<Options<UpdateTokenData>>) => UseMutationOptions<UpdateTokenResponse, DefaultError, Options<UpdateTokenData>>;
|
|
225
|
+
/**
|
|
226
|
+
* Regenerate access token secret key.
|
|
227
|
+
*
|
|
228
|
+
* Generates a new access token secret. Old secret will not be valid anymore.
|
|
229
|
+
*/
|
|
230
|
+
export declare const regenerateTokenMutation: (options?: Partial<Options<RegenerateTokenData>>) => UseMutationOptions<RegenerateTokenResponse, DefaultError, Options<RegenerateTokenData>>;
|
|
231
|
+
export declare const listTicketsQueryKey: (options?: Options<ListTicketsData>) => [Pick<Options<ListTicketsData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
202
232
|
_id: string;
|
|
203
233
|
_infinite?: boolean;
|
|
204
234
|
tags?: ReadonlyArray<string>;
|
|
205
235
|
}];
|
|
206
236
|
/**
|
|
207
|
-
* List
|
|
208
|
-
*
|
|
209
|
-
* Returns a list of charts in the cluster.
|
|
237
|
+
* List tickets for the current organization.
|
|
210
238
|
*
|
|
211
|
-
*
|
|
239
|
+
* Returns all tickets belonging to the caller's organization, newest first.
|
|
212
240
|
*
|
|
213
241
|
*/
|
|
214
|
-
export declare const
|
|
242
|
+
export declare const listTicketsOptions: (options?: Options<ListTicketsData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen").Ticket[], Error, import("../types.gen").Ticket[], [Pick<Options<ListTicketsData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
215
243
|
_id: string;
|
|
216
244
|
_infinite?: boolean;
|
|
217
245
|
tags?: ReadonlyArray<string>;
|
|
218
246
|
}]>, "queryFn"> & {
|
|
219
|
-
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").
|
|
247
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").Ticket[], [Pick<Options<ListTicketsData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
220
248
|
_id: string;
|
|
221
249
|
_infinite?: boolean;
|
|
222
250
|
tags?: ReadonlyArray<string>;
|
|
223
251
|
}], never> | undefined;
|
|
224
252
|
} & {
|
|
225
|
-
queryKey: [Pick<Options<
|
|
253
|
+
queryKey: [Pick<Options<ListTicketsData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
226
254
|
_id: string;
|
|
227
255
|
_infinite?: boolean;
|
|
228
256
|
tags?: ReadonlyArray<string>;
|
|
229
257
|
}] & {
|
|
230
|
-
[dataTagSymbol]: import("../types.gen").
|
|
258
|
+
[dataTagSymbol]: import("../types.gen").Ticket[];
|
|
231
259
|
[dataTagErrorSymbol]: Error;
|
|
232
260
|
};
|
|
233
261
|
};
|
|
234
262
|
/**
|
|
235
|
-
* Create a new
|
|
236
|
-
*
|
|
237
|
-
* Create a new chart deployment.
|
|
263
|
+
* Create a new support ticket.
|
|
238
264
|
*
|
|
239
|
-
*
|
|
265
|
+
* 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).
|
|
240
266
|
*
|
|
241
267
|
*/
|
|
242
|
-
export declare const
|
|
268
|
+
export declare const createTicketMutation: (options?: Partial<Options<CreateTicketData>>) => UseMutationOptions<CreateTicketResponse, DefaultError, Options<CreateTicketData>>;
|
|
243
269
|
/**
|
|
244
|
-
*
|
|
245
|
-
*
|
|
246
|
-
* This endpoint will permanently delete chart. This operation cannot be undone.
|
|
270
|
+
* Close a ticket (soft close).
|
|
247
271
|
*
|
|
248
|
-
*
|
|
272
|
+
* Marks the ticket as closed. Closed is a terminal state — users cannot reply to a closed ticket; a new ticket must be opened instead.
|
|
249
273
|
*
|
|
250
274
|
*/
|
|
251
|
-
export declare const
|
|
252
|
-
export declare const
|
|
275
|
+
export declare const closeTicketMutation: (options?: Partial<Options<CloseTicketData>>) => UseMutationOptions<CloseTicketResponse, DefaultError, Options<CloseTicketData>>;
|
|
276
|
+
export declare const getTicketQueryKey: (options: Options<GetTicketData>) => [Pick<Options<GetTicketData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
253
277
|
_id: string;
|
|
254
278
|
_infinite?: boolean;
|
|
255
279
|
tags?: ReadonlyArray<string>;
|
|
256
280
|
}];
|
|
257
281
|
/**
|
|
258
|
-
* Get
|
|
259
|
-
*
|
|
260
|
-
* Returns the details of the chart deployment.
|
|
261
|
-
*
|
|
262
|
-
* This endpoint is available to all users in the organization.
|
|
263
|
-
*
|
|
282
|
+
* Get a ticket and its messages.
|
|
264
283
|
*/
|
|
265
|
-
export declare const
|
|
284
|
+
export declare const getTicketOptions: (options: Options<GetTicketData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen").Ticket, Error, import("../types.gen").Ticket, [Pick<Options<GetTicketData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
266
285
|
_id: string;
|
|
267
286
|
_infinite?: boolean;
|
|
268
287
|
tags?: ReadonlyArray<string>;
|
|
269
288
|
}]>, "queryFn"> & {
|
|
270
|
-
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").
|
|
289
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").Ticket, [Pick<Options<GetTicketData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
271
290
|
_id: string;
|
|
272
291
|
_infinite?: boolean;
|
|
273
292
|
tags?: ReadonlyArray<string>;
|
|
274
293
|
}], never> | undefined;
|
|
275
294
|
} & {
|
|
276
|
-
queryKey: [Pick<Options<
|
|
295
|
+
queryKey: [Pick<Options<GetTicketData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
277
296
|
_id: string;
|
|
278
297
|
_infinite?: boolean;
|
|
279
298
|
tags?: ReadonlyArray<string>;
|
|
280
299
|
}] & {
|
|
281
|
-
[dataTagSymbol]: import("../types.gen").
|
|
300
|
+
[dataTagSymbol]: import("../types.gen").Ticket;
|
|
282
301
|
[dataTagErrorSymbol]: Error;
|
|
283
302
|
};
|
|
284
303
|
};
|
|
285
304
|
/**
|
|
286
|
-
*
|
|
287
|
-
*
|
|
288
|
-
* This endpoint allows you to update the values of a chart deployment.
|
|
305
|
+
* Append a customer reply to a ticket.
|
|
289
306
|
*
|
|
290
|
-
*
|
|
307
|
+
* Multipart form-data with a JSON-encoded `payload` field carrying `body`, plus up to 3 `attachments` files. Returns 409 if the ticket is closed.
|
|
291
308
|
*
|
|
292
309
|
*/
|
|
293
|
-
export declare const
|
|
294
|
-
export declare const
|
|
310
|
+
export declare const replyTicketMutation: (options?: Partial<Options<ReplyTicketData>>) => UseMutationOptions<ReplyTicketResponse, DefaultError, Options<ReplyTicketData>>;
|
|
311
|
+
export declare const getTicketAttachmentQueryKey: (options: Options<GetTicketAttachmentData>) => [Pick<Options<GetTicketAttachmentData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
295
312
|
_id: string;
|
|
296
313
|
_infinite?: boolean;
|
|
297
314
|
tags?: ReadonlyArray<string>;
|
|
298
315
|
}];
|
|
299
316
|
/**
|
|
300
|
-
*
|
|
301
|
-
*
|
|
302
|
-
* Returns a list of fleets belonging to the cluster. For more information, see [Fleets](https://cloudfleet.ai/docs/cloud-infrastructure/fleets/) section of documentaiton.
|
|
303
|
-
*
|
|
304
|
-
* This endpoint is available to all users in the organization.
|
|
305
|
-
*
|
|
317
|
+
* Download a ticket attachment.
|
|
306
318
|
*/
|
|
307
|
-
export declare const
|
|
319
|
+
export declare const getTicketAttachmentOptions: (options: Options<GetTicketAttachmentData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<Blob | File, Error, Blob | File, [Pick<Options<GetTicketAttachmentData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
308
320
|
_id: string;
|
|
309
321
|
_infinite?: boolean;
|
|
310
322
|
tags?: ReadonlyArray<string>;
|
|
311
323
|
}]>, "queryFn"> & {
|
|
312
|
-
queryFn?: import("@tanstack/react-query").QueryFunction<
|
|
324
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<Blob | File, [Pick<Options<GetTicketAttachmentData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
313
325
|
_id: string;
|
|
314
326
|
_infinite?: boolean;
|
|
315
327
|
tags?: ReadonlyArray<string>;
|
|
316
328
|
}], never> | undefined;
|
|
317
329
|
} & {
|
|
318
|
-
queryKey: [Pick<Options<
|
|
330
|
+
queryKey: [Pick<Options<GetTicketAttachmentData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
319
331
|
_id: string;
|
|
320
332
|
_infinite?: boolean;
|
|
321
333
|
tags?: ReadonlyArray<string>;
|
|
322
334
|
}] & {
|
|
323
|
-
[dataTagSymbol]:
|
|
335
|
+
[dataTagSymbol]: Blob | File;
|
|
324
336
|
[dataTagErrorSymbol]: Error;
|
|
325
337
|
};
|
|
326
338
|
};
|
|
327
|
-
|
|
328
|
-
* Create a new fleet.
|
|
329
|
-
*
|
|
330
|
-
* 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.
|
|
331
|
-
*
|
|
332
|
-
* This endpoint is available to administrators of the organization only.
|
|
333
|
-
*
|
|
334
|
-
*/
|
|
335
|
-
export declare const createFleetMutation: (options?: Partial<Options<CreateFleetData>>) => UseMutationOptions<CreateFleetResponse, CreateFleetError, Options<CreateFleetData>>;
|
|
336
|
-
/**
|
|
337
|
-
* Permanently delete fleet.
|
|
338
|
-
*
|
|
339
|
-
* 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.
|
|
340
|
-
*
|
|
341
|
-
* This endpoint is available to administrators of the organization only.
|
|
342
|
-
*
|
|
343
|
-
*/
|
|
344
|
-
export declare const deleteFleetMutation: (options?: Partial<Options<DeleteFleetData>>) => UseMutationOptions<DeleteFleetResponse, DefaultError, Options<DeleteFleetData>>;
|
|
345
|
-
export declare const getFleetQueryKey: (options: Options<GetFleetData>) => [Pick<Options<GetFleetData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
339
|
+
export declare const listRepositoriesQueryKey: (options?: Options<ListRepositoriesData>) => [Pick<Options<ListRepositoriesData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
346
340
|
_id: string;
|
|
347
341
|
_infinite?: boolean;
|
|
348
342
|
tags?: ReadonlyArray<string>;
|
|
349
343
|
}];
|
|
350
344
|
/**
|
|
351
|
-
*
|
|
352
|
-
*
|
|
353
|
-
* Returns fleet details. For more information, see [Fleets](https://cloudfleet.ai/docs/cloud-infrastructure/fleets/) section of documentaiton.
|
|
345
|
+
* List repositories
|
|
354
346
|
*
|
|
355
|
-
* This endpoint is available to all users in the organization.
|
|
347
|
+
* Returns a list of repositories in the registry across all regions. This endpoint is available to all users in the organization.
|
|
356
348
|
*
|
|
357
349
|
*/
|
|
358
|
-
export declare const
|
|
350
|
+
export declare const listRepositoriesOptions: (options?: Options<ListRepositoriesData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen").RegistryRepository[], Error, import("../types.gen").RegistryRepository[], [Pick<Options<ListRepositoriesData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
359
351
|
_id: string;
|
|
360
352
|
_infinite?: boolean;
|
|
361
353
|
tags?: ReadonlyArray<string>;
|
|
362
354
|
}]>, "queryFn"> & {
|
|
363
|
-
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").
|
|
355
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").RegistryRepository[], [Pick<Options<ListRepositoriesData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
364
356
|
_id: string;
|
|
365
357
|
_infinite?: boolean;
|
|
366
358
|
tags?: ReadonlyArray<string>;
|
|
367
359
|
}], never> | undefined;
|
|
368
360
|
} & {
|
|
369
|
-
queryKey: [Pick<Options<
|
|
361
|
+
queryKey: [Pick<Options<ListRepositoriesData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
370
362
|
_id: string;
|
|
371
363
|
_infinite?: boolean;
|
|
372
364
|
tags?: ReadonlyArray<string>;
|
|
373
365
|
}] & {
|
|
374
|
-
[dataTagSymbol]: import("../types.gen").
|
|
366
|
+
[dataTagSymbol]: import("../types.gen").RegistryRepository[];
|
|
375
367
|
[dataTagErrorSymbol]: Error;
|
|
376
368
|
};
|
|
377
369
|
};
|
|
378
|
-
|
|
379
|
-
* Update fleet information.
|
|
380
|
-
*
|
|
381
|
-
* This endpoint allows you to update fleet details.
|
|
382
|
-
*
|
|
383
|
-
* For more information, see [Fleets](https://cloudfleet.ai/docs/cloud-infrastructure/fleets/) section of documentaiton.
|
|
384
|
-
*
|
|
385
|
-
* This endpoint is available to administrators of the organization only.
|
|
386
|
-
*
|
|
387
|
-
*/
|
|
388
|
-
export declare const updateFleetMutation: (options?: Partial<Options<UpdateFleetData>>) => UseMutationOptions<UpdateFleetResponse, UpdateFleetError, Options<UpdateFleetData>>;
|
|
389
|
-
export declare const queryClusterQueryKey: (options: Options<QueryClusterData>) => [Pick<Options<QueryClusterData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
370
|
+
export declare const listTagsQueryKey: (options: Options<ListTagsData>) => [Pick<Options<ListTagsData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
390
371
|
_id: string;
|
|
391
372
|
_infinite?: boolean;
|
|
392
373
|
tags?: ReadonlyArray<string>;
|
|
393
374
|
}];
|
|
394
375
|
/**
|
|
395
|
-
*
|
|
376
|
+
* List tags for a repository
|
|
377
|
+
*
|
|
378
|
+
* 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.
|
|
396
379
|
*
|
|
397
|
-
* 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.
|
|
398
380
|
*/
|
|
399
|
-
export declare const
|
|
381
|
+
export declare const listTagsOptions: (options: Options<ListTagsData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen").RegistryRepositoryWithTags, Error, import("../types.gen").RegistryRepositoryWithTags, [Pick<Options<ListTagsData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
400
382
|
_id: string;
|
|
401
383
|
_infinite?: boolean;
|
|
402
384
|
tags?: ReadonlyArray<string>;
|
|
403
385
|
}]>, "queryFn"> & {
|
|
404
|
-
queryFn?: import("@tanstack/react-query").QueryFunction<
|
|
386
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").RegistryRepositoryWithTags, [Pick<Options<ListTagsData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
405
387
|
_id: string;
|
|
406
388
|
_infinite?: boolean;
|
|
407
389
|
tags?: ReadonlyArray<string>;
|
|
408
390
|
}], never> | undefined;
|
|
409
391
|
} & {
|
|
410
|
-
queryKey: [Pick<Options<
|
|
392
|
+
queryKey: [Pick<Options<ListTagsData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
411
393
|
_id: string;
|
|
412
394
|
_infinite?: boolean;
|
|
413
395
|
tags?: ReadonlyArray<string>;
|
|
414
396
|
}] & {
|
|
415
|
-
[dataTagSymbol]:
|
|
397
|
+
[dataTagSymbol]: import("../types.gen").RegistryRepositoryWithTags;
|
|
416
398
|
[dataTagErrorSymbol]: Error;
|
|
417
399
|
};
|
|
418
400
|
};
|
|
419
|
-
|
|
401
|
+
/**
|
|
402
|
+
* Delete tag
|
|
403
|
+
*
|
|
404
|
+
* Permanently deletes a specific tag from a repository. This endpoint is available to administrators of the organization only.
|
|
405
|
+
*
|
|
406
|
+
*/
|
|
407
|
+
export declare const deleteTagMutation: (options?: Partial<Options<DeleteTagData>>) => UseMutationOptions<unknown, DefaultError, Options<DeleteTagData>>;
|
|
408
|
+
export declare const getTagQueryKey: (options: Options<GetTagData>) => [Pick<Options<GetTagData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
420
409
|
_id: string;
|
|
421
410
|
_infinite?: boolean;
|
|
422
411
|
tags?: ReadonlyArray<string>;
|
|
423
412
|
}];
|
|
424
413
|
/**
|
|
425
|
-
*
|
|
414
|
+
* Get tag details
|
|
426
415
|
*
|
|
427
|
-
* Returns a
|
|
416
|
+
* 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.
|
|
417
|
+
*
|
|
418
|
+
*/
|
|
419
|
+
export declare const getTagOptions: (options: Options<GetTagData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen").RegistryTag, Error, import("../types.gen").RegistryTag, [Pick<Options<GetTagData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
420
|
+
_id: string;
|
|
421
|
+
_infinite?: boolean;
|
|
422
|
+
tags?: ReadonlyArray<string>;
|
|
423
|
+
}]>, "queryFn"> & {
|
|
424
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").RegistryTag, [Pick<Options<GetTagData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
425
|
+
_id: string;
|
|
426
|
+
_infinite?: boolean;
|
|
427
|
+
tags?: ReadonlyArray<string>;
|
|
428
|
+
}], never> | undefined;
|
|
429
|
+
} & {
|
|
430
|
+
queryKey: [Pick<Options<GetTagData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
431
|
+
_id: string;
|
|
432
|
+
_infinite?: boolean;
|
|
433
|
+
tags?: ReadonlyArray<string>;
|
|
434
|
+
}] & {
|
|
435
|
+
[dataTagSymbol]: import("../types.gen").RegistryTag;
|
|
436
|
+
[dataTagErrorSymbol]: Error;
|
|
437
|
+
};
|
|
438
|
+
};
|
|
439
|
+
export declare const getOrganizationQueryKey: (options?: Options<GetOrganizationData>) => [Pick<Options<GetOrganizationData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
440
|
+
_id: string;
|
|
441
|
+
_infinite?: boolean;
|
|
442
|
+
tags?: ReadonlyArray<string>;
|
|
443
|
+
}];
|
|
444
|
+
/**
|
|
445
|
+
* Get organization information.
|
|
446
|
+
*
|
|
447
|
+
* Returns organization details including quota. For more information about quotas, see [Quotas and limits](https://cloudfleet.ai/docs/organization/quotas/) section of documentaiton.
|
|
428
448
|
*
|
|
429
449
|
* This endpoint is available to all users in the organization.
|
|
430
450
|
*
|
|
431
451
|
*/
|
|
432
|
-
export declare const
|
|
452
|
+
export declare const getOrganizationOptions: (options?: Options<GetOrganizationData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen").Organization, Error, import("../types.gen").Organization, [Pick<Options<GetOrganizationData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
433
453
|
_id: string;
|
|
434
454
|
_infinite?: boolean;
|
|
435
455
|
tags?: ReadonlyArray<string>;
|
|
436
456
|
}]>, "queryFn"> & {
|
|
437
|
-
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").
|
|
457
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").Organization, [Pick<Options<GetOrganizationData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
438
458
|
_id: string;
|
|
439
459
|
_infinite?: boolean;
|
|
440
460
|
tags?: ReadonlyArray<string>;
|
|
441
461
|
}], never> | undefined;
|
|
442
462
|
} & {
|
|
443
|
-
queryKey: [Pick<Options<
|
|
463
|
+
queryKey: [Pick<Options<GetOrganizationData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
444
464
|
_id: string;
|
|
445
465
|
_infinite?: boolean;
|
|
446
466
|
tags?: ReadonlyArray<string>;
|
|
447
467
|
}] & {
|
|
448
|
-
[dataTagSymbol]: import("../types.gen").
|
|
468
|
+
[dataTagSymbol]: import("../types.gen").Organization;
|
|
449
469
|
[dataTagErrorSymbol]: Error;
|
|
450
470
|
};
|
|
451
471
|
};
|
|
452
472
|
/**
|
|
453
|
-
* Create a new
|
|
473
|
+
* Create a new organization / Cloudfleet account signup.
|
|
454
474
|
*
|
|
455
|
-
*
|
|
475
|
+
* This endpoint allows you to create a new Cloudfleet organization and an administrator user.
|
|
456
476
|
*
|
|
457
|
-
|
|
477
|
+
*/
|
|
478
|
+
export declare const createOrganizationMutation: (options?: Partial<Options<CreateOrganizationData>>) => UseMutationOptions<CreateOrganizationResponse, DefaultError, Options<CreateOrganizationData>>;
|
|
479
|
+
export declare const getBasicPriceConsentQueryKey: (options?: Options<GetBasicPriceConsentData>) => [Pick<Options<GetBasicPriceConsentData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
480
|
+
_id: string;
|
|
481
|
+
_infinite?: boolean;
|
|
482
|
+
tags?: ReadonlyArray<string>;
|
|
483
|
+
}];
|
|
484
|
+
/**
|
|
485
|
+
* Get the organization's consent status for the new Basic price.
|
|
486
|
+
*
|
|
487
|
+
* Returns the organization's consent status for the migration from the free tier to the paid Basic plan. `pending` means an administrator must opt in; `not_applicable` means the organization is not in scope for the migration; `accepted` / `rejected` reflect a recorded decision.
|
|
488
|
+
*
|
|
489
|
+
* This endpoint is available to all users in the organization and drives the consent dialog in the console.
|
|
458
490
|
*
|
|
459
491
|
*/
|
|
460
|
-
export declare const
|
|
492
|
+
export declare const getBasicPriceConsentOptions: (options?: Options<GetBasicPriceConsentData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen").BasicPriceConsent, Error, import("../types.gen").BasicPriceConsent, [Pick<Options<GetBasicPriceConsentData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
493
|
+
_id: string;
|
|
494
|
+
_infinite?: boolean;
|
|
495
|
+
tags?: ReadonlyArray<string>;
|
|
496
|
+
}]>, "queryFn"> & {
|
|
497
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").BasicPriceConsent, [Pick<Options<GetBasicPriceConsentData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
498
|
+
_id: string;
|
|
499
|
+
_infinite?: boolean;
|
|
500
|
+
tags?: ReadonlyArray<string>;
|
|
501
|
+
}], never> | undefined;
|
|
502
|
+
} & {
|
|
503
|
+
queryKey: [Pick<Options<GetBasicPriceConsentData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
504
|
+
_id: string;
|
|
505
|
+
_infinite?: boolean;
|
|
506
|
+
tags?: ReadonlyArray<string>;
|
|
507
|
+
}] & {
|
|
508
|
+
[dataTagSymbol]: import("../types.gen").BasicPriceConsent;
|
|
509
|
+
[dataTagErrorSymbol]: Error;
|
|
510
|
+
};
|
|
511
|
+
};
|
|
461
512
|
/**
|
|
462
|
-
*
|
|
513
|
+
* Record an administrator's decision on the new Basic price.
|
|
463
514
|
*
|
|
464
|
-
*
|
|
515
|
+
* Records an affirmative decision to continue on the paid Basic plan (`accepted`) or to opt out (`rejected`). This is an organization-binding financial decision, so it is restricted to administrators. Each call appends an immutable audit entry (who and when) and sends a confirmation email to the acting administrator.
|
|
465
516
|
*
|
|
466
|
-
|
|
517
|
+
*/
|
|
518
|
+
export declare const setBasicPriceConsentMutation: (options?: Partial<Options<SetBasicPriceConsentData>>) => UseMutationOptions<SetBasicPriceConsentResponse, DefaultError, Options<SetBasicPriceConsentData>>;
|
|
519
|
+
/**
|
|
520
|
+
* MCP endpoint
|
|
467
521
|
*
|
|
522
|
+
* MCP endpoint for handling Model Context Protocol JSON-RPC 2.0 messages.
|
|
468
523
|
*/
|
|
469
|
-
export declare const
|
|
470
|
-
export declare const
|
|
524
|
+
export declare const postMcpMutation: (options?: Partial<Options<PostMcpData>>) => UseMutationOptions<PostMcpResponse, DefaultError, Options<PostMcpData>>;
|
|
525
|
+
export declare const listMarketplaceChartsQueryKey: (options?: Options<ListMarketplaceChartsData>) => [Pick<Options<ListMarketplaceChartsData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
471
526
|
_id: string;
|
|
472
527
|
_infinite?: boolean;
|
|
473
528
|
tags?: ReadonlyArray<string>;
|
|
474
529
|
}];
|
|
475
530
|
/**
|
|
476
|
-
*
|
|
531
|
+
* List chart listings available in the marketplace.
|
|
477
532
|
*
|
|
478
|
-
* Returns
|
|
533
|
+
* Returns a list of available charts in the marketplace.
|
|
479
534
|
*
|
|
480
535
|
* This endpoint is available to all users in the organization.
|
|
481
536
|
*
|
|
482
537
|
*/
|
|
483
|
-
export declare const
|
|
538
|
+
export declare const listMarketplaceChartsOptions: (options?: Options<ListMarketplaceChartsData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen").MarketplaceListing[], Error, import("../types.gen").MarketplaceListing[], [Pick<Options<ListMarketplaceChartsData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
484
539
|
_id: string;
|
|
485
540
|
_infinite?: boolean;
|
|
486
541
|
tags?: ReadonlyArray<string>;
|
|
487
542
|
}]>, "queryFn"> & {
|
|
488
|
-
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").
|
|
543
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").MarketplaceListing[], [Pick<Options<ListMarketplaceChartsData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
489
544
|
_id: string;
|
|
490
545
|
_infinite?: boolean;
|
|
491
546
|
tags?: ReadonlyArray<string>;
|
|
492
547
|
}], never> | undefined;
|
|
493
548
|
} & {
|
|
494
|
-
queryKey: [Pick<Options<
|
|
549
|
+
queryKey: [Pick<Options<ListMarketplaceChartsData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
495
550
|
_id: string;
|
|
496
551
|
_infinite?: boolean;
|
|
497
552
|
tags?: ReadonlyArray<string>;
|
|
498
553
|
}] & {
|
|
499
|
-
[dataTagSymbol]: import("../types.gen").
|
|
554
|
+
[dataTagSymbol]: import("../types.gen").MarketplaceListing[];
|
|
500
555
|
[dataTagErrorSymbol]: Error;
|
|
501
556
|
};
|
|
502
557
|
};
|
|
558
|
+
export declare const getMarketplaceChartFilesQueryKey: (options: Options<GetMarketplaceChartFilesData>) => [Pick<Options<GetMarketplaceChartFilesData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
559
|
+
_id: string;
|
|
560
|
+
_infinite?: boolean;
|
|
561
|
+
tags?: ReadonlyArray<string>;
|
|
562
|
+
}];
|
|
503
563
|
/**
|
|
504
|
-
*
|
|
505
|
-
*
|
|
506
|
-
* 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.
|
|
564
|
+
* Get chart files for a specific version channel.
|
|
507
565
|
*
|
|
508
|
-
*
|
|
566
|
+
* Returns the Chart.yaml, values.yaml, and values.schema.json files for the latest version matching the specified version channel.
|
|
509
567
|
*
|
|
510
|
-
|
|
511
|
-
export declare const updateClusterMutation: (options?: Partial<Options<UpdateClusterData>>) => UseMutationOptions<UpdateClusterResponse, DefaultError, Options<UpdateClusterData>>;
|
|
512
|
-
/**
|
|
513
|
-
* Node join information for the cluster
|
|
568
|
+
* 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.
|
|
514
569
|
*
|
|
515
|
-
*
|
|
570
|
+
* This endpoint is available to all users in the organization.
|
|
516
571
|
*
|
|
517
572
|
*/
|
|
518
|
-
export declare const
|
|
573
|
+
export declare const getMarketplaceChartFilesOptions: (options: Options<GetMarketplaceChartFilesData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen").MarketplaceListingFiles, Error, import("../types.gen").MarketplaceListingFiles, [Pick<Options<GetMarketplaceChartFilesData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
574
|
+
_id: string;
|
|
575
|
+
_infinite?: boolean;
|
|
576
|
+
tags?: ReadonlyArray<string>;
|
|
577
|
+
}]>, "queryFn"> & {
|
|
578
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").MarketplaceListingFiles, [Pick<Options<GetMarketplaceChartFilesData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
579
|
+
_id: string;
|
|
580
|
+
_infinite?: boolean;
|
|
581
|
+
tags?: ReadonlyArray<string>;
|
|
582
|
+
}], never> | undefined;
|
|
583
|
+
} & {
|
|
584
|
+
queryKey: [Pick<Options<GetMarketplaceChartFilesData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
585
|
+
_id: string;
|
|
586
|
+
_infinite?: boolean;
|
|
587
|
+
tags?: ReadonlyArray<string>;
|
|
588
|
+
}] & {
|
|
589
|
+
[dataTagSymbol]: import("../types.gen").MarketplaceListingFiles;
|
|
590
|
+
[dataTagErrorSymbol]: Error;
|
|
591
|
+
};
|
|
592
|
+
};
|
|
519
593
|
export declare const listInvitesQueryKey: (options?: Options<ListInvitesData>) => [Pick<Options<ListInvitesData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
520
594
|
_id: string;
|
|
521
595
|
_infinite?: boolean;
|
|
@@ -604,546 +678,522 @@ export declare const getInviteOptions: (options: Options<GetInviteData>) => impo
|
|
|
604
678
|
*
|
|
605
679
|
*/
|
|
606
680
|
export declare const deleteInviteMutation: (options?: Partial<Options<DeleteInviteData>>) => UseMutationOptions<unknown, DefaultError, Options<DeleteInviteData>>;
|
|
607
|
-
export declare const
|
|
681
|
+
export declare const queryClusterQueryKey: (options: Options<QueryClusterData>) => [Pick<Options<QueryClusterData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
608
682
|
_id: string;
|
|
609
683
|
_infinite?: boolean;
|
|
610
684
|
tags?: ReadonlyArray<string>;
|
|
611
685
|
}];
|
|
612
686
|
/**
|
|
613
|
-
*
|
|
614
|
-
*
|
|
615
|
-
* Returns a list of available charts in the marketplace.
|
|
616
|
-
*
|
|
617
|
-
* This endpoint is available to all users in the organization.
|
|
687
|
+
* Query Kubernetes cluster API
|
|
618
688
|
*
|
|
689
|
+
* 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.
|
|
619
690
|
*/
|
|
620
|
-
export declare const
|
|
691
|
+
export declare const queryClusterOptions: (options: Options<QueryClusterData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<unknown, Error, unknown, [Pick<Options<QueryClusterData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
621
692
|
_id: string;
|
|
622
693
|
_infinite?: boolean;
|
|
623
694
|
tags?: ReadonlyArray<string>;
|
|
624
695
|
}]>, "queryFn"> & {
|
|
625
|
-
queryFn?: import("@tanstack/react-query").QueryFunction<
|
|
696
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<unknown, [Pick<Options<QueryClusterData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
626
697
|
_id: string;
|
|
627
698
|
_infinite?: boolean;
|
|
628
699
|
tags?: ReadonlyArray<string>;
|
|
629
700
|
}], never> | undefined;
|
|
630
701
|
} & {
|
|
631
|
-
queryKey: [Pick<Options<
|
|
702
|
+
queryKey: [Pick<Options<QueryClusterData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
632
703
|
_id: string;
|
|
633
704
|
_infinite?: boolean;
|
|
634
705
|
tags?: ReadonlyArray<string>;
|
|
635
706
|
}] & {
|
|
636
|
-
[dataTagSymbol]:
|
|
707
|
+
[dataTagSymbol]: unknown;
|
|
637
708
|
[dataTagErrorSymbol]: Error;
|
|
638
709
|
};
|
|
639
710
|
};
|
|
640
|
-
export declare const
|
|
711
|
+
export declare const listFleetsQueryKey: (options: Options<ListFleetsData>) => [Pick<Options<ListFleetsData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
641
712
|
_id: string;
|
|
642
713
|
_infinite?: boolean;
|
|
643
714
|
tags?: ReadonlyArray<string>;
|
|
644
715
|
}];
|
|
645
716
|
/**
|
|
646
|
-
*
|
|
647
|
-
*
|
|
648
|
-
* Returns the Chart.yaml, values.yaml, and values.schema.json files for the latest version matching the specified version channel.
|
|
717
|
+
* List fleets.
|
|
649
718
|
*
|
|
650
|
-
*
|
|
719
|
+
* Returns a list of fleets belonging to the cluster. For more information, see [Fleets](https://cloudfleet.ai/docs/cloud-infrastructure/fleets/) section of documentaiton.
|
|
651
720
|
*
|
|
652
721
|
* This endpoint is available to all users in the organization.
|
|
653
722
|
*
|
|
654
723
|
*/
|
|
655
|
-
export declare const
|
|
724
|
+
export declare const listFleetsOptions: (options: Options<ListFleetsData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen").Fleet[], Error, import("../types.gen").Fleet[], [Pick<Options<ListFleetsData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
656
725
|
_id: string;
|
|
657
726
|
_infinite?: boolean;
|
|
658
727
|
tags?: ReadonlyArray<string>;
|
|
659
728
|
}]>, "queryFn"> & {
|
|
660
|
-
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").
|
|
729
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").Fleet[], [Pick<Options<ListFleetsData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
661
730
|
_id: string;
|
|
662
731
|
_infinite?: boolean;
|
|
663
732
|
tags?: ReadonlyArray<string>;
|
|
664
733
|
}], never> | undefined;
|
|
665
734
|
} & {
|
|
666
|
-
queryKey: [Pick<Options<
|
|
735
|
+
queryKey: [Pick<Options<ListFleetsData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
667
736
|
_id: string;
|
|
668
737
|
_infinite?: boolean;
|
|
669
738
|
tags?: ReadonlyArray<string>;
|
|
670
739
|
}] & {
|
|
671
|
-
[dataTagSymbol]: import("../types.gen").
|
|
740
|
+
[dataTagSymbol]: import("../types.gen").Fleet[];
|
|
672
741
|
[dataTagErrorSymbol]: Error;
|
|
673
742
|
};
|
|
674
743
|
};
|
|
675
744
|
/**
|
|
676
|
-
*
|
|
745
|
+
* Create a new fleet.
|
|
746
|
+
*
|
|
747
|
+
* 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.
|
|
748
|
+
*
|
|
749
|
+
* The cluster must be ready (status `deployed`) before a fleet can be added. Adding a fleet while the cluster is still provisioning returns `409`.
|
|
750
|
+
*
|
|
751
|
+
* This endpoint is available to administrators of the organization only.
|
|
677
752
|
*
|
|
678
|
-
* MCP endpoint for handling Model Context Protocol JSON-RPC 2.0 messages.
|
|
679
753
|
*/
|
|
680
|
-
export declare const
|
|
681
|
-
|
|
754
|
+
export declare const createFleetMutation: (options?: Partial<Options<CreateFleetData>>) => UseMutationOptions<CreateFleetResponse, CreateFleetError, Options<CreateFleetData>>;
|
|
755
|
+
/**
|
|
756
|
+
* Permanently delete fleet.
|
|
757
|
+
*
|
|
758
|
+
* 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.
|
|
759
|
+
*
|
|
760
|
+
* Deleting a fleet does not deprovision the cloud infrastructure it provisioned: nodes and other resources keep running. Scale the cluster down first, or remove the infrastructure manually, to avoid orphaned resources.
|
|
761
|
+
*
|
|
762
|
+
* This endpoint is available to administrators of the organization only.
|
|
763
|
+
*
|
|
764
|
+
*/
|
|
765
|
+
export declare const deleteFleetMutation: (options?: Partial<Options<DeleteFleetData>>) => UseMutationOptions<DeleteFleetResponse, DeleteFleetError, Options<DeleteFleetData>>;
|
|
766
|
+
export declare const getFleetQueryKey: (options: Options<GetFleetData>) => [Pick<Options<GetFleetData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
682
767
|
_id: string;
|
|
683
768
|
_infinite?: boolean;
|
|
684
769
|
tags?: ReadonlyArray<string>;
|
|
685
770
|
}];
|
|
686
771
|
/**
|
|
687
|
-
* Get
|
|
772
|
+
* Get fleet information.
|
|
688
773
|
*
|
|
689
|
-
* Returns
|
|
774
|
+
* Returns fleet details. For more information, see [Fleets](https://cloudfleet.ai/docs/cloud-infrastructure/fleets/) section of documentaiton.
|
|
690
775
|
*
|
|
691
776
|
* This endpoint is available to all users in the organization.
|
|
692
777
|
*
|
|
693
778
|
*/
|
|
694
|
-
export declare const
|
|
779
|
+
export declare const getFleetOptions: (options: Options<GetFleetData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen").Fleet, Error, import("../types.gen").Fleet, [Pick<Options<GetFleetData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
695
780
|
_id: string;
|
|
696
781
|
_infinite?: boolean;
|
|
697
782
|
tags?: ReadonlyArray<string>;
|
|
698
783
|
}]>, "queryFn"> & {
|
|
699
|
-
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").
|
|
784
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").Fleet, [Pick<Options<GetFleetData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
700
785
|
_id: string;
|
|
701
786
|
_infinite?: boolean;
|
|
702
787
|
tags?: ReadonlyArray<string>;
|
|
703
788
|
}], never> | undefined;
|
|
704
789
|
} & {
|
|
705
|
-
queryKey: [Pick<Options<
|
|
790
|
+
queryKey: [Pick<Options<GetFleetData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
706
791
|
_id: string;
|
|
707
792
|
_infinite?: boolean;
|
|
708
793
|
tags?: ReadonlyArray<string>;
|
|
709
794
|
}] & {
|
|
710
|
-
[dataTagSymbol]: import("../types.gen").
|
|
795
|
+
[dataTagSymbol]: import("../types.gen").Fleet;
|
|
711
796
|
[dataTagErrorSymbol]: Error;
|
|
712
797
|
};
|
|
713
798
|
};
|
|
714
799
|
/**
|
|
715
|
-
*
|
|
800
|
+
* Update fleet information.
|
|
716
801
|
*
|
|
717
|
-
* This endpoint allows you to
|
|
802
|
+
* This endpoint allows you to update fleet details.
|
|
803
|
+
*
|
|
804
|
+
* For more information, see [Fleets](https://cloudfleet.ai/docs/cloud-infrastructure/fleets/) section of documentaiton.
|
|
805
|
+
*
|
|
806
|
+
* This is a full overwrite: any field omitted from the request is reset to its default rather than left unchanged. The Hetzner API key is the exception: it is kept when omitted (send a new value to rotate it).
|
|
807
|
+
*
|
|
808
|
+
* This endpoint is available to administrators of the organization only.
|
|
718
809
|
*
|
|
719
810
|
*/
|
|
720
|
-
export declare const
|
|
721
|
-
export declare const
|
|
811
|
+
export declare const updateFleetMutation: (options?: Partial<Options<UpdateFleetData>>) => UseMutationOptions<UpdateFleetResponse, UpdateFleetError, Options<UpdateFleetData>>;
|
|
812
|
+
export declare const listChartsQueryKey: (options: Options<ListChartsData>) => [Pick<Options<ListChartsData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
722
813
|
_id: string;
|
|
723
814
|
_infinite?: boolean;
|
|
724
815
|
tags?: ReadonlyArray<string>;
|
|
725
816
|
}];
|
|
726
817
|
/**
|
|
727
|
-
* List
|
|
818
|
+
* List charts.
|
|
728
819
|
*
|
|
729
|
-
* Returns a list of
|
|
820
|
+
* Returns a list of charts in the cluster.
|
|
821
|
+
*
|
|
822
|
+
* This endpoint is available to all users in the organization.
|
|
730
823
|
*
|
|
731
824
|
*/
|
|
732
|
-
export declare const
|
|
825
|
+
export declare const listChartsOptions: (options: Options<ListChartsData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen").Chart[], Error, import("../types.gen").Chart[], [Pick<Options<ListChartsData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
733
826
|
_id: string;
|
|
734
827
|
_infinite?: boolean;
|
|
735
828
|
tags?: ReadonlyArray<string>;
|
|
736
829
|
}]>, "queryFn"> & {
|
|
737
|
-
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").
|
|
830
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").Chart[], [Pick<Options<ListChartsData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
738
831
|
_id: string;
|
|
739
832
|
_infinite?: boolean;
|
|
740
833
|
tags?: ReadonlyArray<string>;
|
|
741
834
|
}], never> | undefined;
|
|
742
835
|
} & {
|
|
743
|
-
queryKey: [Pick<Options<
|
|
836
|
+
queryKey: [Pick<Options<ListChartsData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
744
837
|
_id: string;
|
|
745
838
|
_infinite?: boolean;
|
|
746
839
|
tags?: ReadonlyArray<string>;
|
|
747
840
|
}] & {
|
|
748
|
-
[dataTagSymbol]: import("../types.gen").
|
|
841
|
+
[dataTagSymbol]: import("../types.gen").Chart[];
|
|
749
842
|
[dataTagErrorSymbol]: Error;
|
|
750
843
|
};
|
|
751
844
|
};
|
|
752
|
-
export declare const listTagsQueryKey: (options: Options<ListTagsData>) => [Pick<Options<ListTagsData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
753
|
-
_id: string;
|
|
754
|
-
_infinite?: boolean;
|
|
755
|
-
tags?: ReadonlyArray<string>;
|
|
756
|
-
}];
|
|
757
845
|
/**
|
|
758
|
-
*
|
|
846
|
+
* Create a new chart.
|
|
759
847
|
*
|
|
760
|
-
*
|
|
848
|
+
* Create a new chart deployment.
|
|
849
|
+
*
|
|
850
|
+
* This endpoint is available to administrators of the organization only.
|
|
761
851
|
*
|
|
762
852
|
*/
|
|
763
|
-
export declare const
|
|
764
|
-
_id: string;
|
|
765
|
-
_infinite?: boolean;
|
|
766
|
-
tags?: ReadonlyArray<string>;
|
|
767
|
-
}]>, "queryFn"> & {
|
|
768
|
-
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").RegistryRepositoryWithTags, [Pick<Options<ListTagsData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
769
|
-
_id: string;
|
|
770
|
-
_infinite?: boolean;
|
|
771
|
-
tags?: ReadonlyArray<string>;
|
|
772
|
-
}], never> | undefined;
|
|
773
|
-
} & {
|
|
774
|
-
queryKey: [Pick<Options<ListTagsData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
775
|
-
_id: string;
|
|
776
|
-
_infinite?: boolean;
|
|
777
|
-
tags?: ReadonlyArray<string>;
|
|
778
|
-
}] & {
|
|
779
|
-
[dataTagSymbol]: import("../types.gen").RegistryRepositoryWithTags;
|
|
780
|
-
[dataTagErrorSymbol]: Error;
|
|
781
|
-
};
|
|
782
|
-
};
|
|
853
|
+
export declare const createChartMutation: (options?: Partial<Options<CreateChartData>>) => UseMutationOptions<CreateChartResponse, CreateChartError, Options<CreateChartData>>;
|
|
783
854
|
/**
|
|
784
|
-
*
|
|
855
|
+
* Permanently delete the chart deployment from the cluster.
|
|
785
856
|
*
|
|
786
|
-
*
|
|
857
|
+
* This endpoint will permanently delete chart. This operation cannot be undone.
|
|
858
|
+
*
|
|
859
|
+
* This endpoint is available to administrators of the organization only.
|
|
787
860
|
*
|
|
788
861
|
*/
|
|
789
|
-
export declare const
|
|
790
|
-
export declare const
|
|
862
|
+
export declare const deleteChartMutation: (options?: Partial<Options<DeleteChartData>>) => UseMutationOptions<DeleteChartResponse, DeleteChartError, Options<DeleteChartData>>;
|
|
863
|
+
export declare const getChartQueryKey: (options: Options<GetChartData>) => [Pick<Options<GetChartData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
791
864
|
_id: string;
|
|
792
865
|
_infinite?: boolean;
|
|
793
866
|
tags?: ReadonlyArray<string>;
|
|
794
867
|
}];
|
|
795
868
|
/**
|
|
796
|
-
* Get
|
|
869
|
+
* Get chart information.
|
|
797
870
|
*
|
|
798
|
-
* Returns
|
|
871
|
+
* Returns the details of the chart deployment.
|
|
872
|
+
*
|
|
873
|
+
* This endpoint is available to all users in the organization.
|
|
799
874
|
*
|
|
800
875
|
*/
|
|
801
|
-
export declare const
|
|
876
|
+
export declare const getChartOptions: (options: Options<GetChartData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen").Chart, Error, import("../types.gen").Chart, [Pick<Options<GetChartData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
802
877
|
_id: string;
|
|
803
878
|
_infinite?: boolean;
|
|
804
879
|
tags?: ReadonlyArray<string>;
|
|
805
880
|
}]>, "queryFn"> & {
|
|
806
|
-
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").
|
|
881
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").Chart, [Pick<Options<GetChartData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
807
882
|
_id: string;
|
|
808
883
|
_infinite?: boolean;
|
|
809
884
|
tags?: ReadonlyArray<string>;
|
|
810
885
|
}], never> | undefined;
|
|
811
886
|
} & {
|
|
812
|
-
queryKey: [Pick<Options<
|
|
887
|
+
queryKey: [Pick<Options<GetChartData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
813
888
|
_id: string;
|
|
814
889
|
_infinite?: boolean;
|
|
815
890
|
tags?: ReadonlyArray<string>;
|
|
816
891
|
}] & {
|
|
817
|
-
[dataTagSymbol]: import("../types.gen").
|
|
892
|
+
[dataTagSymbol]: import("../types.gen").Chart;
|
|
818
893
|
[dataTagErrorSymbol]: Error;
|
|
819
894
|
};
|
|
820
895
|
};
|
|
821
|
-
|
|
896
|
+
/**
|
|
897
|
+
* Update chart information.
|
|
898
|
+
*
|
|
899
|
+
* This endpoint allows you to update the values of a chart deployment.
|
|
900
|
+
*
|
|
901
|
+
* This endpoint is available to administrators of the organization only.
|
|
902
|
+
*
|
|
903
|
+
*/
|
|
904
|
+
export declare const updateChartMutation: (options?: Partial<Options<UpdateChartData>>) => UseMutationOptions<UpdateChartResponse, UpdateChartError, Options<UpdateChartData>>;
|
|
905
|
+
export declare const listClustersQueryKey: (options?: Options<ListClustersData>) => [Pick<Options<ListClustersData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
822
906
|
_id: string;
|
|
823
907
|
_infinite?: boolean;
|
|
824
908
|
tags?: ReadonlyArray<string>;
|
|
825
909
|
}];
|
|
826
910
|
/**
|
|
827
|
-
* List
|
|
911
|
+
* List clusters.
|
|
828
912
|
*
|
|
829
|
-
* Returns
|
|
913
|
+
* Returns a list of clusters under the current organization.
|
|
914
|
+
*
|
|
915
|
+
* This endpoint is available to all users in the organization.
|
|
830
916
|
*
|
|
831
917
|
*/
|
|
832
|
-
export declare const
|
|
918
|
+
export declare const listClustersOptions: (options?: Options<ListClustersData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen").Cluster[], Error, import("../types.gen").Cluster[], [Pick<Options<ListClustersData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
833
919
|
_id: string;
|
|
834
920
|
_infinite?: boolean;
|
|
835
921
|
tags?: ReadonlyArray<string>;
|
|
836
922
|
}]>, "queryFn"> & {
|
|
837
|
-
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").
|
|
923
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").Cluster[], [Pick<Options<ListClustersData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
838
924
|
_id: string;
|
|
839
925
|
_infinite?: boolean;
|
|
840
926
|
tags?: ReadonlyArray<string>;
|
|
841
927
|
}], never> | undefined;
|
|
842
928
|
} & {
|
|
843
|
-
queryKey: [Pick<Options<
|
|
929
|
+
queryKey: [Pick<Options<ListClustersData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
844
930
|
_id: string;
|
|
845
931
|
_infinite?: boolean;
|
|
846
932
|
tags?: ReadonlyArray<string>;
|
|
847
933
|
}] & {
|
|
848
|
-
[dataTagSymbol]: import("../types.gen").
|
|
934
|
+
[dataTagSymbol]: import("../types.gen").Cluster[];
|
|
849
935
|
[dataTagErrorSymbol]: Error;
|
|
850
936
|
};
|
|
851
937
|
};
|
|
852
938
|
/**
|
|
853
|
-
* Create a new
|
|
939
|
+
* Create a new cluster.
|
|
854
940
|
*
|
|
855
|
-
*
|
|
941
|
+
* 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.
|
|
942
|
+
*
|
|
943
|
+
* This endpoint is available to administrators of the organization only.
|
|
856
944
|
*
|
|
857
945
|
*/
|
|
858
|
-
export declare const
|
|
946
|
+
export declare const createClusterMutation: (options?: Partial<Options<CreateClusterData>>) => UseMutationOptions<CreateClusterResponse, CreateClusterError, Options<CreateClusterData>>;
|
|
859
947
|
/**
|
|
860
|
-
*
|
|
948
|
+
* Permanently delete cluster.
|
|
861
949
|
*
|
|
862
|
-
*
|
|
950
|
+
* This endpoint will permanently delete the cluster. This operation cannot be undone.
|
|
951
|
+
*
|
|
952
|
+
* Deleting a cluster also deletes its fleets. This does not deprovision the cloud infrastructure those fleets provisioned: nodes and other resources keep running. Scale the cluster down first, or remove the infrastructure manually, to avoid orphaned resources.
|
|
953
|
+
*
|
|
954
|
+
* This endpoint is available to administrators of the organization only.
|
|
863
955
|
*
|
|
864
956
|
*/
|
|
865
|
-
export declare const
|
|
866
|
-
export declare const
|
|
957
|
+
export declare const deleteClusterMutation: (options?: Partial<Options<DeleteClusterData>>) => UseMutationOptions<DeleteClusterResponse, DeleteClusterError, Options<DeleteClusterData>>;
|
|
958
|
+
export declare const getClusterQueryKey: (options: Options<GetClusterData>) => [Pick<Options<GetClusterData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
867
959
|
_id: string;
|
|
868
960
|
_infinite?: boolean;
|
|
869
961
|
tags?: ReadonlyArray<string>;
|
|
870
962
|
}];
|
|
871
963
|
/**
|
|
872
|
-
* Get
|
|
964
|
+
* Get cluster information.
|
|
965
|
+
*
|
|
966
|
+
* Returns cluster details.
|
|
967
|
+
*
|
|
968
|
+
* This endpoint is available to all users in the organization.
|
|
969
|
+
*
|
|
873
970
|
*/
|
|
874
|
-
export declare const
|
|
971
|
+
export declare const getClusterOptions: (options: Options<GetClusterData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen").Cluster, Error, import("../types.gen").Cluster, [Pick<Options<GetClusterData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
875
972
|
_id: string;
|
|
876
973
|
_infinite?: boolean;
|
|
877
974
|
tags?: ReadonlyArray<string>;
|
|
878
975
|
}]>, "queryFn"> & {
|
|
879
|
-
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").
|
|
976
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").Cluster, [Pick<Options<GetClusterData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
880
977
|
_id: string;
|
|
881
978
|
_infinite?: boolean;
|
|
882
979
|
tags?: ReadonlyArray<string>;
|
|
883
980
|
}], never> | undefined;
|
|
884
981
|
} & {
|
|
885
|
-
queryKey: [Pick<Options<
|
|
982
|
+
queryKey: [Pick<Options<GetClusterData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
886
983
|
_id: string;
|
|
887
984
|
_infinite?: boolean;
|
|
888
985
|
tags?: ReadonlyArray<string>;
|
|
889
986
|
}] & {
|
|
890
|
-
[dataTagSymbol]: import("../types.gen").
|
|
987
|
+
[dataTagSymbol]: import("../types.gen").Cluster;
|
|
891
988
|
[dataTagErrorSymbol]: Error;
|
|
892
989
|
};
|
|
893
990
|
};
|
|
894
991
|
/**
|
|
895
|
-
*
|
|
992
|
+
* Update cluster information.
|
|
896
993
|
*
|
|
897
|
-
*
|
|
994
|
+
* This endpoint allows you to update cluster details. For more information about clusters, see [Clusters](https://cloudfleet.ai/docs/cluster-management/cluster-types/) section of documentation.
|
|
995
|
+
*
|
|
996
|
+
* This is a full overwrite: any field omitted from the request is reset to its default rather than left unchanged.
|
|
997
|
+
*
|
|
998
|
+
* This endpoint is available to administrators of the organization only.
|
|
898
999
|
*
|
|
899
1000
|
*/
|
|
900
|
-
export declare const
|
|
901
|
-
export declare const getTicketAttachmentQueryKey: (options: Options<GetTicketAttachmentData>) => [Pick<Options<GetTicketAttachmentData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
902
|
-
_id: string;
|
|
903
|
-
_infinite?: boolean;
|
|
904
|
-
tags?: ReadonlyArray<string>;
|
|
905
|
-
}];
|
|
1001
|
+
export declare const updateClusterMutation: (options?: Partial<Options<UpdateClusterData>>) => UseMutationOptions<UpdateClusterResponse, UpdateClusterError, Options<UpdateClusterData>>;
|
|
906
1002
|
/**
|
|
907
|
-
*
|
|
1003
|
+
* Node join information for the cluster
|
|
1004
|
+
*
|
|
1005
|
+
* 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.
|
|
1006
|
+
*
|
|
908
1007
|
*/
|
|
909
|
-
export declare const
|
|
910
|
-
|
|
911
|
-
_infinite?: boolean;
|
|
912
|
-
tags?: ReadonlyArray<string>;
|
|
913
|
-
}]>, "queryFn"> & {
|
|
914
|
-
queryFn?: import("@tanstack/react-query").QueryFunction<Blob | File, [Pick<Options<GetTicketAttachmentData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
915
|
-
_id: string;
|
|
916
|
-
_infinite?: boolean;
|
|
917
|
-
tags?: ReadonlyArray<string>;
|
|
918
|
-
}], never> | undefined;
|
|
919
|
-
} & {
|
|
920
|
-
queryKey: [Pick<Options<GetTicketAttachmentData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
921
|
-
_id: string;
|
|
922
|
-
_infinite?: boolean;
|
|
923
|
-
tags?: ReadonlyArray<string>;
|
|
924
|
-
}] & {
|
|
925
|
-
[dataTagSymbol]: Blob | File;
|
|
926
|
-
[dataTagErrorSymbol]: Error;
|
|
927
|
-
};
|
|
928
|
-
};
|
|
929
|
-
export declare const listTokensQueryKey: (options?: Options<ListTokensData>) => [Pick<Options<ListTokensData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
1008
|
+
export declare const getJoinInformationMutation: (options?: Partial<Options<GetJoinInformationData>>) => UseMutationOptions<GetJoinInformationResponse, GetJoinInformationError, Options<GetJoinInformationData>>;
|
|
1009
|
+
export declare const getUsageQueryKey: (options?: Options<GetUsageData>) => [Pick<Options<GetUsageData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
930
1010
|
_id: string;
|
|
931
1011
|
_infinite?: boolean;
|
|
932
1012
|
tags?: ReadonlyArray<string>;
|
|
933
1013
|
}];
|
|
934
1014
|
/**
|
|
935
|
-
*
|
|
1015
|
+
* Get billing usage information.
|
|
936
1016
|
*
|
|
937
|
-
*
|
|
1017
|
+
* 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.
|
|
938
1018
|
*
|
|
939
1019
|
*/
|
|
940
|
-
export declare const
|
|
1020
|
+
export declare const getUsageOptions: (options?: Options<GetUsageData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen").UsageResponse, Error, import("../types.gen").UsageResponse, [Pick<Options<GetUsageData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
941
1021
|
_id: string;
|
|
942
1022
|
_infinite?: boolean;
|
|
943
1023
|
tags?: ReadonlyArray<string>;
|
|
944
1024
|
}]>, "queryFn"> & {
|
|
945
|
-
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").
|
|
1025
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").UsageResponse, [Pick<Options<GetUsageData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
946
1026
|
_id: string;
|
|
947
1027
|
_infinite?: boolean;
|
|
948
1028
|
tags?: ReadonlyArray<string>;
|
|
949
1029
|
}], never> | undefined;
|
|
950
1030
|
} & {
|
|
951
|
-
queryKey: [Pick<Options<
|
|
1031
|
+
queryKey: [Pick<Options<GetUsageData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
952
1032
|
_id: string;
|
|
953
1033
|
_infinite?: boolean;
|
|
954
1034
|
tags?: ReadonlyArray<string>;
|
|
955
1035
|
}] & {
|
|
956
|
-
[dataTagSymbol]: import("../types.gen").
|
|
1036
|
+
[dataTagSymbol]: import("../types.gen").UsageResponse;
|
|
957
1037
|
[dataTagErrorSymbol]: Error;
|
|
958
1038
|
};
|
|
959
1039
|
};
|
|
960
1040
|
/**
|
|
961
|
-
*
|
|
962
|
-
*
|
|
963
|
-
* 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.
|
|
964
|
-
*
|
|
965
|
-
* This endpoint is available to administrators of the organization only.
|
|
966
|
-
*
|
|
967
|
-
*/
|
|
968
|
-
export declare const createTokenMutation: (options?: Partial<Options<CreateTokenData>>) => UseMutationOptions<CreateTokenResponse, DefaultError, Options<CreateTokenData>>;
|
|
969
|
-
/**
|
|
970
|
-
* Permanently delete access token.
|
|
1041
|
+
* Get Stripe client secret.
|
|
971
1042
|
*
|
|
972
|
-
*
|
|
1043
|
+
* 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.
|
|
973
1044
|
*
|
|
974
1045
|
*/
|
|
975
|
-
export declare const
|
|
976
|
-
export declare const
|
|
1046
|
+
export declare const getPaymentMethodSecretMutation: (options?: Partial<Options<GetPaymentMethodSecretData>>) => UseMutationOptions<GetPaymentMethodSecretResponse, DefaultError, Options<GetPaymentMethodSecretData>>;
|
|
1047
|
+
export declare const listPaymentMethodsQueryKey: (options?: Options<ListPaymentMethodsData>) => [Pick<Options<ListPaymentMethodsData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
977
1048
|
_id: string;
|
|
978
1049
|
_infinite?: boolean;
|
|
979
1050
|
tags?: ReadonlyArray<string>;
|
|
980
1051
|
}];
|
|
981
1052
|
/**
|
|
982
|
-
*
|
|
1053
|
+
* List organization payment methods.
|
|
983
1054
|
*
|
|
984
|
-
*
|
|
1055
|
+
* 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.
|
|
985
1056
|
*
|
|
986
1057
|
*/
|
|
987
|
-
export declare const
|
|
1058
|
+
export declare const listPaymentMethodsOptions: (options?: Options<ListPaymentMethodsData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen").PaymentMethod[], Error, import("../types.gen").PaymentMethod[], [Pick<Options<ListPaymentMethodsData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
988
1059
|
_id: string;
|
|
989
1060
|
_infinite?: boolean;
|
|
990
1061
|
tags?: ReadonlyArray<string>;
|
|
991
1062
|
}]>, "queryFn"> & {
|
|
992
|
-
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").
|
|
1063
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").PaymentMethod[], [Pick<Options<ListPaymentMethodsData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
993
1064
|
_id: string;
|
|
994
1065
|
_infinite?: boolean;
|
|
995
1066
|
tags?: ReadonlyArray<string>;
|
|
996
1067
|
}], never> | undefined;
|
|
997
1068
|
} & {
|
|
998
|
-
queryKey: [Pick<Options<
|
|
1069
|
+
queryKey: [Pick<Options<ListPaymentMethodsData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
999
1070
|
_id: string;
|
|
1000
1071
|
_infinite?: boolean;
|
|
1001
1072
|
tags?: ReadonlyArray<string>;
|
|
1002
1073
|
}] & {
|
|
1003
|
-
[dataTagSymbol]: import("../types.gen").
|
|
1074
|
+
[dataTagSymbol]: import("../types.gen").PaymentMethod[];
|
|
1004
1075
|
[dataTagErrorSymbol]: Error;
|
|
1005
1076
|
};
|
|
1006
1077
|
};
|
|
1007
1078
|
/**
|
|
1008
|
-
*
|
|
1009
|
-
*
|
|
1010
|
-
* 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.
|
|
1079
|
+
* Set the default payment method.
|
|
1011
1080
|
*
|
|
1012
|
-
*
|
|
1081
|
+
* Sets the given payment method as the default used for invoices and active subscriptions. Requires the Administrator role.
|
|
1013
1082
|
*
|
|
1014
1083
|
*/
|
|
1015
|
-
export declare const
|
|
1084
|
+
export declare const setDefaultPaymentMethodMutation: (options?: Partial<Options<SetDefaultPaymentMethodData>>) => UseMutationOptions<SetDefaultPaymentMethodResponse, DefaultError, Options<SetDefaultPaymentMethodData>>;
|
|
1016
1085
|
/**
|
|
1017
|
-
*
|
|
1086
|
+
* Delete a payment method.
|
|
1087
|
+
*
|
|
1088
|
+
* 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.
|
|
1018
1089
|
*
|
|
1019
|
-
* Generates a new access token secret. Old secret will not be valid anymore.
|
|
1020
1090
|
*/
|
|
1021
|
-
export declare const
|
|
1022
|
-
export declare const
|
|
1091
|
+
export declare const deletePaymentMethodMutation: (options?: Partial<Options<DeletePaymentMethodData>>) => UseMutationOptions<DeletePaymentMethodResponse, DefaultError, Options<DeletePaymentMethodData>>;
|
|
1092
|
+
export declare const listInvoicesQueryKey: (options?: Options<ListInvoicesData>) => [Pick<Options<ListInvoicesData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
1023
1093
|
_id: string;
|
|
1024
1094
|
_infinite?: boolean;
|
|
1025
1095
|
tags?: ReadonlyArray<string>;
|
|
1026
1096
|
}];
|
|
1027
1097
|
/**
|
|
1028
|
-
*
|
|
1098
|
+
* List issued invoices.
|
|
1099
|
+
*
|
|
1100
|
+
* 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.
|
|
1101
|
+
*
|
|
1029
1102
|
*/
|
|
1030
|
-
export declare const
|
|
1031
|
-
realm?: string;
|
|
1032
|
-
displayName?: string;
|
|
1033
|
-
}[], Error, {
|
|
1034
|
-
realm?: string;
|
|
1035
|
-
displayName?: string;
|
|
1036
|
-
}[], [Pick<Options<ListUserOrganizationsData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
1103
|
+
export declare const listInvoicesOptions: (options?: Options<ListInvoicesData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen").Invoice[], Error, import("../types.gen").Invoice[], [Pick<Options<ListInvoicesData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
1037
1104
|
_id: string;
|
|
1038
1105
|
_infinite?: boolean;
|
|
1039
1106
|
tags?: ReadonlyArray<string>;
|
|
1040
1107
|
}]>, "queryFn"> & {
|
|
1041
|
-
queryFn?: import("@tanstack/react-query").QueryFunction<{
|
|
1042
|
-
realm?: string;
|
|
1043
|
-
displayName?: string;
|
|
1044
|
-
}[], [Pick<Options<ListUserOrganizationsData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
1108
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").Invoice[], [Pick<Options<ListInvoicesData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
1045
1109
|
_id: string;
|
|
1046
1110
|
_infinite?: boolean;
|
|
1047
1111
|
tags?: ReadonlyArray<string>;
|
|
1048
1112
|
}], never> | undefined;
|
|
1049
1113
|
} & {
|
|
1050
|
-
queryKey: [Pick<Options<
|
|
1114
|
+
queryKey: [Pick<Options<ListInvoicesData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
1051
1115
|
_id: string;
|
|
1052
1116
|
_infinite?: boolean;
|
|
1053
1117
|
tags?: ReadonlyArray<string>;
|
|
1054
1118
|
}] & {
|
|
1055
|
-
[dataTagSymbol]:
|
|
1056
|
-
realm?: string;
|
|
1057
|
-
displayName?: string;
|
|
1058
|
-
}[];
|
|
1119
|
+
[dataTagSymbol]: import("../types.gen").Invoice[];
|
|
1059
1120
|
[dataTagErrorSymbol]: Error;
|
|
1060
1121
|
};
|
|
1061
1122
|
};
|
|
1062
|
-
export declare const
|
|
1123
|
+
export declare const getContactQueryKey: (options?: Options<GetContactData>) => [Pick<Options<GetContactData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
1063
1124
|
_id: string;
|
|
1064
1125
|
_infinite?: boolean;
|
|
1065
1126
|
tags?: ReadonlyArray<string>;
|
|
1066
1127
|
}];
|
|
1067
1128
|
/**
|
|
1068
|
-
*
|
|
1069
|
-
*
|
|
1070
|
-
* 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.
|
|
1129
|
+
* Get organization contact and billing address information.
|
|
1071
1130
|
*
|
|
1072
|
-
* This endpoint is available to all users in the organization.
|
|
1131
|
+
* Returns the organization contact and billing address information. This endpoint is available to all users in the organization.
|
|
1073
1132
|
*
|
|
1074
1133
|
*/
|
|
1075
|
-
export declare const
|
|
1134
|
+
export declare const getContactOptions: (options?: Options<GetContactData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen").BillingContact, Error, import("../types.gen").BillingContact, [Pick<Options<GetContactData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
1076
1135
|
_id: string;
|
|
1077
1136
|
_infinite?: boolean;
|
|
1078
1137
|
tags?: ReadonlyArray<string>;
|
|
1079
1138
|
}]>, "queryFn"> & {
|
|
1080
|
-
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").
|
|
1139
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").BillingContact, [Pick<Options<GetContactData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
1081
1140
|
_id: string;
|
|
1082
1141
|
_infinite?: boolean;
|
|
1083
1142
|
tags?: ReadonlyArray<string>;
|
|
1084
1143
|
}], never> | undefined;
|
|
1085
1144
|
} & {
|
|
1086
|
-
queryKey: [Pick<Options<
|
|
1145
|
+
queryKey: [Pick<Options<GetContactData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
1087
1146
|
_id: string;
|
|
1088
1147
|
_infinite?: boolean;
|
|
1089
1148
|
tags?: ReadonlyArray<string>;
|
|
1090
1149
|
}] & {
|
|
1091
|
-
[dataTagSymbol]: import("../types.gen").
|
|
1150
|
+
[dataTagSymbol]: import("../types.gen").BillingContact;
|
|
1092
1151
|
[dataTagErrorSymbol]: Error;
|
|
1093
1152
|
};
|
|
1094
1153
|
};
|
|
1095
1154
|
/**
|
|
1096
|
-
*
|
|
1097
|
-
*
|
|
1098
|
-
* 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.
|
|
1099
|
-
*
|
|
1100
|
-
*/
|
|
1101
|
-
export declare const createUserMutation: (options?: Partial<Options<CreateUserData>>) => UseMutationOptions<CreateUserResponse, DefaultError, Options<CreateUserData>>;
|
|
1102
|
-
/**
|
|
1103
|
-
* Delete user by id.
|
|
1155
|
+
* Update organization contact information and billing address.
|
|
1104
1156
|
*
|
|
1105
|
-
*
|
|
1157
|
+
* This endpoint allows you to update organization details with its contact information. This endpoint is available to administrators of the organization only.
|
|
1106
1158
|
*
|
|
1107
1159
|
*/
|
|
1108
|
-
export declare const
|
|
1109
|
-
export declare const
|
|
1160
|
+
export declare const updateContactMutation: (options?: Partial<Options<UpdateContactData>>) => UseMutationOptions<UpdateContactResponse, DefaultError, Options<UpdateContactData>>;
|
|
1161
|
+
export declare const getCreditsQueryKey: (options?: Options<GetCreditsData>) => [Pick<Options<GetCreditsData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
1110
1162
|
_id: string;
|
|
1111
1163
|
_infinite?: boolean;
|
|
1112
1164
|
tags?: ReadonlyArray<string>;
|
|
1113
1165
|
}];
|
|
1114
1166
|
/**
|
|
1115
|
-
* Get
|
|
1116
|
-
*
|
|
1117
|
-
* Returns user details including their roles. For more information on identity access management, see [Users](https://cloudfleet.ai/docs/organization/users/) section of documentaiton.
|
|
1167
|
+
* Get applied promotional credits
|
|
1118
1168
|
*
|
|
1119
|
-
* This endpoint is available to all users in the organization.
|
|
1169
|
+
* 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.
|
|
1120
1170
|
*
|
|
1121
1171
|
*/
|
|
1122
|
-
export declare const
|
|
1172
|
+
export declare const getCreditsOptions: (options?: Options<GetCreditsData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen").BillingCredits[], Error, import("../types.gen").BillingCredits[], [Pick<Options<GetCreditsData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
1123
1173
|
_id: string;
|
|
1124
1174
|
_infinite?: boolean;
|
|
1125
1175
|
tags?: ReadonlyArray<string>;
|
|
1126
1176
|
}]>, "queryFn"> & {
|
|
1127
|
-
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").
|
|
1177
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").BillingCredits[], [Pick<Options<GetCreditsData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
1128
1178
|
_id: string;
|
|
1129
1179
|
_infinite?: boolean;
|
|
1130
1180
|
tags?: ReadonlyArray<string>;
|
|
1131
1181
|
}], never> | undefined;
|
|
1132
1182
|
} & {
|
|
1133
|
-
queryKey: [Pick<Options<
|
|
1183
|
+
queryKey: [Pick<Options<GetCreditsData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
1134
1184
|
_id: string;
|
|
1135
1185
|
_infinite?: boolean;
|
|
1136
1186
|
tags?: ReadonlyArray<string>;
|
|
1137
1187
|
}] & {
|
|
1138
|
-
[dataTagSymbol]: import("../types.gen").
|
|
1188
|
+
[dataTagSymbol]: import("../types.gen").BillingCredits[];
|
|
1139
1189
|
[dataTagErrorSymbol]: Error;
|
|
1140
1190
|
};
|
|
1141
1191
|
};
|
|
1142
1192
|
/**
|
|
1143
|
-
*
|
|
1193
|
+
* Redeem promotional credits code.
|
|
1144
1194
|
*
|
|
1145
|
-
*
|
|
1195
|
+
* 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.
|
|
1146
1196
|
*
|
|
1147
1197
|
*/
|
|
1148
|
-
export declare const
|
|
1198
|
+
export declare const redeemCreditsMutation: (options?: Partial<Options<RedeemCreditsData>>) => UseMutationOptions<unknown, DefaultError, Options<RedeemCreditsData>>;
|
|
1149
1199
|
//# sourceMappingURL=react-query.gen.d.ts.map
|