@cloudfleet/sdk 0.0.1-bbb5ebb → 0.0.1-bc3dfb7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +26 -2
- package/dist/@tanstack/react-query.gen.d.ts +1199 -0
- package/dist/@tanstack/react-query.gen.d.ts.map +1 -0
- package/dist/@tanstack/react-query.gen.js +1215 -0
- package/dist/@tanstack/react-query.gen.js.map +1 -0
- package/dist/client/client.gen.d.ts +3 -0
- package/dist/client/client.gen.d.ts.map +1 -0
- package/dist/client/client.gen.js +217 -0
- package/dist/client/client.gen.js.map +1 -0
- package/dist/client/index.d.ts +9 -0
- package/dist/client/index.d.ts.map +1 -0
- package/dist/client/index.js +7 -0
- package/dist/client/index.js.map +1 -0
- package/dist/client/types.gen.d.ts +121 -0
- package/dist/client/types.gen.d.ts.map +1 -0
- package/dist/client/types.gen.js +3 -0
- package/dist/client/types.gen.js.map +1 -0
- package/dist/client/utils.gen.d.ts +38 -0
- package/dist/client/utils.gen.d.ts.map +1 -0
- package/dist/client/utils.gen.js +229 -0
- package/dist/client/utils.gen.js.map +1 -0
- package/dist/client.gen.d.ts +4 -4
- package/dist/client.gen.d.ts.map +1 -1
- package/dist/client.gen.js +2 -4
- package/dist/client.gen.js.map +1 -1
- package/dist/core/auth.gen.d.ts +19 -0
- package/dist/core/auth.gen.d.ts.map +1 -0
- package/dist/core/auth.gen.js +15 -0
- package/dist/core/auth.gen.js.map +1 -0
- package/dist/core/bodySerializer.gen.d.ts +26 -0
- package/dist/core/bodySerializer.gen.d.ts.map +1 -0
- package/dist/core/bodySerializer.gen.js +58 -0
- package/dist/core/bodySerializer.gen.js.map +1 -0
- package/dist/core/params.gen.d.ts +44 -0
- package/dist/core/params.gen.d.ts.map +1 -0
- package/dist/core/params.gen.js +101 -0
- package/dist/core/params.gen.js.map +1 -0
- package/dist/core/pathSerializer.gen.d.ts +34 -0
- package/dist/core/pathSerializer.gen.d.ts.map +1 -0
- package/dist/core/pathSerializer.gen.js +107 -0
- package/dist/core/pathSerializer.gen.js.map +1 -0
- package/dist/core/queryKeySerializer.gen.d.ts +19 -0
- package/dist/core/queryKeySerializer.gen.d.ts.map +1 -0
- package/dist/core/queryKeySerializer.gen.js +93 -0
- package/dist/core/queryKeySerializer.gen.js.map +1 -0
- package/dist/core/serverSentEvents.gen.d.ts +72 -0
- package/dist/core/serverSentEvents.gen.d.ts.map +1 -0
- package/dist/core/serverSentEvents.gen.js +133 -0
- package/dist/core/serverSentEvents.gen.js.map +1 -0
- package/dist/core/types.gen.d.ts +79 -0
- package/dist/core/types.gen.d.ts.map +1 -0
- package/dist/core/types.gen.js +3 -0
- package/dist/core/types.gen.js.map +1 -0
- package/dist/core/utils.gen.d.ts +20 -0
- package/dist/core/utils.gen.d.ts.map +1 -0
- package/dist/core/utils.gen.js +88 -0
- package/dist/core/utils.gen.js.map +1 -0
- package/dist/schemas.gen.d.ts +1774 -594
- package/dist/schemas.gen.d.ts.map +1 -1
- package/dist/schemas.gen.js +3133 -666
- package/dist/schemas.gen.js.map +1 -1
- package/dist/sdk.gen.d.ts +346 -135
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/sdk.gen.js +492 -259
- package/dist/sdk.gen.js.map +1 -1
- package/dist/services/kubernetes/api.d.ts +20 -20
- package/dist/types.gen.d.ts +2044 -708
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/zod.gen.d.ts +3982 -1998
- package/dist/zod.gen.d.ts.map +1 -1
- package/dist/zod.gen.js +1713 -805
- package/dist/zod.gen.js.map +1 -1
- package/package.json +28 -9
package/dist/sdk.gen.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import type
|
|
2
|
-
import type {
|
|
3
|
-
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> =
|
|
1
|
+
import { type Client, type Options as Options2, type TDataShape } from './client';
|
|
2
|
+
import type { CloseTicketData, CloseTicketResponses, CreateChartData, CreateChartErrors, CreateChartResponses, CreateClusterData, CreateClusterErrors, CreateClusterResponses, CreateFleetData, CreateFleetErrors, CreateFleetResponses, CreateInviteData, CreateInviteResponses, CreateOrganizationData, CreateOrganizationResponses, CreateTicketData, CreateTicketResponses, CreateTokenData, CreateTokenErrors, CreateTokenResponses, CreateUserData, CreateUserResponses, DeleteChartData, DeleteChartErrors, DeleteChartResponses, DeleteClusterData, DeleteClusterErrors, DeleteClusterResponses, DeleteFleetData, DeleteFleetErrors, DeleteFleetResponses, DeleteInviteData, DeleteInviteResponses, DeletePaymentMethodData, DeletePaymentMethodErrors, DeletePaymentMethodResponses, DeleteTagData, DeleteTagErrors, DeleteTagResponses, DeleteTokenData, DeleteTokenResponses, DeleteUserData, DeleteUserErrors, DeleteUserResponses, GetBasicPriceConsentData, GetBasicPriceConsentResponses, GetChartData, GetChartResponses, GetClusterData, GetClusterResponses, GetContactData, GetContactResponses, GetCreditsData, GetCreditsErrors, GetCreditsResponses, GetFleetData, GetFleetResponses, GetInviteData, GetInviteResponses, GetJoinInformationData, GetJoinInformationErrors, GetJoinInformationResponses, GetMarketplaceChartFilesData, GetMarketplaceChartFilesErrors, GetMarketplaceChartFilesResponses, GetOrganizationData, GetOrganizationResponses, GetPaymentMethodSecretData, GetPaymentMethodSecretResponses, GetTagData, GetTagErrors, GetTagResponses, GetTicketAttachmentData, GetTicketAttachmentResponses, GetTicketData, GetTicketResponses, GetTokenData, GetTokenErrors, GetTokenResponses, GetUsageData, GetUsageErrors, GetUsageResponses, GetUserData, GetUserErrors, GetUserResponses, ListChartsData, ListChartsErrors, ListChartsResponses, ListClustersData, ListClustersErrors, ListClustersResponses, ListFleetsData, ListFleetsErrors, ListFleetsResponses, ListInvitesData, ListInvitesErrors, ListInvitesResponses, ListInvoicesData, ListInvoicesErrors, ListInvoicesResponses, ListMarketplaceChartsData, ListMarketplaceChartsErrors, ListMarketplaceChartsResponses, ListPaymentMethodsData, ListPaymentMethodsErrors, ListPaymentMethodsResponses, ListRepositoriesData, ListRepositoriesErrors, ListRepositoriesResponses, ListTagsData, ListTagsErrors, ListTagsResponses, ListTicketsData, ListTicketsResponses, ListTokensData, ListTokensErrors, ListTokensResponses, ListUserOrganizationsData, ListUserOrganizationsResponses, ListUsersData, ListUsersErrors, ListUsersResponses, PostMcpData, PostMcpErrors, PostMcpResponses, QueryClusterData, QueryClusterErrors, QueryClusterResponses, RedeemCreditsData, RedeemCreditsErrors, RedeemCreditsResponses, RegenerateTokenData, RegenerateTokenErrors, RegenerateTokenResponses, ReplyTicketData, ReplyTicketErrors, ReplyTicketResponses, SetBasicPriceConsentData, SetBasicPriceConsentErrors, SetBasicPriceConsentResponses, SetDefaultPaymentMethodData, SetDefaultPaymentMethodErrors, SetDefaultPaymentMethodResponses, UpdateChartData, UpdateChartErrors, UpdateChartResponses, UpdateClusterData, UpdateClusterErrors, UpdateClusterResponses, UpdateContactData, UpdateContactResponses, UpdateFleetData, UpdateFleetErrors, UpdateFleetResponses, UpdateTokenData, UpdateTokenErrors, UpdateTokenResponses, UpdateUserData, UpdateUserResponses } from './types.gen';
|
|
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
|
|
6
6
|
* individual options. This might be also useful if you want to implement a
|
|
@@ -13,281 +13,492 @@ 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
|
-
|
|
18
|
+
* Get a list of organizations the user belongs to. Used during authentication process.
|
|
19
|
+
*/
|
|
20
|
+
static listUserOrganizations<ThrowOnError extends boolean = false>(options: Options<ListUserOrganizationsData, ThrowOnError>): import("./client").RequestResult<ListUserOrganizationsResponses, unknown, ThrowOnError, "fields">;
|
|
21
|
+
/**
|
|
22
|
+
* List users in organization.
|
|
23
|
+
*
|
|
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.
|
|
20
27
|
*
|
|
21
28
|
*/
|
|
22
|
-
static
|
|
29
|
+
static listUsers<ThrowOnError extends boolean = false>(options?: Options<ListUsersData, ThrowOnError>): import("./client").RequestResult<ListUsersResponses, ListUsersErrors, ThrowOnError, "fields">;
|
|
23
30
|
/**
|
|
24
|
-
*
|
|
25
|
-
*
|
|
31
|
+
* Create a new user.
|
|
32
|
+
*
|
|
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.
|
|
26
34
|
*
|
|
27
35
|
*/
|
|
28
|
-
static
|
|
36
|
+
static createUser<ThrowOnError extends boolean = false>(options: Options<CreateUserData, ThrowOnError>): import("./client").RequestResult<CreateUserResponses, unknown, ThrowOnError, "fields">;
|
|
29
37
|
/**
|
|
30
|
-
*
|
|
31
|
-
*
|
|
38
|
+
* Delete user by id.
|
|
39
|
+
*
|
|
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.
|
|
32
41
|
*
|
|
33
42
|
*/
|
|
34
|
-
static
|
|
43
|
+
static deleteUser<ThrowOnError extends boolean = false>(options: Options<DeleteUserData, ThrowOnError>): import("./client").RequestResult<DeleteUserResponses, DeleteUserErrors, ThrowOnError, "fields">;
|
|
35
44
|
/**
|
|
36
|
-
* Get
|
|
37
|
-
*
|
|
45
|
+
* Get user profile information by id.
|
|
46
|
+
*
|
|
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.
|
|
38
50
|
*
|
|
39
51
|
*/
|
|
40
|
-
static
|
|
41
|
-
id?: string;
|
|
42
|
-
}, unknown, ThrowOnError>;
|
|
52
|
+
static getUser<ThrowOnError extends boolean = false>(options: Options<GetUserData, ThrowOnError>): import("./client").RequestResult<GetUserResponses, GetUserErrors, ThrowOnError, "fields">;
|
|
43
53
|
/**
|
|
44
|
-
*
|
|
45
|
-
*
|
|
54
|
+
* Update user profile information.
|
|
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.
|
|
46
57
|
*
|
|
47
58
|
*/
|
|
48
|
-
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 {
|
|
49
62
|
/**
|
|
50
|
-
*
|
|
51
|
-
*
|
|
63
|
+
* List access tokens in organization.
|
|
64
|
+
*
|
|
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.
|
|
52
66
|
*
|
|
53
67
|
*/
|
|
54
|
-
static
|
|
55
|
-
html?: string;
|
|
56
|
-
}, unknown, ThrowOnError>;
|
|
68
|
+
static listTokens<ThrowOnError extends boolean = false>(options?: Options<ListTokensData, ThrowOnError>): import("./client").RequestResult<ListTokensResponses, ListTokensErrors, ThrowOnError, "fields">;
|
|
57
69
|
/**
|
|
58
|
-
*
|
|
59
|
-
*
|
|
70
|
+
* Create a new access token.
|
|
71
|
+
*
|
|
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.
|
|
60
75
|
*
|
|
61
76
|
*/
|
|
62
|
-
static
|
|
77
|
+
static createToken<ThrowOnError extends boolean = false>(options: Options<CreateTokenData, ThrowOnError>): import("./client").RequestResult<CreateTokenResponses, CreateTokenErrors, ThrowOnError, "fields">;
|
|
63
78
|
/**
|
|
64
|
-
*
|
|
65
|
-
*
|
|
79
|
+
* Permanently delete access token.
|
|
80
|
+
*
|
|
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.
|
|
66
82
|
*
|
|
67
83
|
*/
|
|
68
|
-
static
|
|
69
|
-
}
|
|
70
|
-
export declare class ClustersService {
|
|
84
|
+
static deleteToken<ThrowOnError extends boolean = false>(options: Options<DeleteTokenData, ThrowOnError>): import("./client").RequestResult<DeleteTokenResponses, unknown, ThrowOnError, "fields">;
|
|
71
85
|
/**
|
|
72
|
-
*
|
|
73
|
-
* Returns a list of fleets belonging to the cluster. For more information, see [Fleets and fleet types](https://cloudfleet.ai/docs/cloud-infrastructure/fleets-and-fleet-types/) section of documentaiton.
|
|
86
|
+
* Get access token information.
|
|
74
87
|
*
|
|
75
|
-
* This endpoint is available to all users in the organization.
|
|
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.
|
|
76
89
|
*
|
|
77
90
|
*/
|
|
78
|
-
static
|
|
91
|
+
static getToken<ThrowOnError extends boolean = false>(options: Options<GetTokenData, ThrowOnError>): import("./client").RequestResult<GetTokenResponses, GetTokenErrors, ThrowOnError, "fields">;
|
|
79
92
|
/**
|
|
80
|
-
*
|
|
81
|
-
*
|
|
93
|
+
* Update access token information.
|
|
94
|
+
*
|
|
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.
|
|
82
96
|
*
|
|
83
97
|
* This endpoint is available to administrators of the organization only.
|
|
84
98
|
*
|
|
85
99
|
*/
|
|
86
|
-
static
|
|
100
|
+
static updateToken<ThrowOnError extends boolean = false>(options: Options<UpdateTokenData, ThrowOnError>): import("./client").RequestResult<UpdateTokenResponses, UpdateTokenErrors, ThrowOnError, "fields">;
|
|
87
101
|
/**
|
|
88
|
-
*
|
|
89
|
-
* 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 Connected Fleet until the end of the billing period, set the status to `cancelling`. For more information, see [Fleets and fleet types](https://cloudfleet.ai/docs/cloud-infrastructure/fleets-and-fleet-types/) section of documentaiton.
|
|
102
|
+
* Regenerate access token secret key.
|
|
90
103
|
*
|
|
91
|
-
*
|
|
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.
|
|
111
|
+
*
|
|
112
|
+
* Returns all tickets belonging to the caller's organization, newest first.
|
|
92
113
|
*
|
|
93
114
|
*/
|
|
94
|
-
static
|
|
115
|
+
static listTickets<ThrowOnError extends boolean = false>(options?: Options<ListTicketsData, ThrowOnError>): import("./client").RequestResult<ListTicketsResponses, unknown, ThrowOnError, "fields">;
|
|
95
116
|
/**
|
|
96
|
-
*
|
|
97
|
-
* Returns fleet details. For more information, see [Fleets and fleet types](https://cloudfleet.ai/docs/cloud-infrastructure/fleets-and-fleet-types/) section of documentaiton.
|
|
117
|
+
* Create a new support ticket.
|
|
98
118
|
*
|
|
99
|
-
*
|
|
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`, plus up to 3 `attachments` files (10 MB max each).
|
|
100
120
|
*
|
|
101
121
|
*/
|
|
102
|
-
static
|
|
122
|
+
static createTicket<ThrowOnError extends boolean = false>(options: Options<CreateTicketData, ThrowOnError>): import("./client").RequestResult<CreateTicketResponses, unknown, ThrowOnError, "fields">;
|
|
103
123
|
/**
|
|
104
|
-
*
|
|
105
|
-
*
|
|
124
|
+
* Close a ticket (soft close).
|
|
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.
|
|
127
|
+
*
|
|
128
|
+
*/
|
|
129
|
+
static closeTicket<ThrowOnError extends boolean = false>(options: Options<CloseTicketData, ThrowOnError>): import("./client").RequestResult<CloseTicketResponses, unknown, ThrowOnError, "fields">;
|
|
130
|
+
/**
|
|
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
|
+
* Append a customer reply to a ticket.
|
|
106
136
|
*
|
|
107
|
-
*
|
|
137
|
+
* Multipart form-data with a JSON-encoded `payload` field carrying `body`, plus up to 3 `attachments` files. Returns 409 if the ticket is closed.
|
|
108
138
|
*
|
|
109
|
-
|
|
139
|
+
*/
|
|
140
|
+
static replyTicket<ThrowOnError extends boolean = false>(options: Options<ReplyTicketData, ThrowOnError>): import("./client").RequestResult<ReplyTicketResponses, ReplyTicketErrors, ThrowOnError, "fields">;
|
|
141
|
+
/**
|
|
142
|
+
* Download a ticket attachment.
|
|
143
|
+
*/
|
|
144
|
+
static getTicketAttachment<ThrowOnError extends boolean = false>(options: Options<GetTicketAttachmentData, ThrowOnError>): import("./client").RequestResult<GetTicketAttachmentResponses, unknown, ThrowOnError, "fields">;
|
|
145
|
+
}
|
|
146
|
+
export declare class RegistryService {
|
|
147
|
+
/**
|
|
148
|
+
* List repositories
|
|
110
149
|
*
|
|
111
|
-
* This endpoint is available to
|
|
150
|
+
* Returns a list of repositories in the registry across all regions. This endpoint is available to all users in the organization.
|
|
112
151
|
*
|
|
113
152
|
*/
|
|
114
|
-
static
|
|
153
|
+
static listRepositories<ThrowOnError extends boolean = false>(options?: Options<ListRepositoriesData, ThrowOnError>): import("./client").RequestResult<ListRepositoriesResponses, ListRepositoriesErrors, ThrowOnError, "fields">;
|
|
115
154
|
/**
|
|
116
|
-
*
|
|
117
|
-
*
|
|
155
|
+
* List tags for a repository
|
|
156
|
+
*
|
|
157
|
+
* 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.
|
|
158
|
+
*
|
|
118
159
|
*/
|
|
119
|
-
static
|
|
160
|
+
static listTags<ThrowOnError extends boolean = false>(options: Options<ListTagsData, ThrowOnError>): import("./client").RequestResult<ListTagsResponses, ListTagsErrors, ThrowOnError, "fields">;
|
|
120
161
|
/**
|
|
121
|
-
*
|
|
122
|
-
*
|
|
162
|
+
* Delete tag
|
|
163
|
+
*
|
|
164
|
+
* Permanently deletes a specific tag from a repository. This endpoint is available to administrators of the organization only.
|
|
165
|
+
*
|
|
166
|
+
*/
|
|
167
|
+
static deleteTag<ThrowOnError extends boolean = false>(options: Options<DeleteTagData, ThrowOnError>): import("./client").RequestResult<DeleteTagResponses, DeleteTagErrors, ThrowOnError, "fields">;
|
|
168
|
+
/**
|
|
169
|
+
* Get tag details
|
|
170
|
+
*
|
|
171
|
+
* 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.
|
|
172
|
+
*
|
|
173
|
+
*/
|
|
174
|
+
static getTag<ThrowOnError extends boolean = false>(options: Options<GetTagData, ThrowOnError>): import("./client").RequestResult<GetTagResponses, GetTagErrors, ThrowOnError, "fields">;
|
|
175
|
+
}
|
|
176
|
+
export declare class OrganizationService {
|
|
177
|
+
/**
|
|
178
|
+
* Get organization information.
|
|
179
|
+
*
|
|
180
|
+
* Returns organization details including quota. For more information about quotas, see [Quotas and limits](https://cloudfleet.ai/docs/organization/quotas/) section of documentaiton.
|
|
123
181
|
*
|
|
124
182
|
* This endpoint is available to all users in the organization.
|
|
125
183
|
*
|
|
126
184
|
*/
|
|
127
|
-
static
|
|
185
|
+
static getOrganization<ThrowOnError extends boolean = false>(options?: Options<GetOrganizationData, ThrowOnError>): import("./client").RequestResult<GetOrganizationResponses, unknown, ThrowOnError, "fields">;
|
|
128
186
|
/**
|
|
129
|
-
* Create a new
|
|
130
|
-
* 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.
|
|
187
|
+
* Create a new organization / Cloudfleet account signup.
|
|
131
188
|
*
|
|
132
|
-
* This endpoint
|
|
189
|
+
* This endpoint allows you to create a new Cloudfleet organization and an administrator user.
|
|
133
190
|
*
|
|
134
191
|
*/
|
|
135
|
-
static
|
|
192
|
+
static createOrganization<ThrowOnError extends boolean = false>(options: Options<CreateOrganizationData, ThrowOnError>): import("./client").RequestResult<CreateOrganizationResponses, unknown, ThrowOnError, "fields">;
|
|
136
193
|
/**
|
|
137
|
-
*
|
|
138
|
-
* This endpoint will permanently delete the cluster. This operation cannot be undone.
|
|
194
|
+
* Get the organization's consent status for the new Basic price.
|
|
139
195
|
*
|
|
140
|
-
*
|
|
196
|
+
* Returns the organization's consent status for the migration from the free tier to the paid Basic plan. `pending` means an administrator must opt in; `not_applicable` means the organization is not in scope for the migration; `accepted` / `rejected` reflect a recorded decision.
|
|
197
|
+
*
|
|
198
|
+
* This endpoint is available to all users in the organization and drives the consent dialog in the console.
|
|
141
199
|
*
|
|
142
200
|
*/
|
|
143
|
-
static
|
|
201
|
+
static getBasicPriceConsent<ThrowOnError extends boolean = false>(options?: Options<GetBasicPriceConsentData, ThrowOnError>): import("./client").RequestResult<GetBasicPriceConsentResponses, unknown, ThrowOnError, "fields">;
|
|
144
202
|
/**
|
|
145
|
-
*
|
|
146
|
-
* 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.
|
|
203
|
+
* Record an administrator's decision on the new Basic price.
|
|
147
204
|
*
|
|
148
|
-
* This
|
|
205
|
+
* Records an affirmative decision to continue on the paid Basic plan (`accepted`) or to opt out (`rejected`). This is an organization-binding financial decision, so it is restricted to administrators. Each call appends an immutable audit entry (who and when) and sends a confirmation email to the acting administrator.
|
|
149
206
|
*
|
|
150
207
|
*/
|
|
151
|
-
static
|
|
208
|
+
static setBasicPriceConsent<ThrowOnError extends boolean = false>(options: Options<SetBasicPriceConsentData, ThrowOnError>): import("./client").RequestResult<SetBasicPriceConsentResponses, SetBasicPriceConsentErrors, ThrowOnError, "fields">;
|
|
209
|
+
}
|
|
210
|
+
export declare class McpService {
|
|
152
211
|
/**
|
|
153
|
-
*
|
|
154
|
-
* 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.
|
|
212
|
+
* MCP endpoint
|
|
155
213
|
*
|
|
156
|
-
*
|
|
214
|
+
* MCP endpoint for handling Model Context Protocol JSON-RPC 2.0 messages.
|
|
215
|
+
*/
|
|
216
|
+
static postMcp<ThrowOnError extends boolean = false>(options: Options<PostMcpData, ThrowOnError>): import("./client").RequestResult<PostMcpResponses, PostMcpErrors, ThrowOnError, "fields">;
|
|
217
|
+
}
|
|
218
|
+
export declare class ChartsMarketplaceService {
|
|
219
|
+
/**
|
|
220
|
+
* List chart listings available in the marketplace.
|
|
221
|
+
*
|
|
222
|
+
* Returns a list of available charts in the marketplace.
|
|
223
|
+
*
|
|
224
|
+
* This endpoint is available to all users in the organization.
|
|
157
225
|
*
|
|
158
226
|
*/
|
|
159
|
-
static
|
|
227
|
+
static listMarketplaceCharts<ThrowOnError extends boolean = false>(options?: Options<ListMarketplaceChartsData, ThrowOnError>): import("./client").RequestResult<ListMarketplaceChartsResponses, ListMarketplaceChartsErrors, ThrowOnError, "fields">;
|
|
160
228
|
/**
|
|
161
|
-
*
|
|
162
|
-
*
|
|
229
|
+
* Get chart files for a specific version channel.
|
|
230
|
+
*
|
|
231
|
+
* Returns the Chart.yaml, values.yaml, and values.schema.json files for the latest version matching the specified version channel.
|
|
232
|
+
*
|
|
233
|
+
* 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.
|
|
234
|
+
*
|
|
235
|
+
* This endpoint is available to all users in the organization.
|
|
163
236
|
*
|
|
164
237
|
*/
|
|
165
|
-
static
|
|
238
|
+
static getMarketplaceChartFiles<ThrowOnError extends boolean = false>(options: Options<GetMarketplaceChartFilesData, ThrowOnError>): import("./client").RequestResult<GetMarketplaceChartFilesResponses, GetMarketplaceChartFilesErrors, ThrowOnError, "fields">;
|
|
166
239
|
}
|
|
167
240
|
export declare class InvitesService {
|
|
168
241
|
/**
|
|
169
242
|
* List invites.
|
|
170
|
-
*
|
|
243
|
+
*
|
|
244
|
+
* Returns a list of pending (non-expired) invites under the current organization. This endpoint is available to administrators of the organization only.
|
|
171
245
|
*
|
|
172
246
|
*/
|
|
173
|
-
static listInvites<ThrowOnError extends boolean = false>(options?: Options<ListInvitesData, ThrowOnError>): import("
|
|
247
|
+
static listInvites<ThrowOnError extends boolean = false>(options?: Options<ListInvitesData, ThrowOnError>): import("./client").RequestResult<ListInvitesResponses, ListInvitesErrors, ThrowOnError, "fields">;
|
|
174
248
|
/**
|
|
175
249
|
* Create a new invite.
|
|
250
|
+
*
|
|
176
251
|
* 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.
|
|
177
252
|
*
|
|
178
253
|
*/
|
|
179
|
-
static createInvite<ThrowOnError extends boolean = false>(options: Options<CreateInviteData, ThrowOnError>): import("
|
|
254
|
+
static createInvite<ThrowOnError extends boolean = false>(options: Options<CreateInviteData, ThrowOnError>): import("./client").RequestResult<CreateInviteResponses, unknown, ThrowOnError, "fields">;
|
|
180
255
|
/**
|
|
181
256
|
* Get invite information.
|
|
182
|
-
*
|
|
257
|
+
*
|
|
258
|
+
* 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.
|
|
183
259
|
*
|
|
184
260
|
*/
|
|
185
|
-
static getInvite<ThrowOnError extends boolean = false>(options: Options<GetInviteData, ThrowOnError>): import("
|
|
261
|
+
static getInvite<ThrowOnError extends boolean = false>(options: Options<GetInviteData, ThrowOnError>): import("./client").RequestResult<GetInviteResponses, unknown, ThrowOnError, "fields">;
|
|
186
262
|
/**
|
|
187
263
|
* Permanently delete invite.
|
|
264
|
+
*
|
|
188
265
|
* Permanently deletes invite from the organization. This endpoint is available to administrators of the organization only.
|
|
189
266
|
*
|
|
190
267
|
*/
|
|
191
|
-
static deleteInvite<ThrowOnError extends boolean = false>(options: Options<DeleteInviteData, ThrowOnError>): import("
|
|
268
|
+
static deleteInvite<ThrowOnError extends boolean = false>(options: Options<DeleteInviteData, ThrowOnError>): import("./client").RequestResult<DeleteInviteResponses, unknown, ThrowOnError, "fields">;
|
|
192
269
|
}
|
|
193
|
-
export declare class
|
|
270
|
+
export declare class ClustersService {
|
|
194
271
|
/**
|
|
195
|
-
*
|
|
196
|
-
*
|
|
272
|
+
* Query Kubernetes cluster API
|
|
273
|
+
*
|
|
274
|
+
* 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.
|
|
275
|
+
*/
|
|
276
|
+
static queryCluster<ThrowOnError extends boolean = false>(options: Options<QueryClusterData, ThrowOnError>): import("./client").RequestResult<QueryClusterResponses, QueryClusterErrors, ThrowOnError, "fields">;
|
|
277
|
+
/**
|
|
278
|
+
* List fleets.
|
|
279
|
+
*
|
|
280
|
+
* Returns a list of fleets belonging to the cluster. For more information, see [Fleets](https://cloudfleet.ai/docs/cloud-infrastructure/fleets/) section of documentaiton.
|
|
197
281
|
*
|
|
198
282
|
* This endpoint is available to all users in the organization.
|
|
199
283
|
*
|
|
200
284
|
*/
|
|
201
|
-
static
|
|
285
|
+
static listFleets<ThrowOnError extends boolean = false>(options: Options<ListFleetsData, ThrowOnError>): import("./client").RequestResult<ListFleetsResponses, ListFleetsErrors, ThrowOnError, "fields">;
|
|
202
286
|
/**
|
|
203
|
-
* Create a new
|
|
204
|
-
*
|
|
287
|
+
* Create a new fleet.
|
|
288
|
+
*
|
|
289
|
+
* 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.
|
|
290
|
+
*
|
|
291
|
+
* The cluster must be ready (status `deployed`) before a fleet can be added. Adding a fleet while the cluster is still provisioning returns `409`.
|
|
292
|
+
*
|
|
293
|
+
* This endpoint is available to administrators of the organization only.
|
|
205
294
|
*
|
|
206
295
|
*/
|
|
207
|
-
static
|
|
208
|
-
}
|
|
209
|
-
export declare class TokensService {
|
|
296
|
+
static createFleet<ThrowOnError extends boolean = false>(options: Options<CreateFleetData, ThrowOnError>): import("./client").RequestResult<CreateFleetResponses, CreateFleetErrors, ThrowOnError, "fields">;
|
|
210
297
|
/**
|
|
211
|
-
*
|
|
212
|
-
*
|
|
298
|
+
* Permanently delete fleet.
|
|
299
|
+
*
|
|
300
|
+
* 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.
|
|
301
|
+
*
|
|
302
|
+
* 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.
|
|
303
|
+
*
|
|
304
|
+
* This endpoint is available to administrators of the organization only.
|
|
213
305
|
*
|
|
214
306
|
*/
|
|
215
|
-
static
|
|
307
|
+
static deleteFleet<ThrowOnError extends boolean = false>(options: Options<DeleteFleetData, ThrowOnError>): import("./client").RequestResult<DeleteFleetResponses, DeleteFleetErrors, ThrowOnError, "fields">;
|
|
216
308
|
/**
|
|
217
|
-
*
|
|
218
|
-
*
|
|
309
|
+
* Get fleet information.
|
|
310
|
+
*
|
|
311
|
+
* Returns fleet details. For more information, see [Fleets](https://cloudfleet.ai/docs/cloud-infrastructure/fleets/) section of documentaiton.
|
|
312
|
+
*
|
|
313
|
+
* This endpoint is available to all users in the organization.
|
|
314
|
+
*
|
|
315
|
+
*/
|
|
316
|
+
static getFleet<ThrowOnError extends boolean = false>(options: Options<GetFleetData, ThrowOnError>): import("./client").RequestResult<GetFleetResponses, unknown, ThrowOnError, "fields">;
|
|
317
|
+
/**
|
|
318
|
+
* Update fleet information.
|
|
319
|
+
*
|
|
320
|
+
* This endpoint allows you to update fleet details.
|
|
321
|
+
*
|
|
322
|
+
* For more information, see [Fleets](https://cloudfleet.ai/docs/cloud-infrastructure/fleets/) section of documentaiton.
|
|
323
|
+
*
|
|
324
|
+
* 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).
|
|
219
325
|
*
|
|
220
326
|
* This endpoint is available to administrators of the organization only.
|
|
221
327
|
*
|
|
222
328
|
*/
|
|
223
|
-
static
|
|
329
|
+
static updateFleet<ThrowOnError extends boolean = false>(options: Options<UpdateFleetData, ThrowOnError>): import("./client").RequestResult<UpdateFleetResponses, UpdateFleetErrors, ThrowOnError, "fields">;
|
|
224
330
|
/**
|
|
225
|
-
*
|
|
226
|
-
*
|
|
331
|
+
* List charts.
|
|
332
|
+
*
|
|
333
|
+
* Returns a list of charts in the cluster.
|
|
334
|
+
*
|
|
335
|
+
* This endpoint is available to all users in the organization.
|
|
227
336
|
*
|
|
228
337
|
*/
|
|
229
|
-
static
|
|
338
|
+
static listCharts<ThrowOnError extends boolean = false>(options: Options<ListChartsData, ThrowOnError>): import("./client").RequestResult<ListChartsResponses, ListChartsErrors, ThrowOnError, "fields">;
|
|
230
339
|
/**
|
|
231
|
-
*
|
|
232
|
-
*
|
|
340
|
+
* Create a new chart.
|
|
341
|
+
*
|
|
342
|
+
* Create a new chart deployment.
|
|
343
|
+
*
|
|
344
|
+
* This endpoint is available to administrators of the organization only.
|
|
233
345
|
*
|
|
234
346
|
*/
|
|
235
|
-
static
|
|
347
|
+
static createChart<ThrowOnError extends boolean = false>(options: Options<CreateChartData, ThrowOnError>): import("./client").RequestResult<CreateChartResponses, CreateChartErrors, ThrowOnError, "fields">;
|
|
236
348
|
/**
|
|
237
|
-
*
|
|
238
|
-
*
|
|
349
|
+
* Permanently delete the chart deployment from the cluster.
|
|
350
|
+
*
|
|
351
|
+
* This endpoint will permanently delete chart. This operation cannot be undone.
|
|
239
352
|
*
|
|
240
353
|
* This endpoint is available to administrators of the organization only.
|
|
241
354
|
*
|
|
242
355
|
*/
|
|
243
|
-
static
|
|
356
|
+
static deleteChart<ThrowOnError extends boolean = false>(options: Options<DeleteChartData, ThrowOnError>): import("./client").RequestResult<DeleteChartResponses, DeleteChartErrors, ThrowOnError, "fields">;
|
|
244
357
|
/**
|
|
245
|
-
*
|
|
246
|
-
*
|
|
358
|
+
* Get chart information.
|
|
359
|
+
*
|
|
360
|
+
* Returns the details of the chart deployment.
|
|
361
|
+
*
|
|
362
|
+
* This endpoint is available to all users in the organization.
|
|
363
|
+
*
|
|
247
364
|
*/
|
|
248
|
-
static
|
|
249
|
-
}
|
|
250
|
-
export declare class UsersService {
|
|
365
|
+
static getChart<ThrowOnError extends boolean = false>(options: Options<GetChartData, ThrowOnError>): import("./client").RequestResult<GetChartResponses, unknown, ThrowOnError, "fields">;
|
|
251
366
|
/**
|
|
252
|
-
*
|
|
367
|
+
* Update chart information.
|
|
368
|
+
*
|
|
369
|
+
* This endpoint allows you to update the values of a chart deployment.
|
|
370
|
+
*
|
|
371
|
+
* This endpoint is available to administrators of the organization only.
|
|
372
|
+
*
|
|
253
373
|
*/
|
|
254
|
-
static
|
|
255
|
-
realm?: string;
|
|
256
|
-
displayName?: string;
|
|
257
|
-
}[], unknown, ThrowOnError>;
|
|
374
|
+
static updateChart<ThrowOnError extends boolean = false>(options: Options<UpdateChartData, ThrowOnError>): import("./client").RequestResult<UpdateChartResponses, UpdateChartErrors, ThrowOnError, "fields">;
|
|
258
375
|
/**
|
|
259
|
-
* List
|
|
260
|
-
*
|
|
376
|
+
* List clusters.
|
|
377
|
+
*
|
|
378
|
+
* Returns a list of clusters under the current organization.
|
|
261
379
|
*
|
|
262
380
|
* This endpoint is available to all users in the organization.
|
|
263
381
|
*
|
|
264
382
|
*/
|
|
265
|
-
static
|
|
383
|
+
static listClusters<ThrowOnError extends boolean = false>(options?: Options<ListClustersData, ThrowOnError>): import("./client").RequestResult<ListClustersResponses, ListClustersErrors, ThrowOnError, "fields">;
|
|
266
384
|
/**
|
|
267
|
-
* Create a new
|
|
268
|
-
*
|
|
385
|
+
* Create a new cluster.
|
|
386
|
+
*
|
|
387
|
+
* 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.
|
|
388
|
+
*
|
|
389
|
+
* This endpoint is available to administrators of the organization only.
|
|
269
390
|
*
|
|
270
391
|
*/
|
|
271
|
-
static
|
|
392
|
+
static createCluster<ThrowOnError extends boolean = false>(options: Options<CreateClusterData, ThrowOnError>): import("./client").RequestResult<CreateClusterResponses, CreateClusterErrors, ThrowOnError, "fields">;
|
|
272
393
|
/**
|
|
273
|
-
*
|
|
274
|
-
*
|
|
394
|
+
* Permanently delete cluster.
|
|
395
|
+
*
|
|
396
|
+
* This endpoint will permanently delete the cluster. This operation cannot be undone.
|
|
397
|
+
*
|
|
398
|
+
* 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.
|
|
399
|
+
*
|
|
400
|
+
* This endpoint is available to administrators of the organization only.
|
|
275
401
|
*
|
|
276
402
|
*/
|
|
277
|
-
static
|
|
403
|
+
static deleteCluster<ThrowOnError extends boolean = false>(options: Options<DeleteClusterData, ThrowOnError>): import("./client").RequestResult<DeleteClusterResponses, DeleteClusterErrors, ThrowOnError, "fields">;
|
|
278
404
|
/**
|
|
279
|
-
* Get
|
|
280
|
-
*
|
|
405
|
+
* Get cluster information.
|
|
406
|
+
*
|
|
407
|
+
* Returns cluster details.
|
|
281
408
|
*
|
|
282
409
|
* This endpoint is available to all users in the organization.
|
|
283
410
|
*
|
|
284
411
|
*/
|
|
285
|
-
static
|
|
412
|
+
static getCluster<ThrowOnError extends boolean = false>(options: Options<GetClusterData, ThrowOnError>): import("./client").RequestResult<GetClusterResponses, unknown, ThrowOnError, "fields">;
|
|
286
413
|
/**
|
|
287
|
-
* Update
|
|
288
|
-
*
|
|
414
|
+
* Update cluster information.
|
|
415
|
+
*
|
|
416
|
+
* 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.
|
|
417
|
+
*
|
|
418
|
+
* This is a full overwrite: any field omitted from the request is reset to its default rather than left unchanged.
|
|
419
|
+
*
|
|
420
|
+
* This endpoint is available to administrators of the organization only.
|
|
421
|
+
*
|
|
422
|
+
*/
|
|
423
|
+
static updateCluster<ThrowOnError extends boolean = false>(options: Options<UpdateClusterData, ThrowOnError>): import("./client").RequestResult<UpdateClusterResponses, UpdateClusterErrors, ThrowOnError, "fields">;
|
|
424
|
+
/**
|
|
425
|
+
* Node join information for the cluster
|
|
426
|
+
*
|
|
427
|
+
* 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.
|
|
428
|
+
*
|
|
429
|
+
*/
|
|
430
|
+
static getJoinInformation<ThrowOnError extends boolean = false>(options: Options<GetJoinInformationData, ThrowOnError>): import("./client").RequestResult<GetJoinInformationResponses, GetJoinInformationErrors, ThrowOnError, "fields">;
|
|
431
|
+
}
|
|
432
|
+
export declare class BillingService {
|
|
433
|
+
/**
|
|
434
|
+
* Get billing usage information.
|
|
435
|
+
*
|
|
436
|
+
* 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.
|
|
437
|
+
*
|
|
438
|
+
*/
|
|
439
|
+
static getUsage<ThrowOnError extends boolean = false>(options?: Options<GetUsageData, ThrowOnError>): import("./client").RequestResult<GetUsageResponses, GetUsageErrors, ThrowOnError, "fields">;
|
|
440
|
+
/**
|
|
441
|
+
* Get Stripe client secret.
|
|
442
|
+
*
|
|
443
|
+
* 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.
|
|
444
|
+
*
|
|
445
|
+
*/
|
|
446
|
+
static getPaymentMethodSecret<ThrowOnError extends boolean = false>(options?: Options<GetPaymentMethodSecretData, ThrowOnError>): import("./client").RequestResult<GetPaymentMethodSecretResponses, unknown, ThrowOnError, "fields">;
|
|
447
|
+
/**
|
|
448
|
+
* List organization payment methods.
|
|
449
|
+
*
|
|
450
|
+
* 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.
|
|
451
|
+
*
|
|
452
|
+
*/
|
|
453
|
+
static listPaymentMethods<ThrowOnError extends boolean = false>(options?: Options<ListPaymentMethodsData, ThrowOnError>): import("./client").RequestResult<ListPaymentMethodsResponses, ListPaymentMethodsErrors, ThrowOnError, "fields">;
|
|
454
|
+
/**
|
|
455
|
+
* Set the default payment method.
|
|
456
|
+
*
|
|
457
|
+
* Sets the given payment method as the default used for invoices and active subscriptions. Requires the Administrator role.
|
|
458
|
+
*
|
|
459
|
+
*/
|
|
460
|
+
static setDefaultPaymentMethod<ThrowOnError extends boolean = false>(options: Options<SetDefaultPaymentMethodData, ThrowOnError>): import("./client").RequestResult<SetDefaultPaymentMethodResponses, SetDefaultPaymentMethodErrors, ThrowOnError, "fields">;
|
|
461
|
+
/**
|
|
462
|
+
* Delete a payment method.
|
|
463
|
+
*
|
|
464
|
+
* 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.
|
|
465
|
+
*
|
|
466
|
+
*/
|
|
467
|
+
static deletePaymentMethod<ThrowOnError extends boolean = false>(options: Options<DeletePaymentMethodData, ThrowOnError>): import("./client").RequestResult<DeletePaymentMethodResponses, DeletePaymentMethodErrors, ThrowOnError, "fields">;
|
|
468
|
+
/**
|
|
469
|
+
* List issued invoices.
|
|
470
|
+
*
|
|
471
|
+
* 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.
|
|
472
|
+
*
|
|
473
|
+
*/
|
|
474
|
+
static listInvoices<ThrowOnError extends boolean = false>(options?: Options<ListInvoicesData, ThrowOnError>): import("./client").RequestResult<ListInvoicesResponses, ListInvoicesErrors, ThrowOnError, "fields">;
|
|
475
|
+
/**
|
|
476
|
+
* Get organization contact and billing address information.
|
|
477
|
+
*
|
|
478
|
+
* Returns the organization contact and billing address information. This endpoint is available to all users in the organization.
|
|
479
|
+
*
|
|
480
|
+
*/
|
|
481
|
+
static getContact<ThrowOnError extends boolean = false>(options?: Options<GetContactData, ThrowOnError>): import("./client").RequestResult<GetContactResponses, unknown, ThrowOnError, "fields">;
|
|
482
|
+
/**
|
|
483
|
+
* Update organization contact information and billing address.
|
|
484
|
+
*
|
|
485
|
+
* This endpoint allows you to update organization details with its contact information. This endpoint is available to administrators of the organization only.
|
|
486
|
+
*
|
|
487
|
+
*/
|
|
488
|
+
static updateContact<ThrowOnError extends boolean = false>(options: Options<UpdateContactData, ThrowOnError>): import("./client").RequestResult<UpdateContactResponses, unknown, ThrowOnError, "fields">;
|
|
489
|
+
/**
|
|
490
|
+
* Get applied promotional credits
|
|
491
|
+
*
|
|
492
|
+
* 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.
|
|
493
|
+
*
|
|
494
|
+
*/
|
|
495
|
+
static getCredits<ThrowOnError extends boolean = false>(options?: Options<GetCreditsData, ThrowOnError>): import("./client").RequestResult<GetCreditsResponses, GetCreditsErrors, ThrowOnError, "fields">;
|
|
496
|
+
/**
|
|
497
|
+
* Redeem promotional credits code.
|
|
498
|
+
*
|
|
499
|
+
* 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.
|
|
289
500
|
*
|
|
290
501
|
*/
|
|
291
|
-
static
|
|
502
|
+
static redeemCredits<ThrowOnError extends boolean = false>(options: Options<RedeemCreditsData, ThrowOnError>): import("./client").RequestResult<RedeemCreditsResponses, RedeemCreditsErrors, ThrowOnError, "fields">;
|
|
292
503
|
}
|
|
293
504
|
//# sourceMappingURL=sdk.gen.d.ts.map
|