@cloudfleet/sdk 0.0.1-c4175a2 → 0.0.1-c4563f6
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 +521 -576
- package/dist/@tanstack/react-query.gen.d.ts.map +1 -1
- package/dist/@tanstack/react-query.gen.js +520 -382
- 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 +774 -252
- package/dist/schemas.gen.d.ts.map +1 -1
- package/dist/schemas.gen.js +1045 -362
- package/dist/schemas.gen.js.map +1 -1
- package/dist/sdk.gen.d.ts +265 -209
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/sdk.gen.js +396 -312
- package/dist/sdk.gen.js.map +1 -1
- package/dist/types.gen.d.ts +1359 -838
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/zod.gen.d.ts +1919 -1542
- package/dist/zod.gen.d.ts.map +1 -1
- package/dist/zod.gen.js +618 -366
- 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
1
|
import { type Client, type Options as Options2, type TDataShape } from './client';
|
|
2
|
-
import type { CloseTicketData, CloseTicketResponses, CreateChartData, CreateChartResponses, CreateClusterData, CreateClusterErrors, CreateClusterResponses, CreateFleetData, CreateFleetErrors, CreateFleetResponses, CreateInviteData, CreateInviteResponses, CreateOrganizationData, CreateOrganizationResponses, CreateTicketData, CreateTicketResponses, 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, GetMarketplaceChartFilesData, GetMarketplaceChartFilesErrors, GetMarketplaceChartFilesResponses, GetOrganizationData, GetOrganizationResponses,
|
|
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, 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
3
|
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
|
|
4
4
|
/**
|
|
5
5
|
* You can provide a client instance returned by `createClient()` instead of
|
|
@@ -13,223 +13,246 @@ 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
|
-
*
|
|
104
|
-
*
|
|
105
|
-
* Returns the details of the chart deployment.
|
|
117
|
+
* Create a new support ticket.
|
|
106
118
|
*
|
|
107
|
-
*
|
|
119
|
+
* Creates a new support ticket with an initial customer message. The request is `multipart/form-data` with a JSON-encoded `payload` field carrying `category`, `body`, and optional `properties`, plus up to 3 `attachments` files (10 MB max each).
|
|
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
|
+
* Append a customer reply to a ticket.
|
|
124
136
|
*
|
|
125
|
-
*
|
|
137
|
+
* Multipart form-data with a JSON-encoded `payload` field carrying `body`, plus up to 3 `attachments` files. Returns 409 if the ticket is closed.
|
|
126
138
|
*
|
|
127
139
|
*/
|
|
128
|
-
static
|
|
140
|
+
static replyTicket<ThrowOnError extends boolean = false>(options: Options<ReplyTicketData, ThrowOnError>): import("./client").RequestResult<ReplyTicketResponses, ReplyTicketErrors, ThrowOnError, "fields">;
|
|
129
141
|
/**
|
|
130
|
-
*
|
|
131
|
-
|
|
132
|
-
|
|
142
|
+
* Download a ticket attachment.
|
|
143
|
+
*/
|
|
144
|
+
static getTicketAttachment<ThrowOnError extends boolean = false>(options: Options<GetTicketAttachmentData, ThrowOnError>): import("./client").RequestResult<GetTicketAttachmentResponses, unknown, ThrowOnError, "fields">;
|
|
145
|
+
}
|
|
146
|
+
export declare class RoadmapService {
|
|
147
|
+
/**
|
|
148
|
+
* List roadmap items.
|
|
133
149
|
*
|
|
134
|
-
*
|
|
150
|
+
* Returns the published roadmap items, newest first, each with your own vote. Votes of other users are not returned.
|
|
135
151
|
*
|
|
136
152
|
*/
|
|
137
|
-
static
|
|
153
|
+
static listRoadmap<ThrowOnError extends boolean = false>(options?: Options<ListRoadmapData, ThrowOnError>): import("./client").RequestResult<ListRoadmapResponses, unknown, ThrowOnError, "fields">;
|
|
138
154
|
/**
|
|
139
|
-
*
|
|
140
|
-
*
|
|
141
|
-
* This endpoint will permanently delete fleet. This operation cannot be undone. Your subscription will end by the end of the current billing period and you will not be able to receive credit for unused time. If you want to keep using the Fleet until the end of the billing period, set the status to `cancelling`. For more information, see [Fleets](https://cloudfleet.ai/docs/cloud-infrastructure/fleets/) section of documentaiton.
|
|
155
|
+
* Suggest a new roadmap item.
|
|
142
156
|
*
|
|
143
|
-
*
|
|
157
|
+
* 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.
|
|
144
158
|
*
|
|
145
159
|
*/
|
|
146
|
-
static
|
|
160
|
+
static suggestRoadmap<ThrowOnError extends boolean = false>(options: Options<SuggestRoadmapData, ThrowOnError>): import("./client").RequestResult<SuggestRoadmapResponses, unknown, ThrowOnError, "fields">;
|
|
147
161
|
/**
|
|
148
|
-
*
|
|
149
|
-
|
|
150
|
-
|
|
162
|
+
* Remove your vote from a roadmap item.
|
|
163
|
+
*/
|
|
164
|
+
static unvoteRoadmap<ThrowOnError extends boolean = false>(options: Options<UnvoteRoadmapData, ThrowOnError>): import("./client").RequestResult<UnvoteRoadmapResponses, UnvoteRoadmapErrors, ThrowOnError, "fields">;
|
|
165
|
+
/**
|
|
166
|
+
* Vote on a roadmap item.
|
|
151
167
|
*
|
|
152
|
-
*
|
|
168
|
+
* Sets your vote on a roadmap item: -1 (down), 1 (up), or 2 (double up). Replaces any previous vote you cast on the item.
|
|
153
169
|
*
|
|
154
170
|
*/
|
|
155
|
-
static
|
|
171
|
+
static voteRoadmap<ThrowOnError extends boolean = false>(options: Options<VoteRoadmapData, ThrowOnError>): import("./client").RequestResult<VoteRoadmapResponses, VoteRoadmapErrors, ThrowOnError, "fields">;
|
|
172
|
+
}
|
|
173
|
+
export declare class RegistryService {
|
|
156
174
|
/**
|
|
157
|
-
*
|
|
158
|
-
*
|
|
159
|
-
* This endpoint allows you to update fleet details.
|
|
175
|
+
* List repositories
|
|
160
176
|
*
|
|
161
|
-
*
|
|
177
|
+
* Returns a list of repositories in the registry across all regions. This endpoint is available to all users in the organization.
|
|
162
178
|
*
|
|
163
|
-
|
|
179
|
+
*/
|
|
180
|
+
static listRepositories<ThrowOnError extends boolean = false>(options?: Options<ListRepositoriesData, ThrowOnError>): import("./client").RequestResult<ListRepositoriesResponses, ListRepositoriesErrors, ThrowOnError, "fields">;
|
|
181
|
+
/**
|
|
182
|
+
* List tags for a repository
|
|
164
183
|
*
|
|
165
|
-
* This endpoint is available to
|
|
184
|
+
* 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.
|
|
166
185
|
*
|
|
167
186
|
*/
|
|
168
|
-
static
|
|
187
|
+
static listTags<ThrowOnError extends boolean = false>(options: Options<ListTagsData, ThrowOnError>): import("./client").RequestResult<ListTagsResponses, ListTagsErrors, ThrowOnError, "fields">;
|
|
169
188
|
/**
|
|
170
|
-
*
|
|
189
|
+
* Delete tag
|
|
190
|
+
*
|
|
191
|
+
* Permanently deletes a specific tag from a repository. This endpoint is available to administrators of the organization only.
|
|
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 deleteTag<ThrowOnError extends boolean = false>(options: Options<DeleteTagData, ThrowOnError>): import("./client").RequestResult<DeleteTagResponses, DeleteTagErrors, 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
|
+
* Get tag details
|
|
179
197
|
*
|
|
180
|
-
* This endpoint is available to all users in the organization.
|
|
198
|
+
* 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.
|
|
181
199
|
*
|
|
182
200
|
*/
|
|
183
|
-
static
|
|
201
|
+
static getTag<ThrowOnError extends boolean = false>(options: Options<GetTagData, ThrowOnError>): import("./client").RequestResult<GetTagResponses, GetTagErrors, ThrowOnError, "fields">;
|
|
202
|
+
}
|
|
203
|
+
export declare class OrganizationService {
|
|
184
204
|
/**
|
|
185
|
-
*
|
|
205
|
+
* Get organization information.
|
|
186
206
|
*
|
|
187
|
-
*
|
|
207
|
+
* Returns organization details including quota. For more information about quotas, see [Quotas and limits](https://cloudfleet.ai/docs/organization/quotas/) section of documentaiton.
|
|
188
208
|
*
|
|
189
|
-
* This endpoint is available to
|
|
209
|
+
* This endpoint is available to all users in the organization.
|
|
190
210
|
*
|
|
191
211
|
*/
|
|
192
|
-
static
|
|
212
|
+
static getOrganization<ThrowOnError extends boolean = false>(options?: Options<GetOrganizationData, ThrowOnError>): import("./client").RequestResult<GetOrganizationResponses, unknown, ThrowOnError, "fields">;
|
|
193
213
|
/**
|
|
194
|
-
*
|
|
214
|
+
* Create a new organization / Cloudfleet account signup.
|
|
195
215
|
*
|
|
196
|
-
* This endpoint
|
|
216
|
+
* This endpoint allows you to create a new Cloudfleet organization and an administrator user.
|
|
197
217
|
*
|
|
198
|
-
|
|
218
|
+
*/
|
|
219
|
+
static createOrganization<ThrowOnError extends boolean = false>(options: Options<CreateOrganizationData, ThrowOnError>): import("./client").RequestResult<CreateOrganizationResponses, unknown, ThrowOnError, "fields">;
|
|
220
|
+
}
|
|
221
|
+
export declare class McpService {
|
|
222
|
+
/**
|
|
223
|
+
* MCP endpoint
|
|
199
224
|
*
|
|
225
|
+
* MCP endpoint for handling Model Context Protocol JSON-RPC 2.0 messages.
|
|
200
226
|
*/
|
|
201
|
-
static
|
|
227
|
+
static postMcp<ThrowOnError extends boolean = false>(options: Options<PostMcpData, ThrowOnError>): import("./client").RequestResult<PostMcpResponses, PostMcpErrors, ThrowOnError, "fields">;
|
|
228
|
+
}
|
|
229
|
+
export declare class ChartsMarketplaceService {
|
|
202
230
|
/**
|
|
203
|
-
*
|
|
231
|
+
* List chart listings available in the marketplace.
|
|
204
232
|
*
|
|
205
|
-
* Returns
|
|
233
|
+
* Returns a list of available charts in the marketplace.
|
|
206
234
|
*
|
|
207
235
|
* This endpoint is available to all users in the organization.
|
|
208
236
|
*
|
|
209
237
|
*/
|
|
210
|
-
static
|
|
238
|
+
static listMarketplaceCharts<ThrowOnError extends boolean = false>(options?: Options<ListMarketplaceChartsData, ThrowOnError>): import("./client").RequestResult<ListMarketplaceChartsResponses, ListMarketplaceChartsErrors, ThrowOnError, "fields">;
|
|
211
239
|
/**
|
|
212
|
-
*
|
|
213
|
-
*
|
|
214
|
-
* This endpoint allows you to update cluster details, including quota and cluster status. For more information about clusters, see [Clusters](https://cloudfleet.ai/docs/cluster-management/cluster-types/) section of documentaiton.
|
|
240
|
+
* Get chart files for a specific version channel.
|
|
215
241
|
*
|
|
216
|
-
*
|
|
242
|
+
* Returns the Chart.yaml, values.yaml, and values.schema.json files for the latest version matching the specified version channel.
|
|
217
243
|
*
|
|
218
|
-
|
|
219
|
-
static updateCluster<ThrowOnError extends boolean = false>(options: Options<UpdateClusterData, ThrowOnError>): import("./client").RequestResult<UpdateClusterResponses, unknown, ThrowOnError, "fields">;
|
|
220
|
-
/**
|
|
221
|
-
* Node join information for the cluster
|
|
244
|
+
* 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.
|
|
222
245
|
*
|
|
223
|
-
*
|
|
246
|
+
* This endpoint is available to all users in the organization.
|
|
224
247
|
*
|
|
225
248
|
*/
|
|
226
|
-
static
|
|
249
|
+
static getMarketplaceChartFiles<ThrowOnError extends boolean = false>(options: Options<GetMarketplaceChartFilesData, ThrowOnError>): import("./client").RequestResult<GetMarketplaceChartFilesResponses, GetMarketplaceChartFilesErrors, ThrowOnError, "fields">;
|
|
227
250
|
}
|
|
228
251
|
export declare class InvitesService {
|
|
229
252
|
/**
|
|
230
253
|
* List invites.
|
|
231
254
|
*
|
|
232
|
-
* Returns a list of invites under the current organization. This endpoint is available to
|
|
255
|
+
* Returns a list of pending (non-expired) invites under the current organization. This endpoint is available to administrators of the organization only.
|
|
233
256
|
*
|
|
234
257
|
*/
|
|
235
258
|
static listInvites<ThrowOnError extends boolean = false>(options?: Options<ListInvitesData, ThrowOnError>): import("./client").RequestResult<ListInvitesResponses, ListInvitesErrors, ThrowOnError, "fields">;
|
|
@@ -243,7 +266,7 @@ export declare class InvitesService {
|
|
|
243
266
|
/**
|
|
244
267
|
* Get invite information.
|
|
245
268
|
*
|
|
246
|
-
*
|
|
269
|
+
* 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
270
|
*
|
|
248
271
|
*/
|
|
249
272
|
static getInvite<ThrowOnError extends boolean = false>(options: Options<GetInviteData, ThrowOnError>): import("./client").RequestResult<GetInviteResponses, unknown, ThrowOnError, "fields">;
|
|
@@ -255,212 +278,245 @@ export declare class InvitesService {
|
|
|
255
278
|
*/
|
|
256
279
|
static deleteInvite<ThrowOnError extends boolean = false>(options: Options<DeleteInviteData, ThrowOnError>): import("./client").RequestResult<DeleteInviteResponses, unknown, ThrowOnError, "fields">;
|
|
257
280
|
}
|
|
258
|
-
export declare class
|
|
281
|
+
export declare class ClustersService {
|
|
259
282
|
/**
|
|
260
|
-
*
|
|
283
|
+
* Query Kubernetes cluster API
|
|
261
284
|
*
|
|
262
|
-
*
|
|
285
|
+
* 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.
|
|
286
|
+
*/
|
|
287
|
+
static queryCluster<ThrowOnError extends boolean = false>(options: Options<QueryClusterData, ThrowOnError>): import("./client").RequestResult<QueryClusterResponses, QueryClusterErrors, ThrowOnError, "fields">;
|
|
288
|
+
/**
|
|
289
|
+
* List fleets.
|
|
290
|
+
*
|
|
291
|
+
* 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
292
|
*
|
|
264
293
|
* This endpoint is available to all users in the organization.
|
|
265
294
|
*
|
|
266
295
|
*/
|
|
267
|
-
static
|
|
296
|
+
static listFleets<ThrowOnError extends boolean = false>(options: Options<ListFleetsData, ThrowOnError>): import("./client").RequestResult<ListFleetsResponses, ListFleetsErrors, ThrowOnError, "fields">;
|
|
268
297
|
/**
|
|
269
|
-
*
|
|
298
|
+
* Create a new fleet.
|
|
270
299
|
*
|
|
271
|
-
*
|
|
300
|
+
* 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
301
|
*
|
|
273
|
-
*
|
|
302
|
+
* The cluster must be ready (status `deployed`) before a fleet can be added. Adding a fleet while the cluster is still provisioning returns `409`.
|
|
274
303
|
*
|
|
275
|
-
* This endpoint is available to
|
|
304
|
+
* This endpoint is available to administrators of the organization only.
|
|
276
305
|
*
|
|
277
306
|
*/
|
|
278
|
-
static
|
|
279
|
-
}
|
|
280
|
-
export declare class McpService {
|
|
307
|
+
static createFleet<ThrowOnError extends boolean = false>(options: Options<CreateFleetData, ThrowOnError>): import("./client").RequestResult<CreateFleetResponses, CreateFleetErrors, ThrowOnError, "fields">;
|
|
281
308
|
/**
|
|
282
|
-
*
|
|
309
|
+
* Permanently delete fleet.
|
|
310
|
+
*
|
|
311
|
+
* 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.
|
|
312
|
+
*
|
|
313
|
+
* 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.
|
|
314
|
+
*
|
|
315
|
+
* This endpoint is available to administrators of the organization only.
|
|
283
316
|
*
|
|
284
|
-
* MCP endpoint for handling Model Context Protocol JSON-RPC 2.0 messages.
|
|
285
317
|
*/
|
|
286
|
-
static
|
|
287
|
-
}
|
|
288
|
-
export declare class OrganizationService {
|
|
318
|
+
static deleteFleet<ThrowOnError extends boolean = false>(options: Options<DeleteFleetData, ThrowOnError>): import("./client").RequestResult<DeleteFleetResponses, DeleteFleetErrors, ThrowOnError, "fields">;
|
|
289
319
|
/**
|
|
290
|
-
* Get
|
|
320
|
+
* Get fleet information.
|
|
291
321
|
*
|
|
292
|
-
* Returns
|
|
322
|
+
* Returns fleet details. For more information, see [Fleets](https://cloudfleet.ai/docs/cloud-infrastructure/fleets/) section of documentaiton.
|
|
293
323
|
*
|
|
294
324
|
* This endpoint is available to all users in the organization.
|
|
295
325
|
*
|
|
296
326
|
*/
|
|
297
|
-
static
|
|
327
|
+
static getFleet<ThrowOnError extends boolean = false>(options: Options<GetFleetData, ThrowOnError>): import("./client").RequestResult<GetFleetResponses, unknown, ThrowOnError, "fields">;
|
|
298
328
|
/**
|
|
299
|
-
*
|
|
329
|
+
* Update fleet information.
|
|
300
330
|
*
|
|
301
|
-
* This endpoint allows you to
|
|
331
|
+
* This endpoint allows you to update fleet details.
|
|
302
332
|
*
|
|
303
|
-
|
|
304
|
-
static createOrganization<ThrowOnError extends boolean = false>(options: Options<CreateOrganizationData, ThrowOnError>): import("./client").RequestResult<CreateOrganizationResponses, unknown, ThrowOnError, "fields">;
|
|
305
|
-
}
|
|
306
|
-
export declare class RegistryService {
|
|
307
|
-
/**
|
|
308
|
-
* List repositories
|
|
333
|
+
* For more information, see [Fleets](https://cloudfleet.ai/docs/cloud-infrastructure/fleets/) section of documentaiton.
|
|
309
334
|
*
|
|
310
|
-
*
|
|
335
|
+
* 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).
|
|
336
|
+
*
|
|
337
|
+
* This endpoint is available to administrators of the organization only.
|
|
311
338
|
*
|
|
312
339
|
*/
|
|
313
|
-
static
|
|
340
|
+
static updateFleet<ThrowOnError extends boolean = false>(options: Options<UpdateFleetData, ThrowOnError>): import("./client").RequestResult<UpdateFleetResponses, UpdateFleetErrors, ThrowOnError, "fields">;
|
|
314
341
|
/**
|
|
315
|
-
* List
|
|
342
|
+
* List charts.
|
|
316
343
|
*
|
|
317
|
-
* Returns a list of
|
|
344
|
+
* Returns a list of charts in the cluster.
|
|
345
|
+
*
|
|
346
|
+
* This endpoint is available to all users in the organization.
|
|
318
347
|
*
|
|
319
348
|
*/
|
|
320
|
-
static
|
|
349
|
+
static listCharts<ThrowOnError extends boolean = false>(options: Options<ListChartsData, ThrowOnError>): import("./client").RequestResult<ListChartsResponses, ListChartsErrors, ThrowOnError, "fields">;
|
|
321
350
|
/**
|
|
322
|
-
*
|
|
351
|
+
* Create a new chart.
|
|
323
352
|
*
|
|
324
|
-
*
|
|
353
|
+
* Create a new chart deployment.
|
|
354
|
+
*
|
|
355
|
+
* This endpoint is available to administrators of the organization only.
|
|
325
356
|
*
|
|
326
357
|
*/
|
|
327
|
-
static
|
|
358
|
+
static createChart<ThrowOnError extends boolean = false>(options: Options<CreateChartData, ThrowOnError>): import("./client").RequestResult<CreateChartResponses, CreateChartErrors, ThrowOnError, "fields">;
|
|
328
359
|
/**
|
|
329
|
-
*
|
|
360
|
+
* Permanently delete the chart deployment from the cluster.
|
|
330
361
|
*
|
|
331
|
-
*
|
|
362
|
+
* This endpoint will permanently delete chart. This operation cannot be undone.
|
|
363
|
+
*
|
|
364
|
+
* This endpoint is available to administrators of the organization only.
|
|
332
365
|
*
|
|
333
366
|
*/
|
|
334
|
-
static
|
|
335
|
-
}
|
|
336
|
-
export declare class TicketsService {
|
|
367
|
+
static deleteChart<ThrowOnError extends boolean = false>(options: Options<DeleteChartData, ThrowOnError>): import("./client").RequestResult<DeleteChartResponses, DeleteChartErrors, ThrowOnError, "fields">;
|
|
337
368
|
/**
|
|
338
|
-
*
|
|
369
|
+
* Get chart information.
|
|
339
370
|
*
|
|
340
|
-
* Returns
|
|
371
|
+
* Returns the details of the chart deployment.
|
|
372
|
+
*
|
|
373
|
+
* This endpoint is available to all users in the organization.
|
|
341
374
|
*
|
|
342
375
|
*/
|
|
343
|
-
static
|
|
376
|
+
static getChart<ThrowOnError extends boolean = false>(options: Options<GetChartData, ThrowOnError>): import("./client").RequestResult<GetChartResponses, unknown, ThrowOnError, "fields">;
|
|
344
377
|
/**
|
|
345
|
-
*
|
|
378
|
+
* Update chart information.
|
|
346
379
|
*
|
|
347
|
-
*
|
|
380
|
+
* This endpoint allows you to update the values of a chart deployment.
|
|
381
|
+
*
|
|
382
|
+
* This endpoint is available to administrators of the organization only.
|
|
348
383
|
*
|
|
349
384
|
*/
|
|
350
|
-
static
|
|
385
|
+
static updateChart<ThrowOnError extends boolean = false>(options: Options<UpdateChartData, ThrowOnError>): import("./client").RequestResult<UpdateChartResponses, UpdateChartErrors, ThrowOnError, "fields">;
|
|
351
386
|
/**
|
|
352
|
-
*
|
|
387
|
+
* List clusters.
|
|
353
388
|
*
|
|
354
|
-
*
|
|
389
|
+
* Returns a list of clusters under the current organization.
|
|
390
|
+
*
|
|
391
|
+
* This endpoint is available to all users in the organization.
|
|
355
392
|
*
|
|
356
393
|
*/
|
|
357
|
-
static
|
|
358
|
-
/**
|
|
359
|
-
* Get a ticket and its messages.
|
|
360
|
-
*/
|
|
361
|
-
static getTicket<ThrowOnError extends boolean = false>(options: Options<GetTicketData, ThrowOnError>): import("./client").RequestResult<GetTicketResponses, unknown, ThrowOnError, "fields">;
|
|
394
|
+
static listClusters<ThrowOnError extends boolean = false>(options?: Options<ListClustersData, ThrowOnError>): import("./client").RequestResult<ListClustersResponses, ListClustersErrors, ThrowOnError, "fields">;
|
|
362
395
|
/**
|
|
363
|
-
*
|
|
396
|
+
* Create a new cluster.
|
|
364
397
|
*
|
|
365
|
-
*
|
|
398
|
+
* 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.
|
|
399
|
+
*
|
|
400
|
+
* This endpoint is available to administrators of the organization only.
|
|
366
401
|
*
|
|
367
402
|
*/
|
|
368
|
-
static
|
|
403
|
+
static createCluster<ThrowOnError extends boolean = false>(options: Options<CreateClusterData, ThrowOnError>): import("./client").RequestResult<CreateClusterResponses, CreateClusterErrors, ThrowOnError, "fields">;
|
|
369
404
|
/**
|
|
370
|
-
*
|
|
405
|
+
* Permanently delete cluster.
|
|
406
|
+
*
|
|
407
|
+
* This endpoint will permanently delete the cluster. This operation cannot be undone.
|
|
408
|
+
*
|
|
409
|
+
* 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.
|
|
410
|
+
*
|
|
411
|
+
* This endpoint is available to administrators of the organization only.
|
|
412
|
+
*
|
|
371
413
|
*/
|
|
372
|
-
static
|
|
373
|
-
}
|
|
374
|
-
export declare class TokensService {
|
|
414
|
+
static deleteCluster<ThrowOnError extends boolean = false>(options: Options<DeleteClusterData, ThrowOnError>): import("./client").RequestResult<DeleteClusterResponses, DeleteClusterErrors, ThrowOnError, "fields">;
|
|
375
415
|
/**
|
|
376
|
-
*
|
|
416
|
+
* Get cluster information.
|
|
377
417
|
*
|
|
378
|
-
*
|
|
418
|
+
* Returns cluster details.
|
|
419
|
+
*
|
|
420
|
+
* This endpoint is available to all users in the organization.
|
|
379
421
|
*
|
|
380
422
|
*/
|
|
381
|
-
static
|
|
423
|
+
static getCluster<ThrowOnError extends boolean = false>(options: Options<GetClusterData, ThrowOnError>): import("./client").RequestResult<GetClusterResponses, unknown, ThrowOnError, "fields">;
|
|
382
424
|
/**
|
|
383
|
-
*
|
|
425
|
+
* Update cluster information.
|
|
384
426
|
*
|
|
385
|
-
* This endpoint allows you to
|
|
427
|
+
* 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.
|
|
428
|
+
*
|
|
429
|
+
* This is a full overwrite: any field omitted from the request is reset to its default rather than left unchanged.
|
|
386
430
|
*
|
|
387
431
|
* This endpoint is available to administrators of the organization only.
|
|
388
432
|
*
|
|
389
433
|
*/
|
|
390
|
-
static
|
|
434
|
+
static updateCluster<ThrowOnError extends boolean = false>(options: Options<UpdateClusterData, ThrowOnError>): import("./client").RequestResult<UpdateClusterResponses, UpdateClusterErrors, ThrowOnError, "fields">;
|
|
391
435
|
/**
|
|
392
|
-
*
|
|
436
|
+
* Node join information for the cluster
|
|
393
437
|
*
|
|
394
|
-
*
|
|
438
|
+
* 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.
|
|
395
439
|
*
|
|
396
440
|
*/
|
|
397
|
-
static
|
|
441
|
+
static getJoinInformation<ThrowOnError extends boolean = false>(options: Options<GetJoinInformationData, ThrowOnError>): import("./client").RequestResult<GetJoinInformationResponses, GetJoinInformationErrors, ThrowOnError, "fields">;
|
|
442
|
+
}
|
|
443
|
+
export declare class BillingService {
|
|
398
444
|
/**
|
|
399
|
-
* Get
|
|
445
|
+
* Get billing usage information.
|
|
400
446
|
*
|
|
401
|
-
*
|
|
447
|
+
* 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.
|
|
402
448
|
*
|
|
403
449
|
*/
|
|
404
|
-
static
|
|
450
|
+
static getUsage<ThrowOnError extends boolean = false>(options?: Options<GetUsageData, ThrowOnError>): import("./client").RequestResult<GetUsageResponses, GetUsageErrors, ThrowOnError, "fields">;
|
|
405
451
|
/**
|
|
406
|
-
*
|
|
407
|
-
*
|
|
408
|
-
* 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.
|
|
452
|
+
* Get Stripe client secret.
|
|
409
453
|
*
|
|
410
|
-
* This endpoint is available to administrators of the organization only.
|
|
454
|
+
* 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.
|
|
411
455
|
*
|
|
412
456
|
*/
|
|
413
|
-
static
|
|
457
|
+
static getPaymentMethodSecret<ThrowOnError extends boolean = false>(options?: Options<GetPaymentMethodSecretData, ThrowOnError>): import("./client").RequestResult<GetPaymentMethodSecretResponses, unknown, ThrowOnError, "fields">;
|
|
414
458
|
/**
|
|
415
|
-
*
|
|
459
|
+
* List organization payment methods.
|
|
460
|
+
*
|
|
461
|
+
* 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.
|
|
416
462
|
*
|
|
417
|
-
* Generates a new access token secret. Old secret will not be valid anymore.
|
|
418
463
|
*/
|
|
419
|
-
static
|
|
420
|
-
}
|
|
421
|
-
export declare class UsersService {
|
|
464
|
+
static listPaymentMethods<ThrowOnError extends boolean = false>(options?: Options<ListPaymentMethodsData, ThrowOnError>): import("./client").RequestResult<ListPaymentMethodsResponses, ListPaymentMethodsErrors, ThrowOnError, "fields">;
|
|
422
465
|
/**
|
|
423
|
-
*
|
|
466
|
+
* Set the default payment method.
|
|
467
|
+
*
|
|
468
|
+
* Sets the given payment method as the default used for invoices and active subscriptions. Requires the Administrator role.
|
|
469
|
+
*
|
|
424
470
|
*/
|
|
425
|
-
static
|
|
471
|
+
static setDefaultPaymentMethod<ThrowOnError extends boolean = false>(options: Options<SetDefaultPaymentMethodData, ThrowOnError>): import("./client").RequestResult<SetDefaultPaymentMethodResponses, SetDefaultPaymentMethodErrors, ThrowOnError, "fields">;
|
|
426
472
|
/**
|
|
427
|
-
*
|
|
473
|
+
* Delete a payment method.
|
|
428
474
|
*
|
|
429
|
-
*
|
|
475
|
+
* 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.
|
|
430
476
|
*
|
|
431
|
-
|
|
477
|
+
*/
|
|
478
|
+
static deletePaymentMethod<ThrowOnError extends boolean = false>(options: Options<DeletePaymentMethodData, ThrowOnError>): import("./client").RequestResult<DeletePaymentMethodResponses, DeletePaymentMethodErrors, ThrowOnError, "fields">;
|
|
479
|
+
/**
|
|
480
|
+
* List issued invoices.
|
|
481
|
+
*
|
|
482
|
+
* 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.
|
|
432
483
|
*
|
|
433
484
|
*/
|
|
434
|
-
static
|
|
485
|
+
static listInvoices<ThrowOnError extends boolean = false>(options?: Options<ListInvoicesData, ThrowOnError>): import("./client").RequestResult<ListInvoicesResponses, ListInvoicesErrors, ThrowOnError, "fields">;
|
|
435
486
|
/**
|
|
436
|
-
*
|
|
487
|
+
* Pay the organization's open invoices.
|
|
437
488
|
*
|
|
438
|
-
*
|
|
489
|
+
* Charges all open invoices of the organization against its default payment method. This endpoint is available to administrators of the organization only.
|
|
439
490
|
*
|
|
440
491
|
*/
|
|
441
|
-
static
|
|
492
|
+
static payOpenInvoices<ThrowOnError extends boolean = false>(options?: Options<PayOpenInvoicesData, ThrowOnError>): import("./client").RequestResult<PayOpenInvoicesResponses, PayOpenInvoicesErrors, ThrowOnError, "fields">;
|
|
442
493
|
/**
|
|
443
|
-
*
|
|
494
|
+
* Get organization contact and billing address information.
|
|
444
495
|
*
|
|
445
|
-
*
|
|
496
|
+
* Returns the organization contact and billing address information. This endpoint is available to all users in the organization.
|
|
446
497
|
*
|
|
447
498
|
*/
|
|
448
|
-
static
|
|
499
|
+
static getContact<ThrowOnError extends boolean = false>(options?: Options<GetContactData, ThrowOnError>): import("./client").RequestResult<GetContactResponses, unknown, ThrowOnError, "fields">;
|
|
449
500
|
/**
|
|
450
|
-
*
|
|
501
|
+
* Update organization contact information and billing address.
|
|
451
502
|
*
|
|
452
|
-
*
|
|
503
|
+
* This endpoint allows you to update organization details with its contact information. This endpoint is available to administrators of the organization only.
|
|
453
504
|
*
|
|
454
|
-
|
|
505
|
+
*/
|
|
506
|
+
static updateContact<ThrowOnError extends boolean = false>(options: Options<UpdateContactData, ThrowOnError>): import("./client").RequestResult<UpdateContactResponses, unknown, ThrowOnError, "fields">;
|
|
507
|
+
/**
|
|
508
|
+
* Get applied promotional credits
|
|
509
|
+
*
|
|
510
|
+
* Returns applied promotional credits for the organization. For more information on billing and payments, see [Billing and pricing](https://cloudfleet.ai/docs/organization/billing/) section of documentaiton. This endpoint is available to all users in the organization.
|
|
455
511
|
*
|
|
456
512
|
*/
|
|
457
|
-
static
|
|
513
|
+
static getCredits<ThrowOnError extends boolean = false>(options?: Options<GetCreditsData, ThrowOnError>): import("./client").RequestResult<GetCreditsResponses, GetCreditsErrors, ThrowOnError, "fields">;
|
|
458
514
|
/**
|
|
459
|
-
*
|
|
515
|
+
* Redeem promotional credits code.
|
|
460
516
|
*
|
|
461
|
-
*
|
|
517
|
+
* Applies promotional credits for the organization. For more information on billing and payments, see [Billing and pricing](https://cloudfleet.ai/docs/organization/billing/) section of documentaiton. This endpoint is available to all users in the organization.
|
|
462
518
|
*
|
|
463
519
|
*/
|
|
464
|
-
static
|
|
520
|
+
static redeemCredits<ThrowOnError extends boolean = false>(options: Options<RedeemCreditsData, ThrowOnError>): import("./client").RequestResult<RedeemCreditsResponses, RedeemCreditsErrors, ThrowOnError, "fields">;
|
|
465
521
|
}
|
|
466
522
|
//# sourceMappingURL=sdk.gen.d.ts.map
|