@scaleway/sdk 2.45.0 → 2.46.0
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/dist/api/account/index.gen.d.ts +6 -0
- package/dist/api/applesilicon/index.gen.d.ts +5 -0
- package/dist/api/baremetal/index.gen.d.ts +5 -0
- package/dist/api/baremetal/v1/index.gen.d.ts +1 -1
- package/dist/api/baremetal/v1/marshalling.gen.cjs +61 -1
- package/dist/api/baremetal/v1/marshalling.gen.js +61 -1
- package/dist/api/baremetal/v1/types.gen.d.ts +120 -1
- package/dist/api/billing/index.gen.d.ts +6 -0
- package/dist/api/block/index.gen.d.ts +5 -0
- package/dist/api/cockpit/index.gen.d.ts +6 -0
- package/dist/api/cockpit/v1/types.gen.d.ts +1 -1
- package/dist/api/container/index.gen.d.ts +5 -0
- package/dist/api/container/v1beta1/api.gen.cjs +0 -23
- package/dist/api/container/v1beta1/api.gen.d.ts +1 -9
- package/dist/api/container/v1beta1/api.gen.js +1 -24
- package/dist/api/container/v1beta1/index.gen.d.ts +1 -1
- package/dist/api/container/v1beta1/types.gen.d.ts +0 -12
- package/dist/api/dedibox/index.gen.d.ts +5 -0
- package/dist/api/document_db/index.gen.d.ts +5 -0
- package/dist/api/domain/index.gen.d.ts +5 -0
- package/dist/api/edge_services/index.gen.d.ts +5 -0
- package/dist/api/flexibleip/index.gen.d.ts +5 -0
- package/dist/api/function/index.gen.d.ts +5 -0
- package/dist/api/function/v1beta1/api.gen.cjs +0 -23
- package/dist/api/function/v1beta1/api.gen.d.ts +1 -9
- package/dist/api/function/v1beta1/api.gen.js +1 -24
- package/dist/api/function/v1beta1/index.gen.d.ts +1 -1
- package/dist/api/function/v1beta1/types.gen.d.ts +0 -12
- package/dist/api/iam/index.gen.d.ts +5 -0
- package/dist/api/iam/v1alpha1/api.gen.cjs +1 -1
- package/dist/api/iam/v1alpha1/api.gen.d.ts +1 -1
- package/dist/api/iam/v1alpha1/api.gen.js +1 -1
- package/dist/api/iam/v1alpha1/index.gen.d.ts +1 -1
- package/dist/api/iam/v1alpha1/marshalling.gen.cjs +16 -3
- package/dist/api/iam/v1alpha1/marshalling.gen.js +16 -3
- package/dist/api/iam/v1alpha1/types.gen.d.ts +25 -3
- package/dist/api/iam/v1alpha1/validation-rules.gen.cjs +12 -0
- package/dist/api/iam/v1alpha1/validation-rules.gen.d.ts +11 -0
- package/dist/api/iam/v1alpha1/validation-rules.gen.js +12 -0
- package/dist/api/index.gen.d.ts +43 -0
- package/dist/api/inference/index.gen.d.ts +5 -0
- package/dist/api/instance/index.gen.d.ts +5 -0
- package/dist/api/instance/v1/marshalling.gen.cjs +1 -0
- package/dist/api/instance/v1/marshalling.gen.js +1 -0
- package/dist/api/instance/v1/types.gen.d.ts +22 -8
- package/dist/api/instance/v1/types.private.gen.d.ts +2 -2
- package/dist/api/iot/index.gen.d.ts +5 -0
- package/dist/api/ipam/index.gen.d.ts +5 -0
- package/dist/api/ipam/v1/api.gen.cjs +67 -2
- package/dist/api/ipam/v1/api.gen.d.ts +38 -3
- package/dist/api/ipam/v1/api.gen.js +68 -3
- package/dist/api/ipam/v1/index.gen.d.ts +1 -1
- package/dist/api/ipam/v1/marshalling.gen.cjs +18 -0
- package/dist/api/ipam/v1/marshalling.gen.d.ts +4 -1
- package/dist/api/ipam/v1/marshalling.gen.js +18 -0
- package/dist/api/ipam/v1/types.gen.d.ts +59 -5
- package/dist/api/ipfs/index.gen.d.ts +5 -0
- package/dist/api/jobs/index.gen.d.ts +5 -0
- package/dist/api/k8s/index.gen.d.ts +5 -0
- package/dist/api/k8s/v1/api.gen.cjs +17 -0
- package/dist/api/k8s/v1/api.gen.d.ts +10 -1
- package/dist/api/k8s/v1/api.gen.js +17 -0
- package/dist/api/k8s/v1/index.gen.d.ts +1 -1
- package/dist/api/k8s/v1/types.gen.d.ts +13 -0
- package/dist/api/key_manager/index.gen.d.ts +5 -0
- package/dist/api/key_manager/v1alpha1/api.gen.cjs +31 -0
- package/dist/api/key_manager/v1alpha1/api.gen.d.ts +17 -1
- package/dist/api/key_manager/v1alpha1/api.gen.js +32 -1
- package/dist/api/key_manager/v1alpha1/index.gen.d.ts +1 -1
- package/dist/api/key_manager/v1alpha1/marshalling.gen.cjs +7 -0
- package/dist/api/key_manager/v1alpha1/marshalling.gen.d.ts +2 -1
- package/dist/api/key_manager/v1alpha1/marshalling.gen.js +7 -0
- package/dist/api/key_manager/v1alpha1/types.gen.d.ts +33 -0
- package/dist/api/lb/index.gen.d.ts +5 -0
- package/dist/api/llm_inference/index.gen.d.ts +5 -0
- package/dist/api/marketplace/index.gen.d.ts +5 -0
- package/dist/api/mnq/index.gen.d.ts +5 -0
- package/dist/api/qaas/index.gen.d.ts +5 -0
- package/dist/api/qaas/v1alpha1/api.gen.d.ts +256 -0
- package/dist/api/qaas/v1alpha1/content.gen.d.ts +7 -0
- package/dist/api/qaas/v1alpha1/index.gen.d.ts +4 -0
- package/dist/api/qaas/v1alpha1/marshalling.gen.d.ts +22 -0
- package/dist/api/qaas/v1alpha1/types.gen.d.ts +470 -0
- package/dist/api/qaas/v1alpha1/validation-rules.gen.d.ts +10 -0
- package/dist/api/rdb/index.gen.d.ts +5 -0
- package/dist/api/redis/index.gen.d.ts +5 -0
- package/dist/api/registry/index.gen.d.ts +5 -0
- package/dist/api/secret/index.gen.d.ts +6 -0
- package/dist/api/serverless_sqldb/index.gen.d.ts +5 -0
- package/dist/api/tem/index.gen.d.ts +5 -0
- package/dist/api/tem/v1alpha1/content.gen.cjs +4 -1
- package/dist/api/tem/v1alpha1/content.gen.js +4 -1
- package/dist/api/tem/v1alpha1/types.gen.d.ts +1 -1
- package/dist/api/test/index.gen.d.ts +5 -0
- package/dist/api/vpc/index.gen.d.ts +6 -0
- package/dist/api/vpc/v2/marshalling.gen.cjs +1 -0
- package/dist/api/vpc/v2/marshalling.gen.js +1 -0
- package/dist/api/vpc/v2/types.gen.d.ts +3 -0
- package/dist/api/vpcgw/index.gen.d.ts +5 -0
- package/dist/api/webhosting/index.gen.d.ts +6 -0
- package/dist/api/webhosting/v1/api.gen.d.ts +326 -0
- package/dist/api/webhosting/v1/content.gen.d.ts +5 -0
- package/dist/api/webhosting/v1/index.gen.d.ts +4 -0
- package/dist/api/webhosting/v1/marshalling.gen.d.ts +29 -0
- package/dist/api/webhosting/v1/types.gen.d.ts +693 -0
- package/dist/api/webhosting/v1/validation-rules.gen.d.ts +72 -0
- package/dist/scw/constants.cjs +1 -1
- package/dist/scw/constants.d.ts +2 -2
- package/dist/scw/constants.js +1 -1
- package/package.json +2 -2
|
@@ -0,0 +1,326 @@
|
|
|
1
|
+
import { API as ParentAPI } from '../../../bridge';
|
|
2
|
+
import type { Region, WaitForOptions } from '../../../bridge';
|
|
3
|
+
import type { ControlPanelApiListControlPanelsRequest, Database, DatabaseApiAssignDatabaseUserRequest, DatabaseApiChangeDatabaseUserPasswordRequest, DatabaseApiCreateDatabaseRequest, DatabaseApiCreateDatabaseUserRequest, DatabaseApiDeleteDatabaseRequest, DatabaseApiDeleteDatabaseUserRequest, DatabaseApiGetDatabaseRequest, DatabaseApiGetDatabaseUserRequest, DatabaseApiListDatabaseUsersRequest, DatabaseApiListDatabasesRequest, DatabaseApiUnassignDatabaseUserRequest, DatabaseUser, FtpAccount, FtpAccountApiChangeFtpAccountPasswordRequest, FtpAccountApiCreateFtpAccountRequest, FtpAccountApiListFtpAccountsRequest, FtpAccountApiRemoveFtpAccountRequest, Hosting, HostingApiCreateHostingRequest, HostingApiCreateSessionRequest, HostingApiDeleteHostingRequest, HostingApiGetHostingRequest, HostingApiListHostingsRequest, HostingApiResetHostingPasswordRequest, HostingApiUpdateHostingRequest, ListControlPanelsResponse, ListDatabaseUsersResponse, ListDatabasesResponse, ListFtpAccountsResponse, ListHostingsResponse, ListMailAccountsResponse, ListOffersResponse, ListWebsitesResponse, MailAccount, MailAccountApiChangeMailAccountPasswordRequest, MailAccountApiCreateMailAccountRequest, MailAccountApiListMailAccountsRequest, MailAccountApiRemoveMailAccountRequest, OfferApiListOffersRequest, ResetHostingPasswordResponse, Session, WebsiteApiListWebsitesRequest } from './types.gen';
|
|
4
|
+
/**
|
|
5
|
+
* Web Hosting API.
|
|
6
|
+
*
|
|
7
|
+
* This API allows you to manage your Web Hosting services.
|
|
8
|
+
*/
|
|
9
|
+
export declare class ControlPanelAPI extends ParentAPI {
|
|
10
|
+
/** Lists the available regions of the API. */
|
|
11
|
+
static readonly LOCALITIES: Region[];
|
|
12
|
+
protected pageOfListControlPanels: (request?: Readonly<ControlPanelApiListControlPanelsRequest>) => Promise<ListControlPanelsResponse>;
|
|
13
|
+
/**
|
|
14
|
+
* "List the control panels type: cpanel or plesk.".
|
|
15
|
+
*
|
|
16
|
+
* @param request - The request {@link ControlPanelApiListControlPanelsRequest}
|
|
17
|
+
* @returns A Promise of ListControlPanelsResponse
|
|
18
|
+
*/
|
|
19
|
+
listControlPanels: (request?: Readonly<ControlPanelApiListControlPanelsRequest>) => Promise<ListControlPanelsResponse> & {
|
|
20
|
+
all: () => Promise<import("./types.gen").ControlPanel[]>;
|
|
21
|
+
[Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen").ControlPanel[], void, void>;
|
|
22
|
+
};
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* Web Hosting Database API.
|
|
26
|
+
*
|
|
27
|
+
* This API allows you to manage your databases and database users for your Web
|
|
28
|
+
* Hosting services.
|
|
29
|
+
*/
|
|
30
|
+
export declare class DatabaseAPI extends ParentAPI {
|
|
31
|
+
/** Lists the available regions of the API. */
|
|
32
|
+
static readonly LOCALITIES: Region[];
|
|
33
|
+
/**
|
|
34
|
+
* "Create a new database within your hosting plan".
|
|
35
|
+
*
|
|
36
|
+
* @param request - The request {@link DatabaseApiCreateDatabaseRequest}
|
|
37
|
+
* @returns A Promise of Database
|
|
38
|
+
*/
|
|
39
|
+
createDatabase: (request: Readonly<DatabaseApiCreateDatabaseRequest>) => Promise<Database>;
|
|
40
|
+
protected pageOfListDatabases: (request: Readonly<DatabaseApiListDatabasesRequest>) => Promise<ListDatabasesResponse>;
|
|
41
|
+
/**
|
|
42
|
+
* "List all databases within your hosting plan".
|
|
43
|
+
*
|
|
44
|
+
* @param request - The request {@link DatabaseApiListDatabasesRequest}
|
|
45
|
+
* @returns A Promise of ListDatabasesResponse
|
|
46
|
+
*/
|
|
47
|
+
listDatabases: (request: Readonly<DatabaseApiListDatabasesRequest>) => Promise<ListDatabasesResponse> & {
|
|
48
|
+
all: () => Promise<Database[]>;
|
|
49
|
+
[Symbol.asyncIterator]: () => AsyncGenerator<Database[], void, void>;
|
|
50
|
+
};
|
|
51
|
+
/**
|
|
52
|
+
* "Get details of a database within your hosting plan".
|
|
53
|
+
*
|
|
54
|
+
* @param request - The request {@link DatabaseApiGetDatabaseRequest}
|
|
55
|
+
* @returns A Promise of Database
|
|
56
|
+
*/
|
|
57
|
+
getDatabase: (request: Readonly<DatabaseApiGetDatabaseRequest>) => Promise<Database>;
|
|
58
|
+
/**
|
|
59
|
+
* "Delete a database within your hosting plan".
|
|
60
|
+
*
|
|
61
|
+
* @param request - The request {@link DatabaseApiDeleteDatabaseRequest}
|
|
62
|
+
* @returns A Promise of Database
|
|
63
|
+
*/
|
|
64
|
+
deleteDatabase: (request: Readonly<DatabaseApiDeleteDatabaseRequest>) => Promise<Database>;
|
|
65
|
+
/**
|
|
66
|
+
* "Create a new database user".
|
|
67
|
+
*
|
|
68
|
+
* @param request - The request {@link DatabaseApiCreateDatabaseUserRequest}
|
|
69
|
+
* @returns A Promise of DatabaseUser
|
|
70
|
+
*/
|
|
71
|
+
createDatabaseUser: (request: Readonly<DatabaseApiCreateDatabaseUserRequest>) => Promise<DatabaseUser>;
|
|
72
|
+
protected pageOfListDatabaseUsers: (request: Readonly<DatabaseApiListDatabaseUsersRequest>) => Promise<ListDatabaseUsersResponse>;
|
|
73
|
+
/**
|
|
74
|
+
* "List all database users".
|
|
75
|
+
*
|
|
76
|
+
* @param request - The request {@link DatabaseApiListDatabaseUsersRequest}
|
|
77
|
+
* @returns A Promise of ListDatabaseUsersResponse
|
|
78
|
+
*/
|
|
79
|
+
listDatabaseUsers: (request: Readonly<DatabaseApiListDatabaseUsersRequest>) => Promise<ListDatabaseUsersResponse> & {
|
|
80
|
+
all: () => Promise<DatabaseUser[]>;
|
|
81
|
+
[Symbol.asyncIterator]: () => AsyncGenerator<DatabaseUser[], void, void>;
|
|
82
|
+
};
|
|
83
|
+
/**
|
|
84
|
+
* "Get details of a database user".
|
|
85
|
+
*
|
|
86
|
+
* @param request - The request {@link DatabaseApiGetDatabaseUserRequest}
|
|
87
|
+
* @returns A Promise of DatabaseUser
|
|
88
|
+
*/
|
|
89
|
+
getDatabaseUser: (request: Readonly<DatabaseApiGetDatabaseUserRequest>) => Promise<DatabaseUser>;
|
|
90
|
+
/**
|
|
91
|
+
* "Delete a database user".
|
|
92
|
+
*
|
|
93
|
+
* @param request - The request {@link DatabaseApiDeleteDatabaseUserRequest}
|
|
94
|
+
* @returns A Promise of DatabaseUser
|
|
95
|
+
*/
|
|
96
|
+
deleteDatabaseUser: (request: Readonly<DatabaseApiDeleteDatabaseUserRequest>) => Promise<DatabaseUser>;
|
|
97
|
+
/**
|
|
98
|
+
* "Change the password of a database user".
|
|
99
|
+
*
|
|
100
|
+
* @param request - The request
|
|
101
|
+
* {@link DatabaseApiChangeDatabaseUserPasswordRequest}
|
|
102
|
+
* @returns A Promise of DatabaseUser
|
|
103
|
+
*/
|
|
104
|
+
changeDatabaseUserPassword: (request: Readonly<DatabaseApiChangeDatabaseUserPasswordRequest>) => Promise<DatabaseUser>;
|
|
105
|
+
/**
|
|
106
|
+
* "Assign a database user to a database".
|
|
107
|
+
*
|
|
108
|
+
* @param request - The request {@link DatabaseApiAssignDatabaseUserRequest}
|
|
109
|
+
* @returns A Promise of DatabaseUser
|
|
110
|
+
*/
|
|
111
|
+
assignDatabaseUser: (request: Readonly<DatabaseApiAssignDatabaseUserRequest>) => Promise<DatabaseUser>;
|
|
112
|
+
/**
|
|
113
|
+
* "Unassign a database user from a database".
|
|
114
|
+
*
|
|
115
|
+
* @param request - The request {@link DatabaseApiUnassignDatabaseUserRequest}
|
|
116
|
+
* @returns A Promise of DatabaseUser
|
|
117
|
+
*/
|
|
118
|
+
unassignDatabaseUser: (request: Readonly<DatabaseApiUnassignDatabaseUserRequest>) => Promise<DatabaseUser>;
|
|
119
|
+
}
|
|
120
|
+
/**
|
|
121
|
+
* Web Hosting Offer API.
|
|
122
|
+
*
|
|
123
|
+
* This API allows you to manage your offer for your Web Hosting services.
|
|
124
|
+
*/
|
|
125
|
+
export declare class OfferAPI extends ParentAPI {
|
|
126
|
+
/** Lists the available regions of the API. */
|
|
127
|
+
static readonly LOCALITIES: Region[];
|
|
128
|
+
protected pageOfListOffers: (request?: Readonly<OfferApiListOffersRequest>) => Promise<ListOffersResponse>;
|
|
129
|
+
/**
|
|
130
|
+
* List all available hosting offers along with their specific options.. List
|
|
131
|
+
* all available hosting offers along with their specific options.
|
|
132
|
+
*
|
|
133
|
+
* @param request - The request {@link OfferApiListOffersRequest}
|
|
134
|
+
* @returns A Promise of ListOffersResponse
|
|
135
|
+
*/
|
|
136
|
+
listOffers: (request?: Readonly<OfferApiListOffersRequest>) => Promise<ListOffersResponse> & {
|
|
137
|
+
all: () => Promise<import("./types.gen").Offer[]>;
|
|
138
|
+
[Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen").Offer[], void, void>;
|
|
139
|
+
};
|
|
140
|
+
}
|
|
141
|
+
/**
|
|
142
|
+
* Web Hosting API.
|
|
143
|
+
*
|
|
144
|
+
* This API allows you to manage your Web Hosting services.
|
|
145
|
+
*/
|
|
146
|
+
export declare class HostingAPI extends ParentAPI {
|
|
147
|
+
/** Lists the available regions of the API. */
|
|
148
|
+
static readonly LOCALITIES: Region[];
|
|
149
|
+
/**
|
|
150
|
+
* Order a Web Hosting plan. Order a Web Hosting plan, specifying the offer
|
|
151
|
+
* type required via the `offer_id` parameter.
|
|
152
|
+
*
|
|
153
|
+
* @param request - The request {@link HostingApiCreateHostingRequest}
|
|
154
|
+
* @returns A Promise of Hosting
|
|
155
|
+
*/
|
|
156
|
+
createHosting: (request: Readonly<HostingApiCreateHostingRequest>) => Promise<Hosting>;
|
|
157
|
+
protected pageOfListHostings: (request?: Readonly<HostingApiListHostingsRequest>) => Promise<ListHostingsResponse>;
|
|
158
|
+
/**
|
|
159
|
+
* List all Web Hosting plans. List all of your existing Web Hosting plans.
|
|
160
|
+
* Various filters are available to limit the results, including filtering by
|
|
161
|
+
* domain, status, tag and Project ID.
|
|
162
|
+
*
|
|
163
|
+
* @param request - The request {@link HostingApiListHostingsRequest}
|
|
164
|
+
* @returns A Promise of ListHostingsResponse
|
|
165
|
+
*/
|
|
166
|
+
listHostings: (request?: Readonly<HostingApiListHostingsRequest>) => Promise<ListHostingsResponse> & {
|
|
167
|
+
all: () => Promise<import("./types.gen").HostingSummary[]>;
|
|
168
|
+
[Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen").HostingSummary[], void, void>;
|
|
169
|
+
};
|
|
170
|
+
/**
|
|
171
|
+
* Get a Web Hosting plan. Get the details of one of your existing Web Hosting
|
|
172
|
+
* plans, specified by its `hosting_id`.
|
|
173
|
+
*
|
|
174
|
+
* @param request - The request {@link HostingApiGetHostingRequest}
|
|
175
|
+
* @returns A Promise of Hosting
|
|
176
|
+
*/
|
|
177
|
+
getHosting: (request: Readonly<HostingApiGetHostingRequest>) => Promise<Hosting>;
|
|
178
|
+
/**
|
|
179
|
+
* Waits for {@link Hosting} to be in a final state.
|
|
180
|
+
*
|
|
181
|
+
* @param request - The request {@link HostingApiGetHostingRequest}
|
|
182
|
+
* @param options - The waiting options
|
|
183
|
+
* @returns A Promise of Hosting
|
|
184
|
+
*/
|
|
185
|
+
waitForHosting: (request: Readonly<HostingApiGetHostingRequest>, options?: Readonly<WaitForOptions<Hosting>>) => Promise<Hosting>;
|
|
186
|
+
/**
|
|
187
|
+
* Update a Web Hosting plan. Update the details of one of your existing Web
|
|
188
|
+
* Hosting plans, specified by its `hosting_id`. You can update parameters
|
|
189
|
+
* including the contact email address, tags, options and offer.
|
|
190
|
+
*
|
|
191
|
+
* @param request - The request {@link HostingApiUpdateHostingRequest}
|
|
192
|
+
* @returns A Promise of Hosting
|
|
193
|
+
*/
|
|
194
|
+
updateHosting: (request: Readonly<HostingApiUpdateHostingRequest>) => Promise<Hosting>;
|
|
195
|
+
/**
|
|
196
|
+
* Delete a Web Hosting plan. Delete a Web Hosting plan, specified by its
|
|
197
|
+
* `hosting_id`. Note that deletion is not immediate: it will take place at
|
|
198
|
+
* the end of the calendar month, after which time your Web Hosting plan and
|
|
199
|
+
* all its data (files and emails) will be irreversibly lost.
|
|
200
|
+
*
|
|
201
|
+
* @param request - The request {@link HostingApiDeleteHostingRequest}
|
|
202
|
+
* @returns A Promise of Hosting
|
|
203
|
+
*/
|
|
204
|
+
deleteHosting: (request: Readonly<HostingApiDeleteHostingRequest>) => Promise<Hosting>;
|
|
205
|
+
/**
|
|
206
|
+
* Create a user session.
|
|
207
|
+
*
|
|
208
|
+
* @param request - The request {@link HostingApiCreateSessionRequest}
|
|
209
|
+
* @returns A Promise of Session
|
|
210
|
+
*/
|
|
211
|
+
createSession: (request: Readonly<HostingApiCreateSessionRequest>) => Promise<Session>;
|
|
212
|
+
/**
|
|
213
|
+
* Reset a Web Hosting plan password.
|
|
214
|
+
*
|
|
215
|
+
* @param request - The request {@link HostingApiResetHostingPasswordRequest}
|
|
216
|
+
* @returns A Promise of ResetHostingPasswordResponse
|
|
217
|
+
*/
|
|
218
|
+
resetHostingPassword: (request: Readonly<HostingApiResetHostingPasswordRequest>) => Promise<ResetHostingPasswordResponse>;
|
|
219
|
+
}
|
|
220
|
+
/**
|
|
221
|
+
* Web Hosting FTP Account API.
|
|
222
|
+
*
|
|
223
|
+
* This API allows you to manage your FTP accounts for your Web Hosting
|
|
224
|
+
* services.
|
|
225
|
+
*/
|
|
226
|
+
export declare class FtpAccountAPI extends ParentAPI {
|
|
227
|
+
/** Lists the available regions of the API. */
|
|
228
|
+
static readonly LOCALITIES: Region[];
|
|
229
|
+
/**
|
|
230
|
+
* Create a new FTP account within your hosting plan.. Create a new FTP
|
|
231
|
+
* account within your hosting plan.
|
|
232
|
+
*
|
|
233
|
+
* @param request - The request {@link FtpAccountApiCreateFtpAccountRequest}
|
|
234
|
+
* @returns A Promise of FtpAccount
|
|
235
|
+
*/
|
|
236
|
+
createFtpAccount: (request: Readonly<FtpAccountApiCreateFtpAccountRequest>) => Promise<FtpAccount>;
|
|
237
|
+
protected pageOfListFtpAccounts: (request: Readonly<FtpAccountApiListFtpAccountsRequest>) => Promise<ListFtpAccountsResponse>;
|
|
238
|
+
/**
|
|
239
|
+
* List all FTP accounts within your hosting plan.. List all FTP accounts
|
|
240
|
+
* within your hosting plan.
|
|
241
|
+
*
|
|
242
|
+
* @param request - The request {@link FtpAccountApiListFtpAccountsRequest}
|
|
243
|
+
* @returns A Promise of ListFtpAccountsResponse
|
|
244
|
+
*/
|
|
245
|
+
listFtpAccounts: (request: Readonly<FtpAccountApiListFtpAccountsRequest>) => Promise<ListFtpAccountsResponse> & {
|
|
246
|
+
all: () => Promise<FtpAccount[]>;
|
|
247
|
+
[Symbol.asyncIterator]: () => AsyncGenerator<FtpAccount[], void, void>;
|
|
248
|
+
};
|
|
249
|
+
/**
|
|
250
|
+
* Delete a specific FTP account within your hosting plan.. Delete a specific
|
|
251
|
+
* FTP account within your hosting plan.
|
|
252
|
+
*
|
|
253
|
+
* @param request - The request {@link FtpAccountApiRemoveFtpAccountRequest}
|
|
254
|
+
* @returns A Promise of FtpAccount
|
|
255
|
+
*/
|
|
256
|
+
removeFtpAccount: (request: Readonly<FtpAccountApiRemoveFtpAccountRequest>) => Promise<FtpAccount>;
|
|
257
|
+
changeFtpAccountPassword: (request: Readonly<FtpAccountApiChangeFtpAccountPasswordRequest>) => Promise<FtpAccount>;
|
|
258
|
+
}
|
|
259
|
+
/**
|
|
260
|
+
* Web Hosting Mail Account API.
|
|
261
|
+
*
|
|
262
|
+
* This API allows you to manage your mail accounts for your Web Hosting
|
|
263
|
+
* services.
|
|
264
|
+
*/
|
|
265
|
+
export declare class MailAccountAPI extends ParentAPI {
|
|
266
|
+
/** Lists the available regions of the API. */
|
|
267
|
+
static readonly LOCALITIES: Region[];
|
|
268
|
+
/**
|
|
269
|
+
* Create a new mail account within your hosting plan.. Create a new mail
|
|
270
|
+
* account within your hosting plan.
|
|
271
|
+
*
|
|
272
|
+
* @param request - The request {@link MailAccountApiCreateMailAccountRequest}
|
|
273
|
+
* @returns A Promise of MailAccount
|
|
274
|
+
*/
|
|
275
|
+
createMailAccount: (request: Readonly<MailAccountApiCreateMailAccountRequest>) => Promise<MailAccount>;
|
|
276
|
+
protected pageOfListMailAccounts: (request: Readonly<MailAccountApiListMailAccountsRequest>) => Promise<ListMailAccountsResponse>;
|
|
277
|
+
/**
|
|
278
|
+
* List all mail accounts within your hosting plan.. List all mail accounts
|
|
279
|
+
* within your hosting plan.
|
|
280
|
+
*
|
|
281
|
+
* @param request - The request {@link MailAccountApiListMailAccountsRequest}
|
|
282
|
+
* @returns A Promise of ListMailAccountsResponse
|
|
283
|
+
*/
|
|
284
|
+
listMailAccounts: (request: Readonly<MailAccountApiListMailAccountsRequest>) => Promise<ListMailAccountsResponse> & {
|
|
285
|
+
all: () => Promise<MailAccount[]>;
|
|
286
|
+
[Symbol.asyncIterator]: () => AsyncGenerator<MailAccount[], void, void>;
|
|
287
|
+
};
|
|
288
|
+
/**
|
|
289
|
+
* Delete a mail account within your hosting plan.. Delete a mail account
|
|
290
|
+
* within your hosting plan.
|
|
291
|
+
*
|
|
292
|
+
* @param request - The request {@link MailAccountApiRemoveMailAccountRequest}
|
|
293
|
+
* @returns A Promise of MailAccount
|
|
294
|
+
*/
|
|
295
|
+
removeMailAccount: (request: Readonly<MailAccountApiRemoveMailAccountRequest>) => Promise<MailAccount>;
|
|
296
|
+
/**
|
|
297
|
+
* Update the password of a mail account within your hosting plan.. Update the
|
|
298
|
+
* password of a mail account within your hosting plan.
|
|
299
|
+
*
|
|
300
|
+
* @param request - The request
|
|
301
|
+
* {@link MailAccountApiChangeMailAccountPasswordRequest}
|
|
302
|
+
* @returns A Promise of MailAccount
|
|
303
|
+
*/
|
|
304
|
+
changeMailAccountPassword: (request: Readonly<MailAccountApiChangeMailAccountPasswordRequest>) => Promise<MailAccount>;
|
|
305
|
+
}
|
|
306
|
+
/**
|
|
307
|
+
* Web Hosting Website API.
|
|
308
|
+
*
|
|
309
|
+
* This API allows you to manage your websites for your Web Hosting services.
|
|
310
|
+
*/
|
|
311
|
+
export declare class WebsiteAPI extends ParentAPI {
|
|
312
|
+
/** Lists the available regions of the API. */
|
|
313
|
+
static readonly LOCALITIES: Region[];
|
|
314
|
+
protected pageOfListWebsites: (request: Readonly<WebsiteApiListWebsitesRequest>) => Promise<ListWebsitesResponse>;
|
|
315
|
+
/**
|
|
316
|
+
* List all websites for a specific hosting.. List all websites for a specific
|
|
317
|
+
* hosting.
|
|
318
|
+
*
|
|
319
|
+
* @param request - The request {@link WebsiteApiListWebsitesRequest}
|
|
320
|
+
* @returns A Promise of ListWebsitesResponse
|
|
321
|
+
*/
|
|
322
|
+
listWebsites: (request: Readonly<WebsiteApiListWebsitesRequest>) => Promise<ListWebsitesResponse> & {
|
|
323
|
+
all: () => Promise<import("./types.gen").Website[]>;
|
|
324
|
+
[Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen").Website[], void, void>;
|
|
325
|
+
};
|
|
326
|
+
}
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import type { HostingStatus, HostingSummaryStatus } from './types.gen';
|
|
2
|
+
/** Lists transient statutes of the enum {@link HostingStatus}. */
|
|
3
|
+
export declare const HOSTING_TRANSIENT_STATUSES: HostingStatus[];
|
|
4
|
+
/** Lists transient statutes of the enum {@link HostingSummaryStatus}. */
|
|
5
|
+
export declare const HOSTING_SUMMARY_TRANSIENT_STATUSES: HostingSummaryStatus[];
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
export { ControlPanelAPI, DatabaseAPI, FtpAccountAPI, HostingAPI, MailAccountAPI, OfferAPI, WebsiteAPI, } from './api.gen';
|
|
2
|
+
export * from './content.gen';
|
|
3
|
+
export type { ControlPanel, ControlPanelApiListControlPanelsRequest, CreateHostingRequestDomainConfiguration, Database, DatabaseApiAssignDatabaseUserRequest, DatabaseApiChangeDatabaseUserPasswordRequest, DatabaseApiCreateDatabaseRequest, DatabaseApiCreateDatabaseUserRequest, DatabaseApiDeleteDatabaseRequest, DatabaseApiDeleteDatabaseUserRequest, DatabaseApiGetDatabaseRequest, DatabaseApiGetDatabaseUserRequest, DatabaseApiListDatabaseUsersRequest, DatabaseApiListDatabasesRequest, DatabaseApiUnassignDatabaseUserRequest, DatabaseUser, FtpAccount, FtpAccountApiChangeFtpAccountPasswordRequest, FtpAccountApiCreateFtpAccountRequest, FtpAccountApiListFtpAccountsRequest, FtpAccountApiRemoveFtpAccountRequest, Hosting, HostingApiCreateHostingRequest, HostingApiCreateSessionRequest, HostingApiDeleteHostingRequest, HostingApiGetHostingRequest, HostingApiListHostingsRequest, HostingApiResetHostingPasswordRequest, HostingApiUpdateHostingRequest, HostingCpanelUrls, HostingDnsStatus, HostingOption, HostingStatus, HostingSummary, HostingSummaryStatus, ListControlPanelsResponse, ListDatabaseUsersRequestOrderBy, ListDatabaseUsersResponse, ListDatabasesRequestOrderBy, ListDatabasesResponse, ListFtpAccountsRequestOrderBy, ListFtpAccountsResponse, ListHostingsRequestOrderBy, ListHostingsResponse, ListMailAccountsRequestOrderBy, ListMailAccountsResponse, ListOffersRequestOrderBy, ListOffersResponse, ListWebsitesRequestOrderBy, ListWebsitesResponse, MailAccount, MailAccountApiChangeMailAccountPasswordRequest, MailAccountApiCreateMailAccountRequest, MailAccountApiListMailAccountsRequest, MailAccountApiRemoveMailAccountRequest, Offer, OfferApiListOffersRequest, OfferOption, OfferOptionName, OfferOptionRequest, OfferOptionWarning, ResetHostingPasswordResponse, Session, Website, WebsiteApiListWebsitesRequest, } from './types.gen';
|
|
4
|
+
export * as ValidationRules from './validation-rules.gen';
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import type { DefaultValues } from '../../../bridge';
|
|
2
|
+
import type { Database, DatabaseApiAssignDatabaseUserRequest, DatabaseApiChangeDatabaseUserPasswordRequest, DatabaseApiCreateDatabaseRequest, DatabaseApiCreateDatabaseUserRequest, DatabaseApiUnassignDatabaseUserRequest, DatabaseUser, FtpAccount, FtpAccountApiChangeFtpAccountPasswordRequest, FtpAccountApiCreateFtpAccountRequest, Hosting, HostingApiCreateHostingRequest, HostingApiUpdateHostingRequest, ListControlPanelsResponse, ListDatabaseUsersResponse, ListDatabasesResponse, ListFtpAccountsResponse, ListHostingsResponse, ListMailAccountsResponse, ListOffersResponse, ListWebsitesResponse, MailAccount, MailAccountApiChangeMailAccountPasswordRequest, MailAccountApiCreateMailAccountRequest, MailAccountApiRemoveMailAccountRequest, ResetHostingPasswordResponse, Session } from './types.gen';
|
|
3
|
+
export declare const unmarshalDatabaseUser: (data: unknown) => DatabaseUser;
|
|
4
|
+
export declare const unmarshalDatabase: (data: unknown) => Database;
|
|
5
|
+
export declare const unmarshalFtpAccount: (data: unknown) => FtpAccount;
|
|
6
|
+
export declare const unmarshalMailAccount: (data: unknown) => MailAccount;
|
|
7
|
+
export declare const unmarshalHosting: (data: unknown) => Hosting;
|
|
8
|
+
export declare const unmarshalListControlPanelsResponse: (data: unknown) => ListControlPanelsResponse;
|
|
9
|
+
export declare const unmarshalListDatabaseUsersResponse: (data: unknown) => ListDatabaseUsersResponse;
|
|
10
|
+
export declare const unmarshalListDatabasesResponse: (data: unknown) => ListDatabasesResponse;
|
|
11
|
+
export declare const unmarshalListFtpAccountsResponse: (data: unknown) => ListFtpAccountsResponse;
|
|
12
|
+
export declare const unmarshalListHostingsResponse: (data: unknown) => ListHostingsResponse;
|
|
13
|
+
export declare const unmarshalListMailAccountsResponse: (data: unknown) => ListMailAccountsResponse;
|
|
14
|
+
export declare const unmarshalListOffersResponse: (data: unknown) => ListOffersResponse;
|
|
15
|
+
export declare const unmarshalListWebsitesResponse: (data: unknown) => ListWebsitesResponse;
|
|
16
|
+
export declare const unmarshalResetHostingPasswordResponse: (data: unknown) => ResetHostingPasswordResponse;
|
|
17
|
+
export declare const unmarshalSession: (data: unknown) => Session;
|
|
18
|
+
export declare const marshalDatabaseApiAssignDatabaseUserRequest: (request: DatabaseApiAssignDatabaseUserRequest, defaults: DefaultValues) => Record<string, unknown>;
|
|
19
|
+
export declare const marshalDatabaseApiChangeDatabaseUserPasswordRequest: (request: DatabaseApiChangeDatabaseUserPasswordRequest, defaults: DefaultValues) => Record<string, unknown>;
|
|
20
|
+
export declare const marshalDatabaseApiCreateDatabaseRequest: (request: DatabaseApiCreateDatabaseRequest, defaults: DefaultValues) => Record<string, unknown>;
|
|
21
|
+
export declare const marshalDatabaseApiCreateDatabaseUserRequest: (request: DatabaseApiCreateDatabaseUserRequest, defaults: DefaultValues) => Record<string, unknown>;
|
|
22
|
+
export declare const marshalDatabaseApiUnassignDatabaseUserRequest: (request: DatabaseApiUnassignDatabaseUserRequest, defaults: DefaultValues) => Record<string, unknown>;
|
|
23
|
+
export declare const marshalFtpAccountApiChangeFtpAccountPasswordRequest: (request: FtpAccountApiChangeFtpAccountPasswordRequest, defaults: DefaultValues) => Record<string, unknown>;
|
|
24
|
+
export declare const marshalFtpAccountApiCreateFtpAccountRequest: (request: FtpAccountApiCreateFtpAccountRequest, defaults: DefaultValues) => Record<string, unknown>;
|
|
25
|
+
export declare const marshalHostingApiCreateHostingRequest: (request: HostingApiCreateHostingRequest, defaults: DefaultValues) => Record<string, unknown>;
|
|
26
|
+
export declare const marshalHostingApiUpdateHostingRequest: (request: HostingApiUpdateHostingRequest, defaults: DefaultValues) => Record<string, unknown>;
|
|
27
|
+
export declare const marshalMailAccountApiChangeMailAccountPasswordRequest: (request: MailAccountApiChangeMailAccountPasswordRequest, defaults: DefaultValues) => Record<string, unknown>;
|
|
28
|
+
export declare const marshalMailAccountApiCreateMailAccountRequest: (request: MailAccountApiCreateMailAccountRequest, defaults: DefaultValues) => Record<string, unknown>;
|
|
29
|
+
export declare const marshalMailAccountApiRemoveMailAccountRequest: (request: MailAccountApiRemoveMailAccountRequest, defaults: DefaultValues) => Record<string, unknown>;
|