@cloudfleet/sdk 0.0.1-28564af → 0.0.1-289b770
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 +971 -514
- package/dist/schemas.gen.d.ts.map +1 -1
- package/dist/schemas.gen.js +1961 -664
- 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 +1334 -994
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/zod.gen.d.ts +3539 -1498
- package/dist/zod.gen.d.ts.map +1 -1
- package/dist/zod.gen.js +1289 -399
- package/dist/zod.gen.js.map +1 -1
- package/package.json +10 -15
package/dist/sdk.gen.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { type Client, type Options as Options2, type TDataShape } from './client';
|
|
2
|
-
import type { CloseTicketData, CloseTicketResponses,
|
|
2
|
+
import type { CloseTicketData, CloseTicketResponses, CreateClusterData, CreateClusterErrors, CreateClusterResponses, CreateFleetData, CreateFleetErrors, CreateFleetResponses, CreateInviteData, CreateInviteResponses, CreateOrganizationData, CreateOrganizationResponses, CreateTicketData, CreateTicketResponses, CreateTokenData, CreateTokenErrors, CreateTokenResponses, CreateUserData, CreateUserResponses, DeleteClusterData, DeleteClusterErrors, DeleteClusterResponses, DeleteFleetData, DeleteFleetErrors, DeleteFleetResponses, DeleteInviteData, DeleteInviteResponses, DeletePaymentMethodData, DeletePaymentMethodErrors, DeletePaymentMethodResponses, DeleteTagData, DeleteTagErrors, DeleteTagResponses, DeleteTokenData, DeleteTokenResponses, DeleteUserData, DeleteUserErrors, DeleteUserResponses, GetClusterData, GetClusterResponses, GetContactData, GetContactResponses, GetCreditsData, GetCreditsErrors, GetCreditsResponses, GetFleetData, GetFleetResponses, GetInviteData, GetInviteResponses, GetJoinInformationData, GetJoinInformationErrors, GetJoinInformationResponses, GetOrganizationData, GetOrganizationResponses, GetPaymentMethodSecretData, GetPaymentMethodSecretResponses, GetTagData, GetTagErrors, GetTagResponses, GetTicketAttachmentData, GetTicketAttachmentResponses, GetTicketData, GetTicketResponses, GetTokenData, GetTokenErrors, GetTokenResponses, GetUsageData, GetUsageErrors, GetUsageResponses, GetUserData, GetUserErrors, GetUserResponses, GrantTicketSupportAccessData, GrantTicketSupportAccessErrors, GrantTicketSupportAccessResponses, ListClustersData, ListClustersErrors, ListClustersResponses, ListFleetsData, ListFleetsErrors, ListFleetsResponses, ListInvitesData, ListInvitesErrors, ListInvitesResponses, ListInvoicesData, ListInvoicesErrors, ListInvoicesResponses, ListPaymentMethodsData, ListPaymentMethodsErrors, ListPaymentMethodsResponses, ListRepositoriesData, ListRepositoriesErrors, ListRepositoriesResponses, ListRoadmapData, ListRoadmapResponses, ListTagsData, ListTagsErrors, ListTagsResponses, ListTicketsData, ListTicketsResponses, ListTokensData, ListTokensErrors, ListTokensResponses, ListUserOrganizationsData, ListUserOrganizationsResponses, ListUsersData, ListUsersErrors, ListUsersResponses, PayOpenInvoicesData, PayOpenInvoicesErrors, PayOpenInvoicesResponses, PostMcpData, PostMcpErrors, PostMcpResponses, QueryClusterData, QueryClusterErrors, QueryClusterResponses, RedeemCreditsData, RedeemCreditsErrors, RedeemCreditsResponses, RegenerateTokenData, RegenerateTokenErrors, RegenerateTokenResponses, ReplyTicketData, ReplyTicketErrors, ReplyTicketResponses, SendFeedbackData, SendFeedbackErrors, SendFeedbackResponses, SetDefaultPaymentMethodData, SetDefaultPaymentMethodErrors, SetDefaultPaymentMethodResponses, SuggestRoadmapData, SuggestRoadmapResponses, UnvoteRoadmapData, UnvoteRoadmapErrors, UnvoteRoadmapResponses, UpdateClusterData, UpdateClusterErrors, UpdateClusterResponses, UpdateContactData, UpdateContactResponses, UpdateFleetData, UpdateFleetErrors, UpdateFleetResponses, UpdateTokenData, UpdateTokenErrors, UpdateTokenResponses, UpdateUserData, UpdateUserResponses, VoteRoadmapData, VoteRoadmapErrors, VoteRoadmapResponses } from './types.gen';
|
|
3
3
|
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
|
|
4
4
|
/**
|
|
5
5
|
* You can provide a client instance returned by `createClient()` instead of
|
|
@@ -13,223 +13,231 @@ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends
|
|
|
13
13
|
*/
|
|
14
14
|
meta?: Record<string, unknown>;
|
|
15
15
|
};
|
|
16
|
-
export declare class
|
|
16
|
+
export declare class UsersService {
|
|
17
17
|
/**
|
|
18
|
-
* Get
|
|
19
|
-
*
|
|
20
|
-
* 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.
|
|
21
|
-
*
|
|
18
|
+
* Get a list of organizations the user belongs to. Used during authentication process.
|
|
22
19
|
*/
|
|
23
|
-
static
|
|
20
|
+
static listUserOrganizations<ThrowOnError extends boolean = false>(options: Options<ListUserOrganizationsData, ThrowOnError>): import("./client").RequestResult<ListUserOrganizationsResponses, unknown, ThrowOnError, "fields">;
|
|
24
21
|
/**
|
|
25
|
-
*
|
|
22
|
+
* List users in organization.
|
|
26
23
|
*
|
|
27
|
-
* Returns
|
|
24
|
+
* 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.
|
|
25
|
+
*
|
|
26
|
+
* This endpoint is available to all users in the organization.
|
|
28
27
|
*
|
|
29
28
|
*/
|
|
30
|
-
static
|
|
29
|
+
static listUsers<ThrowOnError extends boolean = false>(options?: Options<ListUsersData, ThrowOnError>): import("./client").RequestResult<ListUsersResponses, ListUsersErrors, ThrowOnError, "fields">;
|
|
31
30
|
/**
|
|
32
|
-
*
|
|
31
|
+
* Create a new user.
|
|
33
32
|
*
|
|
34
|
-
*
|
|
33
|
+
* 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.
|
|
35
34
|
*
|
|
36
35
|
*/
|
|
37
|
-
static
|
|
36
|
+
static createUser<ThrowOnError extends boolean = false>(options: Options<CreateUserData, ThrowOnError>): import("./client").RequestResult<CreateUserResponses, unknown, ThrowOnError, "fields">;
|
|
38
37
|
/**
|
|
39
|
-
*
|
|
38
|
+
* Delete user by id.
|
|
40
39
|
*
|
|
41
|
-
*
|
|
40
|
+
* Sets user status to `inactive`. Inactive users cannot log in and manage organization resources. This endpoint is available to administrators of the organization only.
|
|
42
41
|
*
|
|
43
42
|
*/
|
|
44
|
-
static
|
|
43
|
+
static deleteUser<ThrowOnError extends boolean = false>(options: Options<DeleteUserData, ThrowOnError>): import("./client").RequestResult<DeleteUserResponses, DeleteUserErrors, ThrowOnError, "fields">;
|
|
45
44
|
/**
|
|
46
|
-
* Get
|
|
45
|
+
* Get user profile information by id.
|
|
47
46
|
*
|
|
48
|
-
* Returns
|
|
47
|
+
* Returns user details including their roles. For more information on identity access management, see [Users](https://cloudfleet.ai/docs/organization/users/) section of documentaiton.
|
|
48
|
+
*
|
|
49
|
+
* This endpoint is available to all users in the organization.
|
|
49
50
|
*
|
|
50
51
|
*/
|
|
51
|
-
static
|
|
52
|
+
static getUser<ThrowOnError extends boolean = false>(options: Options<GetUserData, ThrowOnError>): import("./client").RequestResult<GetUserResponses, GetUserErrors, ThrowOnError, "fields">;
|
|
52
53
|
/**
|
|
53
|
-
* Update
|
|
54
|
+
* Update user profile information.
|
|
54
55
|
*
|
|
55
|
-
*
|
|
56
|
+
* 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.
|
|
56
57
|
*
|
|
57
58
|
*/
|
|
58
|
-
static
|
|
59
|
+
static updateUser<ThrowOnError extends boolean = false>(options: Options<UpdateUserData, ThrowOnError>): import("./client").RequestResult<UpdateUserResponses, unknown, ThrowOnError, "fields">;
|
|
60
|
+
}
|
|
61
|
+
export declare class TokensService {
|
|
59
62
|
/**
|
|
60
|
-
*
|
|
63
|
+
* List access tokens in organization.
|
|
61
64
|
*
|
|
62
|
-
*
|
|
65
|
+
* 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.
|
|
63
66
|
*
|
|
64
67
|
*/
|
|
65
|
-
static
|
|
68
|
+
static listTokens<ThrowOnError extends boolean = false>(options?: Options<ListTokensData, ThrowOnError>): import("./client").RequestResult<ListTokensResponses, ListTokensErrors, ThrowOnError, "fields">;
|
|
66
69
|
/**
|
|
67
|
-
*
|
|
70
|
+
* Create a new access token.
|
|
68
71
|
*
|
|
69
|
-
*
|
|
72
|
+
* 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.
|
|
73
|
+
*
|
|
74
|
+
* This endpoint is available to administrators of the organization only.
|
|
70
75
|
*
|
|
71
76
|
*/
|
|
72
|
-
static
|
|
73
|
-
}
|
|
74
|
-
export declare class ClustersService {
|
|
77
|
+
static createToken<ThrowOnError extends boolean = false>(options: Options<CreateTokenData, ThrowOnError>): import("./client").RequestResult<CreateTokenResponses, CreateTokenErrors, ThrowOnError, "fields">;
|
|
75
78
|
/**
|
|
76
|
-
*
|
|
77
|
-
*
|
|
78
|
-
* Returns a list of charts in the cluster.
|
|
79
|
+
* Permanently delete access token.
|
|
79
80
|
*
|
|
80
|
-
* This endpoint is available to
|
|
81
|
+
* 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.
|
|
81
82
|
*
|
|
82
83
|
*/
|
|
83
|
-
static
|
|
84
|
+
static deleteToken<ThrowOnError extends boolean = false>(options: Options<DeleteTokenData, ThrowOnError>): import("./client").RequestResult<DeleteTokenResponses, unknown, ThrowOnError, "fields">;
|
|
84
85
|
/**
|
|
85
|
-
*
|
|
86
|
-
*
|
|
87
|
-
* Create a new chart deployment.
|
|
86
|
+
* Get access token information.
|
|
88
87
|
*
|
|
89
|
-
* This endpoint is available to
|
|
88
|
+
* 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.
|
|
90
89
|
*
|
|
91
90
|
*/
|
|
92
|
-
static
|
|
91
|
+
static getToken<ThrowOnError extends boolean = false>(options: Options<GetTokenData, ThrowOnError>): import("./client").RequestResult<GetTokenResponses, GetTokenErrors, ThrowOnError, "fields">;
|
|
93
92
|
/**
|
|
94
|
-
*
|
|
93
|
+
* Update access token information.
|
|
95
94
|
*
|
|
96
|
-
* This endpoint
|
|
95
|
+
* 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.
|
|
97
96
|
*
|
|
98
97
|
* This endpoint is available to administrators of the organization only.
|
|
99
98
|
*
|
|
100
99
|
*/
|
|
101
|
-
static
|
|
100
|
+
static updateToken<ThrowOnError extends boolean = false>(options: Options<UpdateTokenData, ThrowOnError>): import("./client").RequestResult<UpdateTokenResponses, UpdateTokenErrors, ThrowOnError, "fields">;
|
|
102
101
|
/**
|
|
103
|
-
*
|
|
102
|
+
* Regenerate access token secret key.
|
|
104
103
|
*
|
|
105
|
-
*
|
|
104
|
+
* Generates a new access token secret. Old secret will not be valid anymore.
|
|
105
|
+
*/
|
|
106
|
+
static regenerateToken<ThrowOnError extends boolean = false>(options: Options<RegenerateTokenData, ThrowOnError>): import("./client").RequestResult<RegenerateTokenResponses, RegenerateTokenErrors, ThrowOnError, "fields">;
|
|
107
|
+
}
|
|
108
|
+
export declare class TicketsService {
|
|
109
|
+
/**
|
|
110
|
+
* List tickets for the current organization.
|
|
106
111
|
*
|
|
107
|
-
*
|
|
112
|
+
* Returns all tickets belonging to the caller's organization, newest first.
|
|
108
113
|
*
|
|
109
114
|
*/
|
|
110
|
-
static
|
|
115
|
+
static listTickets<ThrowOnError extends boolean = false>(options?: Options<ListTicketsData, ThrowOnError>): import("./client").RequestResult<ListTicketsResponses, unknown, ThrowOnError, "fields">;
|
|
111
116
|
/**
|
|
112
|
-
*
|
|
113
|
-
*
|
|
114
|
-
* This endpoint allows you to update the values of a chart deployment.
|
|
117
|
+
* Create a new support ticket.
|
|
115
118
|
*
|
|
116
|
-
*
|
|
119
|
+
* 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).
|
|
117
120
|
*
|
|
118
121
|
*/
|
|
119
|
-
static
|
|
122
|
+
static createTicket<ThrowOnError extends boolean = false>(options: Options<CreateTicketData, ThrowOnError>): import("./client").RequestResult<CreateTicketResponses, unknown, ThrowOnError, "fields">;
|
|
120
123
|
/**
|
|
121
|
-
*
|
|
122
|
-
*
|
|
123
|
-
* Returns a list of fleets belonging to the cluster. For more information, see [Fleets](https://cloudfleet.ai/docs/cloud-infrastructure/fleets/) section of documentaiton.
|
|
124
|
+
* Close a ticket (soft close).
|
|
124
125
|
*
|
|
125
|
-
*
|
|
126
|
+
* Marks the ticket as closed. Closed is a terminal state — users cannot reply to a closed ticket; a new ticket must be opened instead.
|
|
126
127
|
*
|
|
127
128
|
*/
|
|
128
|
-
static
|
|
129
|
+
static closeTicket<ThrowOnError extends boolean = false>(options: Options<CloseTicketData, ThrowOnError>): import("./client").RequestResult<CloseTicketResponses, unknown, ThrowOnError, "fields">;
|
|
129
130
|
/**
|
|
130
|
-
*
|
|
131
|
-
|
|
132
|
-
|
|
131
|
+
* Get a ticket and its messages.
|
|
132
|
+
*/
|
|
133
|
+
static getTicket<ThrowOnError extends boolean = false>(options: Options<GetTicketData, ThrowOnError>): import("./client").RequestResult<GetTicketResponses, unknown, ThrowOnError, "fields">;
|
|
134
|
+
/**
|
|
135
|
+
* Grant Cloudfleet support access for a ticket.
|
|
133
136
|
*
|
|
134
|
-
*
|
|
137
|
+
* 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.
|
|
135
138
|
*
|
|
136
139
|
*/
|
|
137
|
-
static
|
|
140
|
+
static grantTicketSupportAccess<ThrowOnError extends boolean = false>(options: Options<GrantTicketSupportAccessData, ThrowOnError>): import("./client").RequestResult<GrantTicketSupportAccessResponses, GrantTicketSupportAccessErrors, ThrowOnError, "fields">;
|
|
138
141
|
/**
|
|
139
|
-
*
|
|
140
|
-
*
|
|
141
|
-
* 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.
|
|
142
|
+
* Append a customer reply to a ticket.
|
|
142
143
|
*
|
|
143
|
-
*
|
|
144
|
+
* Multipart form-data with a JSON-encoded `payload` field carrying `body`, plus up to 3 `attachments` files. Returns 409 if the ticket is closed.
|
|
144
145
|
*
|
|
145
146
|
*/
|
|
146
|
-
static
|
|
147
|
+
static replyTicket<ThrowOnError extends boolean = false>(options: Options<ReplyTicketData, ThrowOnError>): import("./client").RequestResult<ReplyTicketResponses, ReplyTicketErrors, ThrowOnError, "fields">;
|
|
147
148
|
/**
|
|
148
|
-
*
|
|
149
|
-
|
|
150
|
-
|
|
149
|
+
* Download a ticket attachment.
|
|
150
|
+
*/
|
|
151
|
+
static getTicketAttachment<ThrowOnError extends boolean = false>(options: Options<GetTicketAttachmentData, ThrowOnError>): import("./client").RequestResult<GetTicketAttachmentResponses, unknown, ThrowOnError, "fields">;
|
|
152
|
+
}
|
|
153
|
+
export declare class RoadmapService {
|
|
154
|
+
/**
|
|
155
|
+
* List roadmap items.
|
|
151
156
|
*
|
|
152
|
-
*
|
|
157
|
+
* Returns the published roadmap items, newest first, each with your own vote. Votes of other users are not returned.
|
|
153
158
|
*
|
|
154
159
|
*/
|
|
155
|
-
static
|
|
160
|
+
static listRoadmap<ThrowOnError extends boolean = false>(options?: Options<ListRoadmapData, ThrowOnError>): import("./client").RequestResult<ListRoadmapResponses, unknown, ThrowOnError, "fields">;
|
|
156
161
|
/**
|
|
157
|
-
*
|
|
162
|
+
* Suggest a new roadmap item.
|
|
158
163
|
*
|
|
159
|
-
*
|
|
160
|
-
*
|
|
161
|
-
* Setting status to `deleted` will permanently delete fleet. This operation cannot be undone. Your subscription will end by the end of the current billing period and you will not be able to receive credit for unused time. If you want to keep using the Fleet until the end of the billing period, set the status to `cancelling`.
|
|
164
|
+
* 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.
|
|
162
165
|
*
|
|
163
|
-
|
|
166
|
+
*/
|
|
167
|
+
static suggestRoadmap<ThrowOnError extends boolean = false>(options: Options<SuggestRoadmapData, ThrowOnError>): import("./client").RequestResult<SuggestRoadmapResponses, unknown, ThrowOnError, "fields">;
|
|
168
|
+
/**
|
|
169
|
+
* Remove your vote from a roadmap item.
|
|
170
|
+
*/
|
|
171
|
+
static unvoteRoadmap<ThrowOnError extends boolean = false>(options: Options<UnvoteRoadmapData, ThrowOnError>): import("./client").RequestResult<UnvoteRoadmapResponses, UnvoteRoadmapErrors, ThrowOnError, "fields">;
|
|
172
|
+
/**
|
|
173
|
+
* Vote on a roadmap item.
|
|
164
174
|
*
|
|
165
|
-
*
|
|
175
|
+
* Sets your vote on a roadmap item: -1 (down), 1 (up), or 2 (double up). Replaces any previous vote you cast on the item.
|
|
166
176
|
*
|
|
167
177
|
*/
|
|
168
|
-
static
|
|
178
|
+
static voteRoadmap<ThrowOnError extends boolean = false>(options: Options<VoteRoadmapData, ThrowOnError>): import("./client").RequestResult<VoteRoadmapResponses, VoteRoadmapErrors, ThrowOnError, "fields">;
|
|
179
|
+
}
|
|
180
|
+
export declare class RegistryService {
|
|
169
181
|
/**
|
|
170
|
-
*
|
|
182
|
+
* List repositories
|
|
183
|
+
*
|
|
184
|
+
* Returns a list of repositories in the registry across all regions. This endpoint is available to all users in the organization.
|
|
171
185
|
*
|
|
172
|
-
* 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.
|
|
173
186
|
*/
|
|
174
|
-
static
|
|
187
|
+
static listRepositories<ThrowOnError extends boolean = false>(options?: Options<ListRepositoriesData, ThrowOnError>): import("./client").RequestResult<ListRepositoriesResponses, ListRepositoriesErrors, ThrowOnError, "fields">;
|
|
175
188
|
/**
|
|
176
|
-
* List
|
|
177
|
-
*
|
|
178
|
-
* 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.
|
|
189
|
+
* List tags for a repository
|
|
179
190
|
*
|
|
180
|
-
* This endpoint is available to all users in the organization.
|
|
191
|
+
* 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.
|
|
181
192
|
*
|
|
182
193
|
*/
|
|
183
|
-
static
|
|
194
|
+
static listTags<ThrowOnError extends boolean = false>(options: Options<ListTagsData, ThrowOnError>): import("./client").RequestResult<ListTagsResponses, ListTagsErrors, ThrowOnError, "fields">;
|
|
184
195
|
/**
|
|
185
|
-
*
|
|
186
|
-
*
|
|
187
|
-
* 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.
|
|
196
|
+
* Delete tag
|
|
188
197
|
*
|
|
189
|
-
* This endpoint is available to administrators of the organization only.
|
|
198
|
+
* Permanently deletes a specific tag from a repository. This endpoint is available to administrators of the organization only.
|
|
190
199
|
*
|
|
191
200
|
*/
|
|
192
|
-
static
|
|
201
|
+
static deleteTag<ThrowOnError extends boolean = false>(options: Options<DeleteTagData, ThrowOnError>): import("./client").RequestResult<DeleteTagResponses, DeleteTagErrors, ThrowOnError, "fields">;
|
|
193
202
|
/**
|
|
194
|
-
*
|
|
195
|
-
*
|
|
196
|
-
* This endpoint will permanently delete the cluster. This operation cannot be undone.
|
|
203
|
+
* Get tag details
|
|
197
204
|
*
|
|
198
|
-
* This endpoint is available to
|
|
205
|
+
* 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.
|
|
199
206
|
*
|
|
200
207
|
*/
|
|
201
|
-
static
|
|
208
|
+
static getTag<ThrowOnError extends boolean = false>(options: Options<GetTagData, ThrowOnError>): import("./client").RequestResult<GetTagResponses, GetTagErrors, ThrowOnError, "fields">;
|
|
209
|
+
}
|
|
210
|
+
export declare class OrganizationService {
|
|
202
211
|
/**
|
|
203
|
-
* Get
|
|
212
|
+
* Get organization information.
|
|
204
213
|
*
|
|
205
|
-
* Returns
|
|
214
|
+
* Returns organization details including quota. For more information about quotas, see [Quotas and limits](https://cloudfleet.ai/docs/organization/quotas/) section of documentaiton.
|
|
206
215
|
*
|
|
207
216
|
* This endpoint is available to all users in the organization.
|
|
208
217
|
*
|
|
209
218
|
*/
|
|
210
|
-
static
|
|
219
|
+
static getOrganization<ThrowOnError extends boolean = false>(options?: Options<GetOrganizationData, ThrowOnError>): import("./client").RequestResult<GetOrganizationResponses, unknown, ThrowOnError, "fields">;
|
|
211
220
|
/**
|
|
212
|
-
*
|
|
213
|
-
*
|
|
214
|
-
* 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.
|
|
221
|
+
* Create a new organization / Cloudfleet account signup.
|
|
215
222
|
*
|
|
216
|
-
* This endpoint
|
|
223
|
+
* This endpoint allows you to create a new Cloudfleet organization and an administrator user.
|
|
217
224
|
*
|
|
218
225
|
*/
|
|
219
|
-
static
|
|
226
|
+
static createOrganization<ThrowOnError extends boolean = false>(options: Options<CreateOrganizationData, ThrowOnError>): import("./client").RequestResult<CreateOrganizationResponses, unknown, ThrowOnError, "fields">;
|
|
227
|
+
}
|
|
228
|
+
export declare class McpService {
|
|
220
229
|
/**
|
|
221
|
-
*
|
|
222
|
-
*
|
|
223
|
-
* 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.
|
|
230
|
+
* MCP endpoint
|
|
224
231
|
*
|
|
232
|
+
* MCP endpoint for handling Model Context Protocol JSON-RPC 2.0 messages.
|
|
225
233
|
*/
|
|
226
|
-
static
|
|
234
|
+
static postMcp<ThrowOnError extends boolean = false>(options: Options<PostMcpData, ThrowOnError>): import("./client").RequestResult<PostMcpResponses, PostMcpErrors, ThrowOnError, "fields">;
|
|
227
235
|
}
|
|
228
236
|
export declare class InvitesService {
|
|
229
237
|
/**
|
|
230
238
|
* List invites.
|
|
231
239
|
*
|
|
232
|
-
* Returns a list of invites under the current organization. This endpoint is available to
|
|
240
|
+
* Returns a list of pending (non-expired) invites under the current organization. This endpoint is available to administrators of the organization only.
|
|
233
241
|
*
|
|
234
242
|
*/
|
|
235
243
|
static listInvites<ThrowOnError extends boolean = false>(options?: Options<ListInvitesData, ThrowOnError>): import("./client").RequestResult<ListInvitesResponses, ListInvitesErrors, ThrowOnError, "fields">;
|
|
@@ -243,7 +251,7 @@ export declare class InvitesService {
|
|
|
243
251
|
/**
|
|
244
252
|
* Get invite information.
|
|
245
253
|
*
|
|
246
|
-
*
|
|
254
|
+
* 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.
|
|
247
255
|
*
|
|
248
256
|
*/
|
|
249
257
|
static getInvite<ThrowOnError extends boolean = false>(options: Options<GetInviteData, ThrowOnError>): import("./client").RequestResult<GetInviteResponses, unknown, ThrowOnError, "fields">;
|
|
@@ -255,212 +263,209 @@ export declare class InvitesService {
|
|
|
255
263
|
*/
|
|
256
264
|
static deleteInvite<ThrowOnError extends boolean = false>(options: Options<DeleteInviteData, ThrowOnError>): import("./client").RequestResult<DeleteInviteResponses, unknown, ThrowOnError, "fields">;
|
|
257
265
|
}
|
|
258
|
-
export declare class
|
|
266
|
+
export declare class FeedbackService {
|
|
259
267
|
/**
|
|
260
|
-
*
|
|
261
|
-
*
|
|
262
|
-
* Returns a list of available charts in the marketplace.
|
|
268
|
+
* Send feedback to the Cloudfleet team
|
|
263
269
|
*
|
|
264
|
-
*
|
|
270
|
+
* 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.
|
|
265
271
|
*
|
|
266
272
|
*/
|
|
267
|
-
static
|
|
273
|
+
static sendFeedback<ThrowOnError extends boolean = false>(options: Options<SendFeedbackData, ThrowOnError>): import("./client").RequestResult<SendFeedbackResponses, SendFeedbackErrors, ThrowOnError, "fields">;
|
|
274
|
+
}
|
|
275
|
+
export declare class ClustersService {
|
|
268
276
|
/**
|
|
269
|
-
*
|
|
277
|
+
* Query Kubernetes cluster API
|
|
270
278
|
*
|
|
271
|
-
*
|
|
279
|
+
* 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.
|
|
280
|
+
*/
|
|
281
|
+
static queryCluster<ThrowOnError extends boolean = false>(options: Options<QueryClusterData, ThrowOnError>): import("./client").RequestResult<QueryClusterResponses, QueryClusterErrors, ThrowOnError, "fields">;
|
|
282
|
+
/**
|
|
283
|
+
* List fleets.
|
|
272
284
|
*
|
|
273
|
-
*
|
|
285
|
+
* Returns a list of fleets belonging to the cluster. For more information, see [Fleets](https://cloudfleet.ai/docs/cloud-infrastructure/fleets/) section of documentaiton.
|
|
274
286
|
*
|
|
275
287
|
* This endpoint is available to all users in the organization.
|
|
276
288
|
*
|
|
277
289
|
*/
|
|
278
|
-
static
|
|
279
|
-
}
|
|
280
|
-
export declare class McpService {
|
|
290
|
+
static listFleets<ThrowOnError extends boolean = false>(options: Options<ListFleetsData, ThrowOnError>): import("./client").RequestResult<ListFleetsResponses, ListFleetsErrors, ThrowOnError, "fields">;
|
|
281
291
|
/**
|
|
282
|
-
*
|
|
292
|
+
* Create a new fleet.
|
|
283
293
|
*
|
|
284
|
-
*
|
|
285
|
-
*/
|
|
286
|
-
static postMcp<ThrowOnError extends boolean = false>(options: Options<PostMcpData, ThrowOnError>): import("./client").RequestResult<PostMcpResponses, PostMcpErrors, ThrowOnError, "fields">;
|
|
287
|
-
}
|
|
288
|
-
export declare class OrganizationService {
|
|
289
|
-
/**
|
|
290
|
-
* Get organization information.
|
|
294
|
+
* 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.
|
|
291
295
|
*
|
|
292
|
-
*
|
|
296
|
+
* The cluster must be ready (status `deployed`) before a fleet can be added. Adding a fleet while the cluster is still provisioning returns `409`.
|
|
293
297
|
*
|
|
294
|
-
* This endpoint is available to
|
|
298
|
+
* This endpoint is available to administrators of the organization only.
|
|
295
299
|
*
|
|
296
300
|
*/
|
|
297
|
-
static
|
|
301
|
+
static createFleet<ThrowOnError extends boolean = false>(options: Options<CreateFleetData, ThrowOnError>): import("./client").RequestResult<CreateFleetResponses, CreateFleetErrors, ThrowOnError, "fields">;
|
|
298
302
|
/**
|
|
299
|
-
*
|
|
303
|
+
* Permanently delete fleet.
|
|
300
304
|
*
|
|
301
|
-
* This endpoint
|
|
305
|
+
* 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.
|
|
302
306
|
*
|
|
303
|
-
|
|
304
|
-
static createOrganization<ThrowOnError extends boolean = false>(options: Options<CreateOrganizationData, ThrowOnError>): import("./client").RequestResult<CreateOrganizationResponses, unknown, ThrowOnError, "fields">;
|
|
305
|
-
}
|
|
306
|
-
export declare class RegistryService {
|
|
307
|
-
/**
|
|
308
|
-
* List repositories
|
|
307
|
+
* 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.
|
|
309
308
|
*
|
|
310
|
-
*
|
|
309
|
+
* This endpoint is available to administrators of the organization only.
|
|
311
310
|
*
|
|
312
311
|
*/
|
|
313
|
-
static
|
|
312
|
+
static deleteFleet<ThrowOnError extends boolean = false>(options: Options<DeleteFleetData, ThrowOnError>): import("./client").RequestResult<DeleteFleetResponses, DeleteFleetErrors, ThrowOnError, "fields">;
|
|
314
313
|
/**
|
|
315
|
-
*
|
|
314
|
+
* Get fleet information.
|
|
316
315
|
*
|
|
317
|
-
* Returns
|
|
316
|
+
* Returns fleet details. For more information, see [Fleets](https://cloudfleet.ai/docs/cloud-infrastructure/fleets/) section of documentaiton.
|
|
317
|
+
*
|
|
318
|
+
* This endpoint is available to all users in the organization.
|
|
318
319
|
*
|
|
319
320
|
*/
|
|
320
|
-
static
|
|
321
|
+
static getFleet<ThrowOnError extends boolean = false>(options: Options<GetFleetData, ThrowOnError>): import("./client").RequestResult<GetFleetResponses, unknown, ThrowOnError, "fields">;
|
|
321
322
|
/**
|
|
322
|
-
*
|
|
323
|
+
* Update fleet information.
|
|
323
324
|
*
|
|
324
|
-
*
|
|
325
|
+
* This endpoint allows you to update fleet details.
|
|
325
326
|
*
|
|
326
|
-
|
|
327
|
-
static deleteTag<ThrowOnError extends boolean = false>(options: Options<DeleteTagData, ThrowOnError>): import("./client").RequestResult<DeleteTagResponses, DeleteTagErrors, ThrowOnError, "fields">;
|
|
328
|
-
/**
|
|
329
|
-
* Get tag details
|
|
327
|
+
* For more information, see [Fleets](https://cloudfleet.ai/docs/cloud-infrastructure/fleets/) section of documentaiton.
|
|
330
328
|
*
|
|
331
|
-
*
|
|
329
|
+
* 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).
|
|
330
|
+
*
|
|
331
|
+
* This endpoint is available to administrators of the organization only.
|
|
332
332
|
*
|
|
333
333
|
*/
|
|
334
|
-
static
|
|
335
|
-
}
|
|
336
|
-
export declare class TicketsService {
|
|
334
|
+
static updateFleet<ThrowOnError extends boolean = false>(options: Options<UpdateFleetData, ThrowOnError>): import("./client").RequestResult<UpdateFleetResponses, UpdateFleetErrors, ThrowOnError, "fields">;
|
|
337
335
|
/**
|
|
338
|
-
* List
|
|
336
|
+
* List clusters.
|
|
339
337
|
*
|
|
340
|
-
* Returns
|
|
338
|
+
* Returns a list of clusters under the current organization.
|
|
339
|
+
*
|
|
340
|
+
* This endpoint is available to all users in the organization.
|
|
341
341
|
*
|
|
342
342
|
*/
|
|
343
|
-
static
|
|
343
|
+
static listClusters<ThrowOnError extends boolean = false>(options?: Options<ListClustersData, ThrowOnError>): import("./client").RequestResult<ListClustersResponses, ListClustersErrors, ThrowOnError, "fields">;
|
|
344
344
|
/**
|
|
345
|
-
* Create a new
|
|
345
|
+
* Create a new cluster.
|
|
346
346
|
*
|
|
347
|
-
*
|
|
347
|
+
* 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.
|
|
348
|
+
*
|
|
349
|
+
* This endpoint is available to administrators of the organization only.
|
|
348
350
|
*
|
|
349
351
|
*/
|
|
350
|
-
static
|
|
352
|
+
static createCluster<ThrowOnError extends boolean = false>(options: Options<CreateClusterData, ThrowOnError>): import("./client").RequestResult<CreateClusterResponses, CreateClusterErrors, ThrowOnError, "fields">;
|
|
351
353
|
/**
|
|
352
|
-
*
|
|
354
|
+
* Permanently delete cluster.
|
|
353
355
|
*
|
|
354
|
-
*
|
|
356
|
+
* This endpoint will permanently delete the cluster. This operation cannot be undone.
|
|
357
|
+
*
|
|
358
|
+
* 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.
|
|
359
|
+
*
|
|
360
|
+
* This endpoint is available to administrators of the organization only.
|
|
355
361
|
*
|
|
356
362
|
*/
|
|
357
|
-
static
|
|
363
|
+
static deleteCluster<ThrowOnError extends boolean = false>(options: Options<DeleteClusterData, ThrowOnError>): import("./client").RequestResult<DeleteClusterResponses, DeleteClusterErrors, ThrowOnError, "fields">;
|
|
358
364
|
/**
|
|
359
|
-
* Get
|
|
365
|
+
* Get cluster information.
|
|
366
|
+
*
|
|
367
|
+
* Returns cluster details.
|
|
368
|
+
*
|
|
369
|
+
* This endpoint is available to all users in the organization.
|
|
370
|
+
*
|
|
360
371
|
*/
|
|
361
|
-
static
|
|
372
|
+
static getCluster<ThrowOnError extends boolean = false>(options: Options<GetClusterData, ThrowOnError>): import("./client").RequestResult<GetClusterResponses, unknown, ThrowOnError, "fields">;
|
|
362
373
|
/**
|
|
363
|
-
*
|
|
374
|
+
* Update cluster information.
|
|
364
375
|
*
|
|
365
|
-
*
|
|
376
|
+
* 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.
|
|
377
|
+
*
|
|
378
|
+
* This is a full overwrite: any field omitted from the request is reset to its default rather than left unchanged.
|
|
379
|
+
*
|
|
380
|
+
* This endpoint is available to administrators of the organization only.
|
|
366
381
|
*
|
|
367
382
|
*/
|
|
368
|
-
static
|
|
383
|
+
static updateCluster<ThrowOnError extends boolean = false>(options: Options<UpdateClusterData, ThrowOnError>): import("./client").RequestResult<UpdateClusterResponses, UpdateClusterErrors, ThrowOnError, "fields">;
|
|
369
384
|
/**
|
|
370
|
-
*
|
|
385
|
+
* Node join information for the cluster
|
|
386
|
+
*
|
|
387
|
+
* 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.
|
|
388
|
+
*
|
|
371
389
|
*/
|
|
372
|
-
static
|
|
390
|
+
static getJoinInformation<ThrowOnError extends boolean = false>(options: Options<GetJoinInformationData, ThrowOnError>): import("./client").RequestResult<GetJoinInformationResponses, GetJoinInformationErrors, ThrowOnError, "fields">;
|
|
373
391
|
}
|
|
374
|
-
export declare class
|
|
392
|
+
export declare class BillingService {
|
|
375
393
|
/**
|
|
376
|
-
*
|
|
394
|
+
* Get billing usage information.
|
|
377
395
|
*
|
|
378
|
-
*
|
|
396
|
+
* 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.
|
|
379
397
|
*
|
|
380
398
|
*/
|
|
381
|
-
static
|
|
399
|
+
static getUsage<ThrowOnError extends boolean = false>(options?: Options<GetUsageData, ThrowOnError>): import("./client").RequestResult<GetUsageResponses, GetUsageErrors, ThrowOnError, "fields">;
|
|
382
400
|
/**
|
|
383
|
-
*
|
|
384
|
-
*
|
|
385
|
-
* 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.
|
|
401
|
+
* Get Stripe client secret.
|
|
386
402
|
*
|
|
387
|
-
* This endpoint is available to administrators of the organization only.
|
|
403
|
+
* 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.
|
|
388
404
|
*
|
|
389
405
|
*/
|
|
390
|
-
static
|
|
406
|
+
static getPaymentMethodSecret<ThrowOnError extends boolean = false>(options?: Options<GetPaymentMethodSecretData, ThrowOnError>): import("./client").RequestResult<GetPaymentMethodSecretResponses, unknown, ThrowOnError, "fields">;
|
|
391
407
|
/**
|
|
392
|
-
*
|
|
408
|
+
* List organization payment methods.
|
|
393
409
|
*
|
|
394
|
-
*
|
|
410
|
+
* 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.
|
|
395
411
|
*
|
|
396
412
|
*/
|
|
397
|
-
static
|
|
413
|
+
static listPaymentMethods<ThrowOnError extends boolean = false>(options?: Options<ListPaymentMethodsData, ThrowOnError>): import("./client").RequestResult<ListPaymentMethodsResponses, ListPaymentMethodsErrors, ThrowOnError, "fields">;
|
|
398
414
|
/**
|
|
399
|
-
*
|
|
415
|
+
* Set the default payment method.
|
|
400
416
|
*
|
|
401
|
-
*
|
|
417
|
+
* Sets the given payment method as the default used for invoices and active subscriptions. Requires the Administrator role.
|
|
402
418
|
*
|
|
403
419
|
*/
|
|
404
|
-
static
|
|
420
|
+
static setDefaultPaymentMethod<ThrowOnError extends boolean = false>(options: Options<SetDefaultPaymentMethodData, ThrowOnError>): import("./client").RequestResult<SetDefaultPaymentMethodResponses, SetDefaultPaymentMethodErrors, ThrowOnError, "fields">;
|
|
405
421
|
/**
|
|
406
|
-
*
|
|
422
|
+
* Delete a payment method.
|
|
407
423
|
*
|
|
408
|
-
*
|
|
409
|
-
*
|
|
410
|
-
* This endpoint is available to administrators of the organization only.
|
|
424
|
+
* 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.
|
|
411
425
|
*
|
|
412
426
|
*/
|
|
413
|
-
static
|
|
427
|
+
static deletePaymentMethod<ThrowOnError extends boolean = false>(options: Options<DeletePaymentMethodData, ThrowOnError>): import("./client").RequestResult<DeletePaymentMethodResponses, DeletePaymentMethodErrors, ThrowOnError, "fields">;
|
|
414
428
|
/**
|
|
415
|
-
*
|
|
429
|
+
* List issued invoices.
|
|
430
|
+
*
|
|
431
|
+
* 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.
|
|
416
432
|
*
|
|
417
|
-
* Generates a new access token secret. Old secret will not be valid anymore.
|
|
418
|
-
*/
|
|
419
|
-
static regenerateToken<ThrowOnError extends boolean = false>(options: Options<RegenerateTokenData, ThrowOnError>): import("./client").RequestResult<RegenerateTokenResponses, RegenerateTokenErrors, ThrowOnError, "fields">;
|
|
420
|
-
}
|
|
421
|
-
export declare class UsersService {
|
|
422
|
-
/**
|
|
423
|
-
* Get a list of organizations the user belongs to. Used during authentication process.
|
|
424
433
|
*/
|
|
425
|
-
static
|
|
434
|
+
static listInvoices<ThrowOnError extends boolean = false>(options?: Options<ListInvoicesData, ThrowOnError>): import("./client").RequestResult<ListInvoicesResponses, ListInvoicesErrors, ThrowOnError, "fields">;
|
|
426
435
|
/**
|
|
427
|
-
*
|
|
436
|
+
* Pay the organization's open invoices.
|
|
428
437
|
*
|
|
429
|
-
*
|
|
430
|
-
*
|
|
431
|
-
* This endpoint is available to all users in the organization.
|
|
438
|
+
* Charges all open invoices of the organization against its default payment method. This endpoint is available to administrators of the organization only.
|
|
432
439
|
*
|
|
433
440
|
*/
|
|
434
|
-
static
|
|
441
|
+
static payOpenInvoices<ThrowOnError extends boolean = false>(options?: Options<PayOpenInvoicesData, ThrowOnError>): import("./client").RequestResult<PayOpenInvoicesResponses, PayOpenInvoicesErrors, ThrowOnError, "fields">;
|
|
435
442
|
/**
|
|
436
|
-
*
|
|
443
|
+
* Get organization contact and billing address information.
|
|
437
444
|
*
|
|
438
|
-
*
|
|
445
|
+
* Returns the organization contact and billing address information. This endpoint is available to all users in the organization.
|
|
439
446
|
*
|
|
440
447
|
*/
|
|
441
|
-
static
|
|
448
|
+
static getContact<ThrowOnError extends boolean = false>(options?: Options<GetContactData, ThrowOnError>): import("./client").RequestResult<GetContactResponses, unknown, ThrowOnError, "fields">;
|
|
442
449
|
/**
|
|
443
|
-
*
|
|
450
|
+
* Update organization contact information and billing address.
|
|
444
451
|
*
|
|
445
|
-
*
|
|
452
|
+
* This endpoint allows you to update organization details with its contact information. This endpoint is available to administrators of the organization only.
|
|
446
453
|
*
|
|
447
454
|
*/
|
|
448
|
-
static
|
|
455
|
+
static updateContact<ThrowOnError extends boolean = false>(options: Options<UpdateContactData, ThrowOnError>): import("./client").RequestResult<UpdateContactResponses, unknown, ThrowOnError, "fields">;
|
|
449
456
|
/**
|
|
450
|
-
* Get
|
|
451
|
-
*
|
|
452
|
-
* Returns user details including their roles. For more information on identity access management, see [Users](https://cloudfleet.ai/docs/organization/users/) section of documentaiton.
|
|
457
|
+
* Get applied promotional credits
|
|
453
458
|
*
|
|
454
|
-
* This endpoint is available to all users in the organization.
|
|
459
|
+
* 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.
|
|
455
460
|
*
|
|
456
461
|
*/
|
|
457
|
-
static
|
|
462
|
+
static getCredits<ThrowOnError extends boolean = false>(options?: Options<GetCreditsData, ThrowOnError>): import("./client").RequestResult<GetCreditsResponses, GetCreditsErrors, ThrowOnError, "fields">;
|
|
458
463
|
/**
|
|
459
|
-
*
|
|
464
|
+
* Redeem promotional credits code.
|
|
460
465
|
*
|
|
461
|
-
*
|
|
466
|
+
* 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.
|
|
462
467
|
*
|
|
463
468
|
*/
|
|
464
|
-
static
|
|
469
|
+
static redeemCredits<ThrowOnError extends boolean = false>(options: Options<RedeemCreditsData, ThrowOnError>): import("./client").RequestResult<RedeemCreditsResponses, RedeemCreditsErrors, ThrowOnError, "fields">;
|
|
465
470
|
}
|
|
466
471
|
//# sourceMappingURL=sdk.gen.d.ts.map
|