@cloudfleet/sdk 0.0.1-41d4ab0 → 0.0.1-43887de
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 +564 -528
- package/dist/@tanstack/react-query.gen.d.ts.map +1 -1
- package/dist/@tanstack/react-query.gen.js +622 -357
- package/dist/@tanstack/react-query.gen.js.map +1 -1
- package/dist/client/client.gen.d.ts.map +1 -1
- package/dist/client/client.gen.js +1 -4
- package/dist/client/client.gen.js.map +1 -1
- package/dist/client/types.gen.d.ts +1 -1
- package/dist/client/types.gen.d.ts.map +1 -1
- package/dist/client/utils.gen.d.ts +2 -2
- package/dist/client/utils.gen.d.ts.map +1 -1
- package/dist/client/utils.gen.js +3 -3
- package/dist/client/utils.gen.js.map +1 -1
- package/dist/core/params.gen.js +4 -4
- package/dist/core/params.gen.js.map +1 -1
- package/dist/schemas.gen.d.ts +1238 -118
- package/dist/schemas.gen.d.ts.map +1 -1
- package/dist/schemas.gen.js +2279 -198
- package/dist/schemas.gen.js.map +1 -1
- package/dist/sdk.gen.d.ts +292 -189
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/sdk.gen.js +444 -275
- package/dist/sdk.gen.js.map +1 -1
- package/dist/types.gen.d.ts +1737 -728
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/zod.gen.d.ts +3631 -1141
- package/dist/zod.gen.d.ts.map +1 -1
- package/dist/zod.gen.js +1417 -292
- package/dist/zod.gen.js.map +1 -1
- package/package.json +10 -13
package/dist/sdk.gen.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
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,
|
|
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, SendFeedbackData, SendFeedbackErrors, SendFeedbackResponses, 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
3
|
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
|
|
4
4
|
/**
|
|
5
5
|
* You can provide a client instance returned by `createClient()` instead of
|
|
@@ -13,230 +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
|
|
19
|
-
*
|
|
20
|
-
* Returns aggregated usage information for the organization with facets for filtering. For more information on billing and payments, see [Billing and pricing](https://cloudfleet.ai/docs/organization/billing/) section of documentaiton. This endpoint is available to all users in the organization.
|
|
21
|
-
*
|
|
18
|
+
* Get a list of organizations the user belongs to. Used during authentication process.
|
|
22
19
|
*/
|
|
23
|
-
static
|
|
20
|
+
static listUserOrganizations<ThrowOnError extends boolean = false>(options: Options<ListUserOrganizationsData, ThrowOnError>): import("./client").RequestResult<ListUserOrganizationsResponses, unknown, ThrowOnError, "fields">;
|
|
24
21
|
/**
|
|
25
|
-
*
|
|
22
|
+
* List users in organization.
|
|
26
23
|
*
|
|
27
|
-
* Returns
|
|
24
|
+
* Returns a list of user details and their roles. For more information on identity access management, see [Users](https://cloudfleet.ai/docs/organization/users/) section of documentaiton.
|
|
25
|
+
*
|
|
26
|
+
* This endpoint is available to all users in the organization.
|
|
28
27
|
*
|
|
29
28
|
*/
|
|
30
|
-
static
|
|
29
|
+
static listUsers<ThrowOnError extends boolean = false>(options?: Options<ListUsersData, ThrowOnError>): import("./client").RequestResult<ListUsersResponses, ListUsersErrors, ThrowOnError, "fields">;
|
|
31
30
|
/**
|
|
32
|
-
*
|
|
31
|
+
* Create a new user.
|
|
33
32
|
*
|
|
34
|
-
*
|
|
33
|
+
* Create a new user in your Cloudfleet organization. Requires a valid invite code generated by the `invites create` command. The invite code is a unique string that can be used only once to create a new user. The invite code is generated by the `POST /invites` endpoint.
|
|
35
34
|
*
|
|
36
35
|
*/
|
|
37
|
-
static
|
|
36
|
+
static createUser<ThrowOnError extends boolean = false>(options: Options<CreateUserData, ThrowOnError>): import("./client").RequestResult<CreateUserResponses, unknown, ThrowOnError, "fields">;
|
|
38
37
|
/**
|
|
39
|
-
*
|
|
38
|
+
* Delete user by id.
|
|
40
39
|
*
|
|
41
|
-
*
|
|
40
|
+
* Sets user status to `inactive`. Inactive users cannot log in and manage organization resources. This endpoint is available to administrators of the organization only.
|
|
42
41
|
*
|
|
43
42
|
*/
|
|
44
|
-
static
|
|
43
|
+
static deleteUser<ThrowOnError extends boolean = false>(options: Options<DeleteUserData, ThrowOnError>): import("./client").RequestResult<DeleteUserResponses, DeleteUserErrors, ThrowOnError, "fields">;
|
|
45
44
|
/**
|
|
46
|
-
* Get
|
|
45
|
+
* Get user profile information by id.
|
|
47
46
|
*
|
|
48
|
-
* Returns
|
|
47
|
+
* Returns user details including their roles. For more information on identity access management, see [Users](https://cloudfleet.ai/docs/organization/users/) section of documentaiton.
|
|
48
|
+
*
|
|
49
|
+
* This endpoint is available to all users in the organization.
|
|
49
50
|
*
|
|
50
51
|
*/
|
|
51
|
-
static
|
|
52
|
+
static getUser<ThrowOnError extends boolean = false>(options: Options<GetUserData, ThrowOnError>): import("./client").RequestResult<GetUserResponses, GetUserErrors, ThrowOnError, "fields">;
|
|
52
53
|
/**
|
|
53
|
-
* Update
|
|
54
|
+
* Update user profile information.
|
|
54
55
|
*
|
|
55
|
-
*
|
|
56
|
+
* Update user profile information: email, first name, last name, role. This endpoint can be accessed by administrators and the user itself. Role and status can be changed by administrators only.
|
|
56
57
|
*
|
|
57
58
|
*/
|
|
58
|
-
static
|
|
59
|
+
static updateUser<ThrowOnError extends boolean = false>(options: Options<UpdateUserData, ThrowOnError>): import("./client").RequestResult<UpdateUserResponses, unknown, ThrowOnError, "fields">;
|
|
60
|
+
}
|
|
61
|
+
export declare class TokensService {
|
|
59
62
|
/**
|
|
60
|
-
*
|
|
63
|
+
* List access tokens in organization.
|
|
61
64
|
*
|
|
62
|
-
*
|
|
65
|
+
* This endpoint allows you to get a list of all access tokens details in organization. For more information about identity access management and security, see [Service Accounts](https://cloudfleet.ai/docs/organization/api-tokens/) section of documentaiton. This endpoint is available to all users in the organization.
|
|
63
66
|
*
|
|
64
67
|
*/
|
|
65
|
-
static
|
|
68
|
+
static listTokens<ThrowOnError extends boolean = false>(options?: Options<ListTokensData, ThrowOnError>): import("./client").RequestResult<ListTokensResponses, ListTokensErrors, ThrowOnError, "fields">;
|
|
66
69
|
/**
|
|
67
|
-
*
|
|
70
|
+
* Create a new access token.
|
|
68
71
|
*
|
|
69
|
-
*
|
|
72
|
+
* This endpoint allows you to create a new access token. For more information about identity access management and security, see [Service Accounts](https://cloudfleet.ai/docs/organization/api-tokens/) section of documentaiton.
|
|
73
|
+
*
|
|
74
|
+
* This endpoint is available to administrators of the organization only.
|
|
70
75
|
*
|
|
71
76
|
*/
|
|
72
|
-
static
|
|
73
|
-
}
|
|
74
|
-
export declare class ClustersService {
|
|
77
|
+
static createToken<ThrowOnError extends boolean = false>(options: Options<CreateTokenData, ThrowOnError>): import("./client").RequestResult<CreateTokenResponses, CreateTokenErrors, ThrowOnError, "fields">;
|
|
75
78
|
/**
|
|
76
|
-
*
|
|
77
|
-
*
|
|
78
|
-
* Returns a list of charts in the cluster.
|
|
79
|
+
* Permanently delete access token.
|
|
79
80
|
*
|
|
80
|
-
* This endpoint is available to
|
|
81
|
+
* This endpoint allows you to delete an access token. For more information about identity access management and security, see [Service Accounts](https://cloudfleet.ai/docs/organization/api-tokens/) section of documentaiton. This endpoint is available to administrators of the organization only.
|
|
81
82
|
*
|
|
82
83
|
*/
|
|
83
|
-
static
|
|
84
|
+
static deleteToken<ThrowOnError extends boolean = false>(options: Options<DeleteTokenData, ThrowOnError>): import("./client").RequestResult<DeleteTokenResponses, unknown, ThrowOnError, "fields">;
|
|
84
85
|
/**
|
|
85
|
-
*
|
|
86
|
-
*
|
|
87
|
-
* Create a new chart deployment.
|
|
86
|
+
* Get access token information.
|
|
88
87
|
*
|
|
89
|
-
* This endpoint is available to
|
|
88
|
+
* This endpoint allows you to get access token details. For more information about identity access management and security, see [Service Accounts](https://cloudfleet.ai/docs/organization/api-tokens/) section of documentaiton. This endpoint is available to all users in the organization.
|
|
90
89
|
*
|
|
91
90
|
*/
|
|
92
|
-
static
|
|
91
|
+
static getToken<ThrowOnError extends boolean = false>(options: Options<GetTokenData, ThrowOnError>): import("./client").RequestResult<GetTokenResponses, GetTokenErrors, ThrowOnError, "fields">;
|
|
93
92
|
/**
|
|
94
|
-
*
|
|
93
|
+
* Update access token information.
|
|
95
94
|
*
|
|
96
|
-
* This endpoint
|
|
95
|
+
* This endpoint allows you to update access token details. For more information about identity access management and security, see [Service Accounts](https://cloudfleet.ai/docs/organization/api-tokens/) section of documentaiton.
|
|
97
96
|
*
|
|
98
97
|
* This endpoint is available to administrators of the organization only.
|
|
99
98
|
*
|
|
100
99
|
*/
|
|
101
|
-
static
|
|
100
|
+
static updateToken<ThrowOnError extends boolean = false>(options: Options<UpdateTokenData, ThrowOnError>): import("./client").RequestResult<UpdateTokenResponses, UpdateTokenErrors, ThrowOnError, "fields">;
|
|
102
101
|
/**
|
|
103
|
-
*
|
|
102
|
+
* Regenerate access token secret key.
|
|
104
103
|
*
|
|
105
|
-
*
|
|
104
|
+
* Generates a new access token secret. Old secret will not be valid anymore.
|
|
105
|
+
*/
|
|
106
|
+
static regenerateToken<ThrowOnError extends boolean = false>(options: Options<RegenerateTokenData, ThrowOnError>): import("./client").RequestResult<RegenerateTokenResponses, RegenerateTokenErrors, ThrowOnError, "fields">;
|
|
107
|
+
}
|
|
108
|
+
export declare class TicketsService {
|
|
109
|
+
/**
|
|
110
|
+
* List tickets for the current organization.
|
|
106
111
|
*
|
|
107
|
-
*
|
|
112
|
+
* Returns all tickets belonging to the caller's organization, newest first.
|
|
108
113
|
*
|
|
109
114
|
*/
|
|
110
|
-
static
|
|
115
|
+
static listTickets<ThrowOnError extends boolean = false>(options?: Options<ListTicketsData, ThrowOnError>): import("./client").RequestResult<ListTicketsResponses, unknown, ThrowOnError, "fields">;
|
|
111
116
|
/**
|
|
112
|
-
*
|
|
113
|
-
*
|
|
114
|
-
* This endpoint allows you to update the values of a chart deployment.
|
|
117
|
+
* Create a new support ticket.
|
|
115
118
|
*
|
|
116
|
-
*
|
|
119
|
+
* Creates a new support ticket with an initial customer message. The request is `multipart/form-data` with a JSON-encoded `payload` field carrying `category`, `body`, and optional `properties` and `grant_support_access`, plus up to 3 `attachments` files (10 MB max each).
|
|
117
120
|
*
|
|
118
121
|
*/
|
|
119
|
-
static
|
|
122
|
+
static createTicket<ThrowOnError extends boolean = false>(options: Options<CreateTicketData, ThrowOnError>): import("./client").RequestResult<CreateTicketResponses, unknown, ThrowOnError, "fields">;
|
|
120
123
|
/**
|
|
121
|
-
*
|
|
124
|
+
* Close a ticket (soft close).
|
|
122
125
|
*
|
|
123
|
-
*
|
|
124
|
-
*
|
|
125
|
-
* This endpoint is available to all users in the organization.
|
|
126
|
+
* Marks the ticket as closed. Closed is a terminal state — users cannot reply to a closed ticket; a new ticket must be opened instead.
|
|
126
127
|
*
|
|
127
128
|
*/
|
|
128
|
-
static
|
|
129
|
+
static closeTicket<ThrowOnError extends boolean = false>(options: Options<CloseTicketData, ThrowOnError>): import("./client").RequestResult<CloseTicketResponses, unknown, ThrowOnError, "fields">;
|
|
129
130
|
/**
|
|
130
|
-
*
|
|
131
|
-
|
|
132
|
-
|
|
131
|
+
* Get a ticket and its messages.
|
|
132
|
+
*/
|
|
133
|
+
static getTicket<ThrowOnError extends boolean = false>(options: Options<GetTicketData, ThrowOnError>): import("./client").RequestResult<GetTicketResponses, unknown, ThrowOnError, "fields">;
|
|
134
|
+
/**
|
|
135
|
+
* Grant Cloudfleet support access for a ticket.
|
|
133
136
|
*
|
|
134
|
-
*
|
|
137
|
+
* Grants Cloudfleet support staff access to the organization's resources while the ticket is open. Access cannot be revoked; it ends when the ticket is closed. Idempotent: granting again keeps the original grant. Returns 409 if the ticket is closed.
|
|
135
138
|
*
|
|
136
139
|
*/
|
|
137
|
-
static
|
|
140
|
+
static grantTicketSupportAccess<ThrowOnError extends boolean = false>(options: Options<GrantTicketSupportAccessData, ThrowOnError>): import("./client").RequestResult<GrantTicketSupportAccessResponses, GrantTicketSupportAccessErrors, ThrowOnError, "fields">;
|
|
138
141
|
/**
|
|
139
|
-
*
|
|
142
|
+
* Append a customer reply to a ticket.
|
|
140
143
|
*
|
|
141
|
-
*
|
|
142
|
-
*
|
|
143
|
-
* This endpoint is available to administrators of the organization only.
|
|
144
|
+
* Multipart form-data with a JSON-encoded `payload` field carrying `body`, plus up to 3 `attachments` files. Returns 409 if the ticket is closed.
|
|
144
145
|
*
|
|
145
146
|
*/
|
|
146
|
-
static
|
|
147
|
+
static replyTicket<ThrowOnError extends boolean = false>(options: Options<ReplyTicketData, ThrowOnError>): import("./client").RequestResult<ReplyTicketResponses, ReplyTicketErrors, ThrowOnError, "fields">;
|
|
147
148
|
/**
|
|
148
|
-
*
|
|
149
|
-
|
|
150
|
-
|
|
149
|
+
* Download a ticket attachment.
|
|
150
|
+
*/
|
|
151
|
+
static getTicketAttachment<ThrowOnError extends boolean = false>(options: Options<GetTicketAttachmentData, ThrowOnError>): import("./client").RequestResult<GetTicketAttachmentResponses, unknown, ThrowOnError, "fields">;
|
|
152
|
+
}
|
|
153
|
+
export declare class RoadmapService {
|
|
154
|
+
/**
|
|
155
|
+
* List roadmap items.
|
|
151
156
|
*
|
|
152
|
-
*
|
|
157
|
+
* Returns the published roadmap items, newest first, each with your own vote. Votes of other users are not returned.
|
|
153
158
|
*
|
|
154
159
|
*/
|
|
155
|
-
static
|
|
160
|
+
static listRoadmap<ThrowOnError extends boolean = false>(options?: Options<ListRoadmapData, ThrowOnError>): import("./client").RequestResult<ListRoadmapResponses, unknown, ThrowOnError, "fields">;
|
|
156
161
|
/**
|
|
157
|
-
*
|
|
158
|
-
*
|
|
159
|
-
* This endpoint allows you to update fleet details.
|
|
162
|
+
* Suggest a new roadmap item.
|
|
160
163
|
*
|
|
161
|
-
*
|
|
164
|
+
* Submits a suggestion in one or two sentences, with your up vote on it. Suggestions are reviewed by the Cloudfleet team before they appear on the roadmap.
|
|
162
165
|
*
|
|
163
|
-
|
|
166
|
+
*/
|
|
167
|
+
static suggestRoadmap<ThrowOnError extends boolean = false>(options: Options<SuggestRoadmapData, ThrowOnError>): import("./client").RequestResult<SuggestRoadmapResponses, unknown, ThrowOnError, "fields">;
|
|
168
|
+
/**
|
|
169
|
+
* Remove your vote from a roadmap item.
|
|
170
|
+
*/
|
|
171
|
+
static unvoteRoadmap<ThrowOnError extends boolean = false>(options: Options<UnvoteRoadmapData, ThrowOnError>): import("./client").RequestResult<UnvoteRoadmapResponses, UnvoteRoadmapErrors, ThrowOnError, "fields">;
|
|
172
|
+
/**
|
|
173
|
+
* Vote on a roadmap item.
|
|
164
174
|
*
|
|
165
|
-
*
|
|
175
|
+
* Sets your vote on a roadmap item: -1 (down), 1 (up), or 2 (double up). Replaces any previous vote you cast on the item.
|
|
166
176
|
*
|
|
167
177
|
*/
|
|
168
|
-
static
|
|
178
|
+
static voteRoadmap<ThrowOnError extends boolean = false>(options: Options<VoteRoadmapData, ThrowOnError>): import("./client").RequestResult<VoteRoadmapResponses, VoteRoadmapErrors, ThrowOnError, "fields">;
|
|
179
|
+
}
|
|
180
|
+
export declare class RegistryService {
|
|
169
181
|
/**
|
|
170
|
-
*
|
|
182
|
+
* List repositories
|
|
183
|
+
*
|
|
184
|
+
* Returns a list of repositories in the registry across all regions. This endpoint is available to all users in the organization.
|
|
171
185
|
*
|
|
172
|
-
* An API endpoint for directly querying a Kubernetes cluster API without requiring kubectl or other tools. This endpoint is ideal for automation and scripting, as well as for internal use in fetching data for the Cloudfleet Console. It acts as a passthrough to the Kubernetes API, allowing access to any valid Kubernetes API endpoint, including those not exposed in the Cloudfleet Console. The endpoint is strictly read-only, ensuring no modifications to the cluster state. It is accessible to all users within the organization and uses the same authentication mechanisms as other Cloudfleet API endpoints.
|
|
173
186
|
*/
|
|
174
|
-
static
|
|
187
|
+
static listRepositories<ThrowOnError extends boolean = false>(options?: Options<ListRepositoriesData, ThrowOnError>): import("./client").RequestResult<ListRepositoriesResponses, ListRepositoriesErrors, ThrowOnError, "fields">;
|
|
175
188
|
/**
|
|
176
|
-
* List
|
|
177
|
-
*
|
|
178
|
-
* Returns a list of clusters under the current organization, including quota. Quota is a set of filters defined by the admin of the organization that will be applied to all resources created in the cluster. Quota information returned here does not take into account quota set on organization or platform level. For calculated quota applied to this account, use /clusters/{cluster_id}/quota endpoint. For more information about quotas, see [Quotas and limits](https://cloudfleet.ai/docs/organization/quotas/) section of documentaiton.
|
|
189
|
+
* List tags for a repository
|
|
179
190
|
*
|
|
180
|
-
* This endpoint is available to all users in the organization.
|
|
191
|
+
* Returns a list of tags for a specific repository, including size and metadata for each tag. This endpoint is available to all users in the organization.
|
|
181
192
|
*
|
|
182
193
|
*/
|
|
183
|
-
static
|
|
194
|
+
static listTags<ThrowOnError extends boolean = false>(options: Options<ListTagsData, ThrowOnError>): import("./client").RequestResult<ListTagsResponses, ListTagsErrors, ThrowOnError, "fields">;
|
|
184
195
|
/**
|
|
185
|
-
*
|
|
186
|
-
*
|
|
187
|
-
* Create a new cluster under the current organization. Clusters allow you to group resources and you can create multiple clusters under the same organization, with billing delegated to the parent organization.
|
|
196
|
+
* Delete tag
|
|
188
197
|
*
|
|
189
|
-
* This endpoint is available to administrators of the organization only.
|
|
198
|
+
* Permanently deletes a specific tag from a repository. This endpoint is available to administrators of the organization only.
|
|
190
199
|
*
|
|
191
200
|
*/
|
|
192
|
-
static
|
|
201
|
+
static deleteTag<ThrowOnError extends boolean = false>(options: Options<DeleteTagData, ThrowOnError>): import("./client").RequestResult<DeleteTagResponses, DeleteTagErrors, ThrowOnError, "fields">;
|
|
193
202
|
/**
|
|
194
|
-
*
|
|
195
|
-
*
|
|
196
|
-
* This endpoint will permanently delete the cluster. This operation cannot be undone.
|
|
203
|
+
* Get tag details
|
|
197
204
|
*
|
|
198
|
-
* This endpoint is available to
|
|
205
|
+
* Returns detailed information for a specific tag in a repository, including manifest details, size, and URI. This endpoint is available to all users in the organization.
|
|
199
206
|
*
|
|
200
207
|
*/
|
|
201
|
-
static
|
|
208
|
+
static getTag<ThrowOnError extends boolean = false>(options: Options<GetTagData, ThrowOnError>): import("./client").RequestResult<GetTagResponses, GetTagErrors, ThrowOnError, "fields">;
|
|
209
|
+
}
|
|
210
|
+
export declare class OrganizationService {
|
|
202
211
|
/**
|
|
203
|
-
* Get
|
|
212
|
+
* Get organization information.
|
|
204
213
|
*
|
|
205
|
-
* Returns
|
|
214
|
+
* Returns organization details including quota. For more information about quotas, see [Quotas and limits](https://cloudfleet.ai/docs/organization/quotas/) section of documentaiton.
|
|
206
215
|
*
|
|
207
216
|
* This endpoint is available to all users in the organization.
|
|
208
217
|
*
|
|
209
218
|
*/
|
|
210
|
-
static
|
|
219
|
+
static getOrganization<ThrowOnError extends boolean = false>(options?: Options<GetOrganizationData, ThrowOnError>): import("./client").RequestResult<GetOrganizationResponses, unknown, ThrowOnError, "fields">;
|
|
211
220
|
/**
|
|
212
|
-
*
|
|
221
|
+
* Create a new organization / Cloudfleet account signup.
|
|
213
222
|
*
|
|
214
|
-
* This endpoint allows you to
|
|
223
|
+
* This endpoint allows you to create a new Cloudfleet organization and an administrator user.
|
|
215
224
|
*
|
|
216
|
-
|
|
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
|
|
217
231
|
*
|
|
232
|
+
* MCP endpoint for handling Model Context Protocol JSON-RPC 2.0 messages.
|
|
218
233
|
*/
|
|
219
|
-
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 {
|
|
220
237
|
/**
|
|
221
|
-
*
|
|
238
|
+
* List chart listings available in the marketplace.
|
|
239
|
+
*
|
|
240
|
+
* Returns a list of available charts in the marketplace.
|
|
222
241
|
*
|
|
223
|
-
*
|
|
242
|
+
* This endpoint is available to all users in the organization.
|
|
224
243
|
*
|
|
225
244
|
*/
|
|
226
|
-
static
|
|
245
|
+
static listMarketplaceCharts<ThrowOnError extends boolean = false>(options?: Options<ListMarketplaceChartsData, ThrowOnError>): import("./client").RequestResult<ListMarketplaceChartsResponses, ListMarketplaceChartsErrors, ThrowOnError, "fields">;
|
|
227
246
|
/**
|
|
228
|
-
*
|
|
247
|
+
* Get chart files for a specific version channel.
|
|
229
248
|
*
|
|
230
|
-
* 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.
|
|
231
254
|
*
|
|
232
255
|
*/
|
|
233
|
-
static
|
|
256
|
+
static getMarketplaceChartFiles<ThrowOnError extends boolean = false>(options: Options<GetMarketplaceChartFilesData, ThrowOnError>): import("./client").RequestResult<GetMarketplaceChartFilesResponses, GetMarketplaceChartFilesErrors, ThrowOnError, "fields">;
|
|
234
257
|
}
|
|
235
258
|
export declare class InvitesService {
|
|
236
259
|
/**
|
|
237
260
|
* List invites.
|
|
238
261
|
*
|
|
239
|
-
* 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.
|
|
240
263
|
*
|
|
241
264
|
*/
|
|
242
265
|
static listInvites<ThrowOnError extends boolean = false>(options?: Options<ListInvitesData, ThrowOnError>): import("./client").RequestResult<ListInvitesResponses, ListInvitesErrors, ThrowOnError, "fields">;
|
|
@@ -250,7 +273,7 @@ export declare class InvitesService {
|
|
|
250
273
|
/**
|
|
251
274
|
* Get invite information.
|
|
252
275
|
*
|
|
253
|
-
*
|
|
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.
|
|
254
277
|
*
|
|
255
278
|
*/
|
|
256
279
|
static getInvite<ThrowOnError extends boolean = false>(options: Options<GetInviteData, ThrowOnError>): import("./client").RequestResult<GetInviteResponses, unknown, ThrowOnError, "fields">;
|
|
@@ -262,174 +285,254 @@ export declare class InvitesService {
|
|
|
262
285
|
*/
|
|
263
286
|
static deleteInvite<ThrowOnError extends boolean = false>(options: Options<DeleteInviteData, ThrowOnError>): import("./client").RequestResult<DeleteInviteResponses, unknown, ThrowOnError, "fields">;
|
|
264
287
|
}
|
|
265
|
-
export declare class
|
|
288
|
+
export declare class FeedbackService {
|
|
266
289
|
/**
|
|
267
|
-
*
|
|
290
|
+
* Send feedback to the Cloudfleet team
|
|
268
291
|
*
|
|
269
|
-
*
|
|
292
|
+
* Sends feedback about Cloudfleet: what was useful, confusing, wrong or missing. Feedback is read by the Cloudfleet team but gets no reply and has no status. This is not a support channel: for anything that needs an answer, open a support ticket with `POST /tickets` instead.
|
|
293
|
+
*
|
|
294
|
+
*/
|
|
295
|
+
static sendFeedback<ThrowOnError extends boolean = false>(options: Options<SendFeedbackData, ThrowOnError>): import("./client").RequestResult<SendFeedbackResponses, SendFeedbackErrors, ThrowOnError, "fields">;
|
|
296
|
+
}
|
|
297
|
+
export declare class ClustersService {
|
|
298
|
+
/**
|
|
299
|
+
* Query Kubernetes cluster API
|
|
300
|
+
*
|
|
301
|
+
* 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.
|
|
302
|
+
*/
|
|
303
|
+
static queryCluster<ThrowOnError extends boolean = false>(options: Options<QueryClusterData, ThrowOnError>): import("./client").RequestResult<QueryClusterResponses, QueryClusterErrors, ThrowOnError, "fields">;
|
|
304
|
+
/**
|
|
305
|
+
* List fleets.
|
|
306
|
+
*
|
|
307
|
+
* Returns a list of fleets belonging to the cluster. For more information, see [Fleets](https://cloudfleet.ai/docs/cloud-infrastructure/fleets/) section of documentaiton.
|
|
270
308
|
*
|
|
271
309
|
* This endpoint is available to all users in the organization.
|
|
272
310
|
*
|
|
273
311
|
*/
|
|
274
|
-
static
|
|
312
|
+
static listFleets<ThrowOnError extends boolean = false>(options: Options<ListFleetsData, ThrowOnError>): import("./client").RequestResult<ListFleetsResponses, ListFleetsErrors, ThrowOnError, "fields">;
|
|
275
313
|
/**
|
|
276
|
-
*
|
|
314
|
+
* Create a new fleet.
|
|
277
315
|
*
|
|
278
|
-
*
|
|
316
|
+
* Create a new fleet under the current organization. fleets allow you to to schedule workloads in cloud service provider accounts owned by you. For more information, see [Fleets](https://cloudfleet.ai/docs/cloud-infrastructure/fleets/) section of documentaiton.
|
|
279
317
|
*
|
|
280
|
-
*
|
|
318
|
+
* The cluster must be ready (status `deployed`) before a fleet can be added. Adding a fleet while the cluster is still provisioning returns `409`.
|
|
281
319
|
*
|
|
282
|
-
* This endpoint is available to
|
|
320
|
+
* This endpoint is available to administrators of the organization only.
|
|
283
321
|
*
|
|
284
322
|
*/
|
|
285
|
-
static
|
|
286
|
-
}
|
|
287
|
-
export declare class McpService {
|
|
323
|
+
static createFleet<ThrowOnError extends boolean = false>(options: Options<CreateFleetData, ThrowOnError>): import("./client").RequestResult<CreateFleetResponses, CreateFleetErrors, ThrowOnError, "fields">;
|
|
288
324
|
/**
|
|
289
|
-
*
|
|
325
|
+
* Permanently delete fleet.
|
|
326
|
+
*
|
|
327
|
+
* 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.
|
|
328
|
+
*
|
|
329
|
+
* 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.
|
|
330
|
+
*
|
|
331
|
+
* This endpoint is available to administrators of the organization only.
|
|
290
332
|
*
|
|
291
|
-
* MCP endpoint for handling Model Context Protocol JSON-RPC 2.0 messages.
|
|
292
333
|
*/
|
|
293
|
-
static
|
|
294
|
-
}
|
|
295
|
-
export declare class OrganizationService {
|
|
334
|
+
static deleteFleet<ThrowOnError extends boolean = false>(options: Options<DeleteFleetData, ThrowOnError>): import("./client").RequestResult<DeleteFleetResponses, DeleteFleetErrors, ThrowOnError, "fields">;
|
|
296
335
|
/**
|
|
297
|
-
* Get
|
|
336
|
+
* Get fleet information.
|
|
298
337
|
*
|
|
299
|
-
* Returns
|
|
338
|
+
* Returns fleet details. For more information, see [Fleets](https://cloudfleet.ai/docs/cloud-infrastructure/fleets/) section of documentaiton.
|
|
300
339
|
*
|
|
301
340
|
* This endpoint is available to all users in the organization.
|
|
302
341
|
*
|
|
303
342
|
*/
|
|
304
|
-
static
|
|
343
|
+
static getFleet<ThrowOnError extends boolean = false>(options: Options<GetFleetData, ThrowOnError>): import("./client").RequestResult<GetFleetResponses, unknown, ThrowOnError, "fields">;
|
|
305
344
|
/**
|
|
306
|
-
*
|
|
345
|
+
* Update fleet information.
|
|
307
346
|
*
|
|
308
|
-
* This endpoint allows you to
|
|
347
|
+
* This endpoint allows you to update fleet details.
|
|
348
|
+
*
|
|
349
|
+
* For more information, see [Fleets](https://cloudfleet.ai/docs/cloud-infrastructure/fleets/) section of documentaiton.
|
|
350
|
+
*
|
|
351
|
+
* 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).
|
|
352
|
+
*
|
|
353
|
+
* This endpoint is available to administrators of the organization only.
|
|
309
354
|
*
|
|
310
355
|
*/
|
|
311
|
-
static
|
|
312
|
-
}
|
|
313
|
-
export declare class RegistryService {
|
|
356
|
+
static updateFleet<ThrowOnError extends boolean = false>(options: Options<UpdateFleetData, ThrowOnError>): import("./client").RequestResult<UpdateFleetResponses, UpdateFleetErrors, ThrowOnError, "fields">;
|
|
314
357
|
/**
|
|
315
|
-
* List
|
|
358
|
+
* List charts.
|
|
316
359
|
*
|
|
317
|
-
* Returns a list of
|
|
360
|
+
* Returns a list of charts in the cluster.
|
|
361
|
+
*
|
|
362
|
+
* This endpoint is available to all users in the organization.
|
|
318
363
|
*
|
|
319
364
|
*/
|
|
320
|
-
static
|
|
365
|
+
static listCharts<ThrowOnError extends boolean = false>(options: Options<ListChartsData, ThrowOnError>): import("./client").RequestResult<ListChartsResponses, ListChartsErrors, ThrowOnError, "fields">;
|
|
321
366
|
/**
|
|
322
|
-
*
|
|
367
|
+
* Create a new chart.
|
|
323
368
|
*
|
|
324
|
-
*
|
|
369
|
+
* Create a new chart deployment.
|
|
370
|
+
*
|
|
371
|
+
* This endpoint is available to administrators of the organization only.
|
|
325
372
|
*
|
|
326
373
|
*/
|
|
327
|
-
static
|
|
374
|
+
static createChart<ThrowOnError extends boolean = false>(options: Options<CreateChartData, ThrowOnError>): import("./client").RequestResult<CreateChartResponses, CreateChartErrors, ThrowOnError, "fields">;
|
|
328
375
|
/**
|
|
329
|
-
*
|
|
376
|
+
* Permanently delete the chart deployment from the cluster.
|
|
330
377
|
*
|
|
331
|
-
*
|
|
378
|
+
* This endpoint will permanently delete chart. This operation cannot be undone.
|
|
379
|
+
*
|
|
380
|
+
* This endpoint is available to administrators of the organization only.
|
|
332
381
|
*
|
|
333
382
|
*/
|
|
334
|
-
static
|
|
383
|
+
static deleteChart<ThrowOnError extends boolean = false>(options: Options<DeleteChartData, ThrowOnError>): import("./client").RequestResult<DeleteChartResponses, DeleteChartErrors, ThrowOnError, "fields">;
|
|
335
384
|
/**
|
|
336
|
-
* Get
|
|
385
|
+
* Get chart information.
|
|
337
386
|
*
|
|
338
|
-
* Returns
|
|
387
|
+
* Returns the details of the chart deployment.
|
|
388
|
+
*
|
|
389
|
+
* This endpoint is available to all users in the organization.
|
|
339
390
|
*
|
|
340
391
|
*/
|
|
341
|
-
static
|
|
342
|
-
}
|
|
343
|
-
export declare class TokensService {
|
|
392
|
+
static getChart<ThrowOnError extends boolean = false>(options: Options<GetChartData, ThrowOnError>): import("./client").RequestResult<GetChartResponses, unknown, ThrowOnError, "fields">;
|
|
344
393
|
/**
|
|
345
|
-
*
|
|
394
|
+
* Update chart information.
|
|
346
395
|
*
|
|
347
|
-
* This endpoint allows you to
|
|
396
|
+
* This endpoint allows you to update the values of a chart deployment.
|
|
397
|
+
*
|
|
398
|
+
* This endpoint is available to administrators of the organization only.
|
|
348
399
|
*
|
|
349
400
|
*/
|
|
350
|
-
static
|
|
401
|
+
static updateChart<ThrowOnError extends boolean = false>(options: Options<UpdateChartData, ThrowOnError>): import("./client").RequestResult<UpdateChartResponses, UpdateChartErrors, ThrowOnError, "fields">;
|
|
351
402
|
/**
|
|
352
|
-
*
|
|
403
|
+
* List clusters.
|
|
353
404
|
*
|
|
354
|
-
*
|
|
405
|
+
* Returns a list of clusters under the current organization.
|
|
406
|
+
*
|
|
407
|
+
* This endpoint is available to all users in the organization.
|
|
408
|
+
*
|
|
409
|
+
*/
|
|
410
|
+
static listClusters<ThrowOnError extends boolean = false>(options?: Options<ListClustersData, ThrowOnError>): import("./client").RequestResult<ListClustersResponses, ListClustersErrors, ThrowOnError, "fields">;
|
|
411
|
+
/**
|
|
412
|
+
* Create a new cluster.
|
|
413
|
+
*
|
|
414
|
+
* 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.
|
|
355
415
|
*
|
|
356
416
|
* This endpoint is available to administrators of the organization only.
|
|
357
417
|
*
|
|
358
418
|
*/
|
|
359
|
-
static
|
|
419
|
+
static createCluster<ThrowOnError extends boolean = false>(options: Options<CreateClusterData, ThrowOnError>): import("./client").RequestResult<CreateClusterResponses, CreateClusterErrors, ThrowOnError, "fields">;
|
|
360
420
|
/**
|
|
361
|
-
* Permanently delete
|
|
421
|
+
* Permanently delete cluster.
|
|
362
422
|
*
|
|
363
|
-
* This endpoint
|
|
423
|
+
* This endpoint will permanently delete the cluster. This operation cannot be undone.
|
|
424
|
+
*
|
|
425
|
+
* 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.
|
|
426
|
+
*
|
|
427
|
+
* This endpoint is available to administrators of the organization only.
|
|
364
428
|
*
|
|
365
429
|
*/
|
|
366
|
-
static
|
|
430
|
+
static deleteCluster<ThrowOnError extends boolean = false>(options: Options<DeleteClusterData, ThrowOnError>): import("./client").RequestResult<DeleteClusterResponses, DeleteClusterErrors, ThrowOnError, "fields">;
|
|
367
431
|
/**
|
|
368
|
-
* Get
|
|
432
|
+
* Get cluster information.
|
|
369
433
|
*
|
|
370
|
-
*
|
|
434
|
+
* Returns cluster details.
|
|
435
|
+
*
|
|
436
|
+
* This endpoint is available to all users in the organization.
|
|
371
437
|
*
|
|
372
438
|
*/
|
|
373
|
-
static
|
|
439
|
+
static getCluster<ThrowOnError extends boolean = false>(options: Options<GetClusterData, ThrowOnError>): import("./client").RequestResult<GetClusterResponses, unknown, ThrowOnError, "fields">;
|
|
374
440
|
/**
|
|
375
|
-
* Update
|
|
441
|
+
* Update cluster information.
|
|
376
442
|
*
|
|
377
|
-
* This endpoint allows you to update
|
|
443
|
+
* 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.
|
|
444
|
+
*
|
|
445
|
+
* This is a full overwrite: any field omitted from the request is reset to its default rather than left unchanged.
|
|
378
446
|
*
|
|
379
447
|
* This endpoint is available to administrators of the organization only.
|
|
380
448
|
*
|
|
381
449
|
*/
|
|
382
|
-
static
|
|
450
|
+
static updateCluster<ThrowOnError extends boolean = false>(options: Options<UpdateClusterData, ThrowOnError>): import("./client").RequestResult<UpdateClusterResponses, UpdateClusterErrors, ThrowOnError, "fields">;
|
|
383
451
|
/**
|
|
384
|
-
*
|
|
452
|
+
* Node join information for the cluster
|
|
453
|
+
*
|
|
454
|
+
* 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.
|
|
385
455
|
*
|
|
386
|
-
* Generates a new access token secret. Old secret will not be valid anymore.
|
|
387
456
|
*/
|
|
388
|
-
static
|
|
457
|
+
static getJoinInformation<ThrowOnError extends boolean = false>(options: Options<GetJoinInformationData, ThrowOnError>): import("./client").RequestResult<GetJoinInformationResponses, GetJoinInformationErrors, ThrowOnError, "fields">;
|
|
389
458
|
}
|
|
390
|
-
export declare class
|
|
459
|
+
export declare class BillingService {
|
|
391
460
|
/**
|
|
392
|
-
* Get
|
|
461
|
+
* Get billing usage information.
|
|
462
|
+
*
|
|
463
|
+
* 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.
|
|
464
|
+
*
|
|
393
465
|
*/
|
|
394
|
-
static
|
|
466
|
+
static getUsage<ThrowOnError extends boolean = false>(options?: Options<GetUsageData, ThrowOnError>): import("./client").RequestResult<GetUsageResponses, GetUsageErrors, ThrowOnError, "fields">;
|
|
395
467
|
/**
|
|
396
|
-
*
|
|
468
|
+
* Get Stripe client secret.
|
|
397
469
|
*
|
|
398
|
-
*
|
|
470
|
+
* 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.
|
|
399
471
|
*
|
|
400
|
-
|
|
472
|
+
*/
|
|
473
|
+
static getPaymentMethodSecret<ThrowOnError extends boolean = false>(options?: Options<GetPaymentMethodSecretData, ThrowOnError>): import("./client").RequestResult<GetPaymentMethodSecretResponses, unknown, ThrowOnError, "fields">;
|
|
474
|
+
/**
|
|
475
|
+
* List organization payment methods.
|
|
476
|
+
*
|
|
477
|
+
* 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.
|
|
401
478
|
*
|
|
402
479
|
*/
|
|
403
|
-
static
|
|
480
|
+
static listPaymentMethods<ThrowOnError extends boolean = false>(options?: Options<ListPaymentMethodsData, ThrowOnError>): import("./client").RequestResult<ListPaymentMethodsResponses, ListPaymentMethodsErrors, ThrowOnError, "fields">;
|
|
404
481
|
/**
|
|
405
|
-
*
|
|
482
|
+
* Set the default payment method.
|
|
406
483
|
*
|
|
407
|
-
*
|
|
484
|
+
* Sets the given payment method as the default used for invoices and active subscriptions. Requires the Administrator role.
|
|
408
485
|
*
|
|
409
486
|
*/
|
|
410
|
-
static
|
|
487
|
+
static setDefaultPaymentMethod<ThrowOnError extends boolean = false>(options: Options<SetDefaultPaymentMethodData, ThrowOnError>): import("./client").RequestResult<SetDefaultPaymentMethodResponses, SetDefaultPaymentMethodErrors, ThrowOnError, "fields">;
|
|
411
488
|
/**
|
|
412
|
-
* Delete
|
|
489
|
+
* Delete a payment method.
|
|
413
490
|
*
|
|
414
|
-
*
|
|
491
|
+
* 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.
|
|
415
492
|
*
|
|
416
493
|
*/
|
|
417
|
-
static
|
|
494
|
+
static deletePaymentMethod<ThrowOnError extends boolean = false>(options: Options<DeletePaymentMethodData, ThrowOnError>): import("./client").RequestResult<DeletePaymentMethodResponses, DeletePaymentMethodErrors, ThrowOnError, "fields">;
|
|
418
495
|
/**
|
|
419
|
-
*
|
|
496
|
+
* List issued invoices.
|
|
420
497
|
*
|
|
421
|
-
* Returns
|
|
498
|
+
* 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.
|
|
422
499
|
*
|
|
423
|
-
|
|
500
|
+
*/
|
|
501
|
+
static listInvoices<ThrowOnError extends boolean = false>(options?: Options<ListInvoicesData, ThrowOnError>): import("./client").RequestResult<ListInvoicesResponses, ListInvoicesErrors, ThrowOnError, "fields">;
|
|
502
|
+
/**
|
|
503
|
+
* Pay the organization's open invoices.
|
|
504
|
+
*
|
|
505
|
+
* Charges all open invoices of the organization against its default payment method. This endpoint is available to administrators of the organization only.
|
|
424
506
|
*
|
|
425
507
|
*/
|
|
426
|
-
static
|
|
508
|
+
static payOpenInvoices<ThrowOnError extends boolean = false>(options?: Options<PayOpenInvoicesData, ThrowOnError>): import("./client").RequestResult<PayOpenInvoicesResponses, PayOpenInvoicesErrors, ThrowOnError, "fields">;
|
|
427
509
|
/**
|
|
428
|
-
*
|
|
510
|
+
* Get organization contact and billing address information.
|
|
429
511
|
*
|
|
430
|
-
*
|
|
512
|
+
* Returns the organization contact and billing address information. This endpoint is available to all users in the organization.
|
|
431
513
|
*
|
|
432
514
|
*/
|
|
433
|
-
static
|
|
515
|
+
static getContact<ThrowOnError extends boolean = false>(options?: Options<GetContactData, ThrowOnError>): import("./client").RequestResult<GetContactResponses, unknown, ThrowOnError, "fields">;
|
|
516
|
+
/**
|
|
517
|
+
* Update organization contact information and billing address.
|
|
518
|
+
*
|
|
519
|
+
* This endpoint allows you to update organization details with its contact information. This endpoint is available to administrators of the organization only.
|
|
520
|
+
*
|
|
521
|
+
*/
|
|
522
|
+
static updateContact<ThrowOnError extends boolean = false>(options: Options<UpdateContactData, ThrowOnError>): import("./client").RequestResult<UpdateContactResponses, unknown, ThrowOnError, "fields">;
|
|
523
|
+
/**
|
|
524
|
+
* Get applied promotional credits
|
|
525
|
+
*
|
|
526
|
+
* 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.
|
|
527
|
+
*
|
|
528
|
+
*/
|
|
529
|
+
static getCredits<ThrowOnError extends boolean = false>(options?: Options<GetCreditsData, ThrowOnError>): import("./client").RequestResult<GetCreditsResponses, GetCreditsErrors, ThrowOnError, "fields">;
|
|
530
|
+
/**
|
|
531
|
+
* Redeem promotional credits code.
|
|
532
|
+
*
|
|
533
|
+
* 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.
|
|
534
|
+
*
|
|
535
|
+
*/
|
|
536
|
+
static redeemCredits<ThrowOnError extends boolean = false>(options: Options<RedeemCreditsData, ThrowOnError>): import("./client").RequestResult<RedeemCreditsResponses, RedeemCreditsErrors, ThrowOnError, "fields">;
|
|
434
537
|
}
|
|
435
538
|
//# sourceMappingURL=sdk.gen.d.ts.map
|