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