@cloudfleet/sdk 0.12.3 → 1.0.1
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 +437 -387
- package/dist/@tanstack/react-query.gen.d.ts.map +1 -1
- package/dist/@tanstack/react-query.gen.js +458 -408
- package/dist/@tanstack/react-query.gen.js.map +1 -1
- package/dist/client/client.gen.d.ts.map +1 -1
- package/dist/client/client.gen.js +1 -4
- package/dist/client/client.gen.js.map +1 -1
- package/dist/client/types.gen.d.ts +1 -1
- package/dist/client/types.gen.d.ts.map +1 -1
- package/dist/client/utils.gen.d.ts +2 -2
- package/dist/client/utils.gen.d.ts.map +1 -1
- package/dist/client/utils.gen.js +3 -3
- package/dist/client/utils.gen.js.map +1 -1
- package/dist/core/params.gen.js +4 -4
- package/dist/core/params.gen.js.map +1 -1
- package/dist/schemas.gen.d.ts +360 -177
- package/dist/schemas.gen.d.ts.map +1 -1
- package/dist/schemas.gen.js +493 -229
- package/dist/schemas.gen.js.map +1 -1
- package/dist/sdk.gen.d.ts +244 -218
- package/dist/sdk.gen.d.ts.map +1 -1
- package/dist/sdk.gen.js +353 -316
- package/dist/sdk.gen.js.map +1 -1
- package/dist/types.gen.d.ts +991 -803
- package/dist/types.gen.d.ts.map +1 -1
- package/dist/zod.gen.d.ts +1560 -1316
- package/dist/zod.gen.d.ts.map +1 -1
- package/dist/zod.gen.js +465 -314
- package/dist/zod.gen.js.map +1 -1
- package/package.json +8 -11
package/dist/sdk.gen.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { type Client, type Options as Options2, type TDataShape } from './client';
|
|
2
|
-
import type { CloseTicketData, CloseTicketResponses, CreateChartData, CreateChartResponses, CreateClusterData, CreateClusterErrors, CreateClusterResponses, CreateFleetData, CreateFleetErrors, CreateFleetResponses, CreateInviteData, CreateInviteResponses, CreateOrganizationData, CreateOrganizationResponses, CreateTicketData, CreateTicketResponses, CreateTokenData, CreateTokenErrors, CreateTokenResponses, CreateUserData, CreateUserResponses, DeleteChartData, DeleteChartResponses, DeleteClusterData, DeleteClusterErrors, DeleteClusterResponses, DeleteFleetData, DeleteFleetResponses, DeleteInviteData, DeleteInviteResponses, DeletePaymentMethodData, DeletePaymentMethodErrors, DeletePaymentMethodResponses, DeleteTagData, DeleteTagErrors, DeleteTagResponses, DeleteTokenData, DeleteTokenResponses, DeleteUserData, DeleteUserErrors, DeleteUserResponses, GetChartData, GetChartResponses, GetClusterData, GetClusterResponses, GetContactData, GetContactResponses, GetCreditsData, GetCreditsErrors, GetCreditsResponses, GetFleetData, GetFleetResponses, GetInviteData, GetInviteResponses, GetJoinInformationData, GetJoinInformationErrors, GetJoinInformationResponses, GetMarketplaceChartFilesData, GetMarketplaceChartFilesErrors, GetMarketplaceChartFilesResponses, GetOrganizationData, GetOrganizationResponses, GetPaymentMethodSecretData, GetPaymentMethodSecretResponses, GetTagData, GetTagErrors, GetTagResponses, GetTicketAttachmentData, GetTicketAttachmentResponses, GetTicketData, GetTicketResponses, GetTokenData, GetTokenErrors, GetTokenResponses, GetUsageData, GetUsageErrors, GetUsageResponses, GetUserData, GetUserErrors, GetUserResponses, ListChartsData, ListChartsErrors, ListChartsResponses, ListClustersData, ListClustersErrors, ListClustersResponses, ListFleetsData, ListFleetsErrors, ListFleetsResponses, ListInvitesData, ListInvitesErrors, ListInvitesResponses, ListInvoicesData, ListInvoicesErrors, ListInvoicesResponses, ListMarketplaceChartsData, ListMarketplaceChartsErrors, ListMarketplaceChartsResponses, ListPaymentMethodsData, ListPaymentMethodsErrors, ListPaymentMethodsResponses, ListRepositoriesData, ListRepositoriesErrors, ListRepositoriesResponses, ListTagsData, ListTagsErrors, ListTagsResponses, ListTicketsData, ListTicketsResponses, ListTokensData, ListTokensErrors, ListTokensResponses, ListUserOrganizationsData, ListUserOrganizationsResponses, ListUsersData, ListUsersErrors, ListUsersResponses, PostMcpData, PostMcpErrors, PostMcpResponses, QueryClusterData, QueryClusterErrors, QueryClusterResponses, RedeemCreditsData, RedeemCreditsErrors, RedeemCreditsResponses, RegenerateTokenData, RegenerateTokenErrors, RegenerateTokenResponses, ReplyTicketData, ReplyTicketErrors, ReplyTicketResponses, SetDefaultPaymentMethodData, SetDefaultPaymentMethodErrors, SetDefaultPaymentMethodResponses, UpdateChartData, UpdateChartResponses, UpdateClusterData, UpdateClusterResponses, UpdateContactData, UpdateContactResponses, UpdateFleetData, UpdateFleetErrors, UpdateFleetResponses, UpdateTokenData, UpdateTokenErrors, UpdateTokenResponses, UpdateUserData, UpdateUserResponses } from './types.gen';
|
|
2
|
+
import type { CloseTicketData, CloseTicketResponses, CreateChartData, CreateChartErrors, CreateChartResponses, CreateClusterData, CreateClusterErrors, CreateClusterResponses, CreateFleetData, CreateFleetErrors, CreateFleetResponses, CreateInviteData, CreateInviteResponses, CreateOrganizationData, CreateOrganizationResponses, CreateTicketData, CreateTicketResponses, CreateTokenData, CreateTokenErrors, CreateTokenResponses, CreateUserData, CreateUserResponses, DeleteChartData, DeleteChartErrors, DeleteChartResponses, DeleteClusterData, DeleteClusterErrors, DeleteClusterResponses, DeleteFleetData, DeleteFleetErrors, DeleteFleetResponses, DeleteInviteData, DeleteInviteResponses, DeletePaymentMethodData, DeletePaymentMethodErrors, DeletePaymentMethodResponses, DeleteTagData, DeleteTagErrors, DeleteTagResponses, DeleteTokenData, DeleteTokenResponses, DeleteUserData, DeleteUserErrors, DeleteUserResponses, 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
3
|
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
|
|
4
4
|
/**
|
|
5
5
|
* You can provide a client instance returned by `createClient()` instead of
|
|
@@ -13,229 +13,229 @@ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends
|
|
|
13
13
|
*/
|
|
14
14
|
meta?: Record<string, unknown>;
|
|
15
15
|
};
|
|
16
|
-
export declare class
|
|
16
|
+
export declare class UsersService {
|
|
17
17
|
/**
|
|
18
|
-
* Get
|
|
19
|
-
*
|
|
20
|
-
* Returns aggregated usage information for the organization with facets for filtering. For more information on billing and payments, see [Billing and pricing](https://cloudfleet.ai/docs/organization/billing/) section of documentaiton. This endpoint is available to all users in the organization.
|
|
21
|
-
*
|
|
18
|
+
* Get a list of organizations the user belongs to. Used during authentication process.
|
|
22
19
|
*/
|
|
23
|
-
static
|
|
20
|
+
static listUserOrganizations<ThrowOnError extends boolean = false>(options: Options<ListUserOrganizationsData, ThrowOnError>): import("./client").RequestResult<ListUserOrganizationsResponses, unknown, ThrowOnError, "fields">;
|
|
24
21
|
/**
|
|
25
|
-
*
|
|
26
|
-
*
|
|
27
|
-
* Endpoint returns the Stripe secret key for the organization. This key is used to securely update the payment method in the Cloudfleet console only, please visit https://console.cloudfleet.ai. This endpoint is available to administrators of the organization only.
|
|
22
|
+
* List users in organization.
|
|
28
23
|
*
|
|
29
|
-
|
|
30
|
-
static getPaymentMethodSecret<ThrowOnError extends boolean = false>(options?: Options<GetPaymentMethodSecretData, ThrowOnError>): import("./client").RequestResult<GetPaymentMethodSecretResponses, unknown, ThrowOnError, "fields">;
|
|
31
|
-
/**
|
|
32
|
-
* List organization payment methods.
|
|
24
|
+
* Returns a list of user details and their roles. For more information on identity access management, see [Users](https://cloudfleet.ai/docs/organization/users/) section of documentaiton.
|
|
33
25
|
*
|
|
34
|
-
*
|
|
26
|
+
* This endpoint is available to all users in the organization.
|
|
35
27
|
*
|
|
36
28
|
*/
|
|
37
|
-
static
|
|
29
|
+
static listUsers<ThrowOnError extends boolean = false>(options?: Options<ListUsersData, ThrowOnError>): import("./client").RequestResult<ListUsersResponses, ListUsersErrors, ThrowOnError, "fields">;
|
|
38
30
|
/**
|
|
39
|
-
*
|
|
31
|
+
* Create a new user.
|
|
40
32
|
*
|
|
41
|
-
*
|
|
33
|
+
* Create a new user in your Cloudfleet organization. Requires a valid invite code generated by the `invites create` command. The invite code is a unique string that can be used only once to create a new user. The invite code is generated by the `POST /invites` endpoint.
|
|
42
34
|
*
|
|
43
35
|
*/
|
|
44
|
-
static
|
|
36
|
+
static createUser<ThrowOnError extends boolean = false>(options: Options<CreateUserData, ThrowOnError>): import("./client").RequestResult<CreateUserResponses, unknown, ThrowOnError, "fields">;
|
|
45
37
|
/**
|
|
46
|
-
* Delete
|
|
38
|
+
* Delete user by id.
|
|
47
39
|
*
|
|
48
|
-
*
|
|
40
|
+
* Sets user status to `inactive`. Inactive users cannot log in and manage organization resources. This endpoint is available to administrators of the organization only.
|
|
49
41
|
*
|
|
50
42
|
*/
|
|
51
|
-
static
|
|
43
|
+
static deleteUser<ThrowOnError extends boolean = false>(options: Options<DeleteUserData, ThrowOnError>): import("./client").RequestResult<DeleteUserResponses, DeleteUserErrors, ThrowOnError, "fields">;
|
|
52
44
|
/**
|
|
53
|
-
*
|
|
45
|
+
* Get user profile information by id.
|
|
54
46
|
*
|
|
55
|
-
* Returns
|
|
47
|
+
* Returns user details including their roles. For more information on identity access management, see [Users](https://cloudfleet.ai/docs/organization/users/) section of documentaiton.
|
|
48
|
+
*
|
|
49
|
+
* This endpoint is available to all users in the organization.
|
|
56
50
|
*
|
|
57
51
|
*/
|
|
58
|
-
static
|
|
52
|
+
static getUser<ThrowOnError extends boolean = false>(options: Options<GetUserData, ThrowOnError>): import("./client").RequestResult<GetUserResponses, GetUserErrors, ThrowOnError, "fields">;
|
|
59
53
|
/**
|
|
60
|
-
*
|
|
54
|
+
* Update user profile information.
|
|
61
55
|
*
|
|
62
|
-
*
|
|
56
|
+
* Update user profile information: email, first name, last name, role. This endpoint can be accessed by administrators and the user itself. Role and status can be changed by administrators only.
|
|
63
57
|
*
|
|
64
58
|
*/
|
|
65
|
-
static
|
|
59
|
+
static updateUser<ThrowOnError extends boolean = false>(options: Options<UpdateUserData, ThrowOnError>): import("./client").RequestResult<UpdateUserResponses, unknown, ThrowOnError, "fields">;
|
|
60
|
+
}
|
|
61
|
+
export declare class TokensService {
|
|
66
62
|
/**
|
|
67
|
-
*
|
|
63
|
+
* List access tokens in organization.
|
|
68
64
|
*
|
|
69
|
-
* This endpoint allows you to
|
|
65
|
+
* This endpoint allows you to get a list of all access tokens details in organization. For more information about identity access management and security, see [Service Accounts](https://cloudfleet.ai/docs/organization/api-tokens/) section of documentaiton. This endpoint is available to all users in the organization.
|
|
70
66
|
*
|
|
71
67
|
*/
|
|
72
|
-
static
|
|
68
|
+
static listTokens<ThrowOnError extends boolean = false>(options?: Options<ListTokensData, ThrowOnError>): import("./client").RequestResult<ListTokensResponses, ListTokensErrors, ThrowOnError, "fields">;
|
|
73
69
|
/**
|
|
74
|
-
*
|
|
70
|
+
* Create a new access token.
|
|
75
71
|
*
|
|
76
|
-
*
|
|
72
|
+
* This endpoint allows you to create a new access token. For more information about identity access management and security, see [Service Accounts](https://cloudfleet.ai/docs/organization/api-tokens/) section of documentaiton.
|
|
73
|
+
*
|
|
74
|
+
* This endpoint is available to administrators of the organization only.
|
|
77
75
|
*
|
|
78
76
|
*/
|
|
79
|
-
static
|
|
77
|
+
static createToken<ThrowOnError extends boolean = false>(options: Options<CreateTokenData, ThrowOnError>): import("./client").RequestResult<CreateTokenResponses, CreateTokenErrors, ThrowOnError, "fields">;
|
|
80
78
|
/**
|
|
81
|
-
*
|
|
79
|
+
* Permanently delete access token.
|
|
82
80
|
*
|
|
83
|
-
*
|
|
81
|
+
* This endpoint allows you to delete an access token. For more information about identity access management and security, see [Service Accounts](https://cloudfleet.ai/docs/organization/api-tokens/) section of documentaiton. This endpoint is available to administrators of the organization only.
|
|
84
82
|
*
|
|
85
83
|
*/
|
|
86
|
-
static
|
|
87
|
-
}
|
|
88
|
-
export declare class ClustersService {
|
|
84
|
+
static deleteToken<ThrowOnError extends boolean = false>(options: Options<DeleteTokenData, ThrowOnError>): import("./client").RequestResult<DeleteTokenResponses, unknown, ThrowOnError, "fields">;
|
|
89
85
|
/**
|
|
90
|
-
*
|
|
91
|
-
*
|
|
92
|
-
* Returns a list of charts in the cluster.
|
|
86
|
+
* Get access token information.
|
|
93
87
|
*
|
|
94
|
-
* This endpoint is available to all users in the organization.
|
|
88
|
+
* This endpoint allows you to get access token details. For more information about identity access management and security, see [Service Accounts](https://cloudfleet.ai/docs/organization/api-tokens/) section of documentaiton. This endpoint is available to all users in the organization.
|
|
95
89
|
*
|
|
96
90
|
*/
|
|
97
|
-
static
|
|
91
|
+
static getToken<ThrowOnError extends boolean = false>(options: Options<GetTokenData, ThrowOnError>): import("./client").RequestResult<GetTokenResponses, GetTokenErrors, ThrowOnError, "fields">;
|
|
98
92
|
/**
|
|
99
|
-
*
|
|
93
|
+
* Update access token information.
|
|
100
94
|
*
|
|
101
|
-
*
|
|
95
|
+
* This endpoint allows you to update access token details. For more information about identity access management and security, see [Service Accounts](https://cloudfleet.ai/docs/organization/api-tokens/) section of documentaiton.
|
|
102
96
|
*
|
|
103
97
|
* This endpoint is available to administrators of the organization only.
|
|
104
98
|
*
|
|
105
99
|
*/
|
|
106
|
-
static
|
|
100
|
+
static updateToken<ThrowOnError extends boolean = false>(options: Options<UpdateTokenData, ThrowOnError>): import("./client").RequestResult<UpdateTokenResponses, UpdateTokenErrors, ThrowOnError, "fields">;
|
|
107
101
|
/**
|
|
108
|
-
*
|
|
109
|
-
*
|
|
110
|
-
* This endpoint will permanently delete chart. This operation cannot be undone.
|
|
111
|
-
*
|
|
112
|
-
* This endpoint is available to administrators of the organization only.
|
|
102
|
+
* Regenerate access token secret key.
|
|
113
103
|
*
|
|
104
|
+
* Generates a new access token secret. Old secret will not be valid anymore.
|
|
114
105
|
*/
|
|
115
|
-
static
|
|
106
|
+
static regenerateToken<ThrowOnError extends boolean = false>(options: Options<RegenerateTokenData, ThrowOnError>): import("./client").RequestResult<RegenerateTokenResponses, RegenerateTokenErrors, ThrowOnError, "fields">;
|
|
107
|
+
}
|
|
108
|
+
export declare class TicketsService {
|
|
116
109
|
/**
|
|
117
|
-
*
|
|
118
|
-
*
|
|
119
|
-
* Returns the details of the chart deployment.
|
|
110
|
+
* List tickets for the current organization.
|
|
120
111
|
*
|
|
121
|
-
*
|
|
112
|
+
* Returns all tickets belonging to the caller's organization, newest first.
|
|
122
113
|
*
|
|
123
114
|
*/
|
|
124
|
-
static
|
|
115
|
+
static listTickets<ThrowOnError extends boolean = false>(options?: Options<ListTicketsData, ThrowOnError>): import("./client").RequestResult<ListTicketsResponses, unknown, ThrowOnError, "fields">;
|
|
125
116
|
/**
|
|
126
|
-
*
|
|
127
|
-
*
|
|
128
|
-
* This endpoint allows you to update the values of a chart deployment.
|
|
117
|
+
* Create a new support ticket.
|
|
129
118
|
*
|
|
130
|
-
*
|
|
119
|
+
* Creates a new support ticket with an initial customer message. The request is `multipart/form-data` with a JSON-encoded `payload` field carrying `category`, `body`, and optional `properties`, plus up to 3 `attachments` files (10 MB max each).
|
|
131
120
|
*
|
|
132
121
|
*/
|
|
133
|
-
static
|
|
122
|
+
static createTicket<ThrowOnError extends boolean = false>(options: Options<CreateTicketData, ThrowOnError>): import("./client").RequestResult<CreateTicketResponses, unknown, ThrowOnError, "fields">;
|
|
134
123
|
/**
|
|
135
|
-
*
|
|
136
|
-
*
|
|
137
|
-
* Returns a list of fleets belonging to the cluster. For more information, see [Fleets](https://cloudfleet.ai/docs/cloud-infrastructure/fleets/) section of documentaiton.
|
|
124
|
+
* Close a ticket (soft close).
|
|
138
125
|
*
|
|
139
|
-
*
|
|
126
|
+
* Marks the ticket as closed. Closed is a terminal state — users cannot reply to a closed ticket; a new ticket must be opened instead.
|
|
140
127
|
*
|
|
141
128
|
*/
|
|
142
|
-
static
|
|
129
|
+
static closeTicket<ThrowOnError extends boolean = false>(options: Options<CloseTicketData, ThrowOnError>): import("./client").RequestResult<CloseTicketResponses, unknown, ThrowOnError, "fields">;
|
|
143
130
|
/**
|
|
144
|
-
*
|
|
145
|
-
*
|
|
146
|
-
* Create a new fleet under the current organization. fleets allow you to to schedule workloads in cloud service provider accounts owned by you. For more information, see [Fleets](https://cloudfleet.ai/docs/cloud-infrastructure/fleets/) section of documentaiton.
|
|
147
|
-
*
|
|
148
|
-
* This endpoint is available to administrators of the organization only.
|
|
149
|
-
*
|
|
131
|
+
* Get a ticket and its messages.
|
|
150
132
|
*/
|
|
151
|
-
static
|
|
133
|
+
static getTicket<ThrowOnError extends boolean = false>(options: Options<GetTicketData, ThrowOnError>): import("./client").RequestResult<GetTicketResponses, unknown, ThrowOnError, "fields">;
|
|
152
134
|
/**
|
|
153
|
-
*
|
|
154
|
-
*
|
|
155
|
-
* This endpoint will permanently delete fleet. This operation cannot be undone. Your subscription will end by the end of the current billing period and you will not be able to receive credit for unused time. For more information, see [Fleets](https://cloudfleet.ai/docs/cloud-infrastructure/fleets/) section of documentaiton.
|
|
135
|
+
* Append a customer reply to a ticket.
|
|
156
136
|
*
|
|
157
|
-
*
|
|
137
|
+
* Multipart form-data with a JSON-encoded `payload` field carrying `body`, plus up to 3 `attachments` files. Returns 409 if the ticket is closed.
|
|
158
138
|
*
|
|
159
139
|
*/
|
|
160
|
-
static
|
|
140
|
+
static replyTicket<ThrowOnError extends boolean = false>(options: Options<ReplyTicketData, ThrowOnError>): import("./client").RequestResult<ReplyTicketResponses, ReplyTicketErrors, ThrowOnError, "fields">;
|
|
161
141
|
/**
|
|
162
|
-
*
|
|
163
|
-
|
|
164
|
-
|
|
142
|
+
* Download a ticket attachment.
|
|
143
|
+
*/
|
|
144
|
+
static getTicketAttachment<ThrowOnError extends boolean = false>(options: Options<GetTicketAttachmentData, ThrowOnError>): import("./client").RequestResult<GetTicketAttachmentResponses, unknown, ThrowOnError, "fields">;
|
|
145
|
+
}
|
|
146
|
+
export declare class RegistryService {
|
|
147
|
+
/**
|
|
148
|
+
* List repositories
|
|
165
149
|
*
|
|
166
|
-
* This endpoint is available to all users in the organization.
|
|
150
|
+
* Returns a list of repositories in the registry across all regions. This endpoint is available to all users in the organization.
|
|
167
151
|
*
|
|
168
152
|
*/
|
|
169
|
-
static
|
|
153
|
+
static listRepositories<ThrowOnError extends boolean = false>(options?: Options<ListRepositoriesData, ThrowOnError>): import("./client").RequestResult<ListRepositoriesResponses, ListRepositoriesErrors, ThrowOnError, "fields">;
|
|
170
154
|
/**
|
|
171
|
-
*
|
|
155
|
+
* List tags for a repository
|
|
172
156
|
*
|
|
173
|
-
* This endpoint
|
|
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.
|
|
174
158
|
*
|
|
175
|
-
|
|
159
|
+
*/
|
|
160
|
+
static listTags<ThrowOnError extends boolean = false>(options: Options<ListTagsData, ThrowOnError>): import("./client").RequestResult<ListTagsResponses, ListTagsErrors, ThrowOnError, "fields">;
|
|
161
|
+
/**
|
|
162
|
+
* Delete tag
|
|
176
163
|
*
|
|
177
|
-
* 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.
|
|
178
165
|
*
|
|
179
166
|
*/
|
|
180
|
-
static
|
|
167
|
+
static deleteTag<ThrowOnError extends boolean = false>(options: Options<DeleteTagData, ThrowOnError>): import("./client").RequestResult<DeleteTagResponses, DeleteTagErrors, ThrowOnError, "fields">;
|
|
181
168
|
/**
|
|
182
|
-
*
|
|
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.
|
|
183
172
|
*
|
|
184
|
-
* 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.
|
|
185
173
|
*/
|
|
186
|
-
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 {
|
|
187
177
|
/**
|
|
188
|
-
*
|
|
178
|
+
* Get organization information.
|
|
189
179
|
*
|
|
190
|
-
* Returns
|
|
180
|
+
* Returns organization details including quota. For more information about quotas, see [Quotas and limits](https://cloudfleet.ai/docs/organization/quotas/) section of documentaiton.
|
|
191
181
|
*
|
|
192
182
|
* This endpoint is available to all users in the organization.
|
|
193
183
|
*
|
|
194
184
|
*/
|
|
195
|
-
static
|
|
185
|
+
static getOrganization<ThrowOnError extends boolean = false>(options?: Options<GetOrganizationData, ThrowOnError>): import("./client").RequestResult<GetOrganizationResponses, unknown, ThrowOnError, "fields">;
|
|
196
186
|
/**
|
|
197
|
-
* Create a new
|
|
198
|
-
*
|
|
199
|
-
* 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.
|
|
200
188
|
*
|
|
201
|
-
* This endpoint
|
|
189
|
+
* This endpoint allows you to create a new Cloudfleet organization and an administrator user.
|
|
202
190
|
*
|
|
203
191
|
*/
|
|
204
|
-
static
|
|
192
|
+
static createOrganization<ThrowOnError extends boolean = false>(options: Options<CreateOrganizationData, ThrowOnError>): import("./client").RequestResult<CreateOrganizationResponses, unknown, ThrowOnError, "fields">;
|
|
205
193
|
/**
|
|
206
|
-
*
|
|
194
|
+
* Get the organization's consent status for the new Basic price.
|
|
207
195
|
*
|
|
208
|
-
*
|
|
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.
|
|
209
197
|
*
|
|
210
|
-
* This endpoint is available to
|
|
198
|
+
* This endpoint is available to all users in the organization and drives the consent dialog in the console.
|
|
211
199
|
*
|
|
212
200
|
*/
|
|
213
|
-
static
|
|
201
|
+
static getBasicPriceConsent<ThrowOnError extends boolean = false>(options?: Options<GetBasicPriceConsentData, ThrowOnError>): import("./client").RequestResult<GetBasicPriceConsentResponses, unknown, ThrowOnError, "fields">;
|
|
214
202
|
/**
|
|
215
|
-
*
|
|
203
|
+
* Record an administrator's decision on the new Basic price.
|
|
216
204
|
*
|
|
217
|
-
*
|
|
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.
|
|
218
206
|
*
|
|
219
|
-
|
|
207
|
+
*/
|
|
208
|
+
static setBasicPriceConsent<ThrowOnError extends boolean = false>(options: Options<SetBasicPriceConsentData, ThrowOnError>): import("./client").RequestResult<SetBasicPriceConsentResponses, SetBasicPriceConsentErrors, ThrowOnError, "fields">;
|
|
209
|
+
}
|
|
210
|
+
export declare class McpService {
|
|
211
|
+
/**
|
|
212
|
+
* MCP endpoint
|
|
220
213
|
*
|
|
214
|
+
* MCP endpoint for handling Model Context Protocol JSON-RPC 2.0 messages.
|
|
221
215
|
*/
|
|
222
|
-
static
|
|
216
|
+
static postMcp<ThrowOnError extends boolean = false>(options: Options<PostMcpData, ThrowOnError>): import("./client").RequestResult<PostMcpResponses, PostMcpErrors, ThrowOnError, "fields">;
|
|
217
|
+
}
|
|
218
|
+
export declare class ChartsMarketplaceService {
|
|
223
219
|
/**
|
|
224
|
-
*
|
|
220
|
+
* List chart listings available in the marketplace.
|
|
225
221
|
*
|
|
226
|
-
*
|
|
222
|
+
* Returns a list of available charts in the marketplace.
|
|
227
223
|
*
|
|
228
|
-
* This endpoint is available to
|
|
224
|
+
* This endpoint is available to all users in the organization.
|
|
229
225
|
*
|
|
230
226
|
*/
|
|
231
|
-
static
|
|
227
|
+
static listMarketplaceCharts<ThrowOnError extends boolean = false>(options?: Options<ListMarketplaceChartsData, ThrowOnError>): import("./client").RequestResult<ListMarketplaceChartsResponses, ListMarketplaceChartsErrors, ThrowOnError, "fields">;
|
|
232
228
|
/**
|
|
233
|
-
*
|
|
229
|
+
* Get chart files for a specific version channel.
|
|
234
230
|
*
|
|
235
|
-
* Returns the
|
|
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.
|
|
236
236
|
*
|
|
237
237
|
*/
|
|
238
|
-
static
|
|
238
|
+
static getMarketplaceChartFiles<ThrowOnError extends boolean = false>(options: Options<GetMarketplaceChartFilesData, ThrowOnError>): import("./client").RequestResult<GetMarketplaceChartFilesResponses, GetMarketplaceChartFilesErrors, ThrowOnError, "fields">;
|
|
239
239
|
}
|
|
240
240
|
export declare class InvitesService {
|
|
241
241
|
/**
|
|
@@ -267,212 +267,238 @@ export declare class InvitesService {
|
|
|
267
267
|
*/
|
|
268
268
|
static deleteInvite<ThrowOnError extends boolean = false>(options: Options<DeleteInviteData, ThrowOnError>): import("./client").RequestResult<DeleteInviteResponses, unknown, ThrowOnError, "fields">;
|
|
269
269
|
}
|
|
270
|
-
export declare class
|
|
270
|
+
export declare class ClustersService {
|
|
271
271
|
/**
|
|
272
|
-
*
|
|
272
|
+
* Query Kubernetes cluster API
|
|
273
273
|
*
|
|
274
|
-
*
|
|
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.
|
|
275
281
|
*
|
|
276
282
|
* This endpoint is available to all users in the organization.
|
|
277
283
|
*
|
|
278
284
|
*/
|
|
279
|
-
static
|
|
285
|
+
static listFleets<ThrowOnError extends boolean = false>(options: Options<ListFleetsData, ThrowOnError>): import("./client").RequestResult<ListFleetsResponses, ListFleetsErrors, ThrowOnError, "fields">;
|
|
280
286
|
/**
|
|
281
|
-
*
|
|
287
|
+
* Create a new fleet.
|
|
282
288
|
*
|
|
283
|
-
*
|
|
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.
|
|
284
290
|
*
|
|
285
|
-
*
|
|
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`.
|
|
286
292
|
*
|
|
287
|
-
* This endpoint is available to
|
|
293
|
+
* This endpoint is available to administrators of the organization only.
|
|
288
294
|
*
|
|
289
295
|
*/
|
|
290
|
-
static
|
|
291
|
-
}
|
|
292
|
-
export declare class McpService {
|
|
296
|
+
static createFleet<ThrowOnError extends boolean = false>(options: Options<CreateFleetData, ThrowOnError>): import("./client").RequestResult<CreateFleetResponses, CreateFleetErrors, ThrowOnError, "fields">;
|
|
293
297
|
/**
|
|
294
|
-
*
|
|
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.
|
|
295
305
|
*
|
|
296
|
-
* MCP endpoint for handling Model Context Protocol JSON-RPC 2.0 messages.
|
|
297
306
|
*/
|
|
298
|
-
static
|
|
299
|
-
}
|
|
300
|
-
export declare class OrganizationService {
|
|
307
|
+
static deleteFleet<ThrowOnError extends boolean = false>(options: Options<DeleteFleetData, ThrowOnError>): import("./client").RequestResult<DeleteFleetResponses, DeleteFleetErrors, ThrowOnError, "fields">;
|
|
301
308
|
/**
|
|
302
|
-
* Get
|
|
309
|
+
* Get fleet information.
|
|
303
310
|
*
|
|
304
|
-
* Returns
|
|
311
|
+
* Returns fleet details. For more information, see [Fleets](https://cloudfleet.ai/docs/cloud-infrastructure/fleets/) section of documentaiton.
|
|
305
312
|
*
|
|
306
313
|
* This endpoint is available to all users in the organization.
|
|
307
314
|
*
|
|
308
315
|
*/
|
|
309
|
-
static
|
|
316
|
+
static getFleet<ThrowOnError extends boolean = false>(options: Options<GetFleetData, ThrowOnError>): import("./client").RequestResult<GetFleetResponses, unknown, ThrowOnError, "fields">;
|
|
310
317
|
/**
|
|
311
|
-
*
|
|
318
|
+
* Update fleet information.
|
|
312
319
|
*
|
|
313
|
-
* This endpoint allows you to
|
|
320
|
+
* This endpoint allows you to update fleet details.
|
|
314
321
|
*
|
|
315
|
-
|
|
316
|
-
static createOrganization<ThrowOnError extends boolean = false>(options: Options<CreateOrganizationData, ThrowOnError>): import("./client").RequestResult<CreateOrganizationResponses, unknown, ThrowOnError, "fields">;
|
|
317
|
-
}
|
|
318
|
-
export declare class RegistryService {
|
|
319
|
-
/**
|
|
320
|
-
* List repositories
|
|
322
|
+
* For more information, see [Fleets](https://cloudfleet.ai/docs/cloud-infrastructure/fleets/) section of documentaiton.
|
|
321
323
|
*
|
|
322
|
-
*
|
|
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.
|
|
323
327
|
*
|
|
324
328
|
*/
|
|
325
|
-
static
|
|
329
|
+
static updateFleet<ThrowOnError extends boolean = false>(options: Options<UpdateFleetData, ThrowOnError>): import("./client").RequestResult<UpdateFleetResponses, UpdateFleetErrors, ThrowOnError, "fields">;
|
|
326
330
|
/**
|
|
327
|
-
* List
|
|
331
|
+
* List charts.
|
|
328
332
|
*
|
|
329
|
-
* Returns a list of
|
|
333
|
+
* Returns a list of charts in the cluster.
|
|
334
|
+
*
|
|
335
|
+
* This endpoint is available to all users in the organization.
|
|
330
336
|
*
|
|
331
337
|
*/
|
|
332
|
-
static
|
|
338
|
+
static listCharts<ThrowOnError extends boolean = false>(options: Options<ListChartsData, ThrowOnError>): import("./client").RequestResult<ListChartsResponses, ListChartsErrors, ThrowOnError, "fields">;
|
|
333
339
|
/**
|
|
334
|
-
*
|
|
340
|
+
* Create a new chart.
|
|
335
341
|
*
|
|
336
|
-
*
|
|
342
|
+
* Create a new chart deployment.
|
|
343
|
+
*
|
|
344
|
+
* This endpoint is available to administrators of the organization only.
|
|
337
345
|
*
|
|
338
346
|
*/
|
|
339
|
-
static
|
|
347
|
+
static createChart<ThrowOnError extends boolean = false>(options: Options<CreateChartData, ThrowOnError>): import("./client").RequestResult<CreateChartResponses, CreateChartErrors, ThrowOnError, "fields">;
|
|
340
348
|
/**
|
|
341
|
-
*
|
|
349
|
+
* Permanently delete the chart deployment from the cluster.
|
|
342
350
|
*
|
|
343
|
-
*
|
|
351
|
+
* This endpoint will permanently delete chart. This operation cannot be undone.
|
|
352
|
+
*
|
|
353
|
+
* This endpoint is available to administrators of the organization only.
|
|
344
354
|
*
|
|
345
355
|
*/
|
|
346
|
-
static
|
|
347
|
-
}
|
|
348
|
-
export declare class TicketsService {
|
|
356
|
+
static deleteChart<ThrowOnError extends boolean = false>(options: Options<DeleteChartData, ThrowOnError>): import("./client").RequestResult<DeleteChartResponses, DeleteChartErrors, ThrowOnError, "fields">;
|
|
349
357
|
/**
|
|
350
|
-
*
|
|
358
|
+
* Get chart information.
|
|
351
359
|
*
|
|
352
|
-
* Returns
|
|
360
|
+
* Returns the details of the chart deployment.
|
|
361
|
+
*
|
|
362
|
+
* This endpoint is available to all users in the organization.
|
|
353
363
|
*
|
|
354
364
|
*/
|
|
355
|
-
static
|
|
365
|
+
static getChart<ThrowOnError extends boolean = false>(options: Options<GetChartData, ThrowOnError>): import("./client").RequestResult<GetChartResponses, unknown, ThrowOnError, "fields">;
|
|
356
366
|
/**
|
|
357
|
-
*
|
|
367
|
+
* Update chart information.
|
|
358
368
|
*
|
|
359
|
-
*
|
|
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.
|
|
360
372
|
*
|
|
361
373
|
*/
|
|
362
|
-
static
|
|
374
|
+
static updateChart<ThrowOnError extends boolean = false>(options: Options<UpdateChartData, ThrowOnError>): import("./client").RequestResult<UpdateChartResponses, UpdateChartErrors, ThrowOnError, "fields">;
|
|
363
375
|
/**
|
|
364
|
-
*
|
|
376
|
+
* List clusters.
|
|
365
377
|
*
|
|
366
|
-
*
|
|
378
|
+
* Returns a list of clusters under the current organization.
|
|
379
|
+
*
|
|
380
|
+
* This endpoint is available to all users in the organization.
|
|
367
381
|
*
|
|
368
382
|
*/
|
|
369
|
-
static
|
|
370
|
-
/**
|
|
371
|
-
* Get a ticket and its messages.
|
|
372
|
-
*/
|
|
373
|
-
static getTicket<ThrowOnError extends boolean = false>(options: Options<GetTicketData, ThrowOnError>): import("./client").RequestResult<GetTicketResponses, unknown, ThrowOnError, "fields">;
|
|
383
|
+
static listClusters<ThrowOnError extends boolean = false>(options?: Options<ListClustersData, ThrowOnError>): import("./client").RequestResult<ListClustersResponses, ListClustersErrors, ThrowOnError, "fields">;
|
|
374
384
|
/**
|
|
375
|
-
*
|
|
385
|
+
* Create a new cluster.
|
|
376
386
|
*
|
|
377
|
-
*
|
|
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.
|
|
388
|
+
*
|
|
389
|
+
* This endpoint is available to administrators of the organization only.
|
|
378
390
|
*
|
|
379
391
|
*/
|
|
380
|
-
static
|
|
392
|
+
static createCluster<ThrowOnError extends boolean = false>(options: Options<CreateClusterData, ThrowOnError>): import("./client").RequestResult<CreateClusterResponses, CreateClusterErrors, ThrowOnError, "fields">;
|
|
381
393
|
/**
|
|
382
|
-
*
|
|
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.
|
|
401
|
+
*
|
|
383
402
|
*/
|
|
384
|
-
static
|
|
385
|
-
}
|
|
386
|
-
export declare class TokensService {
|
|
403
|
+
static deleteCluster<ThrowOnError extends boolean = false>(options: Options<DeleteClusterData, ThrowOnError>): import("./client").RequestResult<DeleteClusterResponses, DeleteClusterErrors, ThrowOnError, "fields">;
|
|
387
404
|
/**
|
|
388
|
-
*
|
|
405
|
+
* Get cluster information.
|
|
389
406
|
*
|
|
390
|
-
*
|
|
407
|
+
* Returns cluster details.
|
|
408
|
+
*
|
|
409
|
+
* This endpoint is available to all users in the organization.
|
|
391
410
|
*
|
|
392
411
|
*/
|
|
393
|
-
static
|
|
412
|
+
static getCluster<ThrowOnError extends boolean = false>(options: Options<GetClusterData, ThrowOnError>): import("./client").RequestResult<GetClusterResponses, unknown, ThrowOnError, "fields">;
|
|
394
413
|
/**
|
|
395
|
-
*
|
|
414
|
+
* Update cluster information.
|
|
396
415
|
*
|
|
397
|
-
* This endpoint allows you to
|
|
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.
|
|
398
419
|
*
|
|
399
420
|
* This endpoint is available to administrators of the organization only.
|
|
400
421
|
*
|
|
401
422
|
*/
|
|
402
|
-
static
|
|
423
|
+
static updateCluster<ThrowOnError extends boolean = false>(options: Options<UpdateClusterData, ThrowOnError>): import("./client").RequestResult<UpdateClusterResponses, UpdateClusterErrors, ThrowOnError, "fields">;
|
|
403
424
|
/**
|
|
404
|
-
*
|
|
425
|
+
* Node join information for the cluster
|
|
405
426
|
*
|
|
406
|
-
*
|
|
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.
|
|
407
428
|
*
|
|
408
429
|
*/
|
|
409
|
-
static
|
|
430
|
+
static getJoinInformation<ThrowOnError extends boolean = false>(options: Options<GetJoinInformationData, ThrowOnError>): import("./client").RequestResult<GetJoinInformationResponses, GetJoinInformationErrors, ThrowOnError, "fields">;
|
|
431
|
+
}
|
|
432
|
+
export declare class BillingService {
|
|
410
433
|
/**
|
|
411
|
-
* Get
|
|
434
|
+
* Get billing usage information.
|
|
412
435
|
*
|
|
413
|
-
*
|
|
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.
|
|
414
437
|
*
|
|
415
438
|
*/
|
|
416
|
-
static
|
|
439
|
+
static getUsage<ThrowOnError extends boolean = false>(options?: Options<GetUsageData, ThrowOnError>): import("./client").RequestResult<GetUsageResponses, GetUsageErrors, ThrowOnError, "fields">;
|
|
417
440
|
/**
|
|
418
|
-
*
|
|
419
|
-
*
|
|
420
|
-
* 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.
|
|
441
|
+
* Get Stripe client secret.
|
|
421
442
|
*
|
|
422
|
-
* This endpoint is available to administrators of the organization only.
|
|
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.
|
|
423
444
|
*
|
|
424
445
|
*/
|
|
425
|
-
static
|
|
446
|
+
static getPaymentMethodSecret<ThrowOnError extends boolean = false>(options?: Options<GetPaymentMethodSecretData, ThrowOnError>): import("./client").RequestResult<GetPaymentMethodSecretResponses, unknown, ThrowOnError, "fields">;
|
|
426
447
|
/**
|
|
427
|
-
*
|
|
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.
|
|
428
451
|
*
|
|
429
|
-
* Generates a new access token secret. Old secret will not be valid anymore.
|
|
430
452
|
*/
|
|
431
|
-
static
|
|
432
|
-
}
|
|
433
|
-
export declare class UsersService {
|
|
453
|
+
static listPaymentMethods<ThrowOnError extends boolean = false>(options?: Options<ListPaymentMethodsData, ThrowOnError>): import("./client").RequestResult<ListPaymentMethodsResponses, ListPaymentMethodsErrors, ThrowOnError, "fields">;
|
|
434
454
|
/**
|
|
435
|
-
*
|
|
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.
|
|
458
|
+
*
|
|
436
459
|
*/
|
|
437
|
-
static
|
|
460
|
+
static setDefaultPaymentMethod<ThrowOnError extends boolean = false>(options: Options<SetDefaultPaymentMethodData, ThrowOnError>): import("./client").RequestResult<SetDefaultPaymentMethodResponses, SetDefaultPaymentMethodErrors, ThrowOnError, "fields">;
|
|
438
461
|
/**
|
|
439
|
-
*
|
|
440
|
-
*
|
|
441
|
-
* 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.
|
|
462
|
+
* Delete a payment method.
|
|
442
463
|
*
|
|
443
|
-
*
|
|
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.
|
|
444
465
|
*
|
|
445
466
|
*/
|
|
446
|
-
static
|
|
467
|
+
static deletePaymentMethod<ThrowOnError extends boolean = false>(options: Options<DeletePaymentMethodData, ThrowOnError>): import("./client").RequestResult<DeletePaymentMethodResponses, DeletePaymentMethodErrors, ThrowOnError, "fields">;
|
|
447
468
|
/**
|
|
448
|
-
*
|
|
469
|
+
* List issued invoices.
|
|
449
470
|
*
|
|
450
|
-
*
|
|
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.
|
|
451
472
|
*
|
|
452
473
|
*/
|
|
453
|
-
static
|
|
474
|
+
static listInvoices<ThrowOnError extends boolean = false>(options?: Options<ListInvoicesData, ThrowOnError>): import("./client").RequestResult<ListInvoicesResponses, ListInvoicesErrors, ThrowOnError, "fields">;
|
|
454
475
|
/**
|
|
455
|
-
*
|
|
476
|
+
* Get organization contact and billing address information.
|
|
456
477
|
*
|
|
457
|
-
*
|
|
478
|
+
* Returns the organization contact and billing address information. This endpoint is available to all users in the organization.
|
|
458
479
|
*
|
|
459
480
|
*/
|
|
460
|
-
static
|
|
481
|
+
static getContact<ThrowOnError extends boolean = false>(options?: Options<GetContactData, ThrowOnError>): import("./client").RequestResult<GetContactResponses, unknown, ThrowOnError, "fields">;
|
|
461
482
|
/**
|
|
462
|
-
*
|
|
483
|
+
* Update organization contact information and billing address.
|
|
463
484
|
*
|
|
464
|
-
*
|
|
485
|
+
* This endpoint allows you to update organization details with its contact information. This endpoint is available to administrators of the organization only.
|
|
465
486
|
*
|
|
466
|
-
|
|
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.
|
|
467
493
|
*
|
|
468
494
|
*/
|
|
469
|
-
static
|
|
495
|
+
static getCredits<ThrowOnError extends boolean = false>(options?: Options<GetCreditsData, ThrowOnError>): import("./client").RequestResult<GetCreditsResponses, GetCreditsErrors, ThrowOnError, "fields">;
|
|
470
496
|
/**
|
|
471
|
-
*
|
|
497
|
+
* Redeem promotional credits code.
|
|
472
498
|
*
|
|
473
|
-
*
|
|
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.
|
|
474
500
|
*
|
|
475
501
|
*/
|
|
476
|
-
static
|
|
502
|
+
static redeemCredits<ThrowOnError extends boolean = false>(options: Options<RedeemCreditsData, ThrowOnError>): import("./client").RequestResult<RedeemCreditsResponses, RedeemCreditsErrors, ThrowOnError, "fields">;
|
|
477
503
|
}
|
|
478
504
|
//# sourceMappingURL=sdk.gen.d.ts.map
|