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