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