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