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