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