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