@cloudfleet/sdk 0.0.1-c4175a2 → 0.0.1-c4563f6
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 +521 -576
- package/dist/@tanstack/react-query.gen.d.ts.map +1 -1
- package/dist/@tanstack/react-query.gen.js +520 -382
- 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 +774 -252
- package/dist/schemas.gen.d.ts.map +1 -1
- package/dist/schemas.gen.js +1045 -362
- package/dist/schemas.gen.js.map +1 -1
- package/dist/sdk.gen.d.ts +265 -209
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/sdk.gen.js +396 -312
- package/dist/sdk.gen.js.map +1 -1
- package/dist/types.gen.d.ts +1359 -838
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/zod.gen.d.ts +1919 -1542
- package/dist/zod.gen.d.ts.map +1 -1
- package/dist/zod.gen.js +618 -366
- 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, 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,464 @@ 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`, 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.
|
|
368
|
-
*
|
|
369
|
-
* Setting status to `deleted` will permanently delete fleet. This operation cannot be undone. Your subscription will end by the end of the current billing period and you will not be able to receive credit for unused time. If you want to keep using the Fleet until the end of the billing period, set the status to `cancelling`.
|
|
370
|
-
*
|
|
371
|
-
* For more information, see [Fleets](https://cloudfleet.ai/docs/cloud-infrastructure/fleets/) section of documentaiton.
|
|
270
|
+
* Append a customer reply to a ticket.
|
|
372
271
|
*
|
|
373
|
-
*
|
|
272
|
+
* 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
273
|
*
|
|
375
274
|
*/
|
|
376
|
-
export declare const
|
|
377
|
-
export declare const
|
|
275
|
+
export declare const replyTicketMutation: (options?: Partial<Options<ReplyTicketData>>) => UseMutationOptions<ReplyTicketResponse, DefaultError, Options<ReplyTicketData>>;
|
|
276
|
+
export declare const getTicketAttachmentQueryKey: (options: Options<GetTicketAttachmentData>) => [Pick<Options<GetTicketAttachmentData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
378
277
|
_id: string;
|
|
379
278
|
_infinite?: boolean;
|
|
380
279
|
tags?: ReadonlyArray<string>;
|
|
381
280
|
}];
|
|
382
281
|
/**
|
|
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.
|
|
282
|
+
* Download a ticket attachment.
|
|
386
283
|
*/
|
|
387
|
-
export declare const
|
|
284
|
+
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
285
|
_id: string;
|
|
389
286
|
_infinite?: boolean;
|
|
390
287
|
tags?: ReadonlyArray<string>;
|
|
391
288
|
}]>, "queryFn"> & {
|
|
392
|
-
queryFn?: import("@tanstack/react-query").QueryFunction<
|
|
289
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<Blob | File, [Pick<Options<GetTicketAttachmentData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
393
290
|
_id: string;
|
|
394
291
|
_infinite?: boolean;
|
|
395
292
|
tags?: ReadonlyArray<string>;
|
|
396
293
|
}], 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"> & {
|
|
294
|
+
} & import("@tanstack/react-query").QueryKeyWithDataTag<[Pick<Options<GetTicketAttachmentData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
295
|
+
_id: string;
|
|
296
|
+
_infinite?: boolean;
|
|
297
|
+
tags?: ReadonlyArray<string>;
|
|
298
|
+
}], Blob | File, Error>;
|
|
299
|
+
export declare const listRoadmapQueryKey: (options?: Options<ListRoadmapData>) => [Pick<Options<ListRoadmapData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
408
300
|
_id: string;
|
|
409
301
|
_infinite?: boolean;
|
|
410
302
|
tags?: ReadonlyArray<string>;
|
|
411
303
|
}];
|
|
412
304
|
/**
|
|
413
|
-
* List
|
|
305
|
+
* List roadmap items.
|
|
414
306
|
*
|
|
415
|
-
* Returns
|
|
416
|
-
*
|
|
417
|
-
* This endpoint is available to all users in the organization.
|
|
307
|
+
* Returns the published roadmap items, newest first, each with your own vote. Votes of other users are not returned.
|
|
418
308
|
*
|
|
419
309
|
*/
|
|
420
|
-
export declare const
|
|
310
|
+
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
311
|
_id: string;
|
|
422
312
|
_infinite?: boolean;
|
|
423
313
|
tags?: ReadonlyArray<string>;
|
|
424
314
|
}]>, "queryFn"> & {
|
|
425
|
-
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").
|
|
315
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").RoadmapItem[], [Pick<Options<ListRoadmapData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
426
316
|
_id: string;
|
|
427
317
|
_infinite?: boolean;
|
|
428
318
|
tags?: ReadonlyArray<string>;
|
|
429
319
|
}], never> | undefined;
|
|
430
|
-
} & {
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
}] & {
|
|
436
|
-
[dataTagSymbol]: import("../types.gen").Cluster[];
|
|
437
|
-
[dataTagErrorSymbol]: Error;
|
|
438
|
-
};
|
|
439
|
-
};
|
|
320
|
+
} & import("@tanstack/react-query").QueryKeyWithDataTag<[Pick<Options<ListRoadmapData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
321
|
+
_id: string;
|
|
322
|
+
_infinite?: boolean;
|
|
323
|
+
tags?: ReadonlyArray<string>;
|
|
324
|
+
}], import("../types.gen").RoadmapItem[], Error>;
|
|
440
325
|
/**
|
|
441
|
-
*
|
|
442
|
-
*
|
|
443
|
-
* 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.
|
|
326
|
+
* Suggest a new roadmap item.
|
|
444
327
|
*
|
|
445
|
-
*
|
|
328
|
+
* 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
329
|
*
|
|
447
330
|
*/
|
|
448
|
-
export declare const
|
|
331
|
+
export declare const suggestRoadmapMutation: (options?: Partial<Options<SuggestRoadmapData>>) => UseMutationOptions<SuggestRoadmapResponse, DefaultError, Options<SuggestRoadmapData>>;
|
|
449
332
|
/**
|
|
450
|
-
*
|
|
451
|
-
|
|
452
|
-
|
|
333
|
+
* Remove your vote from a roadmap item.
|
|
334
|
+
*/
|
|
335
|
+
export declare const unvoteRoadmapMutation: (options?: Partial<Options<UnvoteRoadmapData>>) => UseMutationOptions<UnvoteRoadmapResponse, DefaultError, Options<UnvoteRoadmapData>>;
|
|
336
|
+
/**
|
|
337
|
+
* Vote on a roadmap item.
|
|
453
338
|
*
|
|
454
|
-
*
|
|
339
|
+
* 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
340
|
*
|
|
456
341
|
*/
|
|
457
|
-
export declare const
|
|
458
|
-
export declare const
|
|
342
|
+
export declare const voteRoadmapMutation: (options?: Partial<Options<VoteRoadmapData>>) => UseMutationOptions<VoteRoadmapResponse, DefaultError, Options<VoteRoadmapData>>;
|
|
343
|
+
export declare const listRepositoriesQueryKey: (options?: Options<ListRepositoriesData>) => [Pick<Options<ListRepositoriesData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
459
344
|
_id: string;
|
|
460
345
|
_infinite?: boolean;
|
|
461
346
|
tags?: ReadonlyArray<string>;
|
|
462
347
|
}];
|
|
463
348
|
/**
|
|
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.
|
|
349
|
+
* List repositories
|
|
467
350
|
*
|
|
468
|
-
* This endpoint is available to all users in the organization.
|
|
351
|
+
* Returns a list of repositories in the registry across all regions. This endpoint is available to all users in the organization.
|
|
469
352
|
*
|
|
470
353
|
*/
|
|
471
|
-
export declare const
|
|
354
|
+
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
355
|
_id: string;
|
|
473
356
|
_infinite?: boolean;
|
|
474
357
|
tags?: ReadonlyArray<string>;
|
|
475
358
|
}]>, "queryFn"> & {
|
|
476
|
-
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").
|
|
359
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").RegistryRepository[], [Pick<Options<ListRepositoriesData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
477
360
|
_id: string;
|
|
478
361
|
_infinite?: boolean;
|
|
479
362
|
tags?: ReadonlyArray<string>;
|
|
480
363
|
}], never> | undefined;
|
|
481
|
-
} & {
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
};
|
|
364
|
+
} & import("@tanstack/react-query").QueryKeyWithDataTag<[Pick<Options<ListRepositoriesData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
365
|
+
_id: string;
|
|
366
|
+
_infinite?: boolean;
|
|
367
|
+
tags?: ReadonlyArray<string>;
|
|
368
|
+
}], import("../types.gen").RegistryRepository[], Error>;
|
|
369
|
+
export declare const listTagsQueryKey: (options: Options<ListTagsData>) => [Pick<Options<ListTagsData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
370
|
+
_id: string;
|
|
371
|
+
_infinite?: boolean;
|
|
372
|
+
tags?: ReadonlyArray<string>;
|
|
373
|
+
}];
|
|
491
374
|
/**
|
|
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.
|
|
375
|
+
* List tags for a repository
|
|
495
376
|
*
|
|
496
|
-
* This endpoint is available to
|
|
377
|
+
* 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
378
|
*
|
|
498
379
|
*/
|
|
499
|
-
export declare const
|
|
380
|
+
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"> & {
|
|
381
|
+
_id: string;
|
|
382
|
+
_infinite?: boolean;
|
|
383
|
+
tags?: ReadonlyArray<string>;
|
|
384
|
+
}]>, "queryFn"> & {
|
|
385
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").RegistryRepositoryWithTags, [Pick<Options<ListTagsData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
386
|
+
_id: string;
|
|
387
|
+
_infinite?: boolean;
|
|
388
|
+
tags?: ReadonlyArray<string>;
|
|
389
|
+
}], never> | undefined;
|
|
390
|
+
} & import("@tanstack/react-query").QueryKeyWithDataTag<[Pick<Options<ListTagsData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
391
|
+
_id: string;
|
|
392
|
+
_infinite?: boolean;
|
|
393
|
+
tags?: ReadonlyArray<string>;
|
|
394
|
+
}], import("../types.gen").RegistryRepositoryWithTags, Error>;
|
|
500
395
|
/**
|
|
501
|
-
*
|
|
396
|
+
* Delete tag
|
|
502
397
|
*
|
|
503
|
-
*
|
|
398
|
+
* Permanently deletes a specific tag from a repository. This endpoint is available to administrators of the organization only.
|
|
504
399
|
*
|
|
505
400
|
*/
|
|
506
|
-
export declare const
|
|
507
|
-
export declare const
|
|
401
|
+
export declare const deleteTagMutation: (options?: Partial<Options<DeleteTagData>>) => UseMutationOptions<unknown, DefaultError, Options<DeleteTagData>>;
|
|
402
|
+
export declare const getTagQueryKey: (options: Options<GetTagData>) => [Pick<Options<GetTagData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
508
403
|
_id: string;
|
|
509
404
|
_infinite?: boolean;
|
|
510
405
|
tags?: ReadonlyArray<string>;
|
|
511
406
|
}];
|
|
512
407
|
/**
|
|
513
|
-
*
|
|
408
|
+
* Get tag details
|
|
514
409
|
*
|
|
515
|
-
* Returns a
|
|
410
|
+
* 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
411
|
*
|
|
517
412
|
*/
|
|
518
|
-
export declare const
|
|
413
|
+
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
414
|
_id: string;
|
|
520
415
|
_infinite?: boolean;
|
|
521
416
|
tags?: ReadonlyArray<string>;
|
|
522
417
|
}]>, "queryFn"> & {
|
|
523
|
-
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").
|
|
418
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").RegistryTag, [Pick<Options<GetTagData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
524
419
|
_id: string;
|
|
525
420
|
_infinite?: boolean;
|
|
526
421
|
tags?: ReadonlyArray<string>;
|
|
527
422
|
}], 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"> & {
|
|
423
|
+
} & import("@tanstack/react-query").QueryKeyWithDataTag<[Pick<Options<GetTagData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
424
|
+
_id: string;
|
|
425
|
+
_infinite?: boolean;
|
|
426
|
+
tags?: ReadonlyArray<string>;
|
|
427
|
+
}], import("../types.gen").RegistryTag, Error>;
|
|
428
|
+
export declare const getOrganizationQueryKey: (options?: Options<GetOrganizationData>) => [Pick<Options<GetOrganizationData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
546
429
|
_id: string;
|
|
547
430
|
_infinite?: boolean;
|
|
548
431
|
tags?: ReadonlyArray<string>;
|
|
549
432
|
}];
|
|
550
433
|
/**
|
|
551
|
-
* Get
|
|
434
|
+
* Get organization information.
|
|
552
435
|
*
|
|
553
|
-
* Returns
|
|
436
|
+
* Returns organization details including quota. For more information about quotas, see [Quotas and limits](https://cloudfleet.ai/docs/organization/quotas/) section of documentaiton.
|
|
437
|
+
*
|
|
438
|
+
* This endpoint is available to all users in the organization.
|
|
554
439
|
*
|
|
555
440
|
*/
|
|
556
|
-
export declare const
|
|
441
|
+
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
442
|
_id: string;
|
|
558
443
|
_infinite?: boolean;
|
|
559
444
|
tags?: ReadonlyArray<string>;
|
|
560
445
|
}]>, "queryFn"> & {
|
|
561
|
-
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").
|
|
446
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").Organization, [Pick<Options<GetOrganizationData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
562
447
|
_id: string;
|
|
563
448
|
_infinite?: boolean;
|
|
564
449
|
tags?: ReadonlyArray<string>;
|
|
565
450
|
}], never> | undefined;
|
|
566
|
-
} & {
|
|
567
|
-
|
|
568
|
-
|
|
569
|
-
|
|
570
|
-
|
|
571
|
-
}] & {
|
|
572
|
-
[dataTagSymbol]: import("../types.gen").Invite;
|
|
573
|
-
[dataTagErrorSymbol]: Error;
|
|
574
|
-
};
|
|
575
|
-
};
|
|
451
|
+
} & import("@tanstack/react-query").QueryKeyWithDataTag<[Pick<Options<GetOrganizationData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
452
|
+
_id: string;
|
|
453
|
+
_infinite?: boolean;
|
|
454
|
+
tags?: ReadonlyArray<string>;
|
|
455
|
+
}], import("../types.gen").Organization, Error>;
|
|
576
456
|
/**
|
|
577
|
-
*
|
|
457
|
+
* Create a new organization / Cloudfleet account signup.
|
|
578
458
|
*
|
|
579
|
-
*
|
|
459
|
+
* This endpoint allows you to create a new Cloudfleet organization and an administrator user.
|
|
580
460
|
*
|
|
581
461
|
*/
|
|
582
|
-
export declare const
|
|
462
|
+
export declare const createOrganizationMutation: (options?: Partial<Options<CreateOrganizationData>>) => UseMutationOptions<CreateOrganizationResponse, DefaultError, Options<CreateOrganizationData>>;
|
|
463
|
+
/**
|
|
464
|
+
* MCP endpoint
|
|
465
|
+
*
|
|
466
|
+
* MCP endpoint for handling Model Context Protocol JSON-RPC 2.0 messages.
|
|
467
|
+
*/
|
|
468
|
+
export declare const postMcpMutation: (options?: Partial<Options<PostMcpData>>) => UseMutationOptions<PostMcpResponse, DefaultError, Options<PostMcpData>>;
|
|
583
469
|
export declare const listMarketplaceChartsQueryKey: (options?: Options<ListMarketplaceChartsData>) => [Pick<Options<ListMarketplaceChartsData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
584
470
|
_id: string;
|
|
585
471
|
_infinite?: boolean;
|
|
@@ -603,16 +489,11 @@ export declare const listMarketplaceChartsOptions: (options?: Options<ListMarket
|
|
|
603
489
|
_infinite?: boolean;
|
|
604
490
|
tags?: ReadonlyArray<string>;
|
|
605
491
|
}], never> | undefined;
|
|
606
|
-
} & {
|
|
607
|
-
|
|
608
|
-
|
|
609
|
-
|
|
610
|
-
|
|
611
|
-
}] & {
|
|
612
|
-
[dataTagSymbol]: import("../types.gen").MarketplaceListing[];
|
|
613
|
-
[dataTagErrorSymbol]: Error;
|
|
614
|
-
};
|
|
615
|
-
};
|
|
492
|
+
} & import("@tanstack/react-query").QueryKeyWithDataTag<[Pick<Options<ListMarketplaceChartsData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
493
|
+
_id: string;
|
|
494
|
+
_infinite?: boolean;
|
|
495
|
+
tags?: ReadonlyArray<string>;
|
|
496
|
+
}], import("../types.gen").MarketplaceListing[], Error>;
|
|
616
497
|
export declare const getMarketplaceChartFilesQueryKey: (options: Options<GetMarketplaceChartFilesData>) => [Pick<Options<GetMarketplaceChartFilesData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
617
498
|
_id: string;
|
|
618
499
|
_infinite?: boolean;
|
|
@@ -638,488 +519,552 @@ export declare const getMarketplaceChartFilesOptions: (options: Options<GetMarke
|
|
|
638
519
|
_infinite?: boolean;
|
|
639
520
|
tags?: ReadonlyArray<string>;
|
|
640
521
|
}], never> | undefined;
|
|
641
|
-
} & {
|
|
642
|
-
|
|
522
|
+
} & import("@tanstack/react-query").QueryKeyWithDataTag<[Pick<Options<GetMarketplaceChartFilesData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
523
|
+
_id: string;
|
|
524
|
+
_infinite?: boolean;
|
|
525
|
+
tags?: ReadonlyArray<string>;
|
|
526
|
+
}], import("../types.gen").MarketplaceListingFiles, Error>;
|
|
527
|
+
export declare const listInvitesQueryKey: (options?: Options<ListInvitesData>) => [Pick<Options<ListInvitesData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
528
|
+
_id: string;
|
|
529
|
+
_infinite?: boolean;
|
|
530
|
+
tags?: ReadonlyArray<string>;
|
|
531
|
+
}];
|
|
532
|
+
/**
|
|
533
|
+
* List invites.
|
|
534
|
+
*
|
|
535
|
+
* Returns a list of pending (non-expired) invites under the current organization. This endpoint is available to administrators of the organization only.
|
|
536
|
+
*
|
|
537
|
+
*/
|
|
538
|
+
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"> & {
|
|
539
|
+
_id: string;
|
|
540
|
+
_infinite?: boolean;
|
|
541
|
+
tags?: ReadonlyArray<string>;
|
|
542
|
+
}]>, "queryFn"> & {
|
|
543
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").Invite[], [Pick<Options<ListInvitesData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
643
544
|
_id: string;
|
|
644
545
|
_infinite?: boolean;
|
|
645
546
|
tags?: ReadonlyArray<string>;
|
|
646
|
-
}]
|
|
647
|
-
|
|
648
|
-
|
|
649
|
-
|
|
650
|
-
|
|
547
|
+
}], never> | undefined;
|
|
548
|
+
} & import("@tanstack/react-query").QueryKeyWithDataTag<[Pick<Options<ListInvitesData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
549
|
+
_id: string;
|
|
550
|
+
_infinite?: boolean;
|
|
551
|
+
tags?: ReadonlyArray<string>;
|
|
552
|
+
}], import("../types.gen").Invite[], Error>;
|
|
651
553
|
/**
|
|
652
|
-
*
|
|
554
|
+
* Create a new invite.
|
|
555
|
+
*
|
|
556
|
+
* 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
557
|
*
|
|
654
|
-
* MCP endpoint for handling Model Context Protocol JSON-RPC 2.0 messages.
|
|
655
558
|
*/
|
|
656
|
-
export declare const
|
|
657
|
-
export declare const
|
|
559
|
+
export declare const createInviteMutation: (options?: Partial<Options<CreateInviteData>>) => UseMutationOptions<CreateInviteResponse, DefaultError, Options<CreateInviteData>>;
|
|
560
|
+
export declare const getInviteQueryKey: (options: Options<GetInviteData>) => [Pick<Options<GetInviteData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
658
561
|
_id: string;
|
|
659
562
|
_infinite?: boolean;
|
|
660
563
|
tags?: ReadonlyArray<string>;
|
|
661
564
|
}];
|
|
662
565
|
/**
|
|
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.
|
|
566
|
+
* Get invite information.
|
|
666
567
|
*
|
|
667
|
-
* This endpoint is
|
|
568
|
+
* 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
569
|
*
|
|
669
570
|
*/
|
|
670
|
-
export declare const
|
|
571
|
+
export declare const getInviteOptions: (options: Options<GetInviteData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<{
|
|
572
|
+
email?: string;
|
|
573
|
+
organization_id?: string;
|
|
574
|
+
}, Error, {
|
|
575
|
+
email?: string;
|
|
576
|
+
organization_id?: string;
|
|
577
|
+
}, [Pick<Options<GetInviteData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
671
578
|
_id: string;
|
|
672
579
|
_infinite?: boolean;
|
|
673
580
|
tags?: ReadonlyArray<string>;
|
|
674
581
|
}]>, "queryFn"> & {
|
|
675
|
-
queryFn?: import("@tanstack/react-query").QueryFunction<
|
|
582
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<{
|
|
583
|
+
email?: string;
|
|
584
|
+
organization_id?: string;
|
|
585
|
+
}, [Pick<Options<GetInviteData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
676
586
|
_id: string;
|
|
677
587
|
_infinite?: boolean;
|
|
678
588
|
tags?: ReadonlyArray<string>;
|
|
679
589
|
}], never> | undefined;
|
|
680
|
-
} & {
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
|
|
684
|
-
|
|
685
|
-
|
|
686
|
-
|
|
687
|
-
|
|
688
|
-
};
|
|
689
|
-
};
|
|
590
|
+
} & import("@tanstack/react-query").QueryKeyWithDataTag<[Pick<Options<GetInviteData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
591
|
+
_id: string;
|
|
592
|
+
_infinite?: boolean;
|
|
593
|
+
tags?: ReadonlyArray<string>;
|
|
594
|
+
}], {
|
|
595
|
+
email?: string;
|
|
596
|
+
organization_id?: string;
|
|
597
|
+
}, Error>;
|
|
690
598
|
/**
|
|
691
|
-
*
|
|
599
|
+
* Permanently delete invite.
|
|
692
600
|
*
|
|
693
|
-
* This endpoint
|
|
601
|
+
* Permanently deletes invite from the organization. This endpoint is available to administrators of the organization only.
|
|
694
602
|
*
|
|
695
603
|
*/
|
|
696
|
-
export declare const
|
|
697
|
-
export declare const
|
|
604
|
+
export declare const deleteInviteMutation: (options?: Partial<Options<DeleteInviteData>>) => UseMutationOptions<unknown, DefaultError, Options<DeleteInviteData>>;
|
|
605
|
+
export declare const queryClusterQueryKey: (options: Options<QueryClusterData>) => [Pick<Options<QueryClusterData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
698
606
|
_id: string;
|
|
699
607
|
_infinite?: boolean;
|
|
700
608
|
tags?: ReadonlyArray<string>;
|
|
701
609
|
}];
|
|
702
610
|
/**
|
|
703
|
-
*
|
|
704
|
-
*
|
|
705
|
-
* Returns a list of repositories in the registry across all regions. This endpoint is available to all users in the organization.
|
|
611
|
+
* Query Kubernetes cluster API
|
|
706
612
|
*
|
|
613
|
+
* 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
614
|
*/
|
|
708
|
-
export declare const
|
|
615
|
+
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
616
|
_id: string;
|
|
710
617
|
_infinite?: boolean;
|
|
711
618
|
tags?: ReadonlyArray<string>;
|
|
712
619
|
}]>, "queryFn"> & {
|
|
713
|
-
queryFn?: import("@tanstack/react-query").QueryFunction<
|
|
620
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<unknown, [Pick<Options<QueryClusterData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
714
621
|
_id: string;
|
|
715
622
|
_infinite?: boolean;
|
|
716
623
|
tags?: ReadonlyArray<string>;
|
|
717
624
|
}], 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"> & {
|
|
625
|
+
} & import("@tanstack/react-query").QueryKeyWithDataTag<[Pick<Options<QueryClusterData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
626
|
+
_id: string;
|
|
627
|
+
_infinite?: boolean;
|
|
628
|
+
tags?: ReadonlyArray<string>;
|
|
629
|
+
}], unknown, Error>;
|
|
630
|
+
export declare const listFleetsQueryKey: (options: Options<ListFleetsData>) => [Pick<Options<ListFleetsData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
729
631
|
_id: string;
|
|
730
632
|
_infinite?: boolean;
|
|
731
633
|
tags?: ReadonlyArray<string>;
|
|
732
634
|
}];
|
|
733
635
|
/**
|
|
734
|
-
* List
|
|
636
|
+
* List fleets.
|
|
735
637
|
*
|
|
736
|
-
* Returns a list of
|
|
638
|
+
* Returns a list of fleets belonging to the cluster. For more information, see [Fleets](https://cloudfleet.ai/docs/cloud-infrastructure/fleets/) section of documentaiton.
|
|
639
|
+
*
|
|
640
|
+
* This endpoint is available to all users in the organization.
|
|
737
641
|
*
|
|
738
642
|
*/
|
|
739
|
-
export declare const
|
|
643
|
+
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
644
|
_id: string;
|
|
741
645
|
_infinite?: boolean;
|
|
742
646
|
tags?: ReadonlyArray<string>;
|
|
743
647
|
}]>, "queryFn"> & {
|
|
744
|
-
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").
|
|
648
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").Fleet[], [Pick<Options<ListFleetsData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
745
649
|
_id: string;
|
|
746
650
|
_infinite?: boolean;
|
|
747
651
|
tags?: ReadonlyArray<string>;
|
|
748
652
|
}], never> | undefined;
|
|
749
|
-
} & {
|
|
750
|
-
|
|
751
|
-
|
|
752
|
-
|
|
753
|
-
|
|
754
|
-
}] & {
|
|
755
|
-
[dataTagSymbol]: import("../types.gen").RegistryRepositoryWithTags;
|
|
756
|
-
[dataTagErrorSymbol]: Error;
|
|
757
|
-
};
|
|
758
|
-
};
|
|
653
|
+
} & import("@tanstack/react-query").QueryKeyWithDataTag<[Pick<Options<ListFleetsData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
654
|
+
_id: string;
|
|
655
|
+
_infinite?: boolean;
|
|
656
|
+
tags?: ReadonlyArray<string>;
|
|
657
|
+
}], import("../types.gen").Fleet[], Error>;
|
|
759
658
|
/**
|
|
760
|
-
*
|
|
659
|
+
* Create a new fleet.
|
|
761
660
|
*
|
|
762
|
-
*
|
|
661
|
+
* 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.
|
|
662
|
+
*
|
|
663
|
+
* The cluster must be ready (status `deployed`) before a fleet can be added. Adding a fleet while the cluster is still provisioning returns `409`.
|
|
664
|
+
*
|
|
665
|
+
* This endpoint is available to administrators of the organization only.
|
|
763
666
|
*
|
|
764
667
|
*/
|
|
765
|
-
export declare const
|
|
766
|
-
|
|
668
|
+
export declare const createFleetMutation: (options?: Partial<Options<CreateFleetData>>) => UseMutationOptions<CreateFleetResponse, CreateFleetError, Options<CreateFleetData>>;
|
|
669
|
+
/**
|
|
670
|
+
* Permanently delete fleet.
|
|
671
|
+
*
|
|
672
|
+
* 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.
|
|
673
|
+
*
|
|
674
|
+
* 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.
|
|
675
|
+
*
|
|
676
|
+
* This endpoint is available to administrators of the organization only.
|
|
677
|
+
*
|
|
678
|
+
*/
|
|
679
|
+
export declare const deleteFleetMutation: (options?: Partial<Options<DeleteFleetData>>) => UseMutationOptions<DeleteFleetResponse, DeleteFleetError, Options<DeleteFleetData>>;
|
|
680
|
+
export declare const getFleetQueryKey: (options: Options<GetFleetData>) => [Pick<Options<GetFleetData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
767
681
|
_id: string;
|
|
768
682
|
_infinite?: boolean;
|
|
769
683
|
tags?: ReadonlyArray<string>;
|
|
770
684
|
}];
|
|
771
685
|
/**
|
|
772
|
-
* Get
|
|
686
|
+
* Get fleet information.
|
|
773
687
|
*
|
|
774
|
-
* Returns
|
|
688
|
+
* Returns fleet details. For more information, see [Fleets](https://cloudfleet.ai/docs/cloud-infrastructure/fleets/) section of documentaiton.
|
|
689
|
+
*
|
|
690
|
+
* This endpoint is available to all users in the organization.
|
|
775
691
|
*
|
|
776
692
|
*/
|
|
777
|
-
export declare const
|
|
693
|
+
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
694
|
_id: string;
|
|
779
695
|
_infinite?: boolean;
|
|
780
696
|
tags?: ReadonlyArray<string>;
|
|
781
697
|
}]>, "queryFn"> & {
|
|
782
|
-
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").
|
|
698
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").Fleet, [Pick<Options<GetFleetData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
783
699
|
_id: string;
|
|
784
700
|
_infinite?: boolean;
|
|
785
701
|
tags?: ReadonlyArray<string>;
|
|
786
702
|
}], never> | undefined;
|
|
787
|
-
} & {
|
|
788
|
-
|
|
789
|
-
|
|
790
|
-
|
|
791
|
-
|
|
792
|
-
|
|
793
|
-
|
|
794
|
-
|
|
795
|
-
|
|
796
|
-
|
|
797
|
-
|
|
703
|
+
} & import("@tanstack/react-query").QueryKeyWithDataTag<[Pick<Options<GetFleetData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
704
|
+
_id: string;
|
|
705
|
+
_infinite?: boolean;
|
|
706
|
+
tags?: ReadonlyArray<string>;
|
|
707
|
+
}], import("../types.gen").Fleet, Error>;
|
|
708
|
+
/**
|
|
709
|
+
* Update fleet information.
|
|
710
|
+
*
|
|
711
|
+
* This endpoint allows you to update fleet details.
|
|
712
|
+
*
|
|
713
|
+
* For more information, see [Fleets](https://cloudfleet.ai/docs/cloud-infrastructure/fleets/) section of documentaiton.
|
|
714
|
+
*
|
|
715
|
+
* 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).
|
|
716
|
+
*
|
|
717
|
+
* This endpoint is available to administrators of the organization only.
|
|
718
|
+
*
|
|
719
|
+
*/
|
|
720
|
+
export declare const updateFleetMutation: (options?: Partial<Options<UpdateFleetData>>) => UseMutationOptions<UpdateFleetResponse, UpdateFleetError, Options<UpdateFleetData>>;
|
|
721
|
+
export declare const listChartsQueryKey: (options: Options<ListChartsData>) => [Pick<Options<ListChartsData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
798
722
|
_id: string;
|
|
799
723
|
_infinite?: boolean;
|
|
800
724
|
tags?: ReadonlyArray<string>;
|
|
801
725
|
}];
|
|
802
726
|
/**
|
|
803
|
-
* List
|
|
727
|
+
* List charts.
|
|
804
728
|
*
|
|
805
|
-
* Returns
|
|
729
|
+
* Returns a list of charts in the cluster.
|
|
730
|
+
*
|
|
731
|
+
* This endpoint is available to all users in the organization.
|
|
806
732
|
*
|
|
807
733
|
*/
|
|
808
|
-
export declare const
|
|
734
|
+
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
735
|
_id: string;
|
|
810
736
|
_infinite?: boolean;
|
|
811
737
|
tags?: ReadonlyArray<string>;
|
|
812
738
|
}]>, "queryFn"> & {
|
|
813
|
-
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").
|
|
739
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").Chart[], [Pick<Options<ListChartsData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
814
740
|
_id: string;
|
|
815
741
|
_infinite?: boolean;
|
|
816
742
|
tags?: ReadonlyArray<string>;
|
|
817
743
|
}], never> | undefined;
|
|
818
|
-
} & {
|
|
819
|
-
|
|
820
|
-
|
|
821
|
-
|
|
822
|
-
|
|
823
|
-
}] & {
|
|
824
|
-
[dataTagSymbol]: import("../types.gen").TicketListResponse;
|
|
825
|
-
[dataTagErrorSymbol]: Error;
|
|
826
|
-
};
|
|
827
|
-
};
|
|
744
|
+
} & import("@tanstack/react-query").QueryKeyWithDataTag<[Pick<Options<ListChartsData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
745
|
+
_id: string;
|
|
746
|
+
_infinite?: boolean;
|
|
747
|
+
tags?: ReadonlyArray<string>;
|
|
748
|
+
}], import("../types.gen").Chart[], Error>;
|
|
828
749
|
/**
|
|
829
|
-
* Create a new
|
|
750
|
+
* Create a new chart.
|
|
830
751
|
*
|
|
831
|
-
*
|
|
752
|
+
* Create a new chart deployment.
|
|
753
|
+
*
|
|
754
|
+
* This endpoint is available to administrators of the organization only.
|
|
832
755
|
*
|
|
833
756
|
*/
|
|
834
|
-
export declare const
|
|
757
|
+
export declare const createChartMutation: (options?: Partial<Options<CreateChartData>>) => UseMutationOptions<CreateChartResponse, CreateChartError, Options<CreateChartData>>;
|
|
835
758
|
/**
|
|
836
|
-
*
|
|
759
|
+
* Permanently delete the chart deployment from the cluster.
|
|
837
760
|
*
|
|
838
|
-
*
|
|
761
|
+
* This endpoint will permanently delete chart. This operation cannot be undone.
|
|
762
|
+
*
|
|
763
|
+
* This endpoint is available to administrators of the organization only.
|
|
839
764
|
*
|
|
840
765
|
*/
|
|
841
|
-
export declare const
|
|
842
|
-
export declare const
|
|
766
|
+
export declare const deleteChartMutation: (options?: Partial<Options<DeleteChartData>>) => UseMutationOptions<DeleteChartResponse, DeleteChartError, Options<DeleteChartData>>;
|
|
767
|
+
export declare const getChartQueryKey: (options: Options<GetChartData>) => [Pick<Options<GetChartData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
843
768
|
_id: string;
|
|
844
769
|
_infinite?: boolean;
|
|
845
770
|
tags?: ReadonlyArray<string>;
|
|
846
771
|
}];
|
|
847
772
|
/**
|
|
848
|
-
* Get
|
|
773
|
+
* Get chart information.
|
|
774
|
+
*
|
|
775
|
+
* Returns the details of the chart deployment.
|
|
776
|
+
*
|
|
777
|
+
* This endpoint is available to all users in the organization.
|
|
778
|
+
*
|
|
849
779
|
*/
|
|
850
|
-
export declare const
|
|
780
|
+
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
781
|
_id: string;
|
|
852
782
|
_infinite?: boolean;
|
|
853
783
|
tags?: ReadonlyArray<string>;
|
|
854
784
|
}]>, "queryFn"> & {
|
|
855
|
-
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").
|
|
785
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").Chart, [Pick<Options<GetChartData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
856
786
|
_id: string;
|
|
857
787
|
_infinite?: boolean;
|
|
858
788
|
tags?: ReadonlyArray<string>;
|
|
859
789
|
}], never> | undefined;
|
|
860
|
-
} & {
|
|
861
|
-
|
|
862
|
-
|
|
863
|
-
|
|
864
|
-
|
|
865
|
-
}] & {
|
|
866
|
-
[dataTagSymbol]: import("../types.gen").Ticket;
|
|
867
|
-
[dataTagErrorSymbol]: Error;
|
|
868
|
-
};
|
|
869
|
-
};
|
|
790
|
+
} & import("@tanstack/react-query").QueryKeyWithDataTag<[Pick<Options<GetChartData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
791
|
+
_id: string;
|
|
792
|
+
_infinite?: boolean;
|
|
793
|
+
tags?: ReadonlyArray<string>;
|
|
794
|
+
}], import("../types.gen").Chart, Error>;
|
|
870
795
|
/**
|
|
871
|
-
*
|
|
796
|
+
* Update chart information.
|
|
872
797
|
*
|
|
873
|
-
*
|
|
798
|
+
* This endpoint allows you to update the values of a chart deployment.
|
|
799
|
+
*
|
|
800
|
+
* This endpoint is available to administrators of the organization only.
|
|
874
801
|
*
|
|
875
802
|
*/
|
|
876
|
-
export declare const
|
|
877
|
-
export declare const
|
|
803
|
+
export declare const updateChartMutation: (options?: Partial<Options<UpdateChartData>>) => UseMutationOptions<UpdateChartResponse, UpdateChartError, Options<UpdateChartData>>;
|
|
804
|
+
export declare const listClustersQueryKey: (options?: Options<ListClustersData>) => [Pick<Options<ListClustersData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
878
805
|
_id: string;
|
|
879
806
|
_infinite?: boolean;
|
|
880
807
|
tags?: ReadonlyArray<string>;
|
|
881
808
|
}];
|
|
882
809
|
/**
|
|
883
|
-
*
|
|
810
|
+
* List clusters.
|
|
811
|
+
*
|
|
812
|
+
* Returns a list of clusters under the current organization.
|
|
813
|
+
*
|
|
814
|
+
* This endpoint is available to all users in the organization.
|
|
815
|
+
*
|
|
884
816
|
*/
|
|
885
|
-
export declare const
|
|
817
|
+
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
818
|
_id: string;
|
|
887
819
|
_infinite?: boolean;
|
|
888
820
|
tags?: ReadonlyArray<string>;
|
|
889
821
|
}]>, "queryFn"> & {
|
|
890
|
-
queryFn?: import("@tanstack/react-query").QueryFunction<
|
|
822
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").Cluster[], [Pick<Options<ListClustersData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
891
823
|
_id: string;
|
|
892
824
|
_infinite?: boolean;
|
|
893
825
|
tags?: ReadonlyArray<string>;
|
|
894
826
|
}], never> | undefined;
|
|
895
|
-
} & {
|
|
896
|
-
|
|
897
|
-
|
|
898
|
-
|
|
899
|
-
|
|
900
|
-
|
|
901
|
-
|
|
902
|
-
|
|
903
|
-
|
|
904
|
-
|
|
905
|
-
|
|
827
|
+
} & import("@tanstack/react-query").QueryKeyWithDataTag<[Pick<Options<ListClustersData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
828
|
+
_id: string;
|
|
829
|
+
_infinite?: boolean;
|
|
830
|
+
tags?: ReadonlyArray<string>;
|
|
831
|
+
}], import("../types.gen").Cluster[], Error>;
|
|
832
|
+
/**
|
|
833
|
+
* Create a new cluster.
|
|
834
|
+
*
|
|
835
|
+
* 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.
|
|
836
|
+
*
|
|
837
|
+
* This endpoint is available to administrators of the organization only.
|
|
838
|
+
*
|
|
839
|
+
*/
|
|
840
|
+
export declare const createClusterMutation: (options?: Partial<Options<CreateClusterData>>) => UseMutationOptions<CreateClusterResponse, CreateClusterError, Options<CreateClusterData>>;
|
|
841
|
+
/**
|
|
842
|
+
* Permanently delete cluster.
|
|
843
|
+
*
|
|
844
|
+
* This endpoint will permanently delete the cluster. This operation cannot be undone.
|
|
845
|
+
*
|
|
846
|
+
* 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.
|
|
847
|
+
*
|
|
848
|
+
* This endpoint is available to administrators of the organization only.
|
|
849
|
+
*
|
|
850
|
+
*/
|
|
851
|
+
export declare const deleteClusterMutation: (options?: Partial<Options<DeleteClusterData>>) => UseMutationOptions<DeleteClusterResponse, DeleteClusterError, Options<DeleteClusterData>>;
|
|
852
|
+
export declare const getClusterQueryKey: (options: Options<GetClusterData>) => [Pick<Options<GetClusterData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
906
853
|
_id: string;
|
|
907
854
|
_infinite?: boolean;
|
|
908
855
|
tags?: ReadonlyArray<string>;
|
|
909
856
|
}];
|
|
910
857
|
/**
|
|
911
|
-
*
|
|
858
|
+
* Get cluster information.
|
|
912
859
|
*
|
|
913
|
-
*
|
|
860
|
+
* Returns cluster details.
|
|
861
|
+
*
|
|
862
|
+
* This endpoint is available to all users in the organization.
|
|
914
863
|
*
|
|
915
864
|
*/
|
|
916
|
-
export declare const
|
|
865
|
+
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
866
|
_id: string;
|
|
918
867
|
_infinite?: boolean;
|
|
919
868
|
tags?: ReadonlyArray<string>;
|
|
920
869
|
}]>, "queryFn"> & {
|
|
921
|
-
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").
|
|
870
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").Cluster, [Pick<Options<GetClusterData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
922
871
|
_id: string;
|
|
923
872
|
_infinite?: boolean;
|
|
924
873
|
tags?: ReadonlyArray<string>;
|
|
925
874
|
}], never> | undefined;
|
|
926
|
-
} & {
|
|
927
|
-
|
|
928
|
-
|
|
929
|
-
|
|
930
|
-
|
|
931
|
-
}] & {
|
|
932
|
-
[dataTagSymbol]: import("../types.gen").Token[];
|
|
933
|
-
[dataTagErrorSymbol]: Error;
|
|
934
|
-
};
|
|
935
|
-
};
|
|
875
|
+
} & import("@tanstack/react-query").QueryKeyWithDataTag<[Pick<Options<GetClusterData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
876
|
+
_id: string;
|
|
877
|
+
_infinite?: boolean;
|
|
878
|
+
tags?: ReadonlyArray<string>;
|
|
879
|
+
}], import("../types.gen").Cluster, Error>;
|
|
936
880
|
/**
|
|
937
|
-
*
|
|
881
|
+
* Update cluster information.
|
|
938
882
|
*
|
|
939
|
-
* This endpoint allows you to
|
|
883
|
+
* 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.
|
|
884
|
+
*
|
|
885
|
+
* This is a full overwrite: any field omitted from the request is reset to its default rather than left unchanged.
|
|
940
886
|
*
|
|
941
887
|
* This endpoint is available to administrators of the organization only.
|
|
942
888
|
*
|
|
943
889
|
*/
|
|
944
|
-
export declare const
|
|
890
|
+
export declare const updateClusterMutation: (options?: Partial<Options<UpdateClusterData>>) => UseMutationOptions<UpdateClusterResponse, UpdateClusterError, Options<UpdateClusterData>>;
|
|
945
891
|
/**
|
|
946
|
-
*
|
|
892
|
+
* Node join information for the cluster
|
|
947
893
|
*
|
|
948
|
-
*
|
|
894
|
+
* 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
895
|
*
|
|
950
896
|
*/
|
|
951
|
-
export declare const
|
|
952
|
-
export declare const
|
|
897
|
+
export declare const getJoinInformationMutation: (options?: Partial<Options<GetJoinInformationData>>) => UseMutationOptions<GetJoinInformationResponse, GetJoinInformationError, Options<GetJoinInformationData>>;
|
|
898
|
+
export declare const getUsageQueryKey: (options?: Options<GetUsageData>) => [Pick<Options<GetUsageData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
953
899
|
_id: string;
|
|
954
900
|
_infinite?: boolean;
|
|
955
901
|
tags?: ReadonlyArray<string>;
|
|
956
902
|
}];
|
|
957
903
|
/**
|
|
958
|
-
* Get
|
|
904
|
+
* Get billing usage information.
|
|
959
905
|
*
|
|
960
|
-
*
|
|
906
|
+
* 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
907
|
*
|
|
962
908
|
*/
|
|
963
|
-
export declare const
|
|
909
|
+
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
910
|
_id: string;
|
|
965
911
|
_infinite?: boolean;
|
|
966
912
|
tags?: ReadonlyArray<string>;
|
|
967
913
|
}]>, "queryFn"> & {
|
|
968
|
-
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").
|
|
914
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").UsageResponse, [Pick<Options<GetUsageData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
969
915
|
_id: string;
|
|
970
916
|
_infinite?: boolean;
|
|
971
917
|
tags?: ReadonlyArray<string>;
|
|
972
918
|
}], never> | undefined;
|
|
973
|
-
} & {
|
|
974
|
-
|
|
919
|
+
} & import("@tanstack/react-query").QueryKeyWithDataTag<[Pick<Options<GetUsageData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
920
|
+
_id: string;
|
|
921
|
+
_infinite?: boolean;
|
|
922
|
+
tags?: ReadonlyArray<string>;
|
|
923
|
+
}], import("../types.gen").UsageResponse, Error>;
|
|
924
|
+
/**
|
|
925
|
+
* Get Stripe client secret.
|
|
926
|
+
*
|
|
927
|
+
* 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.
|
|
928
|
+
*
|
|
929
|
+
*/
|
|
930
|
+
export declare const getPaymentMethodSecretMutation: (options?: Partial<Options<GetPaymentMethodSecretData>>) => UseMutationOptions<GetPaymentMethodSecretResponse, DefaultError, Options<GetPaymentMethodSecretData>>;
|
|
931
|
+
export declare const listPaymentMethodsQueryKey: (options?: Options<ListPaymentMethodsData>) => [Pick<Options<ListPaymentMethodsData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
932
|
+
_id: string;
|
|
933
|
+
_infinite?: boolean;
|
|
934
|
+
tags?: ReadonlyArray<string>;
|
|
935
|
+
}];
|
|
936
|
+
/**
|
|
937
|
+
* List organization payment methods.
|
|
938
|
+
*
|
|
939
|
+
* 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.
|
|
940
|
+
*
|
|
941
|
+
*/
|
|
942
|
+
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"> & {
|
|
943
|
+
_id: string;
|
|
944
|
+
_infinite?: boolean;
|
|
945
|
+
tags?: ReadonlyArray<string>;
|
|
946
|
+
}]>, "queryFn"> & {
|
|
947
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").PaymentMethod[], [Pick<Options<ListPaymentMethodsData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
975
948
|
_id: string;
|
|
976
949
|
_infinite?: boolean;
|
|
977
950
|
tags?: ReadonlyArray<string>;
|
|
978
|
-
}]
|
|
979
|
-
|
|
980
|
-
|
|
981
|
-
|
|
982
|
-
|
|
951
|
+
}], never> | undefined;
|
|
952
|
+
} & import("@tanstack/react-query").QueryKeyWithDataTag<[Pick<Options<ListPaymentMethodsData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
953
|
+
_id: string;
|
|
954
|
+
_infinite?: boolean;
|
|
955
|
+
tags?: ReadonlyArray<string>;
|
|
956
|
+
}], import("../types.gen").PaymentMethod[], Error>;
|
|
983
957
|
/**
|
|
984
|
-
*
|
|
958
|
+
* Set the default payment method.
|
|
985
959
|
*
|
|
986
|
-
*
|
|
987
|
-
*
|
|
988
|
-
* This endpoint is available to administrators of the organization only.
|
|
960
|
+
* Sets the given payment method as the default used for invoices and active subscriptions. Requires the Administrator role.
|
|
989
961
|
*
|
|
990
962
|
*/
|
|
991
|
-
export declare const
|
|
963
|
+
export declare const setDefaultPaymentMethodMutation: (options?: Partial<Options<SetDefaultPaymentMethodData>>) => UseMutationOptions<SetDefaultPaymentMethodResponse, DefaultError, Options<SetDefaultPaymentMethodData>>;
|
|
992
964
|
/**
|
|
993
|
-
*
|
|
965
|
+
* Delete a payment method.
|
|
966
|
+
*
|
|
967
|
+
* 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
968
|
*
|
|
995
|
-
* Generates a new access token secret. Old secret will not be valid anymore.
|
|
996
969
|
*/
|
|
997
|
-
export declare const
|
|
998
|
-
export declare const
|
|
970
|
+
export declare const deletePaymentMethodMutation: (options?: Partial<Options<DeletePaymentMethodData>>) => UseMutationOptions<DeletePaymentMethodResponse, DefaultError, Options<DeletePaymentMethodData>>;
|
|
971
|
+
export declare const listInvoicesQueryKey: (options?: Options<ListInvoicesData>) => [Pick<Options<ListInvoicesData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
999
972
|
_id: string;
|
|
1000
973
|
_infinite?: boolean;
|
|
1001
974
|
tags?: ReadonlyArray<string>;
|
|
1002
975
|
}];
|
|
1003
976
|
/**
|
|
1004
|
-
*
|
|
977
|
+
* List issued invoices.
|
|
978
|
+
*
|
|
979
|
+
* 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.
|
|
980
|
+
*
|
|
1005
981
|
*/
|
|
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"> & {
|
|
982
|
+
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
983
|
_id: string;
|
|
1014
984
|
_infinite?: boolean;
|
|
1015
985
|
tags?: ReadonlyArray<string>;
|
|
1016
986
|
}]>, "queryFn"> & {
|
|
1017
|
-
queryFn?: import("@tanstack/react-query").QueryFunction<{
|
|
1018
|
-
realm?: string;
|
|
1019
|
-
displayName?: string;
|
|
1020
|
-
}[], [Pick<Options<ListUserOrganizationsData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
987
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").Invoice[], [Pick<Options<ListInvoicesData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
1021
988
|
_id: string;
|
|
1022
989
|
_infinite?: boolean;
|
|
1023
990
|
tags?: ReadonlyArray<string>;
|
|
1024
991
|
}], 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"> & {
|
|
992
|
+
} & import("@tanstack/react-query").QueryKeyWithDataTag<[Pick<Options<ListInvoicesData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
1039
993
|
_id: string;
|
|
1040
994
|
_infinite?: boolean;
|
|
1041
995
|
tags?: ReadonlyArray<string>;
|
|
1042
|
-
}]
|
|
996
|
+
}], import("../types.gen").Invoice[], Error>;
|
|
1043
997
|
/**
|
|
1044
|
-
*
|
|
998
|
+
* Pay the organization's open invoices.
|
|
1045
999
|
*
|
|
1046
|
-
*
|
|
1000
|
+
* Charges all open invoices of the organization against its default payment method. This endpoint is available to administrators of the organization only.
|
|
1047
1001
|
*
|
|
1048
|
-
|
|
1002
|
+
*/
|
|
1003
|
+
export declare const payOpenInvoicesMutation: (options?: Partial<Options<PayOpenInvoicesData>>) => UseMutationOptions<PayOpenInvoicesResponse, DefaultError, Options<PayOpenInvoicesData>>;
|
|
1004
|
+
export declare const getContactQueryKey: (options?: Options<GetContactData>) => [Pick<Options<GetContactData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
1005
|
+
_id: string;
|
|
1006
|
+
_infinite?: boolean;
|
|
1007
|
+
tags?: ReadonlyArray<string>;
|
|
1008
|
+
}];
|
|
1009
|
+
/**
|
|
1010
|
+
* Get organization contact and billing address information.
|
|
1011
|
+
*
|
|
1012
|
+
* Returns the organization contact and billing address information. This endpoint is available to all users in the organization.
|
|
1049
1013
|
*
|
|
1050
1014
|
*/
|
|
1051
|
-
export declare const
|
|
1015
|
+
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
1016
|
_id: string;
|
|
1053
1017
|
_infinite?: boolean;
|
|
1054
1018
|
tags?: ReadonlyArray<string>;
|
|
1055
1019
|
}]>, "queryFn"> & {
|
|
1056
|
-
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").
|
|
1020
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").BillingContact, [Pick<Options<GetContactData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
1057
1021
|
_id: string;
|
|
1058
1022
|
_infinite?: boolean;
|
|
1059
1023
|
tags?: ReadonlyArray<string>;
|
|
1060
1024
|
}], 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>>;
|
|
1025
|
+
} & import("@tanstack/react-query").QueryKeyWithDataTag<[Pick<Options<GetContactData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
1026
|
+
_id: string;
|
|
1027
|
+
_infinite?: boolean;
|
|
1028
|
+
tags?: ReadonlyArray<string>;
|
|
1029
|
+
}], import("../types.gen").BillingContact, Error>;
|
|
1078
1030
|
/**
|
|
1079
|
-
*
|
|
1031
|
+
* Update organization contact information and billing address.
|
|
1080
1032
|
*
|
|
1081
|
-
*
|
|
1033
|
+
* This endpoint allows you to update organization details with its contact information. This endpoint is available to administrators of the organization only.
|
|
1082
1034
|
*
|
|
1083
1035
|
*/
|
|
1084
|
-
export declare const
|
|
1085
|
-
export declare const
|
|
1036
|
+
export declare const updateContactMutation: (options?: Partial<Options<UpdateContactData>>) => UseMutationOptions<UpdateContactResponse, DefaultError, Options<UpdateContactData>>;
|
|
1037
|
+
export declare const getCreditsQueryKey: (options?: Options<GetCreditsData>) => [Pick<Options<GetCreditsData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
1086
1038
|
_id: string;
|
|
1087
1039
|
_infinite?: boolean;
|
|
1088
1040
|
tags?: ReadonlyArray<string>;
|
|
1089
1041
|
}];
|
|
1090
1042
|
/**
|
|
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.
|
|
1043
|
+
* Get applied promotional credits
|
|
1094
1044
|
*
|
|
1095
|
-
* This endpoint is available to all users in the organization.
|
|
1045
|
+
* 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
1046
|
*
|
|
1097
1047
|
*/
|
|
1098
|
-
export declare const
|
|
1048
|
+
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
1049
|
_id: string;
|
|
1100
1050
|
_infinite?: boolean;
|
|
1101
1051
|
tags?: ReadonlyArray<string>;
|
|
1102
1052
|
}]>, "queryFn"> & {
|
|
1103
|
-
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").
|
|
1053
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").BillingCredits[], [Pick<Options<GetCreditsData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
1104
1054
|
_id: string;
|
|
1105
1055
|
_infinite?: boolean;
|
|
1106
1056
|
tags?: ReadonlyArray<string>;
|
|
1107
1057
|
}], never> | undefined;
|
|
1108
|
-
} & {
|
|
1109
|
-
|
|
1110
|
-
|
|
1111
|
-
|
|
1112
|
-
|
|
1113
|
-
}] & {
|
|
1114
|
-
[dataTagSymbol]: import("../types.gen").User;
|
|
1115
|
-
[dataTagErrorSymbol]: Error;
|
|
1116
|
-
};
|
|
1117
|
-
};
|
|
1058
|
+
} & import("@tanstack/react-query").QueryKeyWithDataTag<[Pick<Options<GetCreditsData>, "body" | "path" | "query" | "headers" | "baseUrl"> & {
|
|
1059
|
+
_id: string;
|
|
1060
|
+
_infinite?: boolean;
|
|
1061
|
+
tags?: ReadonlyArray<string>;
|
|
1062
|
+
}], import("../types.gen").BillingCredits[], Error>;
|
|
1118
1063
|
/**
|
|
1119
|
-
*
|
|
1064
|
+
* Redeem promotional credits code.
|
|
1120
1065
|
*
|
|
1121
|
-
*
|
|
1066
|
+
* 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
1067
|
*
|
|
1123
1068
|
*/
|
|
1124
|
-
export declare const
|
|
1069
|
+
export declare const redeemCreditsMutation: (options?: Partial<Options<RedeemCreditsData>>) => UseMutationOptions<unknown, DefaultError, Options<RedeemCreditsData>>;
|
|
1125
1070
|
//# sourceMappingURL=react-query.gen.d.ts.map
|