@cloudfleet/sdk 0.0.1-bd28e81 → 0.0.1-bd45f1a
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 +1149 -0
- package/dist/@tanstack/react-query.gen.d.ts.map +1 -0
- package/dist/@tanstack/react-query.gen.js +1165 -0
- package/dist/@tanstack/react-query.gen.js.map +1 -0
- package/dist/client/client.gen.d.ts +3 -0
- package/dist/client/client.gen.d.ts.map +1 -0
- package/dist/client/client.gen.js +217 -0
- package/dist/client/client.gen.js.map +1 -0
- package/dist/client/index.d.ts +9 -0
- package/dist/client/index.d.ts.map +1 -0
- package/dist/client/index.js +7 -0
- package/dist/client/index.js.map +1 -0
- package/dist/client/types.gen.d.ts +121 -0
- package/dist/client/types.gen.d.ts.map +1 -0
- package/dist/client/types.gen.js +3 -0
- package/dist/client/types.gen.js.map +1 -0
- package/dist/client/utils.gen.d.ts +38 -0
- package/dist/client/utils.gen.d.ts.map +1 -0
- package/dist/client/utils.gen.js +229 -0
- package/dist/client/utils.gen.js.map +1 -0
- package/dist/client.gen.d.ts +13 -0
- package/dist/client.gen.d.ts.map +1 -0
- package/dist/client.gen.js +4 -0
- package/dist/client.gen.js.map +1 -0
- package/dist/core/auth.gen.d.ts +19 -0
- package/dist/core/auth.gen.d.ts.map +1 -0
- package/dist/core/auth.gen.js +15 -0
- package/dist/core/auth.gen.js.map +1 -0
- package/dist/core/bodySerializer.gen.d.ts +26 -0
- package/dist/core/bodySerializer.gen.d.ts.map +1 -0
- package/dist/core/bodySerializer.gen.js +58 -0
- package/dist/core/bodySerializer.gen.js.map +1 -0
- package/dist/core/params.gen.d.ts +44 -0
- package/dist/core/params.gen.d.ts.map +1 -0
- package/dist/core/params.gen.js +101 -0
- package/dist/core/params.gen.js.map +1 -0
- package/dist/core/pathSerializer.gen.d.ts +34 -0
- package/dist/core/pathSerializer.gen.d.ts.map +1 -0
- package/dist/core/pathSerializer.gen.js +107 -0
- package/dist/core/pathSerializer.gen.js.map +1 -0
- package/dist/core/queryKeySerializer.gen.d.ts +19 -0
- package/dist/core/queryKeySerializer.gen.d.ts.map +1 -0
- package/dist/core/queryKeySerializer.gen.js +93 -0
- package/dist/core/queryKeySerializer.gen.js.map +1 -0
- package/dist/core/serverSentEvents.gen.d.ts +72 -0
- package/dist/core/serverSentEvents.gen.d.ts.map +1 -0
- package/dist/core/serverSentEvents.gen.js +133 -0
- package/dist/core/serverSentEvents.gen.js.map +1 -0
- package/dist/core/types.gen.d.ts +79 -0
- package/dist/core/types.gen.d.ts.map +1 -0
- package/dist/core/types.gen.js +3 -0
- package/dist/core/types.gen.js.map +1 -0
- package/dist/core/utils.gen.d.ts +20 -0
- package/dist/core/utils.gen.d.ts.map +1 -0
- package/dist/core/utils.gen.js +88 -0
- package/dist/core/utils.gen.js.map +1 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +3 -0
- package/dist/index.js.map +1 -1
- package/dist/schemas.gen.d.ts +1915 -1079
- package/dist/schemas.gen.d.ts.map +1 -1
- package/dist/schemas.gen.js +3241 -1127
- package/dist/schemas.gen.js.map +1 -1
- package/dist/sdk.gen.d.ts +326 -198
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/sdk.gen.js +432 -297
- package/dist/sdk.gen.js.map +1 -1
- package/dist/services/kubernetes/api.d.ts +196 -0
- package/dist/services/kubernetes/api.d.ts.map +1 -0
- package/dist/services/kubernetes/api.js +140 -0
- package/dist/services/kubernetes/api.js.map +1 -0
- package/dist/services/kubernetes/index.d.ts +44 -0
- package/dist/services/kubernetes/index.d.ts.map +1 -0
- package/dist/services/kubernetes/index.js +68 -0
- package/dist/services/kubernetes/index.js.map +1 -0
- package/dist/services/kubernetes/types.d.ts +1335 -0
- package/dist/services/kubernetes/types.d.ts.map +1 -0
- package/dist/services/kubernetes/types.js +2 -0
- package/dist/services/kubernetes/types.js.map +1 -0
- package/dist/types.gen.d.ts +1999 -1236
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/zod.gen.d.ts +3920 -2932
- package/dist/zod.gen.d.ts.map +1 -1
- package/dist/zod.gen.js +1693 -920
- package/dist/zod.gen.js.map +1 -1
- package/package.json +30 -7
package/dist/sdk.gen.d.ts
CHANGED
|
@@ -1,350 +1,478 @@
|
|
|
1
|
-
import { type Options } from '
|
|
2
|
-
import type {
|
|
3
|
-
export
|
|
4
|
-
export declare class BillingService {
|
|
1
|
+
import { type Client, type Options as Options2, type TDataShape } from './client';
|
|
2
|
+
import type { CloseTicketData, CloseTicketResponses, CreateChartData, CreateChartErrors, CreateChartResponses, CreateClusterData, CreateClusterErrors, CreateClusterResponses, CreateFleetData, CreateFleetErrors, CreateFleetResponses, CreateInviteData, CreateInviteResponses, CreateOrganizationData, CreateOrganizationResponses, CreateTicketData, CreateTicketResponses, CreateTokenData, CreateTokenErrors, CreateTokenResponses, CreateUserData, CreateUserResponses, DeleteChartData, DeleteChartErrors, DeleteChartResponses, DeleteClusterData, DeleteClusterErrors, DeleteClusterResponses, DeleteFleetData, DeleteFleetErrors, DeleteFleetResponses, DeleteInviteData, DeleteInviteResponses, DeletePaymentMethodData, DeletePaymentMethodErrors, DeletePaymentMethodResponses, DeleteTagData, DeleteTagErrors, DeleteTagResponses, DeleteTokenData, DeleteTokenResponses, DeleteUserData, DeleteUserErrors, DeleteUserResponses, GetChartData, GetChartResponses, GetClusterData, GetClusterResponses, GetContactData, GetContactResponses, GetCreditsData, GetCreditsErrors, GetCreditsResponses, GetFleetData, GetFleetResponses, GetInviteData, GetInviteResponses, GetJoinInformationData, GetJoinInformationErrors, GetJoinInformationResponses, GetMarketplaceChartFilesData, GetMarketplaceChartFilesErrors, GetMarketplaceChartFilesResponses, GetOrganizationData, GetOrganizationResponses, GetPaymentMethodSecretData, GetPaymentMethodSecretResponses, GetTagData, GetTagErrors, GetTagResponses, GetTicketAttachmentData, GetTicketAttachmentResponses, GetTicketData, GetTicketResponses, GetTokenData, GetTokenErrors, GetTokenResponses, GetUsageData, GetUsageErrors, GetUsageResponses, GetUserData, GetUserErrors, GetUserResponses, 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
|
+
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
|
|
5
4
|
/**
|
|
6
|
-
*
|
|
7
|
-
*
|
|
8
|
-
*
|
|
5
|
+
* You can provide a client instance returned by `createClient()` instead of
|
|
6
|
+
* individual options. This might be also useful if you want to implement a
|
|
7
|
+
* custom client.
|
|
8
|
+
*/
|
|
9
|
+
client?: Client;
|
|
10
|
+
/**
|
|
11
|
+
* You can pass arbitrary values through the `meta` object. This can be
|
|
12
|
+
* used to access values that aren't defined as part of the SDK function.
|
|
13
|
+
*/
|
|
14
|
+
meta?: Record<string, unknown>;
|
|
15
|
+
};
|
|
16
|
+
export declare class UsersService {
|
|
17
|
+
/**
|
|
18
|
+
* Get a list of organizations the user belongs to. Used during authentication process.
|
|
9
19
|
*/
|
|
10
|
-
static
|
|
20
|
+
static listUserOrganizations<ThrowOnError extends boolean = false>(options: Options<ListUserOrganizationsData, ThrowOnError>): import("./client").RequestResult<ListUserOrganizationsResponses, unknown, ThrowOnError, "fields">;
|
|
11
21
|
/**
|
|
12
|
-
*
|
|
13
|
-
*
|
|
22
|
+
* List users in organization.
|
|
23
|
+
*
|
|
24
|
+
* Returns a list of user details and their roles. For more information on identity access management, see [Users](https://cloudfleet.ai/docs/organization/users/) section of documentaiton.
|
|
25
|
+
*
|
|
26
|
+
* This endpoint is available to all users in the organization.
|
|
14
27
|
*
|
|
15
28
|
*/
|
|
16
|
-
static
|
|
29
|
+
static listUsers<ThrowOnError extends boolean = false>(options?: Options<ListUsersData, ThrowOnError>): import("./client").RequestResult<ListUsersResponses, ListUsersErrors, ThrowOnError, "fields">;
|
|
17
30
|
/**
|
|
18
|
-
*
|
|
19
|
-
*
|
|
31
|
+
* Create a new user.
|
|
32
|
+
*
|
|
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.
|
|
20
34
|
*
|
|
21
35
|
*/
|
|
22
|
-
static
|
|
36
|
+
static createUser<ThrowOnError extends boolean = false>(options: Options<CreateUserData, ThrowOnError>): import("./client").RequestResult<CreateUserResponses, unknown, ThrowOnError, "fields">;
|
|
23
37
|
/**
|
|
24
|
-
*
|
|
25
|
-
*
|
|
38
|
+
* Delete user by id.
|
|
39
|
+
*
|
|
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.
|
|
26
41
|
*
|
|
27
42
|
*/
|
|
28
|
-
static
|
|
29
|
-
id?: string;
|
|
30
|
-
}, unknown, ThrowOnError>;
|
|
43
|
+
static deleteUser<ThrowOnError extends boolean = false>(options: Options<DeleteUserData, ThrowOnError>): import("./client").RequestResult<DeleteUserResponses, DeleteUserErrors, ThrowOnError, "fields">;
|
|
31
44
|
/**
|
|
32
|
-
*
|
|
33
|
-
*
|
|
45
|
+
* Get user profile information by id.
|
|
46
|
+
*
|
|
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.
|
|
34
50
|
*
|
|
35
51
|
*/
|
|
36
|
-
static
|
|
52
|
+
static getUser<ThrowOnError extends boolean = false>(options: Options<GetUserData, ThrowOnError>): import("./client").RequestResult<GetUserResponses, GetUserErrors, ThrowOnError, "fields">;
|
|
37
53
|
/**
|
|
38
|
-
*
|
|
39
|
-
*
|
|
54
|
+
* Update user profile information.
|
|
55
|
+
*
|
|
56
|
+
* Update user profile information: email, first name, last name, role. This endpoint can be accessed by administrators and the user itself. Role and status can be changed by administrators only.
|
|
40
57
|
*
|
|
41
58
|
*/
|
|
42
|
-
static
|
|
43
|
-
html?: string;
|
|
44
|
-
}, unknown, ThrowOnError>;
|
|
59
|
+
static updateUser<ThrowOnError extends boolean = false>(options: Options<UpdateUserData, ThrowOnError>): import("./client").RequestResult<UpdateUserResponses, unknown, ThrowOnError, "fields">;
|
|
45
60
|
}
|
|
46
|
-
export declare class
|
|
61
|
+
export declare class TokensService {
|
|
47
62
|
/**
|
|
48
|
-
* List
|
|
49
|
-
* Returns a list of fleets belonging to the cluster. For more information, see [Fleets and fleet types](https://cloudfleet.ai/docs/cloud-infrastructure/fleets-and-fleet-types/) section of documentaiton.
|
|
63
|
+
* List access tokens in organization.
|
|
50
64
|
*
|
|
51
|
-
* 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.
|
|
52
66
|
*
|
|
53
67
|
*/
|
|
54
|
-
static
|
|
68
|
+
static listTokens<ThrowOnError extends boolean = false>(options?: Options<ListTokensData, ThrowOnError>): import("./client").RequestResult<ListTokensResponses, ListTokensErrors, ThrowOnError, "fields">;
|
|
55
69
|
/**
|
|
56
|
-
* Create a new
|
|
57
|
-
*
|
|
70
|
+
* Create a new access token.
|
|
71
|
+
*
|
|
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.
|
|
58
73
|
*
|
|
59
74
|
* This endpoint is available to administrators of the organization only.
|
|
60
75
|
*
|
|
61
76
|
*/
|
|
62
|
-
static
|
|
77
|
+
static createToken<ThrowOnError extends boolean = false>(options: Options<CreateTokenData, ThrowOnError>): import("./client").RequestResult<CreateTokenResponses, CreateTokenErrors, ThrowOnError, "fields">;
|
|
63
78
|
/**
|
|
64
|
-
* Permanently delete
|
|
65
|
-
*
|
|
79
|
+
* Permanently delete access token.
|
|
80
|
+
*
|
|
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.
|
|
82
|
+
*
|
|
83
|
+
*/
|
|
84
|
+
static deleteToken<ThrowOnError extends boolean = false>(options: Options<DeleteTokenData, ThrowOnError>): import("./client").RequestResult<DeleteTokenResponses, unknown, ThrowOnError, "fields">;
|
|
85
|
+
/**
|
|
86
|
+
* Get access token information.
|
|
87
|
+
*
|
|
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.
|
|
89
|
+
*
|
|
90
|
+
*/
|
|
91
|
+
static getToken<ThrowOnError extends boolean = false>(options: Options<GetTokenData, ThrowOnError>): import("./client").RequestResult<GetTokenResponses, GetTokenErrors, ThrowOnError, "fields">;
|
|
92
|
+
/**
|
|
93
|
+
* Update access token information.
|
|
94
|
+
*
|
|
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.
|
|
66
96
|
*
|
|
67
97
|
* This endpoint is available to administrators of the organization only.
|
|
68
98
|
*
|
|
69
99
|
*/
|
|
70
|
-
static
|
|
100
|
+
static updateToken<ThrowOnError extends boolean = false>(options: Options<UpdateTokenData, ThrowOnError>): import("./client").RequestResult<UpdateTokenResponses, UpdateTokenErrors, ThrowOnError, "fields">;
|
|
71
101
|
/**
|
|
72
|
-
*
|
|
73
|
-
* Returns fleet details. For more information, see [Fleets and fleet types](https://cloudfleet.ai/docs/cloud-infrastructure/fleets-and-fleet-types/) section of documentaiton.
|
|
102
|
+
* Regenerate access token secret key.
|
|
74
103
|
*
|
|
75
|
-
*
|
|
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.
|
|
111
|
+
*
|
|
112
|
+
* Returns all tickets belonging to the caller's organization, newest first.
|
|
76
113
|
*
|
|
77
114
|
*/
|
|
78
|
-
static
|
|
115
|
+
static listTickets<ThrowOnError extends boolean = false>(options?: Options<ListTicketsData, ThrowOnError>): import("./client").RequestResult<ListTicketsResponses, unknown, ThrowOnError, "fields">;
|
|
79
116
|
/**
|
|
80
|
-
*
|
|
81
|
-
* This endpoint allows you to update fleet details.
|
|
117
|
+
* Create a new support ticket.
|
|
82
118
|
*
|
|
83
|
-
*
|
|
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).
|
|
84
120
|
*
|
|
85
|
-
|
|
121
|
+
*/
|
|
122
|
+
static createTicket<ThrowOnError extends boolean = false>(options: Options<CreateTicketData, ThrowOnError>): import("./client").RequestResult<CreateTicketResponses, unknown, ThrowOnError, "fields">;
|
|
123
|
+
/**
|
|
124
|
+
* Close a ticket (soft close).
|
|
86
125
|
*
|
|
87
|
-
*
|
|
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.
|
|
88
127
|
*
|
|
89
128
|
*/
|
|
90
|
-
static
|
|
129
|
+
static closeTicket<ThrowOnError extends boolean = false>(options: Options<CloseTicketData, ThrowOnError>): import("./client").RequestResult<CloseTicketResponses, unknown, ThrowOnError, "fields">;
|
|
91
130
|
/**
|
|
92
|
-
*
|
|
93
|
-
* 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.
|
|
131
|
+
* Get a ticket and its messages.
|
|
94
132
|
*/
|
|
95
|
-
static
|
|
133
|
+
static getTicket<ThrowOnError extends boolean = false>(options: Options<GetTicketData, ThrowOnError>): import("./client").RequestResult<GetTicketResponses, unknown, ThrowOnError, "fields">;
|
|
96
134
|
/**
|
|
97
|
-
*
|
|
98
|
-
* 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.
|
|
135
|
+
* Append a customer reply to a ticket.
|
|
99
136
|
*
|
|
100
|
-
*
|
|
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.
|
|
101
138
|
*
|
|
102
139
|
*/
|
|
103
|
-
static
|
|
140
|
+
static replyTicket<ThrowOnError extends boolean = false>(options: Options<ReplyTicketData, ThrowOnError>): import("./client").RequestResult<ReplyTicketResponses, ReplyTicketErrors, ThrowOnError, "fields">;
|
|
104
141
|
/**
|
|
105
|
-
*
|
|
106
|
-
|
|
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
|
|
107
149
|
*
|
|
108
|
-
* This endpoint is available to
|
|
150
|
+
* Returns a list of repositories in the registry across all regions. This endpoint is available to all users in the organization.
|
|
109
151
|
*
|
|
110
152
|
*/
|
|
111
|
-
static
|
|
153
|
+
static listRepositories<ThrowOnError extends boolean = false>(options?: Options<ListRepositoriesData, ThrowOnError>): import("./client").RequestResult<ListRepositoriesResponses, ListRepositoriesErrors, ThrowOnError, "fields">;
|
|
112
154
|
/**
|
|
113
|
-
*
|
|
114
|
-
* This endpoint will permanently delete the cluster. This operation cannot be undone.
|
|
155
|
+
* List tags for a repository
|
|
115
156
|
*
|
|
116
|
-
* 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.
|
|
117
158
|
*
|
|
118
159
|
*/
|
|
119
|
-
static
|
|
160
|
+
static listTags<ThrowOnError extends boolean = false>(options: Options<ListTagsData, ThrowOnError>): import("./client").RequestResult<ListTagsResponses, ListTagsErrors, ThrowOnError, "fields">;
|
|
120
161
|
/**
|
|
121
|
-
*
|
|
122
|
-
*
|
|
162
|
+
* Delete tag
|
|
163
|
+
*
|
|
164
|
+
* Permanently deletes a specific tag from a repository. This endpoint is available to administrators of the organization only.
|
|
165
|
+
*
|
|
166
|
+
*/
|
|
167
|
+
static deleteTag<ThrowOnError extends boolean = false>(options: Options<DeleteTagData, ThrowOnError>): import("./client").RequestResult<DeleteTagResponses, DeleteTagErrors, ThrowOnError, "fields">;
|
|
168
|
+
/**
|
|
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.
|
|
172
|
+
*
|
|
173
|
+
*/
|
|
174
|
+
static getTag<ThrowOnError extends boolean = false>(options: Options<GetTagData, ThrowOnError>): import("./client").RequestResult<GetTagResponses, GetTagErrors, ThrowOnError, "fields">;
|
|
175
|
+
}
|
|
176
|
+
export declare class OrganizationService {
|
|
177
|
+
/**
|
|
178
|
+
* Get organization information.
|
|
179
|
+
*
|
|
180
|
+
* Returns organization details including quota. For more information about quotas, see [Quotas and limits](https://cloudfleet.ai/docs/organization/quotas/) section of documentaiton.
|
|
123
181
|
*
|
|
124
182
|
* This endpoint is available to all users in the organization.
|
|
125
183
|
*
|
|
126
184
|
*/
|
|
127
|
-
static
|
|
185
|
+
static getOrganization<ThrowOnError extends boolean = false>(options?: Options<GetOrganizationData, ThrowOnError>): import("./client").RequestResult<GetOrganizationResponses, unknown, ThrowOnError, "fields">;
|
|
128
186
|
/**
|
|
129
|
-
*
|
|
130
|
-
* 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.
|
|
187
|
+
* Create a new organization / Cloudfleet account signup.
|
|
131
188
|
*
|
|
132
|
-
* This endpoint
|
|
189
|
+
* This endpoint allows you to create a new Cloudfleet organization and an administrator user.
|
|
133
190
|
*
|
|
134
191
|
*/
|
|
135
|
-
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 {
|
|
136
195
|
/**
|
|
137
|
-
*
|
|
138
|
-
* Returns the join information for the cluster. This information is used to add a self-managed cluster to the CFKE cluster. This endpoint is available to only admins of the organization.
|
|
196
|
+
* MCP endpoint
|
|
139
197
|
*
|
|
198
|
+
* MCP endpoint for handling Model Context Protocol JSON-RPC 2.0 messages.
|
|
140
199
|
*/
|
|
141
|
-
static
|
|
200
|
+
static postMcp<ThrowOnError extends boolean = false>(options: Options<PostMcpData, ThrowOnError>): import("./client").RequestResult<PostMcpResponses, PostMcpErrors, ThrowOnError, "fields">;
|
|
142
201
|
}
|
|
143
|
-
export declare class
|
|
144
|
-
/**
|
|
145
|
-
*
|
|
146
|
-
*
|
|
147
|
-
*
|
|
148
|
-
*
|
|
149
|
-
*
|
|
150
|
-
*
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
*
|
|
155
|
-
*
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
*
|
|
160
|
-
* This endpoint
|
|
161
|
-
*
|
|
162
|
-
*/
|
|
163
|
-
static
|
|
164
|
-
provider?: Array<string>;
|
|
165
|
-
region?: Array<string>;
|
|
166
|
-
sub_region?: Array<string>;
|
|
167
|
-
csp_region?: Array<string>;
|
|
168
|
-
vcpu_min?: number;
|
|
169
|
-
vcpu_max?: number;
|
|
170
|
-
memory_min?: number;
|
|
171
|
-
memory_max?: number;
|
|
172
|
-
storage_local_min?: number;
|
|
173
|
-
storage_local_max?: number;
|
|
174
|
-
accelerator_name?: Array<string>;
|
|
175
|
-
accelerator_manufacturer?: Array<string>;
|
|
176
|
-
accelerator_count_min?: number;
|
|
177
|
-
accelerator_count_max?: number;
|
|
178
|
-
accelerator_memory_min?: number;
|
|
179
|
-
accelerator_memory_max?: number;
|
|
180
|
-
price_min?: number;
|
|
181
|
-
price_max?: number;
|
|
182
|
-
regions_struct?: Array<{
|
|
183
|
-
region?: string;
|
|
184
|
-
sub_region?: Array<string>;
|
|
185
|
-
}>;
|
|
186
|
-
accelerators_struct?: Array<{
|
|
187
|
-
accelerator_manufacturer?: string;
|
|
188
|
-
accelerator_name?: Array<string>;
|
|
189
|
-
}>;
|
|
190
|
-
count_total?: number;
|
|
191
|
-
count_accelerators?: number;
|
|
192
|
-
count_instance_types?: number;
|
|
193
|
-
count_accelerators_instance_types?: number;
|
|
194
|
-
}[], unknown, ThrowOnError>;
|
|
195
|
-
/**
|
|
196
|
-
* Available Cloudfleet regions and Kubernetes versions.
|
|
197
|
-
* Available Cloudfleet regions and Kubernetes versions.
|
|
198
|
-
*
|
|
199
|
-
*/
|
|
200
|
-
static getRegions<ThrowOnError extends boolean = false>(options?: Options<GetRegionsData, ThrowOnError>): import("@hey-api/client-fetch").RequestResult<{
|
|
201
|
-
[key: string]: unknown;
|
|
202
|
-
}, unknown, ThrowOnError>;
|
|
202
|
+
export declare class ChartsMarketplaceService {
|
|
203
|
+
/**
|
|
204
|
+
* List chart listings available in the marketplace.
|
|
205
|
+
*
|
|
206
|
+
* Returns a list of available charts in the marketplace.
|
|
207
|
+
*
|
|
208
|
+
* This endpoint is available to all users in the organization.
|
|
209
|
+
*
|
|
210
|
+
*/
|
|
211
|
+
static listMarketplaceCharts<ThrowOnError extends boolean = false>(options?: Options<ListMarketplaceChartsData, ThrowOnError>): import("./client").RequestResult<ListMarketplaceChartsResponses, ListMarketplaceChartsErrors, ThrowOnError, "fields">;
|
|
212
|
+
/**
|
|
213
|
+
* Get chart files for a specific version channel.
|
|
214
|
+
*
|
|
215
|
+
* Returns the Chart.yaml, values.yaml, and values.schema.json files for the latest version matching the specified version channel.
|
|
216
|
+
*
|
|
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.
|
|
218
|
+
*
|
|
219
|
+
* This endpoint is available to all users in the organization.
|
|
220
|
+
*
|
|
221
|
+
*/
|
|
222
|
+
static getMarketplaceChartFiles<ThrowOnError extends boolean = false>(options: Options<GetMarketplaceChartFilesData, ThrowOnError>): import("./client").RequestResult<GetMarketplaceChartFilesResponses, GetMarketplaceChartFilesErrors, ThrowOnError, "fields">;
|
|
203
223
|
}
|
|
204
224
|
export declare class InvitesService {
|
|
205
225
|
/**
|
|
206
226
|
* List invites.
|
|
207
|
-
*
|
|
227
|
+
*
|
|
228
|
+
* Returns a list of pending (non-expired) invites under the current organization. This endpoint is available to administrators of the organization only.
|
|
208
229
|
*
|
|
209
230
|
*/
|
|
210
|
-
static listInvites<ThrowOnError extends boolean = false>(options?: Options<ListInvitesData, ThrowOnError>): import("
|
|
231
|
+
static listInvites<ThrowOnError extends boolean = false>(options?: Options<ListInvitesData, ThrowOnError>): import("./client").RequestResult<ListInvitesResponses, ListInvitesErrors, ThrowOnError, "fields">;
|
|
211
232
|
/**
|
|
212
233
|
* Create a new invite.
|
|
213
|
-
*
|
|
234
|
+
*
|
|
235
|
+
* Invite a new user to your Cloudfleet organization. The user will receive an email with a link to create a new account. This endpoint is available to administrators of the organization only.
|
|
214
236
|
*
|
|
215
237
|
*/
|
|
216
|
-
static createInvite<ThrowOnError extends boolean = false>(options: Options<CreateInviteData, ThrowOnError>): import("
|
|
238
|
+
static createInvite<ThrowOnError extends boolean = false>(options: Options<CreateInviteData, ThrowOnError>): import("./client").RequestResult<CreateInviteResponses, unknown, ThrowOnError, "fields">;
|
|
217
239
|
/**
|
|
218
240
|
* Get invite information.
|
|
219
|
-
*
|
|
241
|
+
*
|
|
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.
|
|
220
243
|
*
|
|
221
244
|
*/
|
|
222
|
-
static getInvite<ThrowOnError extends boolean = false>(options: Options<GetInviteData, ThrowOnError>): import("
|
|
245
|
+
static getInvite<ThrowOnError extends boolean = false>(options: Options<GetInviteData, ThrowOnError>): import("./client").RequestResult<GetInviteResponses, unknown, ThrowOnError, "fields">;
|
|
223
246
|
/**
|
|
224
247
|
* Permanently delete invite.
|
|
248
|
+
*
|
|
225
249
|
* Permanently deletes invite from the organization. This endpoint is available to administrators of the organization only.
|
|
226
250
|
*
|
|
227
251
|
*/
|
|
228
|
-
static deleteInvite<ThrowOnError extends boolean = false>(options: Options<DeleteInviteData, ThrowOnError>): import("
|
|
252
|
+
static deleteInvite<ThrowOnError extends boolean = false>(options: Options<DeleteInviteData, ThrowOnError>): import("./client").RequestResult<DeleteInviteResponses, unknown, ThrowOnError, "fields">;
|
|
229
253
|
}
|
|
230
|
-
export declare class
|
|
254
|
+
export declare class ClustersService {
|
|
231
255
|
/**
|
|
232
|
-
*
|
|
233
|
-
*
|
|
256
|
+
* Query Kubernetes cluster API
|
|
257
|
+
*
|
|
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.
|
|
234
265
|
*
|
|
235
266
|
* This endpoint is available to all users in the organization.
|
|
236
267
|
*
|
|
237
268
|
*/
|
|
238
|
-
static
|
|
269
|
+
static listFleets<ThrowOnError extends boolean = false>(options: Options<ListFleetsData, ThrowOnError>): import("./client").RequestResult<ListFleetsResponses, ListFleetsErrors, ThrowOnError, "fields">;
|
|
239
270
|
/**
|
|
240
|
-
* Create a new
|
|
241
|
-
*
|
|
271
|
+
* Create a new fleet.
|
|
272
|
+
*
|
|
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.
|
|
274
|
+
*
|
|
275
|
+
* This endpoint is available to administrators of the organization only.
|
|
242
276
|
*
|
|
243
277
|
*/
|
|
244
|
-
static
|
|
278
|
+
static createFleet<ThrowOnError extends boolean = false>(options: Options<CreateFleetData, ThrowOnError>): import("./client").RequestResult<CreateFleetResponses, CreateFleetErrors, ThrowOnError, "fields">;
|
|
245
279
|
/**
|
|
246
|
-
*
|
|
247
|
-
*
|
|
280
|
+
* Permanently delete fleet.
|
|
281
|
+
*
|
|
282
|
+
* 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.
|
|
248
283
|
*
|
|
249
284
|
* This endpoint is available to administrators of the organization only.
|
|
250
285
|
*
|
|
251
286
|
*/
|
|
252
|
-
static
|
|
253
|
-
}
|
|
254
|
-
export declare class TokensService {
|
|
287
|
+
static deleteFleet<ThrowOnError extends boolean = false>(options: Options<DeleteFleetData, ThrowOnError>): import("./client").RequestResult<DeleteFleetResponses, DeleteFleetErrors, ThrowOnError, "fields">;
|
|
255
288
|
/**
|
|
256
|
-
*
|
|
257
|
-
*
|
|
289
|
+
* Get fleet information.
|
|
290
|
+
*
|
|
291
|
+
* Returns fleet details. For more information, see [Fleets](https://cloudfleet.ai/docs/cloud-infrastructure/fleets/) section of documentaiton.
|
|
292
|
+
*
|
|
293
|
+
* This endpoint is available to all users in the organization.
|
|
258
294
|
*
|
|
259
295
|
*/
|
|
260
|
-
static
|
|
296
|
+
static getFleet<ThrowOnError extends boolean = false>(options: Options<GetFleetData, ThrowOnError>): import("./client").RequestResult<GetFleetResponses, unknown, ThrowOnError, "fields">;
|
|
261
297
|
/**
|
|
262
|
-
*
|
|
263
|
-
*
|
|
298
|
+
* Update fleet information.
|
|
299
|
+
*
|
|
300
|
+
* This endpoint allows you to update fleet details.
|
|
301
|
+
*
|
|
302
|
+
* For more information, see [Fleets](https://cloudfleet.ai/docs/cloud-infrastructure/fleets/) section of documentaiton.
|
|
264
303
|
*
|
|
265
304
|
* This endpoint is available to administrators of the organization only.
|
|
266
305
|
*
|
|
267
306
|
*/
|
|
268
|
-
static
|
|
307
|
+
static updateFleet<ThrowOnError extends boolean = false>(options: Options<UpdateFleetData, ThrowOnError>): import("./client").RequestResult<UpdateFleetResponses, UpdateFleetErrors, ThrowOnError, "fields">;
|
|
269
308
|
/**
|
|
270
|
-
*
|
|
271
|
-
*
|
|
309
|
+
* List charts.
|
|
310
|
+
*
|
|
311
|
+
* Returns a list of charts in the cluster.
|
|
312
|
+
*
|
|
313
|
+
* This endpoint is available to all users in the organization.
|
|
272
314
|
*
|
|
273
315
|
*/
|
|
274
|
-
static
|
|
316
|
+
static listCharts<ThrowOnError extends boolean = false>(options: Options<ListChartsData, ThrowOnError>): import("./client").RequestResult<ListChartsResponses, ListChartsErrors, ThrowOnError, "fields">;
|
|
275
317
|
/**
|
|
276
|
-
*
|
|
277
|
-
*
|
|
318
|
+
* Create a new chart.
|
|
319
|
+
*
|
|
320
|
+
* Create a new chart deployment.
|
|
321
|
+
*
|
|
322
|
+
* This endpoint is available to administrators of the organization only.
|
|
278
323
|
*
|
|
279
324
|
*/
|
|
280
|
-
static
|
|
325
|
+
static createChart<ThrowOnError extends boolean = false>(options: Options<CreateChartData, ThrowOnError>): import("./client").RequestResult<CreateChartResponses, CreateChartErrors, ThrowOnError, "fields">;
|
|
281
326
|
/**
|
|
282
|
-
*
|
|
283
|
-
*
|
|
327
|
+
* Permanently delete the chart deployment from the cluster.
|
|
328
|
+
*
|
|
329
|
+
* This endpoint will permanently delete chart. This operation cannot be undone.
|
|
284
330
|
*
|
|
285
331
|
* This endpoint is available to administrators of the organization only.
|
|
286
332
|
*
|
|
287
333
|
*/
|
|
288
|
-
static
|
|
334
|
+
static deleteChart<ThrowOnError extends boolean = false>(options: Options<DeleteChartData, ThrowOnError>): import("./client").RequestResult<DeleteChartResponses, DeleteChartErrors, ThrowOnError, "fields">;
|
|
289
335
|
/**
|
|
290
|
-
*
|
|
291
|
-
*
|
|
336
|
+
* Get chart information.
|
|
337
|
+
*
|
|
338
|
+
* Returns the details of the chart deployment.
|
|
339
|
+
*
|
|
340
|
+
* This endpoint is available to all users in the organization.
|
|
341
|
+
*
|
|
292
342
|
*/
|
|
293
|
-
static
|
|
294
|
-
}
|
|
295
|
-
export declare class UsersService {
|
|
343
|
+
static getChart<ThrowOnError extends boolean = false>(options: Options<GetChartData, ThrowOnError>): import("./client").RequestResult<GetChartResponses, unknown, ThrowOnError, "fields">;
|
|
296
344
|
/**
|
|
297
|
-
*
|
|
345
|
+
* Update chart information.
|
|
346
|
+
*
|
|
347
|
+
* This endpoint allows you to update the values of a chart deployment.
|
|
348
|
+
*
|
|
349
|
+
* This endpoint is available to administrators of the organization only.
|
|
350
|
+
*
|
|
298
351
|
*/
|
|
299
|
-
static
|
|
300
|
-
realm?: string;
|
|
301
|
-
displayName?: string;
|
|
302
|
-
}[], unknown, ThrowOnError>;
|
|
352
|
+
static updateChart<ThrowOnError extends boolean = false>(options: Options<UpdateChartData, ThrowOnError>): import("./client").RequestResult<UpdateChartResponses, UpdateChartErrors, ThrowOnError, "fields">;
|
|
303
353
|
/**
|
|
304
|
-
* List
|
|
305
|
-
*
|
|
354
|
+
* List clusters.
|
|
355
|
+
*
|
|
356
|
+
* Returns a list of clusters under the current organization.
|
|
306
357
|
*
|
|
307
358
|
* This endpoint is available to all users in the organization.
|
|
308
359
|
*
|
|
309
360
|
*/
|
|
310
|
-
static
|
|
361
|
+
static listClusters<ThrowOnError extends boolean = false>(options?: Options<ListClustersData, ThrowOnError>): import("./client").RequestResult<ListClustersResponses, ListClustersErrors, ThrowOnError, "fields">;
|
|
311
362
|
/**
|
|
312
|
-
* Create a new
|
|
313
|
-
*
|
|
363
|
+
* Create a new cluster.
|
|
364
|
+
*
|
|
365
|
+
* 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.
|
|
366
|
+
*
|
|
367
|
+
* This endpoint is available to administrators of the organization only.
|
|
314
368
|
*
|
|
315
369
|
*/
|
|
316
|
-
static
|
|
370
|
+
static createCluster<ThrowOnError extends boolean = false>(options: Options<CreateClusterData, ThrowOnError>): import("./client").RequestResult<CreateClusterResponses, CreateClusterErrors, ThrowOnError, "fields">;
|
|
317
371
|
/**
|
|
318
|
-
*
|
|
319
|
-
*
|
|
372
|
+
* Permanently delete cluster.
|
|
373
|
+
*
|
|
374
|
+
* This endpoint will permanently delete the cluster. This operation cannot be undone.
|
|
375
|
+
*
|
|
376
|
+
* This endpoint is available to administrators of the organization only.
|
|
320
377
|
*
|
|
321
378
|
*/
|
|
322
|
-
static
|
|
379
|
+
static deleteCluster<ThrowOnError extends boolean = false>(options: Options<DeleteClusterData, ThrowOnError>): import("./client").RequestResult<DeleteClusterResponses, DeleteClusterErrors, ThrowOnError, "fields">;
|
|
323
380
|
/**
|
|
324
|
-
* Get
|
|
325
|
-
*
|
|
381
|
+
* Get cluster information.
|
|
382
|
+
*
|
|
383
|
+
* Returns cluster details.
|
|
326
384
|
*
|
|
327
385
|
* This endpoint is available to all users in the organization.
|
|
328
386
|
*
|
|
329
387
|
*/
|
|
330
|
-
static
|
|
388
|
+
static getCluster<ThrowOnError extends boolean = false>(options: Options<GetClusterData, ThrowOnError>): import("./client").RequestResult<GetClusterResponses, unknown, ThrowOnError, "fields">;
|
|
331
389
|
/**
|
|
332
|
-
* Update
|
|
333
|
-
*
|
|
390
|
+
* Update cluster information.
|
|
391
|
+
*
|
|
392
|
+
* 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.
|
|
393
|
+
*
|
|
394
|
+
* This endpoint is available to administrators of the organization only.
|
|
334
395
|
*
|
|
335
396
|
*/
|
|
336
|
-
static
|
|
397
|
+
static updateCluster<ThrowOnError extends boolean = false>(options: Options<UpdateClusterData, ThrowOnError>): import("./client").RequestResult<UpdateClusterResponses, UpdateClusterErrors, ThrowOnError, "fields">;
|
|
337
398
|
/**
|
|
338
|
-
*
|
|
339
|
-
*
|
|
399
|
+
* Node join information for the cluster
|
|
400
|
+
*
|
|
401
|
+
* 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.
|
|
402
|
+
*
|
|
403
|
+
*/
|
|
404
|
+
static getJoinInformation<ThrowOnError extends boolean = false>(options: Options<GetJoinInformationData, ThrowOnError>): import("./client").RequestResult<GetJoinInformationResponses, GetJoinInformationErrors, ThrowOnError, "fields">;
|
|
405
|
+
}
|
|
406
|
+
export declare class BillingService {
|
|
407
|
+
/**
|
|
408
|
+
* Get billing usage information.
|
|
409
|
+
*
|
|
410
|
+
* 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.
|
|
340
411
|
*
|
|
341
412
|
*/
|
|
342
|
-
static
|
|
413
|
+
static getUsage<ThrowOnError extends boolean = false>(options?: Options<GetUsageData, ThrowOnError>): import("./client").RequestResult<GetUsageResponses, GetUsageErrors, ThrowOnError, "fields">;
|
|
343
414
|
/**
|
|
344
|
-
*
|
|
345
|
-
*
|
|
415
|
+
* Get Stripe client secret.
|
|
416
|
+
*
|
|
417
|
+
* 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.
|
|
418
|
+
*
|
|
419
|
+
*/
|
|
420
|
+
static getPaymentMethodSecret<ThrowOnError extends boolean = false>(options?: Options<GetPaymentMethodSecretData, ThrowOnError>): import("./client").RequestResult<GetPaymentMethodSecretResponses, unknown, ThrowOnError, "fields">;
|
|
421
|
+
/**
|
|
422
|
+
* List organization payment methods.
|
|
423
|
+
*
|
|
424
|
+
* 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.
|
|
425
|
+
*
|
|
426
|
+
*/
|
|
427
|
+
static listPaymentMethods<ThrowOnError extends boolean = false>(options?: Options<ListPaymentMethodsData, ThrowOnError>): import("./client").RequestResult<ListPaymentMethodsResponses, ListPaymentMethodsErrors, ThrowOnError, "fields">;
|
|
428
|
+
/**
|
|
429
|
+
* Set the default payment method.
|
|
430
|
+
*
|
|
431
|
+
* Sets the given payment method as the default used for invoices and active subscriptions. Requires the Administrator role.
|
|
432
|
+
*
|
|
433
|
+
*/
|
|
434
|
+
static setDefaultPaymentMethod<ThrowOnError extends boolean = false>(options: Options<SetDefaultPaymentMethodData, ThrowOnError>): import("./client").RequestResult<SetDefaultPaymentMethodResponses, SetDefaultPaymentMethodErrors, ThrowOnError, "fields">;
|
|
435
|
+
/**
|
|
436
|
+
* Delete a payment method.
|
|
437
|
+
*
|
|
438
|
+
* 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.
|
|
439
|
+
*
|
|
440
|
+
*/
|
|
441
|
+
static deletePaymentMethod<ThrowOnError extends boolean = false>(options: Options<DeletePaymentMethodData, ThrowOnError>): import("./client").RequestResult<DeletePaymentMethodResponses, DeletePaymentMethodErrors, ThrowOnError, "fields">;
|
|
442
|
+
/**
|
|
443
|
+
* List issued invoices.
|
|
444
|
+
*
|
|
445
|
+
* 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.
|
|
446
|
+
*
|
|
447
|
+
*/
|
|
448
|
+
static listInvoices<ThrowOnError extends boolean = false>(options?: Options<ListInvoicesData, ThrowOnError>): import("./client").RequestResult<ListInvoicesResponses, ListInvoicesErrors, ThrowOnError, "fields">;
|
|
449
|
+
/**
|
|
450
|
+
* Get organization contact and billing address information.
|
|
451
|
+
*
|
|
452
|
+
* Returns the organization contact and billing address information. This endpoint is available to all users in the organization.
|
|
453
|
+
*
|
|
454
|
+
*/
|
|
455
|
+
static getContact<ThrowOnError extends boolean = false>(options?: Options<GetContactData, ThrowOnError>): import("./client").RequestResult<GetContactResponses, unknown, ThrowOnError, "fields">;
|
|
456
|
+
/**
|
|
457
|
+
* Update organization contact information and billing address.
|
|
458
|
+
*
|
|
459
|
+
* This endpoint allows you to update organization details with its contact information. This endpoint is available to administrators of the organization only.
|
|
460
|
+
*
|
|
461
|
+
*/
|
|
462
|
+
static updateContact<ThrowOnError extends boolean = false>(options: Options<UpdateContactData, ThrowOnError>): import("./client").RequestResult<UpdateContactResponses, unknown, ThrowOnError, "fields">;
|
|
463
|
+
/**
|
|
464
|
+
* Get applied promotional credits
|
|
465
|
+
*
|
|
466
|
+
* 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.
|
|
467
|
+
*
|
|
468
|
+
*/
|
|
469
|
+
static getCredits<ThrowOnError extends boolean = false>(options?: Options<GetCreditsData, ThrowOnError>): import("./client").RequestResult<GetCreditsResponses, GetCreditsErrors, ThrowOnError, "fields">;
|
|
470
|
+
/**
|
|
471
|
+
* Redeem promotional credits code.
|
|
472
|
+
*
|
|
473
|
+
* 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.
|
|
346
474
|
*
|
|
347
475
|
*/
|
|
348
|
-
static
|
|
476
|
+
static redeemCredits<ThrowOnError extends boolean = false>(options: Options<RedeemCreditsData, ThrowOnError>): import("./client").RequestResult<RedeemCreditsResponses, RedeemCreditsErrors, ThrowOnError, "fields">;
|
|
349
477
|
}
|
|
350
478
|
//# sourceMappingURL=sdk.gen.d.ts.map
|