hostinger-api-sdk 1.38.0 → 1.40.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/README.md +2 -2
- package/api.ts +1536 -32
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +2 -2
- package/dist/api.d.ts +1086 -30
- package/dist/api.js +902 -44
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +2 -2
- package/dist/esm/api.d.ts +1086 -30
- package/dist/esm/api.js +892 -34
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +2 -2
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/AgencyHostingFilesApi.md +54 -0
- package/docs/AgencyHostingListAgencyPlanWebsitesV1200Response.md +22 -0
- package/docs/AgencyHostingV1WebsitesBuilderWebsiteDetailsResource.md +28 -0
- package/docs/AgencyHostingV1WebsitesH5gWebsiteDetailsResource.md +46 -0
- package/docs/AgencyHostingV1WebsitesPlanResource.md +25 -0
- package/docs/AgencyHostingV1WebsitesU4sWebsiteDetailsResource.md +36 -0
- package/docs/AgencyHostingV1WebsitesWebsiteListItemResource.md +37 -0
- package/docs/AgencyHostingV1WebsitesWebsiteListItemResourceDetails.md +59 -0
- package/docs/AgencyHostingWebsitesApi.md +69 -0
- package/docs/HostingDatabasesApi.md +2 -2
- package/docs/HostingFilesApi.md +56 -0
- package/docs/HostingNodeJSApi.md +124 -1
- package/docs/HostingV1FilesGenerateUploadUrlRequest.md +22 -0
- package/docs/HostingV1FilesUploadUrlResource.md +24 -0
- package/docs/HostingV1NodeJsBuildSettingsResource.md +34 -0
- package/docs/HostingV1NodeJsGetBuildSettingsRequest.md +20 -0
- package/docs/HostingV1NodeJsStartBuildRequest.md +36 -0
- package/docs/HostingV1NodeJsStartBuildRequestSourceOptions.md +21 -0
- package/docs/HostingV1WebsitesDeployArchiveRequest.md +20 -0
- package/docs/HostingWebsitesApi.md +69 -4
- package/docs/WordPressInstallationsApi.md +64 -2
- package/docs/WordPressPluginsApi.md +64 -2
- package/docs/WordPressThemesApi.md +62 -0
- package/docs/WordPressV1InstallationsImportWordPressRequest.md +22 -0
- package/docs/WordPressV1PluginsDeployPluginRequest.md +22 -0
- package/docs/WordPressV1ThemesDeployThemeRequest.md +24 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/api.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Hostinger API
|
|
3
3
|
*
|
|
4
|
-
* API Version: 1.
|
|
4
|
+
* API Version: 1.42.0
|
|
5
5
|
*
|
|
6
6
|
* NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
|
|
7
7
|
* If you want to contribute or request a new feature, please create an issue or pull request on https://github.com/hostinger/api
|
|
@@ -10,6 +10,25 @@ import type { Configuration } from './configuration';
|
|
|
10
10
|
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
11
11
|
import type { RequestArgs } from './base';
|
|
12
12
|
import { BaseAPI } from './base';
|
|
13
|
+
/**
|
|
14
|
+
*
|
|
15
|
+
* @export
|
|
16
|
+
* @interface AgencyHostingListAgencyPlanWebsitesV1200Response
|
|
17
|
+
*/
|
|
18
|
+
export interface AgencyHostingListAgencyPlanWebsitesV1200Response {
|
|
19
|
+
/**
|
|
20
|
+
* Array of [`AgencyHosting.V1.Websites.WebsiteListItemResource`](#model/agencyhostingv1websiteswebsitelistitemresource)
|
|
21
|
+
* @type {Array<AgencyHostingV1WebsitesWebsiteListItemResource>}
|
|
22
|
+
* @memberof AgencyHostingListAgencyPlanWebsitesV1200Response
|
|
23
|
+
*/
|
|
24
|
+
'data': Array<AgencyHostingV1WebsitesWebsiteListItemResource>;
|
|
25
|
+
/**
|
|
26
|
+
*
|
|
27
|
+
* @type {CommonSchemaPaginationMetaSchema}
|
|
28
|
+
* @memberof AgencyHostingListAgencyPlanWebsitesV1200Response
|
|
29
|
+
*/
|
|
30
|
+
'meta': CommonSchemaPaginationMetaSchema;
|
|
31
|
+
}
|
|
13
32
|
/**
|
|
14
33
|
*
|
|
15
34
|
* @export
|
|
@@ -862,6 +881,43 @@ export interface AgencyHostingV1WebsitesBuildAssetsRequest {
|
|
|
862
881
|
*/
|
|
863
882
|
'archive_path': string;
|
|
864
883
|
}
|
|
884
|
+
/**
|
|
885
|
+
*
|
|
886
|
+
* @export
|
|
887
|
+
* @interface AgencyHostingV1WebsitesBuilderWebsiteDetailsResource
|
|
888
|
+
*/
|
|
889
|
+
export interface AgencyHostingV1WebsitesBuilderWebsiteDetailsResource {
|
|
890
|
+
/**
|
|
891
|
+
* Builder ID
|
|
892
|
+
* @type {string}
|
|
893
|
+
* @memberof AgencyHostingV1WebsitesBuilderWebsiteDetailsResource
|
|
894
|
+
*/
|
|
895
|
+
'id': string | null;
|
|
896
|
+
/**
|
|
897
|
+
* Domain name
|
|
898
|
+
* @type {string}
|
|
899
|
+
* @memberof AgencyHostingV1WebsitesBuilderWebsiteDetailsResource
|
|
900
|
+
*/
|
|
901
|
+
'vhost': string;
|
|
902
|
+
/**
|
|
903
|
+
* Detected website type
|
|
904
|
+
* @type {string}
|
|
905
|
+
* @memberof AgencyHostingV1WebsitesBuilderWebsiteDetailsResource
|
|
906
|
+
*/
|
|
907
|
+
'type': string;
|
|
908
|
+
/**
|
|
909
|
+
* Account username
|
|
910
|
+
* @type {string}
|
|
911
|
+
* @memberof AgencyHostingV1WebsitesBuilderWebsiteDetailsResource
|
|
912
|
+
*/
|
|
913
|
+
'username': string;
|
|
914
|
+
/**
|
|
915
|
+
*
|
|
916
|
+
* @type {string}
|
|
917
|
+
* @memberof AgencyHostingV1WebsitesBuilderWebsiteDetailsResource
|
|
918
|
+
*/
|
|
919
|
+
'created_at': string;
|
|
920
|
+
}
|
|
865
921
|
/**
|
|
866
922
|
*
|
|
867
923
|
* @export
|
|
@@ -1037,6 +1093,136 @@ export interface AgencyHostingV1WebsitesDatabasesUsersCreateDatabaseUserRequest
|
|
|
1037
1093
|
*/
|
|
1038
1094
|
'host': string | null;
|
|
1039
1095
|
}
|
|
1096
|
+
/**
|
|
1097
|
+
*
|
|
1098
|
+
* @export
|
|
1099
|
+
* @interface AgencyHostingV1WebsitesH5gWebsiteDetailsResource
|
|
1100
|
+
*/
|
|
1101
|
+
export interface AgencyHostingV1WebsitesH5gWebsiteDetailsResource {
|
|
1102
|
+
/**
|
|
1103
|
+
* Website UID
|
|
1104
|
+
* @type {string}
|
|
1105
|
+
* @memberof AgencyHostingV1WebsitesH5gWebsiteDetailsResource
|
|
1106
|
+
*/
|
|
1107
|
+
'uid': string;
|
|
1108
|
+
/**
|
|
1109
|
+
* IPv4 address
|
|
1110
|
+
* @type {string}
|
|
1111
|
+
* @memberof AgencyHostingV1WebsitesH5gWebsiteDetailsResource
|
|
1112
|
+
*/
|
|
1113
|
+
'ipv4': string;
|
|
1114
|
+
/**
|
|
1115
|
+
* Setup flavor
|
|
1116
|
+
* @type {string}
|
|
1117
|
+
* @memberof AgencyHostingV1WebsitesH5gWebsiteDetailsResource
|
|
1118
|
+
*/
|
|
1119
|
+
'flavor': string;
|
|
1120
|
+
/**
|
|
1121
|
+
* Detected website type
|
|
1122
|
+
* @type {string}
|
|
1123
|
+
* @memberof AgencyHostingV1WebsitesH5gWebsiteDetailsResource
|
|
1124
|
+
*/
|
|
1125
|
+
'type': AgencyHostingV1WebsitesH5gWebsiteDetailsResourceTypeEnum;
|
|
1126
|
+
/**
|
|
1127
|
+
* Username for this order
|
|
1128
|
+
* @type {string}
|
|
1129
|
+
* @memberof AgencyHostingV1WebsitesH5gWebsiteDetailsResource
|
|
1130
|
+
*/
|
|
1131
|
+
'username': string;
|
|
1132
|
+
/**
|
|
1133
|
+
* Description
|
|
1134
|
+
* @type {string}
|
|
1135
|
+
* @memberof AgencyHostingV1WebsitesH5gWebsiteDetailsResource
|
|
1136
|
+
*/
|
|
1137
|
+
'description': string | null;
|
|
1138
|
+
/**
|
|
1139
|
+
* Website state
|
|
1140
|
+
* @type {string}
|
|
1141
|
+
* @memberof AgencyHostingV1WebsitesH5gWebsiteDetailsResource
|
|
1142
|
+
*/
|
|
1143
|
+
'state': AgencyHostingV1WebsitesH5gWebsiteDetailsResourceStateEnum;
|
|
1144
|
+
/**
|
|
1145
|
+
*
|
|
1146
|
+
* @type {string}
|
|
1147
|
+
* @memberof AgencyHostingV1WebsitesH5gWebsiteDetailsResource
|
|
1148
|
+
*/
|
|
1149
|
+
'created_at': string;
|
|
1150
|
+
/**
|
|
1151
|
+
* Website settings, e.g. PHP configuration
|
|
1152
|
+
* @type {object}
|
|
1153
|
+
* @memberof AgencyHostingV1WebsitesH5gWebsiteDetailsResource
|
|
1154
|
+
*/
|
|
1155
|
+
'settings': object;
|
|
1156
|
+
/**
|
|
1157
|
+
* WordPress installation details
|
|
1158
|
+
* @type {object}
|
|
1159
|
+
* @memberof AgencyHostingV1WebsitesH5gWebsiteDetailsResource
|
|
1160
|
+
*/
|
|
1161
|
+
'wordpress': object | null;
|
|
1162
|
+
/**
|
|
1163
|
+
* Website domains
|
|
1164
|
+
* @type {Array<object>}
|
|
1165
|
+
* @memberof AgencyHostingV1WebsitesH5gWebsiteDetailsResource
|
|
1166
|
+
*/
|
|
1167
|
+
'domains': Array<object>;
|
|
1168
|
+
/**
|
|
1169
|
+
* Preview domain
|
|
1170
|
+
* @type {object}
|
|
1171
|
+
* @memberof AgencyHostingV1WebsitesH5gWebsiteDetailsResource
|
|
1172
|
+
*/
|
|
1173
|
+
'preview_domain': object | null;
|
|
1174
|
+
/**
|
|
1175
|
+
* Ongoing website processes
|
|
1176
|
+
* @type {Array<object>}
|
|
1177
|
+
* @memberof AgencyHostingV1WebsitesH5gWebsiteDetailsResource
|
|
1178
|
+
*/
|
|
1179
|
+
'processes': Array<object>;
|
|
1180
|
+
/**
|
|
1181
|
+
* Horizons UUID (only for horizons websites)
|
|
1182
|
+
* @type {string}
|
|
1183
|
+
* @memberof AgencyHostingV1WebsitesH5gWebsiteDetailsResource
|
|
1184
|
+
*/
|
|
1185
|
+
'horizons_uuid': string | null;
|
|
1186
|
+
}
|
|
1187
|
+
export declare const AgencyHostingV1WebsitesH5gWebsiteDetailsResourceTypeEnum: {
|
|
1188
|
+
readonly Wordpress: "wordpress";
|
|
1189
|
+
readonly Builder: "builder";
|
|
1190
|
+
readonly Horizons: "horizons";
|
|
1191
|
+
readonly Nodejs: "nodejs";
|
|
1192
|
+
readonly U4s: "u4s";
|
|
1193
|
+
readonly Other: "other";
|
|
1194
|
+
};
|
|
1195
|
+
export type AgencyHostingV1WebsitesH5gWebsiteDetailsResourceTypeEnum = typeof AgencyHostingV1WebsitesH5gWebsiteDetailsResourceTypeEnum[keyof typeof AgencyHostingV1WebsitesH5gWebsiteDetailsResourceTypeEnum];
|
|
1196
|
+
export declare const AgencyHostingV1WebsitesH5gWebsiteDetailsResourceStateEnum: {
|
|
1197
|
+
readonly Active: "active";
|
|
1198
|
+
readonly Suspended: "suspended";
|
|
1199
|
+
};
|
|
1200
|
+
export type AgencyHostingV1WebsitesH5gWebsiteDetailsResourceStateEnum = typeof AgencyHostingV1WebsitesH5gWebsiteDetailsResourceStateEnum[keyof typeof AgencyHostingV1WebsitesH5gWebsiteDetailsResourceStateEnum];
|
|
1201
|
+
/**
|
|
1202
|
+
* Website plan details
|
|
1203
|
+
* @export
|
|
1204
|
+
* @interface AgencyHostingV1WebsitesPlanResource
|
|
1205
|
+
*/
|
|
1206
|
+
export interface AgencyHostingV1WebsitesPlanResource {
|
|
1207
|
+
/**
|
|
1208
|
+
*
|
|
1209
|
+
* @type {string}
|
|
1210
|
+
* @memberof AgencyHostingV1WebsitesPlanResource
|
|
1211
|
+
*/
|
|
1212
|
+
'name': string;
|
|
1213
|
+
/**
|
|
1214
|
+
*
|
|
1215
|
+
* @type {string}
|
|
1216
|
+
* @memberof AgencyHostingV1WebsitesPlanResource
|
|
1217
|
+
*/
|
|
1218
|
+
'display_name': string;
|
|
1219
|
+
/**
|
|
1220
|
+
*
|
|
1221
|
+
* @type {boolean}
|
|
1222
|
+
* @memberof AgencyHostingV1WebsitesPlanResource
|
|
1223
|
+
*/
|
|
1224
|
+
'has_cdn': boolean;
|
|
1225
|
+
}
|
|
1040
1226
|
/**
|
|
1041
1227
|
*
|
|
1042
1228
|
* @export
|
|
@@ -1062,6 +1248,72 @@ export interface AgencyHostingV1WebsitesSslCertResource {
|
|
|
1062
1248
|
*/
|
|
1063
1249
|
'created_at': string;
|
|
1064
1250
|
}
|
|
1251
|
+
/**
|
|
1252
|
+
*
|
|
1253
|
+
* @export
|
|
1254
|
+
* @interface AgencyHostingV1WebsitesU4sWebsiteDetailsResource
|
|
1255
|
+
*/
|
|
1256
|
+
export interface AgencyHostingV1WebsitesU4sWebsiteDetailsResource {
|
|
1257
|
+
/**
|
|
1258
|
+
* Application UUID
|
|
1259
|
+
* @type {string}
|
|
1260
|
+
* @memberof AgencyHostingV1WebsitesU4sWebsiteDetailsResource
|
|
1261
|
+
*/
|
|
1262
|
+
'uuid': string;
|
|
1263
|
+
/**
|
|
1264
|
+
* Application title
|
|
1265
|
+
* @type {string}
|
|
1266
|
+
* @memberof AgencyHostingV1WebsitesU4sWebsiteDetailsResource
|
|
1267
|
+
*/
|
|
1268
|
+
'title': string;
|
|
1269
|
+
/**
|
|
1270
|
+
* Application port
|
|
1271
|
+
* @type {number}
|
|
1272
|
+
* @memberof AgencyHostingV1WebsitesU4sWebsiteDetailsResource
|
|
1273
|
+
*/
|
|
1274
|
+
'port': number;
|
|
1275
|
+
/**
|
|
1276
|
+
* Detected website type
|
|
1277
|
+
* @type {string}
|
|
1278
|
+
* @memberof AgencyHostingV1WebsitesU4sWebsiteDetailsResource
|
|
1279
|
+
*/
|
|
1280
|
+
'type': AgencyHostingV1WebsitesU4sWebsiteDetailsResourceTypeEnum;
|
|
1281
|
+
/**
|
|
1282
|
+
* Application runtime
|
|
1283
|
+
* @type {string}
|
|
1284
|
+
* @memberof AgencyHostingV1WebsitesU4sWebsiteDetailsResource
|
|
1285
|
+
*/
|
|
1286
|
+
'runtime': string;
|
|
1287
|
+
/**
|
|
1288
|
+
* Application state
|
|
1289
|
+
* @type {string}
|
|
1290
|
+
* @memberof AgencyHostingV1WebsitesU4sWebsiteDetailsResource
|
|
1291
|
+
*/
|
|
1292
|
+
'state': string;
|
|
1293
|
+
/**
|
|
1294
|
+
* Application domains
|
|
1295
|
+
* @type {Array<object>}
|
|
1296
|
+
* @memberof AgencyHostingV1WebsitesU4sWebsiteDetailsResource
|
|
1297
|
+
*/
|
|
1298
|
+
'domains': Array<object>;
|
|
1299
|
+
/**
|
|
1300
|
+
* Horizons UUID
|
|
1301
|
+
* @type {string}
|
|
1302
|
+
* @memberof AgencyHostingV1WebsitesU4sWebsiteDetailsResource
|
|
1303
|
+
*/
|
|
1304
|
+
'horizons_uuid': string | null;
|
|
1305
|
+
/**
|
|
1306
|
+
* Preview domain
|
|
1307
|
+
* @type {object}
|
|
1308
|
+
* @memberof AgencyHostingV1WebsitesU4sWebsiteDetailsResource
|
|
1309
|
+
*/
|
|
1310
|
+
'preview_domain': object | null;
|
|
1311
|
+
}
|
|
1312
|
+
export declare const AgencyHostingV1WebsitesU4sWebsiteDetailsResourceTypeEnum: {
|
|
1313
|
+
readonly U4s: "u4s";
|
|
1314
|
+
readonly Horizons: "horizons";
|
|
1315
|
+
};
|
|
1316
|
+
export type AgencyHostingV1WebsitesU4sWebsiteDetailsResourceTypeEnum = typeof AgencyHostingV1WebsitesU4sWebsiteDetailsResourceTypeEnum[keyof typeof AgencyHostingV1WebsitesU4sWebsiteDetailsResourceTypeEnum];
|
|
1065
1317
|
/**
|
|
1066
1318
|
*
|
|
1067
1319
|
* @export
|
|
@@ -1111,6 +1363,79 @@ export interface AgencyHostingV1WebsitesWebsiteDomainDetailsResource {
|
|
|
1111
1363
|
*/
|
|
1112
1364
|
'custom_ssl_cert': AgencyHostingV1WebsitesCustomSslCertResource | null;
|
|
1113
1365
|
}
|
|
1366
|
+
/**
|
|
1367
|
+
* Website item. The `details` shape differs per platform — see the `platform` field.
|
|
1368
|
+
* @export
|
|
1369
|
+
* @interface AgencyHostingV1WebsitesWebsiteListItemResource
|
|
1370
|
+
*/
|
|
1371
|
+
export interface AgencyHostingV1WebsitesWebsiteListItemResource {
|
|
1372
|
+
/**
|
|
1373
|
+
*
|
|
1374
|
+
* @type {string}
|
|
1375
|
+
* @memberof AgencyHostingV1WebsitesWebsiteListItemResource
|
|
1376
|
+
*/
|
|
1377
|
+
'id': string;
|
|
1378
|
+
/**
|
|
1379
|
+
*
|
|
1380
|
+
* @type {number}
|
|
1381
|
+
* @memberof AgencyHostingV1WebsitesWebsiteListItemResource
|
|
1382
|
+
*/
|
|
1383
|
+
'client_id': number;
|
|
1384
|
+
/**
|
|
1385
|
+
*
|
|
1386
|
+
* @type {number}
|
|
1387
|
+
* @memberof AgencyHostingV1WebsitesWebsiteListItemResource
|
|
1388
|
+
*/
|
|
1389
|
+
'order_id': number;
|
|
1390
|
+
/**
|
|
1391
|
+
* Website platform
|
|
1392
|
+
* @type {string}
|
|
1393
|
+
* @memberof AgencyHostingV1WebsitesWebsiteListItemResource
|
|
1394
|
+
*/
|
|
1395
|
+
'platform': AgencyHostingV1WebsitesWebsiteListItemResourcePlatformEnum;
|
|
1396
|
+
/**
|
|
1397
|
+
* Website state
|
|
1398
|
+
* @type {string}
|
|
1399
|
+
* @memberof AgencyHostingV1WebsitesWebsiteListItemResource
|
|
1400
|
+
*/
|
|
1401
|
+
'state': string;
|
|
1402
|
+
/**
|
|
1403
|
+
*
|
|
1404
|
+
* @type {string}
|
|
1405
|
+
* @memberof AgencyHostingV1WebsitesWebsiteListItemResource
|
|
1406
|
+
*/
|
|
1407
|
+
'created_at': string;
|
|
1408
|
+
/**
|
|
1409
|
+
*
|
|
1410
|
+
* @type {AgencyHostingV1WebsitesPlanResource}
|
|
1411
|
+
* @memberof AgencyHostingV1WebsitesWebsiteListItemResource
|
|
1412
|
+
*/
|
|
1413
|
+
'plan': AgencyHostingV1WebsitesPlanResource;
|
|
1414
|
+
/**
|
|
1415
|
+
*
|
|
1416
|
+
* @type {AgencyHostingV1WebsitesWebsiteListItemResourceDetails}
|
|
1417
|
+
* @memberof AgencyHostingV1WebsitesWebsiteListItemResource
|
|
1418
|
+
*/
|
|
1419
|
+
'details': AgencyHostingV1WebsitesWebsiteListItemResourceDetails;
|
|
1420
|
+
/**
|
|
1421
|
+
* Reason for suspension, only populated for payment related suspensions
|
|
1422
|
+
* @type {string}
|
|
1423
|
+
* @memberof AgencyHostingV1WebsitesWebsiteListItemResource
|
|
1424
|
+
*/
|
|
1425
|
+
'suspension_reason': string | null;
|
|
1426
|
+
}
|
|
1427
|
+
export declare const AgencyHostingV1WebsitesWebsiteListItemResourcePlatformEnum: {
|
|
1428
|
+
readonly H5g: "h5g";
|
|
1429
|
+
readonly Builder: "builder";
|
|
1430
|
+
readonly U4s: "u4s";
|
|
1431
|
+
};
|
|
1432
|
+
export type AgencyHostingV1WebsitesWebsiteListItemResourcePlatformEnum = typeof AgencyHostingV1WebsitesWebsiteListItemResourcePlatformEnum[keyof typeof AgencyHostingV1WebsitesWebsiteListItemResourcePlatformEnum];
|
|
1433
|
+
/**
|
|
1434
|
+
* @type AgencyHostingV1WebsitesWebsiteListItemResourceDetails
|
|
1435
|
+
* Platform-specific website details. Shape depends on `platform`.
|
|
1436
|
+
* @export
|
|
1437
|
+
*/
|
|
1438
|
+
export type AgencyHostingV1WebsitesWebsiteListItemResourceDetails = AgencyHostingV1WebsitesBuilderWebsiteDetailsResource | AgencyHostingV1WebsitesH5gWebsiteDetailsResource | AgencyHostingV1WebsitesU4sWebsiteDetailsResource;
|
|
1114
1439
|
/**
|
|
1115
1440
|
*
|
|
1116
1441
|
* @export
|
|
@@ -5198,6 +5523,50 @@ export declare const HostingV1FilesFilesResourceItemsInnerTypeEnum: {
|
|
|
5198
5523
|
readonly Other: "other";
|
|
5199
5524
|
};
|
|
5200
5525
|
export type HostingV1FilesFilesResourceItemsInnerTypeEnum = typeof HostingV1FilesFilesResourceItemsInnerTypeEnum[keyof typeof HostingV1FilesFilesResourceItemsInnerTypeEnum];
|
|
5526
|
+
/**
|
|
5527
|
+
*
|
|
5528
|
+
* @export
|
|
5529
|
+
* @interface HostingV1FilesGenerateUploadUrlRequest
|
|
5530
|
+
*/
|
|
5531
|
+
export interface HostingV1FilesGenerateUploadUrlRequest {
|
|
5532
|
+
/**
|
|
5533
|
+
* Account username
|
|
5534
|
+
* @type {string}
|
|
5535
|
+
* @memberof HostingV1FilesGenerateUploadUrlRequest
|
|
5536
|
+
*/
|
|
5537
|
+
'username': string;
|
|
5538
|
+
/**
|
|
5539
|
+
* Website domain
|
|
5540
|
+
* @type {string}
|
|
5541
|
+
* @memberof HostingV1FilesGenerateUploadUrlRequest
|
|
5542
|
+
*/
|
|
5543
|
+
'domain': string;
|
|
5544
|
+
}
|
|
5545
|
+
/**
|
|
5546
|
+
*
|
|
5547
|
+
* @export
|
|
5548
|
+
* @interface HostingV1FilesUploadUrlResource
|
|
5549
|
+
*/
|
|
5550
|
+
export interface HostingV1FilesUploadUrlResource {
|
|
5551
|
+
/**
|
|
5552
|
+
* The TUS upload endpoint URL to send upload requests to
|
|
5553
|
+
* @type {string}
|
|
5554
|
+
* @memberof HostingV1FilesUploadUrlResource
|
|
5555
|
+
*/
|
|
5556
|
+
'url': string;
|
|
5557
|
+
/**
|
|
5558
|
+
* Authentication token to pass as the `X-Auth` header in TUS upload requests
|
|
5559
|
+
* @type {string}
|
|
5560
|
+
* @memberof HostingV1FilesUploadUrlResource
|
|
5561
|
+
*/
|
|
5562
|
+
'auth_key': string;
|
|
5563
|
+
/**
|
|
5564
|
+
* Authentication token to pass as the `X-Auth-Rest` header in TUS upload requests
|
|
5565
|
+
* @type {string}
|
|
5566
|
+
* @memberof HostingV1FilesUploadUrlResource
|
|
5567
|
+
*/
|
|
5568
|
+
'rest_auth_key': string;
|
|
5569
|
+
}
|
|
5201
5570
|
/**
|
|
5202
5571
|
*
|
|
5203
5572
|
* @export
|
|
@@ -5354,6 +5723,89 @@ export declare const HostingV1NodeJsBuildResourceStateEnum: {
|
|
|
5354
5723
|
readonly Failed: "failed";
|
|
5355
5724
|
};
|
|
5356
5725
|
export type HostingV1NodeJsBuildResourceStateEnum = typeof HostingV1NodeJsBuildResourceStateEnum[keyof typeof HostingV1NodeJsBuildResourceStateEnum];
|
|
5726
|
+
/**
|
|
5727
|
+
*
|
|
5728
|
+
* @export
|
|
5729
|
+
* @interface HostingV1NodeJsBuildSettingsResource
|
|
5730
|
+
*/
|
|
5731
|
+
export interface HostingV1NodeJsBuildSettingsResource {
|
|
5732
|
+
/**
|
|
5733
|
+
* Node.js application type
|
|
5734
|
+
* @type {string}
|
|
5735
|
+
* @memberof HostingV1NodeJsBuildSettingsResource
|
|
5736
|
+
*/
|
|
5737
|
+
'app_type': HostingV1NodeJsBuildSettingsResourceAppTypeEnum | null;
|
|
5738
|
+
/**
|
|
5739
|
+
* Node.js version
|
|
5740
|
+
* @type {number}
|
|
5741
|
+
* @memberof HostingV1NodeJsBuildSettingsResource
|
|
5742
|
+
*/
|
|
5743
|
+
'node_version': number | null;
|
|
5744
|
+
/**
|
|
5745
|
+
* Application root directory
|
|
5746
|
+
* @type {string}
|
|
5747
|
+
* @memberof HostingV1NodeJsBuildSettingsResource
|
|
5748
|
+
*/
|
|
5749
|
+
'root_directory': string | null;
|
|
5750
|
+
/**
|
|
5751
|
+
* Build output directory
|
|
5752
|
+
* @type {string}
|
|
5753
|
+
* @memberof HostingV1NodeJsBuildSettingsResource
|
|
5754
|
+
*/
|
|
5755
|
+
'output_directory': string | null;
|
|
5756
|
+
/**
|
|
5757
|
+
* The npm script to run to build the application
|
|
5758
|
+
* @type {string}
|
|
5759
|
+
* @memberof HostingV1NodeJsBuildSettingsResource
|
|
5760
|
+
*/
|
|
5761
|
+
'build_script': string | null;
|
|
5762
|
+
/**
|
|
5763
|
+
* The main entry point file for the application
|
|
5764
|
+
* @type {string}
|
|
5765
|
+
* @memberof HostingV1NodeJsBuildSettingsResource
|
|
5766
|
+
*/
|
|
5767
|
+
'entry_file': string | null;
|
|
5768
|
+
/**
|
|
5769
|
+
* Package manager
|
|
5770
|
+
* @type {string}
|
|
5771
|
+
* @memberof HostingV1NodeJsBuildSettingsResource
|
|
5772
|
+
*/
|
|
5773
|
+
'package_manager': HostingV1NodeJsBuildSettingsResourcePackageManagerEnum | null;
|
|
5774
|
+
/**
|
|
5775
|
+
* The scripts configured in the package.json file
|
|
5776
|
+
* @type {Array<string>}
|
|
5777
|
+
* @memberof HostingV1NodeJsBuildSettingsResource
|
|
5778
|
+
*/
|
|
5779
|
+
'available_scripts': Array<string>;
|
|
5780
|
+
}
|
|
5781
|
+
export declare const HostingV1NodeJsBuildSettingsResourceAppTypeEnum: {
|
|
5782
|
+
readonly CreateReactApp: "create-react-app";
|
|
5783
|
+
readonly Gatsby: "gatsby";
|
|
5784
|
+
readonly Vite: "vite";
|
|
5785
|
+
readonly Angular: "angular";
|
|
5786
|
+
readonly React: "react";
|
|
5787
|
+
readonly Vue: "vue";
|
|
5788
|
+
readonly Parcel: "parcel";
|
|
5789
|
+
readonly Next: "next";
|
|
5790
|
+
readonly Nuxt: "nuxt";
|
|
5791
|
+
readonly Nest: "nest";
|
|
5792
|
+
readonly Express: "express";
|
|
5793
|
+
readonly Fastify: "fastify";
|
|
5794
|
+
readonly Astro: "astro";
|
|
5795
|
+
readonly Svelte: "svelte";
|
|
5796
|
+
readonly SvelteKit: "svelte-kit";
|
|
5797
|
+
readonly Hono: "hono";
|
|
5798
|
+
readonly ReactRouter: "react-router";
|
|
5799
|
+
readonly Nitro: "nitro";
|
|
5800
|
+
readonly Other: "other";
|
|
5801
|
+
};
|
|
5802
|
+
export type HostingV1NodeJsBuildSettingsResourceAppTypeEnum = typeof HostingV1NodeJsBuildSettingsResourceAppTypeEnum[keyof typeof HostingV1NodeJsBuildSettingsResourceAppTypeEnum];
|
|
5803
|
+
export declare const HostingV1NodeJsBuildSettingsResourcePackageManagerEnum: {
|
|
5804
|
+
readonly Npm: "npm";
|
|
5805
|
+
readonly Yarn: "yarn";
|
|
5806
|
+
readonly Pnpm: "pnpm";
|
|
5807
|
+
};
|
|
5808
|
+
export type HostingV1NodeJsBuildSettingsResourcePackageManagerEnum = typeof HostingV1NodeJsBuildSettingsResourcePackageManagerEnum[keyof typeof HostingV1NodeJsBuildSettingsResourcePackageManagerEnum];
|
|
5357
5809
|
/**
|
|
5358
5810
|
*
|
|
5359
5811
|
* @export
|
|
@@ -5444,6 +5896,19 @@ export declare const HostingV1NodeJsCreateFromArchiveRequestPackageManagerEnum:
|
|
|
5444
5896
|
readonly Pnpm: "pnpm";
|
|
5445
5897
|
};
|
|
5446
5898
|
export type HostingV1NodeJsCreateFromArchiveRequestPackageManagerEnum = typeof HostingV1NodeJsCreateFromArchiveRequestPackageManagerEnum[keyof typeof HostingV1NodeJsCreateFromArchiveRequestPackageManagerEnum];
|
|
5899
|
+
/**
|
|
5900
|
+
*
|
|
5901
|
+
* @export
|
|
5902
|
+
* @interface HostingV1NodeJsGetBuildSettingsRequest
|
|
5903
|
+
*/
|
|
5904
|
+
export interface HostingV1NodeJsGetBuildSettingsRequest {
|
|
5905
|
+
/**
|
|
5906
|
+
* The path to the archive file relative to the document root of the vhost
|
|
5907
|
+
* @type {string}
|
|
5908
|
+
* @memberof HostingV1NodeJsGetBuildSettingsRequest
|
|
5909
|
+
*/
|
|
5910
|
+
'archive_path': string;
|
|
5911
|
+
}
|
|
5447
5912
|
/**
|
|
5448
5913
|
*
|
|
5449
5914
|
* @export
|
|
@@ -5501,6 +5966,119 @@ export interface HostingV1NodeJsSourceOptionsResource {
|
|
|
5501
5966
|
*/
|
|
5502
5967
|
'archive_path': string | null;
|
|
5503
5968
|
}
|
|
5969
|
+
/**
|
|
5970
|
+
*
|
|
5971
|
+
* @export
|
|
5972
|
+
* @interface HostingV1NodeJsStartBuildRequest
|
|
5973
|
+
*/
|
|
5974
|
+
export interface HostingV1NodeJsStartBuildRequest {
|
|
5975
|
+
/**
|
|
5976
|
+
* Node.js version
|
|
5977
|
+
* @type {number}
|
|
5978
|
+
* @memberof HostingV1NodeJsStartBuildRequest
|
|
5979
|
+
*/
|
|
5980
|
+
'node_version': HostingV1NodeJsStartBuildRequestNodeVersionEnum;
|
|
5981
|
+
/**
|
|
5982
|
+
* Node.js application type
|
|
5983
|
+
* @type {string}
|
|
5984
|
+
* @memberof HostingV1NodeJsStartBuildRequest
|
|
5985
|
+
*/
|
|
5986
|
+
'app_type': HostingV1NodeJsStartBuildRequestAppTypeEnum | null;
|
|
5987
|
+
/**
|
|
5988
|
+
* Application root directory (where package.json is located) relative to public_html
|
|
5989
|
+
* @type {string}
|
|
5990
|
+
* @memberof HostingV1NodeJsStartBuildRequest
|
|
5991
|
+
*/
|
|
5992
|
+
'root_directory': string | null;
|
|
5993
|
+
/**
|
|
5994
|
+
* Build output directory relative to the root directory
|
|
5995
|
+
* @type {string}
|
|
5996
|
+
* @memberof HostingV1NodeJsStartBuildRequest
|
|
5997
|
+
*/
|
|
5998
|
+
'output_directory': string | null;
|
|
5999
|
+
/**
|
|
6000
|
+
* Build script that will be ran to build the application
|
|
6001
|
+
* @type {string}
|
|
6002
|
+
* @memberof HostingV1NodeJsStartBuildRequest
|
|
6003
|
+
*/
|
|
6004
|
+
'build_script': string | null;
|
|
6005
|
+
/**
|
|
6006
|
+
* The main entry point file for the application
|
|
6007
|
+
* @type {string}
|
|
6008
|
+
* @memberof HostingV1NodeJsStartBuildRequest
|
|
6009
|
+
*/
|
|
6010
|
+
'entry_file': string | null;
|
|
6011
|
+
/**
|
|
6012
|
+
* Package manager
|
|
6013
|
+
* @type {string}
|
|
6014
|
+
* @memberof HostingV1NodeJsStartBuildRequest
|
|
6015
|
+
*/
|
|
6016
|
+
'package_manager': HostingV1NodeJsStartBuildRequestPackageManagerEnum | null;
|
|
6017
|
+
/**
|
|
6018
|
+
* The source type of the files
|
|
6019
|
+
* @type {string}
|
|
6020
|
+
* @memberof HostingV1NodeJsStartBuildRequest
|
|
6021
|
+
*/
|
|
6022
|
+
'source_type': HostingV1NodeJsStartBuildRequestSourceTypeEnum;
|
|
6023
|
+
/**
|
|
6024
|
+
*
|
|
6025
|
+
* @type {HostingV1NodeJsStartBuildRequestSourceOptions}
|
|
6026
|
+
* @memberof HostingV1NodeJsStartBuildRequest
|
|
6027
|
+
*/
|
|
6028
|
+
'source_options': HostingV1NodeJsStartBuildRequestSourceOptions | null;
|
|
6029
|
+
}
|
|
6030
|
+
export declare const HostingV1NodeJsStartBuildRequestNodeVersionEnum: {
|
|
6031
|
+
readonly NUMBER_18: 18;
|
|
6032
|
+
readonly NUMBER_20: 20;
|
|
6033
|
+
readonly NUMBER_22: 22;
|
|
6034
|
+
readonly NUMBER_24: 24;
|
|
6035
|
+
};
|
|
6036
|
+
export type HostingV1NodeJsStartBuildRequestNodeVersionEnum = typeof HostingV1NodeJsStartBuildRequestNodeVersionEnum[keyof typeof HostingV1NodeJsStartBuildRequestNodeVersionEnum];
|
|
6037
|
+
export declare const HostingV1NodeJsStartBuildRequestAppTypeEnum: {
|
|
6038
|
+
readonly CreateReactApp: "create-react-app";
|
|
6039
|
+
readonly Gatsby: "gatsby";
|
|
6040
|
+
readonly Vite: "vite";
|
|
6041
|
+
readonly Angular: "angular";
|
|
6042
|
+
readonly React: "react";
|
|
6043
|
+
readonly Vue: "vue";
|
|
6044
|
+
readonly Parcel: "parcel";
|
|
6045
|
+
readonly Next: "next";
|
|
6046
|
+
readonly Nuxt: "nuxt";
|
|
6047
|
+
readonly Nest: "nest";
|
|
6048
|
+
readonly Express: "express";
|
|
6049
|
+
readonly Fastify: "fastify";
|
|
6050
|
+
readonly Astro: "astro";
|
|
6051
|
+
readonly Svelte: "svelte";
|
|
6052
|
+
readonly SvelteKit: "svelte-kit";
|
|
6053
|
+
readonly Hono: "hono";
|
|
6054
|
+
readonly ReactRouter: "react-router";
|
|
6055
|
+
readonly Nitro: "nitro";
|
|
6056
|
+
readonly Other: "other";
|
|
6057
|
+
};
|
|
6058
|
+
export type HostingV1NodeJsStartBuildRequestAppTypeEnum = typeof HostingV1NodeJsStartBuildRequestAppTypeEnum[keyof typeof HostingV1NodeJsStartBuildRequestAppTypeEnum];
|
|
6059
|
+
export declare const HostingV1NodeJsStartBuildRequestPackageManagerEnum: {
|
|
6060
|
+
readonly Npm: "npm";
|
|
6061
|
+
readonly Yarn: "yarn";
|
|
6062
|
+
readonly Pnpm: "pnpm";
|
|
6063
|
+
};
|
|
6064
|
+
export type HostingV1NodeJsStartBuildRequestPackageManagerEnum = typeof HostingV1NodeJsStartBuildRequestPackageManagerEnum[keyof typeof HostingV1NodeJsStartBuildRequestPackageManagerEnum];
|
|
6065
|
+
export declare const HostingV1NodeJsStartBuildRequestSourceTypeEnum: {
|
|
6066
|
+
readonly Archive: "archive";
|
|
6067
|
+
};
|
|
6068
|
+
export type HostingV1NodeJsStartBuildRequestSourceTypeEnum = typeof HostingV1NodeJsStartBuildRequestSourceTypeEnum[keyof typeof HostingV1NodeJsStartBuildRequestSourceTypeEnum];
|
|
6069
|
+
/**
|
|
6070
|
+
* Source-specific options
|
|
6071
|
+
* @export
|
|
6072
|
+
* @interface HostingV1NodeJsStartBuildRequestSourceOptions
|
|
6073
|
+
*/
|
|
6074
|
+
export interface HostingV1NodeJsStartBuildRequestSourceOptions {
|
|
6075
|
+
/**
|
|
6076
|
+
* The path to the archive file relative to the document root of the vhost (required if source is \"archive\")
|
|
6077
|
+
* @type {string}
|
|
6078
|
+
* @memberof HostingV1NodeJsStartBuildRequestSourceOptions
|
|
6079
|
+
*/
|
|
6080
|
+
'archive_path': string;
|
|
6081
|
+
}
|
|
5504
6082
|
/**
|
|
5505
6083
|
*
|
|
5506
6084
|
* @export
|
|
@@ -5910,6 +6488,19 @@ export interface HostingV1WebsitesCreateWebsiteRequest {
|
|
|
5910
6488
|
*/
|
|
5911
6489
|
'datacenter_code': string | null;
|
|
5912
6490
|
}
|
|
6491
|
+
/**
|
|
6492
|
+
*
|
|
6493
|
+
* @export
|
|
6494
|
+
* @interface HostingV1WebsitesDeployArchiveRequest
|
|
6495
|
+
*/
|
|
6496
|
+
export interface HostingV1WebsitesDeployArchiveRequest {
|
|
6497
|
+
/**
|
|
6498
|
+
* Relative path to the archive file from website root directory
|
|
6499
|
+
* @type {string}
|
|
6500
|
+
* @memberof HostingV1WebsitesDeployArchiveRequest
|
|
6501
|
+
*/
|
|
6502
|
+
'archive_path': string;
|
|
6503
|
+
}
|
|
5913
6504
|
/**
|
|
5914
6505
|
*
|
|
5915
6506
|
* @export
|
|
@@ -11972,6 +12563,25 @@ export interface WordPressV1InstallationsDeleteInstallationRequest {
|
|
|
11972
12563
|
*/
|
|
11973
12564
|
'delete_database': boolean;
|
|
11974
12565
|
}
|
|
12566
|
+
/**
|
|
12567
|
+
*
|
|
12568
|
+
* @export
|
|
12569
|
+
* @interface WordPressV1InstallationsImportWordPressRequest
|
|
12570
|
+
*/
|
|
12571
|
+
export interface WordPressV1InstallationsImportWordPressRequest {
|
|
12572
|
+
/**
|
|
12573
|
+
* Path to the WordPress archive file (relative to website root)
|
|
12574
|
+
* @type {string}
|
|
12575
|
+
* @memberof WordPressV1InstallationsImportWordPressRequest
|
|
12576
|
+
*/
|
|
12577
|
+
'archive_path': string;
|
|
12578
|
+
/**
|
|
12579
|
+
* Path to the database SQL file (relative to website root)
|
|
12580
|
+
* @type {string}
|
|
12581
|
+
* @memberof WordPressV1InstallationsImportWordPressRequest
|
|
12582
|
+
*/
|
|
12583
|
+
'sql_path': string;
|
|
12584
|
+
}
|
|
11975
12585
|
/**
|
|
11976
12586
|
*
|
|
11977
12587
|
* @export
|
|
@@ -12526,7 +13136,26 @@ export interface WordPressV1PluginsDeactivatePluginRequest {
|
|
|
12526
13136
|
* @type {string}
|
|
12527
13137
|
* @memberof WordPressV1PluginsDeactivatePluginRequest
|
|
12528
13138
|
*/
|
|
12529
|
-
'plugin': string;
|
|
13139
|
+
'plugin': string;
|
|
13140
|
+
}
|
|
13141
|
+
/**
|
|
13142
|
+
*
|
|
13143
|
+
* @export
|
|
13144
|
+
* @interface WordPressV1PluginsDeployPluginRequest
|
|
13145
|
+
*/
|
|
13146
|
+
export interface WordPressV1PluginsDeployPluginRequest {
|
|
13147
|
+
/**
|
|
13148
|
+
* Slug of the plugin
|
|
13149
|
+
* @type {string}
|
|
13150
|
+
* @memberof WordPressV1PluginsDeployPluginRequest
|
|
13151
|
+
*/
|
|
13152
|
+
'slug': string;
|
|
13153
|
+
/**
|
|
13154
|
+
* Relative path to the plugin directory from wp-content/plugins
|
|
13155
|
+
* @type {string}
|
|
13156
|
+
* @memberof WordPressV1PluginsDeployPluginRequest
|
|
13157
|
+
*/
|
|
13158
|
+
'plugin_path': string;
|
|
12530
13159
|
}
|
|
12531
13160
|
/**
|
|
12532
13161
|
*
|
|
@@ -12814,6 +13443,31 @@ export interface WordPressV1ThemesActivateThemeRequest {
|
|
|
12814
13443
|
*/
|
|
12815
13444
|
'theme': string;
|
|
12816
13445
|
}
|
|
13446
|
+
/**
|
|
13447
|
+
*
|
|
13448
|
+
* @export
|
|
13449
|
+
* @interface WordPressV1ThemesDeployThemeRequest
|
|
13450
|
+
*/
|
|
13451
|
+
export interface WordPressV1ThemesDeployThemeRequest {
|
|
13452
|
+
/**
|
|
13453
|
+
* Slug of the theme
|
|
13454
|
+
* @type {string}
|
|
13455
|
+
* @memberof WordPressV1ThemesDeployThemeRequest
|
|
13456
|
+
*/
|
|
13457
|
+
'slug': string;
|
|
13458
|
+
/**
|
|
13459
|
+
* Relative path to the theme directory from wp-content/themes
|
|
13460
|
+
* @type {string}
|
|
13461
|
+
* @memberof WordPressV1ThemesDeployThemeRequest
|
|
13462
|
+
*/
|
|
13463
|
+
'theme_path': string;
|
|
13464
|
+
/**
|
|
13465
|
+
* Whether to activate the theme after deployment
|
|
13466
|
+
* @type {boolean}
|
|
13467
|
+
* @memberof WordPressV1ThemesDeployThemeRequest
|
|
13468
|
+
*/
|
|
13469
|
+
'is_activated': boolean | null;
|
|
13470
|
+
}
|
|
12817
13471
|
/**
|
|
12818
13472
|
*
|
|
12819
13473
|
* @export
|
|
@@ -13652,6 +14306,14 @@ export declare class AgencyHostingDomainsApi extends BaseAPI {
|
|
|
13652
14306
|
* @export
|
|
13653
14307
|
*/
|
|
13654
14308
|
export declare const AgencyHostingFilesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
14309
|
+
/**
|
|
14310
|
+
* Generate a file browser upload URL with authentication credentials for uploading files to an Agency Plan website\'s file storage. Returns `url`, `auth_key` and `rest_auth_key`. Use these to upload a file to the website\'s file storage via the TUS resumable upload protocol (TUS 1.0.0). Send `X-Auth: {auth_key}` and `X-Auth-Rest: {rest_auth_key}` headers on every request below. 1. Create the upload: `POST` to `{url}/{relative_file_path}?override=true` with headers `upload-length: {file size in bytes}` and `upload-offset: 0`. Expect `201 Created`. 2. Upload the file: send the file bytes to the same location (any TUS 1.0.0 client, or `PATCH` requests with an `upload-offset` header tracking progress) until complete. `relative_file_path` is the destination path inside the website\'s file storage, e.g. `app.zip`. Instead of a TUS client, plain `curl` also works: ``` FILE=app.zip SIZE=$(stat -f%z \"$FILE\") # stat -c%s on Linux curl -i -X POST \"{url}/${FILE}?override=true\" \\ -H \"X-Auth: {auth_key}\" \\ -H \"X-Auth-Rest: {rest_auth_key}\" \\ -H \"Tus-Resumable: 1.0.0\" \\ -H \"Upload-Length: ${SIZE}\" \\ -H \"Upload-Offset: 0\" # -> 201 Created curl -i -X PATCH \"{url}/${FILE}?override=true\" \\ -H \"X-Auth: {auth_key}\" \\ -H \"X-Auth-Rest: {rest_auth_key}\" \\ -H \"Tus-Resumable: 1.0.0\" \\ -H \"Content-Type: application/offset+octet-stream\" \\ -H \"Upload-Offset: 0\" \\ --data-binary \"@${FILE}\" # -> 204 No Content, Upload-Offset response header equals SIZE when done ```
|
|
14311
|
+
* @summary Generate upload URL
|
|
14312
|
+
* @param {string} websiteUid Agency Plan website UID
|
|
14313
|
+
* @param {*} [options] Override http request option.
|
|
14314
|
+
* @throws {RequiredError}
|
|
14315
|
+
*/
|
|
14316
|
+
generateUploadURLV1: (websiteUid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
13655
14317
|
/**
|
|
13656
14318
|
* Imports an Agency Plan website from an already-uploaded archive. Upload the archive to the website\'s root directory via file browser first, then provide its filename in this request. Website contents are overwritten by the archive contents. Supported archive types: .zip, .tar, .tar.gz, .tgz.
|
|
13657
14319
|
* @summary Import website from archive
|
|
@@ -13667,6 +14329,14 @@ export declare const AgencyHostingFilesApiAxiosParamCreator: (configuration?: Co
|
|
|
13667
14329
|
* @export
|
|
13668
14330
|
*/
|
|
13669
14331
|
export declare const AgencyHostingFilesApiFp: (configuration?: Configuration) => {
|
|
14332
|
+
/**
|
|
14333
|
+
* Generate a file browser upload URL with authentication credentials for uploading files to an Agency Plan website\'s file storage. Returns `url`, `auth_key` and `rest_auth_key`. Use these to upload a file to the website\'s file storage via the TUS resumable upload protocol (TUS 1.0.0). Send `X-Auth: {auth_key}` and `X-Auth-Rest: {rest_auth_key}` headers on every request below. 1. Create the upload: `POST` to `{url}/{relative_file_path}?override=true` with headers `upload-length: {file size in bytes}` and `upload-offset: 0`. Expect `201 Created`. 2. Upload the file: send the file bytes to the same location (any TUS 1.0.0 client, or `PATCH` requests with an `upload-offset` header tracking progress) until complete. `relative_file_path` is the destination path inside the website\'s file storage, e.g. `app.zip`. Instead of a TUS client, plain `curl` also works: ``` FILE=app.zip SIZE=$(stat -f%z \"$FILE\") # stat -c%s on Linux curl -i -X POST \"{url}/${FILE}?override=true\" \\ -H \"X-Auth: {auth_key}\" \\ -H \"X-Auth-Rest: {rest_auth_key}\" \\ -H \"Tus-Resumable: 1.0.0\" \\ -H \"Upload-Length: ${SIZE}\" \\ -H \"Upload-Offset: 0\" # -> 201 Created curl -i -X PATCH \"{url}/${FILE}?override=true\" \\ -H \"X-Auth: {auth_key}\" \\ -H \"X-Auth-Rest: {rest_auth_key}\" \\ -H \"Tus-Resumable: 1.0.0\" \\ -H \"Content-Type: application/offset+octet-stream\" \\ -H \"Upload-Offset: 0\" \\ --data-binary \"@${FILE}\" # -> 204 No Content, Upload-Offset response header equals SIZE when done ```
|
|
14334
|
+
* @summary Generate upload URL
|
|
14335
|
+
* @param {string} websiteUid Agency Plan website UID
|
|
14336
|
+
* @param {*} [options] Override http request option.
|
|
14337
|
+
* @throws {RequiredError}
|
|
14338
|
+
*/
|
|
14339
|
+
generateUploadURLV1(websiteUid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AgencyHostingV1FilesUploadUrlResource>>;
|
|
13670
14340
|
/**
|
|
13671
14341
|
* Imports an Agency Plan website from an already-uploaded archive. Upload the archive to the website\'s root directory via file browser first, then provide its filename in this request. Website contents are overwritten by the archive contents. Supported archive types: .zip, .tar, .tar.gz, .tgz.
|
|
13672
14342
|
* @summary Import website from archive
|
|
@@ -13682,6 +14352,14 @@ export declare const AgencyHostingFilesApiFp: (configuration?: Configuration) =>
|
|
|
13682
14352
|
* @export
|
|
13683
14353
|
*/
|
|
13684
14354
|
export declare const AgencyHostingFilesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
14355
|
+
/**
|
|
14356
|
+
* Generate a file browser upload URL with authentication credentials for uploading files to an Agency Plan website\'s file storage. Returns `url`, `auth_key` and `rest_auth_key`. Use these to upload a file to the website\'s file storage via the TUS resumable upload protocol (TUS 1.0.0). Send `X-Auth: {auth_key}` and `X-Auth-Rest: {rest_auth_key}` headers on every request below. 1. Create the upload: `POST` to `{url}/{relative_file_path}?override=true` with headers `upload-length: {file size in bytes}` and `upload-offset: 0`. Expect `201 Created`. 2. Upload the file: send the file bytes to the same location (any TUS 1.0.0 client, or `PATCH` requests with an `upload-offset` header tracking progress) until complete. `relative_file_path` is the destination path inside the website\'s file storage, e.g. `app.zip`. Instead of a TUS client, plain `curl` also works: ``` FILE=app.zip SIZE=$(stat -f%z \"$FILE\") # stat -c%s on Linux curl -i -X POST \"{url}/${FILE}?override=true\" \\ -H \"X-Auth: {auth_key}\" \\ -H \"X-Auth-Rest: {rest_auth_key}\" \\ -H \"Tus-Resumable: 1.0.0\" \\ -H \"Upload-Length: ${SIZE}\" \\ -H \"Upload-Offset: 0\" # -> 201 Created curl -i -X PATCH \"{url}/${FILE}?override=true\" \\ -H \"X-Auth: {auth_key}\" \\ -H \"X-Auth-Rest: {rest_auth_key}\" \\ -H \"Tus-Resumable: 1.0.0\" \\ -H \"Content-Type: application/offset+octet-stream\" \\ -H \"Upload-Offset: 0\" \\ --data-binary \"@${FILE}\" # -> 204 No Content, Upload-Offset response header equals SIZE when done ```
|
|
14357
|
+
* @summary Generate upload URL
|
|
14358
|
+
* @param {string} websiteUid Agency Plan website UID
|
|
14359
|
+
* @param {*} [options] Override http request option.
|
|
14360
|
+
* @throws {RequiredError}
|
|
14361
|
+
*/
|
|
14362
|
+
generateUploadURLV1(websiteUid: string, options?: RawAxiosRequestConfig): AxiosPromise<AgencyHostingV1FilesUploadUrlResource>;
|
|
13685
14363
|
/**
|
|
13686
14364
|
* Imports an Agency Plan website from an already-uploaded archive. Upload the archive to the website\'s root directory via file browser first, then provide its filename in this request. Website contents are overwritten by the archive contents. Supported archive types: .zip, .tar, .tar.gz, .tgz.
|
|
13687
14365
|
* @summary Import website from archive
|
|
@@ -13699,6 +14377,15 @@ export declare const AgencyHostingFilesApiFactory: (configuration?: Configuratio
|
|
|
13699
14377
|
* @extends {BaseAPI}
|
|
13700
14378
|
*/
|
|
13701
14379
|
export declare class AgencyHostingFilesApi extends BaseAPI {
|
|
14380
|
+
/**
|
|
14381
|
+
* Generate a file browser upload URL with authentication credentials for uploading files to an Agency Plan website\'s file storage. Returns `url`, `auth_key` and `rest_auth_key`. Use these to upload a file to the website\'s file storage via the TUS resumable upload protocol (TUS 1.0.0). Send `X-Auth: {auth_key}` and `X-Auth-Rest: {rest_auth_key}` headers on every request below. 1. Create the upload: `POST` to `{url}/{relative_file_path}?override=true` with headers `upload-length: {file size in bytes}` and `upload-offset: 0`. Expect `201 Created`. 2. Upload the file: send the file bytes to the same location (any TUS 1.0.0 client, or `PATCH` requests with an `upload-offset` header tracking progress) until complete. `relative_file_path` is the destination path inside the website\'s file storage, e.g. `app.zip`. Instead of a TUS client, plain `curl` also works: ``` FILE=app.zip SIZE=$(stat -f%z \"$FILE\") # stat -c%s on Linux curl -i -X POST \"{url}/${FILE}?override=true\" \\ -H \"X-Auth: {auth_key}\" \\ -H \"X-Auth-Rest: {rest_auth_key}\" \\ -H \"Tus-Resumable: 1.0.0\" \\ -H \"Upload-Length: ${SIZE}\" \\ -H \"Upload-Offset: 0\" # -> 201 Created curl -i -X PATCH \"{url}/${FILE}?override=true\" \\ -H \"X-Auth: {auth_key}\" \\ -H \"X-Auth-Rest: {rest_auth_key}\" \\ -H \"Tus-Resumable: 1.0.0\" \\ -H \"Content-Type: application/offset+octet-stream\" \\ -H \"Upload-Offset: 0\" \\ --data-binary \"@${FILE}\" # -> 204 No Content, Upload-Offset response header equals SIZE when done ```
|
|
14382
|
+
* @summary Generate upload URL
|
|
14383
|
+
* @param {string} websiteUid Agency Plan website UID
|
|
14384
|
+
* @param {*} [options] Override http request option.
|
|
14385
|
+
* @throws {RequiredError}
|
|
14386
|
+
* @memberof AgencyHostingFilesApi
|
|
14387
|
+
*/
|
|
14388
|
+
generateUploadURLV1(websiteUid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AgencyHostingV1FilesUploadUrlResource, any, {}, any>>;
|
|
13702
14389
|
/**
|
|
13703
14390
|
* Imports an Agency Plan website from an already-uploaded archive. Upload the archive to the website\'s root directory via file browser first, then provide its filename in this request. Website contents are overwritten by the archive contents. Supported archive types: .zip, .tar, .tar.gz, .tgz.
|
|
13704
14391
|
* @summary Import website from archive
|
|
@@ -14293,6 +14980,19 @@ export declare const AgencyHostingWebsitesApiAxiosParamCreator: (configuration?:
|
|
|
14293
14980
|
* @throws {RequiredError}
|
|
14294
14981
|
*/
|
|
14295
14982
|
getWebsiteDetailsV1: (websiteUid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14983
|
+
/**
|
|
14984
|
+
* Retrieve a paginated list of Agency Plan websites (H5G, Builder, and Horizons) accessible to the authenticated client. This endpoint returns websites from your hosting accounts as well as websites from other client hosting accounts that have shared access with you. The response shape differs per platform — see the `platform` field on each item. Use `website_types` to list only websites of a given detected type, e.g. only WordPress websites (`website_types=wordpress`) or only Node.js websites (`website_types=nodejs`). Combine with `order_ids`, `states`, or `domain` for more targeted results.
|
|
14985
|
+
* @summary List Agency Plan websites
|
|
14986
|
+
* @param {number} [page] Page number
|
|
14987
|
+
* @param {number} [perPage] Number of items per page
|
|
14988
|
+
* @param {Array<number> | null} [orderIds] Filter by order IDs. Accepts a comma-separated list.
|
|
14989
|
+
* @param {Array<ListAgencyPlanWebsitesV1StatesEnum>} [states] Filter by website state. Accepts a comma-separated list.
|
|
14990
|
+
* @param {Array<ListAgencyPlanWebsitesV1WebsiteTypesEnum>} [websiteTypes] Filter by detected website type, e.g. wordpress,nodejs. Accepts a comma-separated list.
|
|
14991
|
+
* @param {string | null} [domain] Filter by domain name (case-insensitive substring match)
|
|
14992
|
+
* @param {*} [options] Override http request option.
|
|
14993
|
+
* @throws {RequiredError}
|
|
14994
|
+
*/
|
|
14995
|
+
listAgencyPlanWebsitesV1: (page?: number, perPage?: number, orderIds?: Array<number> | null, states?: Array<ListAgencyPlanWebsitesV1StatesEnum>, websiteTypes?: Array<ListAgencyPlanWebsitesV1WebsiteTypesEnum>, domain?: string | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14296
14996
|
/**
|
|
14297
14997
|
* Lists active and recently completed asynchronous processes for an Agency Plan website. Each process has a unique ID (for tracking), a type, and a status (running, completed, failed). Poll this endpoint after initiating async operations (SSL setup, backups, cloning) to track progress.
|
|
14298
14998
|
* @summary List website processes
|
|
@@ -14332,6 +15032,19 @@ export declare const AgencyHostingWebsitesApiFp: (configuration?: Configuration)
|
|
|
14332
15032
|
* @throws {RequiredError}
|
|
14333
15033
|
*/
|
|
14334
15034
|
getWebsiteDetailsV1(websiteUid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AgencyHostingV1WebsitesWebsiteResource>>;
|
|
15035
|
+
/**
|
|
15036
|
+
* Retrieve a paginated list of Agency Plan websites (H5G, Builder, and Horizons) accessible to the authenticated client. This endpoint returns websites from your hosting accounts as well as websites from other client hosting accounts that have shared access with you. The response shape differs per platform — see the `platform` field on each item. Use `website_types` to list only websites of a given detected type, e.g. only WordPress websites (`website_types=wordpress`) or only Node.js websites (`website_types=nodejs`). Combine with `order_ids`, `states`, or `domain` for more targeted results.
|
|
15037
|
+
* @summary List Agency Plan websites
|
|
15038
|
+
* @param {number} [page] Page number
|
|
15039
|
+
* @param {number} [perPage] Number of items per page
|
|
15040
|
+
* @param {Array<number> | null} [orderIds] Filter by order IDs. Accepts a comma-separated list.
|
|
15041
|
+
* @param {Array<ListAgencyPlanWebsitesV1StatesEnum>} [states] Filter by website state. Accepts a comma-separated list.
|
|
15042
|
+
* @param {Array<ListAgencyPlanWebsitesV1WebsiteTypesEnum>} [websiteTypes] Filter by detected website type, e.g. wordpress,nodejs. Accepts a comma-separated list.
|
|
15043
|
+
* @param {string | null} [domain] Filter by domain name (case-insensitive substring match)
|
|
15044
|
+
* @param {*} [options] Override http request option.
|
|
15045
|
+
* @throws {RequiredError}
|
|
15046
|
+
*/
|
|
15047
|
+
listAgencyPlanWebsitesV1(page?: number, perPage?: number, orderIds?: Array<number> | null, states?: Array<ListAgencyPlanWebsitesV1StatesEnum>, websiteTypes?: Array<ListAgencyPlanWebsitesV1WebsiteTypesEnum>, domain?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AgencyHostingListAgencyPlanWebsitesV1200Response>>;
|
|
14335
15048
|
/**
|
|
14336
15049
|
* Lists active and recently completed asynchronous processes for an Agency Plan website. Each process has a unique ID (for tracking), a type, and a status (running, completed, failed). Poll this endpoint after initiating async operations (SSL setup, backups, cloning) to track progress.
|
|
14337
15050
|
* @summary List website processes
|
|
@@ -14371,6 +15084,19 @@ export declare const AgencyHostingWebsitesApiFactory: (configuration?: Configura
|
|
|
14371
15084
|
* @throws {RequiredError}
|
|
14372
15085
|
*/
|
|
14373
15086
|
getWebsiteDetailsV1(websiteUid: string, options?: RawAxiosRequestConfig): AxiosPromise<AgencyHostingV1WebsitesWebsiteResource>;
|
|
15087
|
+
/**
|
|
15088
|
+
* Retrieve a paginated list of Agency Plan websites (H5G, Builder, and Horizons) accessible to the authenticated client. This endpoint returns websites from your hosting accounts as well as websites from other client hosting accounts that have shared access with you. The response shape differs per platform — see the `platform` field on each item. Use `website_types` to list only websites of a given detected type, e.g. only WordPress websites (`website_types=wordpress`) or only Node.js websites (`website_types=nodejs`). Combine with `order_ids`, `states`, or `domain` for more targeted results.
|
|
15089
|
+
* @summary List Agency Plan websites
|
|
15090
|
+
* @param {number} [page] Page number
|
|
15091
|
+
* @param {number} [perPage] Number of items per page
|
|
15092
|
+
* @param {Array<number> | null} [orderIds] Filter by order IDs. Accepts a comma-separated list.
|
|
15093
|
+
* @param {Array<ListAgencyPlanWebsitesV1StatesEnum>} [states] Filter by website state. Accepts a comma-separated list.
|
|
15094
|
+
* @param {Array<ListAgencyPlanWebsitesV1WebsiteTypesEnum>} [websiteTypes] Filter by detected website type, e.g. wordpress,nodejs. Accepts a comma-separated list.
|
|
15095
|
+
* @param {string | null} [domain] Filter by domain name (case-insensitive substring match)
|
|
15096
|
+
* @param {*} [options] Override http request option.
|
|
15097
|
+
* @throws {RequiredError}
|
|
15098
|
+
*/
|
|
15099
|
+
listAgencyPlanWebsitesV1(page?: number, perPage?: number, orderIds?: Array<number> | null, states?: Array<ListAgencyPlanWebsitesV1StatesEnum>, websiteTypes?: Array<ListAgencyPlanWebsitesV1WebsiteTypesEnum>, domain?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<AgencyHostingListAgencyPlanWebsitesV1200Response>;
|
|
14374
15100
|
/**
|
|
14375
15101
|
* Lists active and recently completed asynchronous processes for an Agency Plan website. Each process has a unique ID (for tracking), a type, and a status (running, completed, failed). Poll this endpoint after initiating async operations (SSL setup, backups, cloning) to track progress.
|
|
14376
15102
|
* @summary List website processes
|
|
@@ -14415,6 +15141,20 @@ export declare class AgencyHostingWebsitesApi extends BaseAPI {
|
|
|
14415
15141
|
* @memberof AgencyHostingWebsitesApi
|
|
14416
15142
|
*/
|
|
14417
15143
|
getWebsiteDetailsV1(websiteUid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AgencyHostingV1WebsitesWebsiteResource, any, {}, any>>;
|
|
15144
|
+
/**
|
|
15145
|
+
* Retrieve a paginated list of Agency Plan websites (H5G, Builder, and Horizons) accessible to the authenticated client. This endpoint returns websites from your hosting accounts as well as websites from other client hosting accounts that have shared access with you. The response shape differs per platform — see the `platform` field on each item. Use `website_types` to list only websites of a given detected type, e.g. only WordPress websites (`website_types=wordpress`) or only Node.js websites (`website_types=nodejs`). Combine with `order_ids`, `states`, or `domain` for more targeted results.
|
|
15146
|
+
* @summary List Agency Plan websites
|
|
15147
|
+
* @param {number} [page] Page number
|
|
15148
|
+
* @param {number} [perPage] Number of items per page
|
|
15149
|
+
* @param {Array<number> | null} [orderIds] Filter by order IDs. Accepts a comma-separated list.
|
|
15150
|
+
* @param {Array<ListAgencyPlanWebsitesV1StatesEnum>} [states] Filter by website state. Accepts a comma-separated list.
|
|
15151
|
+
* @param {Array<ListAgencyPlanWebsitesV1WebsiteTypesEnum>} [websiteTypes] Filter by detected website type, e.g. wordpress,nodejs. Accepts a comma-separated list.
|
|
15152
|
+
* @param {string | null} [domain] Filter by domain name (case-insensitive substring match)
|
|
15153
|
+
* @param {*} [options] Override http request option.
|
|
15154
|
+
* @throws {RequiredError}
|
|
15155
|
+
* @memberof AgencyHostingWebsitesApi
|
|
15156
|
+
*/
|
|
15157
|
+
listAgencyPlanWebsitesV1(page?: number, perPage?: number, orderIds?: Array<number> | null, states?: Array<ListAgencyPlanWebsitesV1StatesEnum>, websiteTypes?: Array<ListAgencyPlanWebsitesV1WebsiteTypesEnum>, domain?: string | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AgencyHostingListAgencyPlanWebsitesV1200Response, any, {}, any>>;
|
|
14418
15158
|
/**
|
|
14419
15159
|
* Lists active and recently completed asynchronous processes for an Agency Plan website. Each process has a unique ID (for tracking), a type, and a status (running, completed, failed). Poll this endpoint after initiating async operations (SSL setup, backups, cloning) to track progress.
|
|
14420
15160
|
* @summary List website processes
|
|
@@ -14425,6 +15165,28 @@ export declare class AgencyHostingWebsitesApi extends BaseAPI {
|
|
|
14425
15165
|
*/
|
|
14426
15166
|
listWebsiteProcessesV1(websiteUid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AgencyHostingV1WebsitesWebsiteProcessResource[], any, {}, any>>;
|
|
14427
15167
|
}
|
|
15168
|
+
/**
|
|
15169
|
+
* @export
|
|
15170
|
+
*/
|
|
15171
|
+
export declare const ListAgencyPlanWebsitesV1StatesEnum: {
|
|
15172
|
+
readonly Active: "active";
|
|
15173
|
+
readonly Locked: "locked";
|
|
15174
|
+
readonly Suspended: "suspended";
|
|
15175
|
+
readonly Deleting: "deleting";
|
|
15176
|
+
readonly Deleted: "deleted";
|
|
15177
|
+
};
|
|
15178
|
+
export type ListAgencyPlanWebsitesV1StatesEnum = typeof ListAgencyPlanWebsitesV1StatesEnum[keyof typeof ListAgencyPlanWebsitesV1StatesEnum];
|
|
15179
|
+
/**
|
|
15180
|
+
* @export
|
|
15181
|
+
*/
|
|
15182
|
+
export declare const ListAgencyPlanWebsitesV1WebsiteTypesEnum: {
|
|
15183
|
+
readonly Wordpress: "wordpress";
|
|
15184
|
+
readonly Builder: "builder";
|
|
15185
|
+
readonly Horizons: "horizons";
|
|
15186
|
+
readonly Nodejs: "nodejs";
|
|
15187
|
+
readonly Other: "other";
|
|
15188
|
+
};
|
|
15189
|
+
export type ListAgencyPlanWebsitesV1WebsiteTypesEnum = typeof ListAgencyPlanWebsitesV1WebsiteTypesEnum[keyof typeof ListAgencyPlanWebsitesV1WebsiteTypesEnum];
|
|
14428
15190
|
/**
|
|
14429
15191
|
* AgencyHostingWordPressApi - axios parameter creator
|
|
14430
15192
|
* @export
|
|
@@ -17943,7 +18705,7 @@ export declare const HostingDatabasesApiAxiosParamCreator: (configuration?: Conf
|
|
|
17943
18705
|
* @param {string} username
|
|
17944
18706
|
* @param {number} [page] Page number
|
|
17945
18707
|
* @param {number} [perPage] Number of items per page
|
|
17946
|
-
* @param {string | null} [domain] Filter by domain name (
|
|
18708
|
+
* @param {string | null} [domain] Filter by domain name (case-insensitive substring match)
|
|
17947
18709
|
* @param {boolean | null} [isAssigned] When used with domain, return only databases assigned to that domain.
|
|
17948
18710
|
* @param {string | null} [search] Search databases by name, user, or creation date.
|
|
17949
18711
|
* @param {*} [options] Override http request option.
|
|
@@ -18037,7 +18799,7 @@ export declare const HostingDatabasesApiFp: (configuration?: Configuration) => {
|
|
|
18037
18799
|
* @param {string} username
|
|
18038
18800
|
* @param {number} [page] Page number
|
|
18039
18801
|
* @param {number} [perPage] Number of items per page
|
|
18040
|
-
* @param {string | null} [domain] Filter by domain name (
|
|
18802
|
+
* @param {string | null} [domain] Filter by domain name (case-insensitive substring match)
|
|
18041
18803
|
* @param {boolean | null} [isAssigned] When used with domain, return only databases assigned to that domain.
|
|
18042
18804
|
* @param {string | null} [search] Search databases by name, user, or creation date.
|
|
18043
18805
|
* @param {*} [options] Override http request option.
|
|
@@ -18131,7 +18893,7 @@ export declare const HostingDatabasesApiFactory: (configuration?: Configuration,
|
|
|
18131
18893
|
* @param {string} username
|
|
18132
18894
|
* @param {number} [page] Page number
|
|
18133
18895
|
* @param {number} [perPage] Number of items per page
|
|
18134
|
-
* @param {string | null} [domain] Filter by domain name (
|
|
18896
|
+
* @param {string | null} [domain] Filter by domain name (case-insensitive substring match)
|
|
18135
18897
|
* @param {boolean | null} [isAssigned] When used with domain, return only databases assigned to that domain.
|
|
18136
18898
|
* @param {string | null} [search] Search databases by name, user, or creation date.
|
|
18137
18899
|
* @param {*} [options] Override http request option.
|
|
@@ -18233,7 +18995,7 @@ export declare class HostingDatabasesApi extends BaseAPI {
|
|
|
18233
18995
|
* @param {string} username
|
|
18234
18996
|
* @param {number} [page] Page number
|
|
18235
18997
|
* @param {number} [perPage] Number of items per page
|
|
18236
|
-
* @param {string | null} [domain] Filter by domain name (
|
|
18998
|
+
* @param {string | null} [domain] Filter by domain name (case-insensitive substring match)
|
|
18237
18999
|
* @param {boolean | null} [isAssigned] When used with domain, return only databases assigned to that domain.
|
|
18238
19000
|
* @param {string | null} [search] Search databases by name, user, or creation date.
|
|
18239
19001
|
* @param {*} [options] Override http request option.
|
|
@@ -18652,6 +19414,14 @@ export declare class HostingDomainsApi extends BaseAPI {
|
|
|
18652
19414
|
* @export
|
|
18653
19415
|
*/
|
|
18654
19416
|
export declare const HostingFilesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
19417
|
+
/**
|
|
19418
|
+
* Generate a file browser upload URL with authentication credentials for uploading files directly to a website\'s file storage. Returns `url`, `auth_key` and `rest_auth_key`. Use these to upload a file to the website\'s `public_html` directory via the TUS resumable upload protocol (TUS 1.0.0). Send `X-Auth: {auth_key}` and `X-Auth-Rest: {rest_auth_key}` headers on every request below. 1. Create the upload: `POST` to `{url}/{relative_file_path}?override=true` with headers `upload-length: {file size in bytes}` and `upload-offset: 0`. Expect `201 Created`. 2. Upload the file: send the file bytes to the same location (any TUS 1.0.0 client, or `PATCH` requests with an `upload-offset` header tracking progress) until complete. `relative_file_path` is the destination path inside `public_html`, e.g. `app.zip`. Instead of a TUS client, plain `curl` also works: ``` FILE=app.zip SIZE=$(stat -f%z \"$FILE\") # stat -c%s on Linux curl -i -X POST \"{url}/${FILE}?override=true\" \\ -H \"X-Auth: {auth_key}\" \\ -H \"X-Auth-Rest: {rest_auth_key}\" \\ -H \"Tus-Resumable: 1.0.0\" \\ -H \"Upload-Length: ${SIZE}\" \\ -H \"Upload-Offset: 0\" # -> 201 Created curl -i -X PATCH \"{url}/${FILE}?override=true\" \\ -H \"X-Auth: {auth_key}\" \\ -H \"X-Auth-Rest: {rest_auth_key}\" \\ -H \"Tus-Resumable: 1.0.0\" \\ -H \"Content-Type: application/offset+octet-stream\" \\ -H \"Upload-Offset: 0\" \\ --data-binary \"@${FILE}\" # -> 204 No Content, Upload-Offset response header equals SIZE when done ```
|
|
19419
|
+
* @summary Generate upload URL
|
|
19420
|
+
* @param {HostingV1FilesGenerateUploadUrlRequest} hostingV1FilesGenerateUploadUrlRequest
|
|
19421
|
+
* @param {*} [options] Override http request option.
|
|
19422
|
+
* @throws {RequiredError}
|
|
19423
|
+
*/
|
|
19424
|
+
generateUploadURLV1: (hostingV1FilesGenerateUploadUrlRequest: HostingV1FilesGenerateUploadUrlRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
18655
19425
|
/**
|
|
18656
19426
|
* Get a single file\'s content, relative to a website\'s document root. Read-only; refuses symlinks, oversized files, non-text file types, and files identified as containing secrets (e.g. credential files) — none of these are returned by this endpoint.
|
|
18657
19427
|
* @summary Get website file content
|
|
@@ -18684,6 +19454,14 @@ export declare const HostingFilesApiAxiosParamCreator: (configuration?: Configur
|
|
|
18684
19454
|
* @export
|
|
18685
19455
|
*/
|
|
18686
19456
|
export declare const HostingFilesApiFp: (configuration?: Configuration) => {
|
|
19457
|
+
/**
|
|
19458
|
+
* Generate a file browser upload URL with authentication credentials for uploading files directly to a website\'s file storage. Returns `url`, `auth_key` and `rest_auth_key`. Use these to upload a file to the website\'s `public_html` directory via the TUS resumable upload protocol (TUS 1.0.0). Send `X-Auth: {auth_key}` and `X-Auth-Rest: {rest_auth_key}` headers on every request below. 1. Create the upload: `POST` to `{url}/{relative_file_path}?override=true` with headers `upload-length: {file size in bytes}` and `upload-offset: 0`. Expect `201 Created`. 2. Upload the file: send the file bytes to the same location (any TUS 1.0.0 client, or `PATCH` requests with an `upload-offset` header tracking progress) until complete. `relative_file_path` is the destination path inside `public_html`, e.g. `app.zip`. Instead of a TUS client, plain `curl` also works: ``` FILE=app.zip SIZE=$(stat -f%z \"$FILE\") # stat -c%s on Linux curl -i -X POST \"{url}/${FILE}?override=true\" \\ -H \"X-Auth: {auth_key}\" \\ -H \"X-Auth-Rest: {rest_auth_key}\" \\ -H \"Tus-Resumable: 1.0.0\" \\ -H \"Upload-Length: ${SIZE}\" \\ -H \"Upload-Offset: 0\" # -> 201 Created curl -i -X PATCH \"{url}/${FILE}?override=true\" \\ -H \"X-Auth: {auth_key}\" \\ -H \"X-Auth-Rest: {rest_auth_key}\" \\ -H \"Tus-Resumable: 1.0.0\" \\ -H \"Content-Type: application/offset+octet-stream\" \\ -H \"Upload-Offset: 0\" \\ --data-binary \"@${FILE}\" # -> 204 No Content, Upload-Offset response header equals SIZE when done ```
|
|
19459
|
+
* @summary Generate upload URL
|
|
19460
|
+
* @param {HostingV1FilesGenerateUploadUrlRequest} hostingV1FilesGenerateUploadUrlRequest
|
|
19461
|
+
* @param {*} [options] Override http request option.
|
|
19462
|
+
* @throws {RequiredError}
|
|
19463
|
+
*/
|
|
19464
|
+
generateUploadURLV1(hostingV1FilesGenerateUploadUrlRequest: HostingV1FilesGenerateUploadUrlRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<HostingV1FilesUploadUrlResource>>;
|
|
18687
19465
|
/**
|
|
18688
19466
|
* Get a single file\'s content, relative to a website\'s document root. Read-only; refuses symlinks, oversized files, non-text file types, and files identified as containing secrets (e.g. credential files) — none of these are returned by this endpoint.
|
|
18689
19467
|
* @summary Get website file content
|
|
@@ -18716,6 +19494,14 @@ export declare const HostingFilesApiFp: (configuration?: Configuration) => {
|
|
|
18716
19494
|
* @export
|
|
18717
19495
|
*/
|
|
18718
19496
|
export declare const HostingFilesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
19497
|
+
/**
|
|
19498
|
+
* Generate a file browser upload URL with authentication credentials for uploading files directly to a website\'s file storage. Returns `url`, `auth_key` and `rest_auth_key`. Use these to upload a file to the website\'s `public_html` directory via the TUS resumable upload protocol (TUS 1.0.0). Send `X-Auth: {auth_key}` and `X-Auth-Rest: {rest_auth_key}` headers on every request below. 1. Create the upload: `POST` to `{url}/{relative_file_path}?override=true` with headers `upload-length: {file size in bytes}` and `upload-offset: 0`. Expect `201 Created`. 2. Upload the file: send the file bytes to the same location (any TUS 1.0.0 client, or `PATCH` requests with an `upload-offset` header tracking progress) until complete. `relative_file_path` is the destination path inside `public_html`, e.g. `app.zip`. Instead of a TUS client, plain `curl` also works: ``` FILE=app.zip SIZE=$(stat -f%z \"$FILE\") # stat -c%s on Linux curl -i -X POST \"{url}/${FILE}?override=true\" \\ -H \"X-Auth: {auth_key}\" \\ -H \"X-Auth-Rest: {rest_auth_key}\" \\ -H \"Tus-Resumable: 1.0.0\" \\ -H \"Upload-Length: ${SIZE}\" \\ -H \"Upload-Offset: 0\" # -> 201 Created curl -i -X PATCH \"{url}/${FILE}?override=true\" \\ -H \"X-Auth: {auth_key}\" \\ -H \"X-Auth-Rest: {rest_auth_key}\" \\ -H \"Tus-Resumable: 1.0.0\" \\ -H \"Content-Type: application/offset+octet-stream\" \\ -H \"Upload-Offset: 0\" \\ --data-binary \"@${FILE}\" # -> 204 No Content, Upload-Offset response header equals SIZE when done ```
|
|
19499
|
+
* @summary Generate upload URL
|
|
19500
|
+
* @param {HostingV1FilesGenerateUploadUrlRequest} hostingV1FilesGenerateUploadUrlRequest
|
|
19501
|
+
* @param {*} [options] Override http request option.
|
|
19502
|
+
* @throws {RequiredError}
|
|
19503
|
+
*/
|
|
19504
|
+
generateUploadURLV1(hostingV1FilesGenerateUploadUrlRequest: HostingV1FilesGenerateUploadUrlRequest, options?: RawAxiosRequestConfig): AxiosPromise<HostingV1FilesUploadUrlResource>;
|
|
18719
19505
|
/**
|
|
18720
19506
|
* Get a single file\'s content, relative to a website\'s document root. Read-only; refuses symlinks, oversized files, non-text file types, and files identified as containing secrets (e.g. credential files) — none of these are returned by this endpoint.
|
|
18721
19507
|
* @summary Get website file content
|
|
@@ -18750,6 +19536,15 @@ export declare const HostingFilesApiFactory: (configuration?: Configuration, bas
|
|
|
18750
19536
|
* @extends {BaseAPI}
|
|
18751
19537
|
*/
|
|
18752
19538
|
export declare class HostingFilesApi extends BaseAPI {
|
|
19539
|
+
/**
|
|
19540
|
+
* Generate a file browser upload URL with authentication credentials for uploading files directly to a website\'s file storage. Returns `url`, `auth_key` and `rest_auth_key`. Use these to upload a file to the website\'s `public_html` directory via the TUS resumable upload protocol (TUS 1.0.0). Send `X-Auth: {auth_key}` and `X-Auth-Rest: {rest_auth_key}` headers on every request below. 1. Create the upload: `POST` to `{url}/{relative_file_path}?override=true` with headers `upload-length: {file size in bytes}` and `upload-offset: 0`. Expect `201 Created`. 2. Upload the file: send the file bytes to the same location (any TUS 1.0.0 client, or `PATCH` requests with an `upload-offset` header tracking progress) until complete. `relative_file_path` is the destination path inside `public_html`, e.g. `app.zip`. Instead of a TUS client, plain `curl` also works: ``` FILE=app.zip SIZE=$(stat -f%z \"$FILE\") # stat -c%s on Linux curl -i -X POST \"{url}/${FILE}?override=true\" \\ -H \"X-Auth: {auth_key}\" \\ -H \"X-Auth-Rest: {rest_auth_key}\" \\ -H \"Tus-Resumable: 1.0.0\" \\ -H \"Upload-Length: ${SIZE}\" \\ -H \"Upload-Offset: 0\" # -> 201 Created curl -i -X PATCH \"{url}/${FILE}?override=true\" \\ -H \"X-Auth: {auth_key}\" \\ -H \"X-Auth-Rest: {rest_auth_key}\" \\ -H \"Tus-Resumable: 1.0.0\" \\ -H \"Content-Type: application/offset+octet-stream\" \\ -H \"Upload-Offset: 0\" \\ --data-binary \"@${FILE}\" # -> 204 No Content, Upload-Offset response header equals SIZE when done ```
|
|
19541
|
+
* @summary Generate upload URL
|
|
19542
|
+
* @param {HostingV1FilesGenerateUploadUrlRequest} hostingV1FilesGenerateUploadUrlRequest
|
|
19543
|
+
* @param {*} [options] Override http request option.
|
|
19544
|
+
* @throws {RequiredError}
|
|
19545
|
+
* @memberof HostingFilesApi
|
|
19546
|
+
*/
|
|
19547
|
+
generateUploadURLV1(hostingV1FilesGenerateUploadUrlRequest: HostingV1FilesGenerateUploadUrlRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<HostingV1FilesUploadUrlResource, any, {}, any>>;
|
|
18753
19548
|
/**
|
|
18754
19549
|
* Get a single file\'s content, relative to a website\'s document root. Read-only; refuses symlinks, oversized files, non-text file types, and files identified as containing secrets (e.g. credential files) — none of these are returned by this endpoint.
|
|
18755
19550
|
* @summary Get website file content
|
|
@@ -18795,7 +19590,7 @@ export type ListWebsiteFilesAndDirectoriesV1FileTypesEnum = typeof ListWebsiteFi
|
|
|
18795
19590
|
*/
|
|
18796
19591
|
export declare const HostingNodeJSApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
18797
19592
|
/**
|
|
18798
|
-
* Upload a project archive, auto-detect build settings, and immediately start a Node.js build. This is the recommended single-step approach for deploying a Node.js application. The archive is uploaded to the website\'s file storage, build settings are auto-detected from the package.json inside the archive, and the build process starts automatically. Optional override fields take precedence over auto-detected values. Maximum archive size is 50MB. Before archiving, exclude `node_modules/` and any build output directories (e.g. `dist/`, `.next/`, `build/`) — they are not needed because the build process runs the install step automatically, and including them unnecessarily increases the archive size. This also helps keep the archive well under the 50MB limit. Example (zip): ``` zip -r archive.zip . --exclude \"node_modules/_*\" --exclude \"dist/_*\" ``` The returned build `uuid` can be used to poll progress and retrieve logs via the `Get Node.js Build Logs` endpoint.
|
|
19593
|
+
* Upload a project archive, auto-detect build settings, and immediately start a Node.js build. WARNING: on success this overwrites the website\'s existing contents and cannot be undone — verify this is intended before calling this endpoint. This is the recommended single-step approach for deploying a Node.js application. The archive is uploaded to the website\'s file storage, build settings are auto-detected from the package.json inside the archive, and the build process starts automatically. Optional override fields take precedence over auto-detected values. Maximum archive size is 50MB. Before archiving, exclude `node_modules/` and any build output directories (e.g. `dist/`, `.next/`, `build/`) — they are not needed because the build process runs the install step automatically, and including them unnecessarily increases the archive size. This also helps keep the archive well under the 50MB limit. Example (zip): ``` zip -r archive.zip . --exclude \"node_modules/_*\" --exclude \"dist/_*\" ``` The returned build `uuid` can be used to poll progress and retrieve logs via the `Get Node.js Build Logs` endpoint.
|
|
18799
19594
|
* @summary Create NodeJS build from archive
|
|
18800
19595
|
* @param {string} username
|
|
18801
19596
|
* @param {string} domain Domain name
|
|
@@ -18815,6 +19610,16 @@ export declare const HostingNodeJSApiAxiosParamCreator: (configuration?: Configu
|
|
|
18815
19610
|
* @throws {RequiredError}
|
|
18816
19611
|
*/
|
|
18817
19612
|
getNodeJSBuildLogsV1: (username: string, domain: string, uuid: string, fromLine?: number | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
19613
|
+
/**
|
|
19614
|
+
* Auto-detect Node.js build settings from a package.json inside an archive already on the server. Use this before calling `Start Node.js Build` to preview what settings will be used, or to let the user review and override values (framework, node version, root directory, output directory, build script) before committing to a build. The archive must already be present on the website\'s file storage. Use the `Generate Upload URL` endpoint to obtain credentials and upload the archive first. To upload an archive and start a build in one step without inspecting settings first, use the `Create Node.js Build from Archive` endpoint instead.
|
|
19615
|
+
* @summary Get Node.js build settings from archive
|
|
19616
|
+
* @param {string} username
|
|
19617
|
+
* @param {string} domain Domain name
|
|
19618
|
+
* @param {string} archivePath The path to the archive file relative to the document root of the vhost
|
|
19619
|
+
* @param {*} [options] Override http request option.
|
|
19620
|
+
* @throws {RequiredError}
|
|
19621
|
+
*/
|
|
19622
|
+
getNodeJsBuildSettingsFromArchiveV1: (username: string, domain: string, archivePath: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
18818
19623
|
/**
|
|
18819
19624
|
* Retrieve a paginated list of Node.js build processes for a specific website. Each build represents a single run of the Node.js build pipeline. Use the `states` query parameter to filter results by build state (pending, running, completed, failed). Use the `uuid` from a build to poll its output via the `Get Node.js Build Logs` endpoint.
|
|
18820
19625
|
* @summary List NodeJS builds
|
|
@@ -18856,6 +19661,16 @@ export declare const HostingNodeJSApiAxiosParamCreator: (configuration?: Configu
|
|
|
18856
19661
|
* @throws {RequiredError}
|
|
18857
19662
|
*/
|
|
18858
19663
|
restartNodeJsApplicationV1: (username: string, domain: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
19664
|
+
/**
|
|
19665
|
+
* Start a Node.js build process using files already present on the website\'s file storage. WARNING: on success this overwrites the website\'s existing contents and cannot be undone — verify this is intended before calling this endpoint. The `source_type` must be `archive` and `source_options.archive_path` must point to an existing archive file on the server (relative to the website document root). Use the `Generate Upload URL` endpoint to obtain credentials and upload the archive first. To auto-detect build settings from an archive before starting, first call the `Get Node.js Build Settings from Archive` endpoint. To upload an archive and start a build in one step, use the `Create Node.js Build from Archive` endpoint instead. The returned build `uuid` can be used to poll progress and retrieve logs via the `Get Node.js Build Logs` endpoint.
|
|
19666
|
+
* @summary Start Node.js build
|
|
19667
|
+
* @param {string} username
|
|
19668
|
+
* @param {string} domain Domain name
|
|
19669
|
+
* @param {HostingV1NodeJsStartBuildRequest} hostingV1NodeJsStartBuildRequest
|
|
19670
|
+
* @param {*} [options] Override http request option.
|
|
19671
|
+
* @throws {RequiredError}
|
|
19672
|
+
*/
|
|
19673
|
+
startNodeJsBuildV1: (username: string, domain: string, hostingV1NodeJsStartBuildRequest: HostingV1NodeJsStartBuildRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
18859
19674
|
};
|
|
18860
19675
|
/**
|
|
18861
19676
|
* HostingNodeJSApi - functional programming interface
|
|
@@ -18863,7 +19678,7 @@ export declare const HostingNodeJSApiAxiosParamCreator: (configuration?: Configu
|
|
|
18863
19678
|
*/
|
|
18864
19679
|
export declare const HostingNodeJSApiFp: (configuration?: Configuration) => {
|
|
18865
19680
|
/**
|
|
18866
|
-
* Upload a project archive, auto-detect build settings, and immediately start a Node.js build. This is the recommended single-step approach for deploying a Node.js application. The archive is uploaded to the website\'s file storage, build settings are auto-detected from the package.json inside the archive, and the build process starts automatically. Optional override fields take precedence over auto-detected values. Maximum archive size is 50MB. Before archiving, exclude `node_modules/` and any build output directories (e.g. `dist/`, `.next/`, `build/`) — they are not needed because the build process runs the install step automatically, and including them unnecessarily increases the archive size. This also helps keep the archive well under the 50MB limit. Example (zip): ``` zip -r archive.zip . --exclude \"node_modules/_*\" --exclude \"dist/_*\" ``` The returned build `uuid` can be used to poll progress and retrieve logs via the `Get Node.js Build Logs` endpoint.
|
|
19681
|
+
* Upload a project archive, auto-detect build settings, and immediately start a Node.js build. WARNING: on success this overwrites the website\'s existing contents and cannot be undone — verify this is intended before calling this endpoint. This is the recommended single-step approach for deploying a Node.js application. The archive is uploaded to the website\'s file storage, build settings are auto-detected from the package.json inside the archive, and the build process starts automatically. Optional override fields take precedence over auto-detected values. Maximum archive size is 50MB. Before archiving, exclude `node_modules/` and any build output directories (e.g. `dist/`, `.next/`, `build/`) — they are not needed because the build process runs the install step automatically, and including them unnecessarily increases the archive size. This also helps keep the archive well under the 50MB limit. Example (zip): ``` zip -r archive.zip . --exclude \"node_modules/_*\" --exclude \"dist/_*\" ``` The returned build `uuid` can be used to poll progress and retrieve logs via the `Get Node.js Build Logs` endpoint.
|
|
18867
19682
|
* @summary Create NodeJS build from archive
|
|
18868
19683
|
* @param {string} username
|
|
18869
19684
|
* @param {string} domain Domain name
|
|
@@ -18883,6 +19698,16 @@ export declare const HostingNodeJSApiFp: (configuration?: Configuration) => {
|
|
|
18883
19698
|
* @throws {RequiredError}
|
|
18884
19699
|
*/
|
|
18885
19700
|
getNodeJSBuildLogsV1(username: string, domain: string, uuid: string, fromLine?: number | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<HostingV1NodeJsBuildLogsResource>>;
|
|
19701
|
+
/**
|
|
19702
|
+
* Auto-detect Node.js build settings from a package.json inside an archive already on the server. Use this before calling `Start Node.js Build` to preview what settings will be used, or to let the user review and override values (framework, node version, root directory, output directory, build script) before committing to a build. The archive must already be present on the website\'s file storage. Use the `Generate Upload URL` endpoint to obtain credentials and upload the archive first. To upload an archive and start a build in one step without inspecting settings first, use the `Create Node.js Build from Archive` endpoint instead.
|
|
19703
|
+
* @summary Get Node.js build settings from archive
|
|
19704
|
+
* @param {string} username
|
|
19705
|
+
* @param {string} domain Domain name
|
|
19706
|
+
* @param {string} archivePath The path to the archive file relative to the document root of the vhost
|
|
19707
|
+
* @param {*} [options] Override http request option.
|
|
19708
|
+
* @throws {RequiredError}
|
|
19709
|
+
*/
|
|
19710
|
+
getNodeJsBuildSettingsFromArchiveV1(username: string, domain: string, archivePath: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<HostingV1NodeJsBuildSettingsResource>>;
|
|
18886
19711
|
/**
|
|
18887
19712
|
* Retrieve a paginated list of Node.js build processes for a specific website. Each build represents a single run of the Node.js build pipeline. Use the `states` query parameter to filter results by build state (pending, running, completed, failed). Use the `uuid` from a build to poll its output via the `Get Node.js Build Logs` endpoint.
|
|
18888
19713
|
* @summary List NodeJS builds
|
|
@@ -18924,6 +19749,16 @@ export declare const HostingNodeJSApiFp: (configuration?: Configuration) => {
|
|
|
18924
19749
|
* @throws {RequiredError}
|
|
18925
19750
|
*/
|
|
18926
19751
|
restartNodeJsApplicationV1(username: string, domain: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommonSuccessEmptyResource>>;
|
|
19752
|
+
/**
|
|
19753
|
+
* Start a Node.js build process using files already present on the website\'s file storage. WARNING: on success this overwrites the website\'s existing contents and cannot be undone — verify this is intended before calling this endpoint. The `source_type` must be `archive` and `source_options.archive_path` must point to an existing archive file on the server (relative to the website document root). Use the `Generate Upload URL` endpoint to obtain credentials and upload the archive first. To auto-detect build settings from an archive before starting, first call the `Get Node.js Build Settings from Archive` endpoint. To upload an archive and start a build in one step, use the `Create Node.js Build from Archive` endpoint instead. The returned build `uuid` can be used to poll progress and retrieve logs via the `Get Node.js Build Logs` endpoint.
|
|
19754
|
+
* @summary Start Node.js build
|
|
19755
|
+
* @param {string} username
|
|
19756
|
+
* @param {string} domain Domain name
|
|
19757
|
+
* @param {HostingV1NodeJsStartBuildRequest} hostingV1NodeJsStartBuildRequest
|
|
19758
|
+
* @param {*} [options] Override http request option.
|
|
19759
|
+
* @throws {RequiredError}
|
|
19760
|
+
*/
|
|
19761
|
+
startNodeJsBuildV1(username: string, domain: string, hostingV1NodeJsStartBuildRequest: HostingV1NodeJsStartBuildRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<HostingV1NodeJsBuildResource>>;
|
|
18927
19762
|
};
|
|
18928
19763
|
/**
|
|
18929
19764
|
* HostingNodeJSApi - factory interface
|
|
@@ -18931,7 +19766,7 @@ export declare const HostingNodeJSApiFp: (configuration?: Configuration) => {
|
|
|
18931
19766
|
*/
|
|
18932
19767
|
export declare const HostingNodeJSApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
18933
19768
|
/**
|
|
18934
|
-
* Upload a project archive, auto-detect build settings, and immediately start a Node.js build. This is the recommended single-step approach for deploying a Node.js application. The archive is uploaded to the website\'s file storage, build settings are auto-detected from the package.json inside the archive, and the build process starts automatically. Optional override fields take precedence over auto-detected values. Maximum archive size is 50MB. Before archiving, exclude `node_modules/` and any build output directories (e.g. `dist/`, `.next/`, `build/`) — they are not needed because the build process runs the install step automatically, and including them unnecessarily increases the archive size. This also helps keep the archive well under the 50MB limit. Example (zip): ``` zip -r archive.zip . --exclude \"node_modules/_*\" --exclude \"dist/_*\" ``` The returned build `uuid` can be used to poll progress and retrieve logs via the `Get Node.js Build Logs` endpoint.
|
|
19769
|
+
* Upload a project archive, auto-detect build settings, and immediately start a Node.js build. WARNING: on success this overwrites the website\'s existing contents and cannot be undone — verify this is intended before calling this endpoint. This is the recommended single-step approach for deploying a Node.js application. The archive is uploaded to the website\'s file storage, build settings are auto-detected from the package.json inside the archive, and the build process starts automatically. Optional override fields take precedence over auto-detected values. Maximum archive size is 50MB. Before archiving, exclude `node_modules/` and any build output directories (e.g. `dist/`, `.next/`, `build/`) — they are not needed because the build process runs the install step automatically, and including them unnecessarily increases the archive size. This also helps keep the archive well under the 50MB limit. Example (zip): ``` zip -r archive.zip . --exclude \"node_modules/_*\" --exclude \"dist/_*\" ``` The returned build `uuid` can be used to poll progress and retrieve logs via the `Get Node.js Build Logs` endpoint.
|
|
18935
19770
|
* @summary Create NodeJS build from archive
|
|
18936
19771
|
* @param {string} username
|
|
18937
19772
|
* @param {string} domain Domain name
|
|
@@ -18951,6 +19786,16 @@ export declare const HostingNodeJSApiFactory: (configuration?: Configuration, ba
|
|
|
18951
19786
|
* @throws {RequiredError}
|
|
18952
19787
|
*/
|
|
18953
19788
|
getNodeJSBuildLogsV1(username: string, domain: string, uuid: string, fromLine?: number | null, options?: RawAxiosRequestConfig): AxiosPromise<HostingV1NodeJsBuildLogsResource>;
|
|
19789
|
+
/**
|
|
19790
|
+
* Auto-detect Node.js build settings from a package.json inside an archive already on the server. Use this before calling `Start Node.js Build` to preview what settings will be used, or to let the user review and override values (framework, node version, root directory, output directory, build script) before committing to a build. The archive must already be present on the website\'s file storage. Use the `Generate Upload URL` endpoint to obtain credentials and upload the archive first. To upload an archive and start a build in one step without inspecting settings first, use the `Create Node.js Build from Archive` endpoint instead.
|
|
19791
|
+
* @summary Get Node.js build settings from archive
|
|
19792
|
+
* @param {string} username
|
|
19793
|
+
* @param {string} domain Domain name
|
|
19794
|
+
* @param {string} archivePath The path to the archive file relative to the document root of the vhost
|
|
19795
|
+
* @param {*} [options] Override http request option.
|
|
19796
|
+
* @throws {RequiredError}
|
|
19797
|
+
*/
|
|
19798
|
+
getNodeJsBuildSettingsFromArchiveV1(username: string, domain: string, archivePath: string, options?: RawAxiosRequestConfig): AxiosPromise<HostingV1NodeJsBuildSettingsResource>;
|
|
18954
19799
|
/**
|
|
18955
19800
|
* Retrieve a paginated list of Node.js build processes for a specific website. Each build represents a single run of the Node.js build pipeline. Use the `states` query parameter to filter results by build state (pending, running, completed, failed). Use the `uuid` from a build to poll its output via the `Get Node.js Build Logs` endpoint.
|
|
18956
19801
|
* @summary List NodeJS builds
|
|
@@ -18992,6 +19837,16 @@ export declare const HostingNodeJSApiFactory: (configuration?: Configuration, ba
|
|
|
18992
19837
|
* @throws {RequiredError}
|
|
18993
19838
|
*/
|
|
18994
19839
|
restartNodeJsApplicationV1(username: string, domain: string, options?: RawAxiosRequestConfig): AxiosPromise<CommonSuccessEmptyResource>;
|
|
19840
|
+
/**
|
|
19841
|
+
* Start a Node.js build process using files already present on the website\'s file storage. WARNING: on success this overwrites the website\'s existing contents and cannot be undone — verify this is intended before calling this endpoint. The `source_type` must be `archive` and `source_options.archive_path` must point to an existing archive file on the server (relative to the website document root). Use the `Generate Upload URL` endpoint to obtain credentials and upload the archive first. To auto-detect build settings from an archive before starting, first call the `Get Node.js Build Settings from Archive` endpoint. To upload an archive and start a build in one step, use the `Create Node.js Build from Archive` endpoint instead. The returned build `uuid` can be used to poll progress and retrieve logs via the `Get Node.js Build Logs` endpoint.
|
|
19842
|
+
* @summary Start Node.js build
|
|
19843
|
+
* @param {string} username
|
|
19844
|
+
* @param {string} domain Domain name
|
|
19845
|
+
* @param {HostingV1NodeJsStartBuildRequest} hostingV1NodeJsStartBuildRequest
|
|
19846
|
+
* @param {*} [options] Override http request option.
|
|
19847
|
+
* @throws {RequiredError}
|
|
19848
|
+
*/
|
|
19849
|
+
startNodeJsBuildV1(username: string, domain: string, hostingV1NodeJsStartBuildRequest: HostingV1NodeJsStartBuildRequest, options?: RawAxiosRequestConfig): AxiosPromise<HostingV1NodeJsBuildResource>;
|
|
18995
19850
|
};
|
|
18996
19851
|
/**
|
|
18997
19852
|
* HostingNodeJSApi - object-oriented interface
|
|
@@ -19001,7 +19856,7 @@ export declare const HostingNodeJSApiFactory: (configuration?: Configuration, ba
|
|
|
19001
19856
|
*/
|
|
19002
19857
|
export declare class HostingNodeJSApi extends BaseAPI {
|
|
19003
19858
|
/**
|
|
19004
|
-
* Upload a project archive, auto-detect build settings, and immediately start a Node.js build. This is the recommended single-step approach for deploying a Node.js application. The archive is uploaded to the website\'s file storage, build settings are auto-detected from the package.json inside the archive, and the build process starts automatically. Optional override fields take precedence over auto-detected values. Maximum archive size is 50MB. Before archiving, exclude `node_modules/` and any build output directories (e.g. `dist/`, `.next/`, `build/`) — they are not needed because the build process runs the install step automatically, and including them unnecessarily increases the archive size. This also helps keep the archive well under the 50MB limit. Example (zip): ``` zip -r archive.zip . --exclude \"node_modules/_*\" --exclude \"dist/_*\" ``` The returned build `uuid` can be used to poll progress and retrieve logs via the `Get Node.js Build Logs` endpoint.
|
|
19859
|
+
* Upload a project archive, auto-detect build settings, and immediately start a Node.js build. WARNING: on success this overwrites the website\'s existing contents and cannot be undone — verify this is intended before calling this endpoint. This is the recommended single-step approach for deploying a Node.js application. The archive is uploaded to the website\'s file storage, build settings are auto-detected from the package.json inside the archive, and the build process starts automatically. Optional override fields take precedence over auto-detected values. Maximum archive size is 50MB. Before archiving, exclude `node_modules/` and any build output directories (e.g. `dist/`, `.next/`, `build/`) — they are not needed because the build process runs the install step automatically, and including them unnecessarily increases the archive size. This also helps keep the archive well under the 50MB limit. Example (zip): ``` zip -r archive.zip . --exclude \"node_modules/_*\" --exclude \"dist/_*\" ``` The returned build `uuid` can be used to poll progress and retrieve logs via the `Get Node.js Build Logs` endpoint.
|
|
19005
19860
|
* @summary Create NodeJS build from archive
|
|
19006
19861
|
* @param {string} username
|
|
19007
19862
|
* @param {string} domain Domain name
|
|
@@ -19023,6 +19878,17 @@ export declare class HostingNodeJSApi extends BaseAPI {
|
|
|
19023
19878
|
* @memberof HostingNodeJSApi
|
|
19024
19879
|
*/
|
|
19025
19880
|
getNodeJSBuildLogsV1(username: string, domain: string, uuid: string, fromLine?: number | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<HostingV1NodeJsBuildLogsResource, any, {}, any>>;
|
|
19881
|
+
/**
|
|
19882
|
+
* Auto-detect Node.js build settings from a package.json inside an archive already on the server. Use this before calling `Start Node.js Build` to preview what settings will be used, or to let the user review and override values (framework, node version, root directory, output directory, build script) before committing to a build. The archive must already be present on the website\'s file storage. Use the `Generate Upload URL` endpoint to obtain credentials and upload the archive first. To upload an archive and start a build in one step without inspecting settings first, use the `Create Node.js Build from Archive` endpoint instead.
|
|
19883
|
+
* @summary Get Node.js build settings from archive
|
|
19884
|
+
* @param {string} username
|
|
19885
|
+
* @param {string} domain Domain name
|
|
19886
|
+
* @param {string} archivePath The path to the archive file relative to the document root of the vhost
|
|
19887
|
+
* @param {*} [options] Override http request option.
|
|
19888
|
+
* @throws {RequiredError}
|
|
19889
|
+
* @memberof HostingNodeJSApi
|
|
19890
|
+
*/
|
|
19891
|
+
getNodeJsBuildSettingsFromArchiveV1(username: string, domain: string, archivePath: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<HostingV1NodeJsBuildSettingsResource, any, {}, any>>;
|
|
19026
19892
|
/**
|
|
19027
19893
|
* Retrieve a paginated list of Node.js build processes for a specific website. Each build represents a single run of the Node.js build pipeline. Use the `states` query parameter to filter results by build state (pending, running, completed, failed). Use the `uuid` from a build to poll its output via the `Get Node.js Build Logs` endpoint.
|
|
19028
19894
|
* @summary List NodeJS builds
|
|
@@ -19068,6 +19934,17 @@ export declare class HostingNodeJSApi extends BaseAPI {
|
|
|
19068
19934
|
* @memberof HostingNodeJSApi
|
|
19069
19935
|
*/
|
|
19070
19936
|
restartNodeJsApplicationV1(username: string, domain: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CommonSuccessEmptyResource, any, {}, any>>;
|
|
19937
|
+
/**
|
|
19938
|
+
* Start a Node.js build process using files already present on the website\'s file storage. WARNING: on success this overwrites the website\'s existing contents and cannot be undone — verify this is intended before calling this endpoint. The `source_type` must be `archive` and `source_options.archive_path` must point to an existing archive file on the server (relative to the website document root). Use the `Generate Upload URL` endpoint to obtain credentials and upload the archive first. To auto-detect build settings from an archive before starting, first call the `Get Node.js Build Settings from Archive` endpoint. To upload an archive and start a build in one step, use the `Create Node.js Build from Archive` endpoint instead. The returned build `uuid` can be used to poll progress and retrieve logs via the `Get Node.js Build Logs` endpoint.
|
|
19939
|
+
* @summary Start Node.js build
|
|
19940
|
+
* @param {string} username
|
|
19941
|
+
* @param {string} domain Domain name
|
|
19942
|
+
* @param {HostingV1NodeJsStartBuildRequest} hostingV1NodeJsStartBuildRequest
|
|
19943
|
+
* @param {*} [options] Override http request option.
|
|
19944
|
+
* @throws {RequiredError}
|
|
19945
|
+
* @memberof HostingNodeJSApi
|
|
19946
|
+
*/
|
|
19947
|
+
startNodeJsBuildV1(username: string, domain: string, hostingV1NodeJsStartBuildRequest: HostingV1NodeJsStartBuildRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<HostingV1NodeJsBuildResource, any, {}, any>>;
|
|
19071
19948
|
}
|
|
19072
19949
|
/**
|
|
19073
19950
|
* @export
|
|
@@ -19606,18 +20483,29 @@ export declare const HostingWebsitesApiAxiosParamCreator: (configuration?: Confi
|
|
|
19606
20483
|
*/
|
|
19607
20484
|
deleteWebsiteV1: (domain: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
19608
20485
|
/**
|
|
19609
|
-
*
|
|
20486
|
+
* Deploy a static application from an archive file. WARNING: this overwrites the website\'s existing contents and cannot be undone — verify this is intended before calling this endpoint. This endpoint allows you to deploy a static application from an archive file that has been uploaded to the website\'s directory. This only works for static sites (pre-built HTML/CSS/JS with no build step). For Node.js applications, use `Create NodeJS build from archive` instead, or `Start Node.js build` if the archive is already uploaded. For WordPress sites, use `Import WordPress website`.
|
|
20487
|
+
* @summary Deploy static site archive
|
|
20488
|
+
* @param {string} username
|
|
20489
|
+
* @param {string} domain Domain name
|
|
20490
|
+
* @param {HostingV1WebsitesDeployArchiveRequest} hostingV1WebsitesDeployArchiveRequest
|
|
20491
|
+
* @param {*} [options] Override http request option.
|
|
20492
|
+
* @throws {RequiredError}
|
|
20493
|
+
*/
|
|
20494
|
+
deployStaticSiteArchiveV1: (username: string, domain: string, hostingV1WebsitesDeployArchiveRequest: HostingV1WebsitesDeployArchiveRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
20495
|
+
/**
|
|
20496
|
+
* Retrieve a paginated list of websites (CloudLinux, Builder, and Horizons) accessible to the authenticated client. This endpoint returns websites from your hosting accounts as well as websites from other client hosting accounts that have shared access with you. Each website includes a `website_type` field describing the type of website detected on the underlying platform (`wordpress`, `builder`, `horizons`, `nodejs`, or `other`). Some fields, such as `vhost_type`, `username`, and `root_directory`, only apply to CloudLinux websites and are null for other platforms. Use `website_types` to list only websites of a given detected type, e.g. only WordPress websites (`website_types=wordpress`) or only Node.js websites (`website_types=nodejs`). Combine with the other available query parameters to filter by username, order ID, enabled status, or domain name for more targeted results.
|
|
19610
20497
|
* @summary List websites
|
|
19611
20498
|
* @param {number} [page] Page number
|
|
19612
20499
|
* @param {number} [perPage] Number of items per page
|
|
19613
20500
|
* @param {string | null} [username] Filter by specific username
|
|
19614
20501
|
* @param {number | null} [orderId] Order ID
|
|
19615
20502
|
* @param {boolean | null} [isEnabled] Filter by enabled status
|
|
19616
|
-
* @param {string | null} [domain] Filter by domain name (
|
|
20503
|
+
* @param {string | null} [domain] Filter by domain name (case-insensitive substring match)
|
|
20504
|
+
* @param {Array<ListWebsitesV1WebsiteTypesEnum>} [websiteTypes] Filter by detected website type, e.g. wordpress,nodejs. Accepts a comma-separated list.
|
|
19617
20505
|
* @param {*} [options] Override http request option.
|
|
19618
20506
|
* @throws {RequiredError}
|
|
19619
20507
|
*/
|
|
19620
|
-
listWebsitesV1: (page?: number, perPage?: number, username?: string | null, orderId?: number | null, isEnabled?: boolean | null, domain?: string | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
20508
|
+
listWebsitesV1: (page?: number, perPage?: number, username?: string | null, orderId?: number | null, isEnabled?: boolean | null, domain?: string | null, websiteTypes?: Array<ListWebsitesV1WebsiteTypesEnum>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
19621
20509
|
};
|
|
19622
20510
|
/**
|
|
19623
20511
|
* HostingWebsitesApi - functional programming interface
|
|
@@ -19641,18 +20529,29 @@ export declare const HostingWebsitesApiFp: (configuration?: Configuration) => {
|
|
|
19641
20529
|
*/
|
|
19642
20530
|
deleteWebsiteV1(domain: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommonSuccessEmptyResource>>;
|
|
19643
20531
|
/**
|
|
19644
|
-
*
|
|
20532
|
+
* Deploy a static application from an archive file. WARNING: this overwrites the website\'s existing contents and cannot be undone — verify this is intended before calling this endpoint. This endpoint allows you to deploy a static application from an archive file that has been uploaded to the website\'s directory. This only works for static sites (pre-built HTML/CSS/JS with no build step). For Node.js applications, use `Create NodeJS build from archive` instead, or `Start Node.js build` if the archive is already uploaded. For WordPress sites, use `Import WordPress website`.
|
|
20533
|
+
* @summary Deploy static site archive
|
|
20534
|
+
* @param {string} username
|
|
20535
|
+
* @param {string} domain Domain name
|
|
20536
|
+
* @param {HostingV1WebsitesDeployArchiveRequest} hostingV1WebsitesDeployArchiveRequest
|
|
20537
|
+
* @param {*} [options] Override http request option.
|
|
20538
|
+
* @throws {RequiredError}
|
|
20539
|
+
*/
|
|
20540
|
+
deployStaticSiteArchiveV1(username: string, domain: string, hostingV1WebsitesDeployArchiveRequest: HostingV1WebsitesDeployArchiveRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommonSuccessEmptyResource>>;
|
|
20541
|
+
/**
|
|
20542
|
+
* Retrieve a paginated list of websites (CloudLinux, Builder, and Horizons) accessible to the authenticated client. This endpoint returns websites from your hosting accounts as well as websites from other client hosting accounts that have shared access with you. Each website includes a `website_type` field describing the type of website detected on the underlying platform (`wordpress`, `builder`, `horizons`, `nodejs`, or `other`). Some fields, such as `vhost_type`, `username`, and `root_directory`, only apply to CloudLinux websites and are null for other platforms. Use `website_types` to list only websites of a given detected type, e.g. only WordPress websites (`website_types=wordpress`) or only Node.js websites (`website_types=nodejs`). Combine with the other available query parameters to filter by username, order ID, enabled status, or domain name for more targeted results.
|
|
19645
20543
|
* @summary List websites
|
|
19646
20544
|
* @param {number} [page] Page number
|
|
19647
20545
|
* @param {number} [perPage] Number of items per page
|
|
19648
20546
|
* @param {string | null} [username] Filter by specific username
|
|
19649
20547
|
* @param {number | null} [orderId] Order ID
|
|
19650
20548
|
* @param {boolean | null} [isEnabled] Filter by enabled status
|
|
19651
|
-
* @param {string | null} [domain] Filter by domain name (
|
|
20549
|
+
* @param {string | null} [domain] Filter by domain name (case-insensitive substring match)
|
|
20550
|
+
* @param {Array<ListWebsitesV1WebsiteTypesEnum>} [websiteTypes] Filter by detected website type, e.g. wordpress,nodejs. Accepts a comma-separated list.
|
|
19652
20551
|
* @param {*} [options] Override http request option.
|
|
19653
20552
|
* @throws {RequiredError}
|
|
19654
20553
|
*/
|
|
19655
|
-
listWebsitesV1(page?: number, perPage?: number, username?: string | null, orderId?: number | null, isEnabled?: boolean | null, domain?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<HostingListWebsitesV1200Response>>;
|
|
20554
|
+
listWebsitesV1(page?: number, perPage?: number, username?: string | null, orderId?: number | null, isEnabled?: boolean | null, domain?: string | null, websiteTypes?: Array<ListWebsitesV1WebsiteTypesEnum>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<HostingListWebsitesV1200Response>>;
|
|
19656
20555
|
};
|
|
19657
20556
|
/**
|
|
19658
20557
|
* HostingWebsitesApi - factory interface
|
|
@@ -19676,18 +20575,29 @@ export declare const HostingWebsitesApiFactory: (configuration?: Configuration,
|
|
|
19676
20575
|
*/
|
|
19677
20576
|
deleteWebsiteV1(domain: string, options?: RawAxiosRequestConfig): AxiosPromise<CommonSuccessEmptyResource>;
|
|
19678
20577
|
/**
|
|
19679
|
-
*
|
|
20578
|
+
* Deploy a static application from an archive file. WARNING: this overwrites the website\'s existing contents and cannot be undone — verify this is intended before calling this endpoint. This endpoint allows you to deploy a static application from an archive file that has been uploaded to the website\'s directory. This only works for static sites (pre-built HTML/CSS/JS with no build step). For Node.js applications, use `Create NodeJS build from archive` instead, or `Start Node.js build` if the archive is already uploaded. For WordPress sites, use `Import WordPress website`.
|
|
20579
|
+
* @summary Deploy static site archive
|
|
20580
|
+
* @param {string} username
|
|
20581
|
+
* @param {string} domain Domain name
|
|
20582
|
+
* @param {HostingV1WebsitesDeployArchiveRequest} hostingV1WebsitesDeployArchiveRequest
|
|
20583
|
+
* @param {*} [options] Override http request option.
|
|
20584
|
+
* @throws {RequiredError}
|
|
20585
|
+
*/
|
|
20586
|
+
deployStaticSiteArchiveV1(username: string, domain: string, hostingV1WebsitesDeployArchiveRequest: HostingV1WebsitesDeployArchiveRequest, options?: RawAxiosRequestConfig): AxiosPromise<CommonSuccessEmptyResource>;
|
|
20587
|
+
/**
|
|
20588
|
+
* Retrieve a paginated list of websites (CloudLinux, Builder, and Horizons) accessible to the authenticated client. This endpoint returns websites from your hosting accounts as well as websites from other client hosting accounts that have shared access with you. Each website includes a `website_type` field describing the type of website detected on the underlying platform (`wordpress`, `builder`, `horizons`, `nodejs`, or `other`). Some fields, such as `vhost_type`, `username`, and `root_directory`, only apply to CloudLinux websites and are null for other platforms. Use `website_types` to list only websites of a given detected type, e.g. only WordPress websites (`website_types=wordpress`) or only Node.js websites (`website_types=nodejs`). Combine with the other available query parameters to filter by username, order ID, enabled status, or domain name for more targeted results.
|
|
19680
20589
|
* @summary List websites
|
|
19681
20590
|
* @param {number} [page] Page number
|
|
19682
20591
|
* @param {number} [perPage] Number of items per page
|
|
19683
20592
|
* @param {string | null} [username] Filter by specific username
|
|
19684
20593
|
* @param {number | null} [orderId] Order ID
|
|
19685
20594
|
* @param {boolean | null} [isEnabled] Filter by enabled status
|
|
19686
|
-
* @param {string | null} [domain] Filter by domain name (
|
|
20595
|
+
* @param {string | null} [domain] Filter by domain name (case-insensitive substring match)
|
|
20596
|
+
* @param {Array<ListWebsitesV1WebsiteTypesEnum>} [websiteTypes] Filter by detected website type, e.g. wordpress,nodejs. Accepts a comma-separated list.
|
|
19687
20597
|
* @param {*} [options] Override http request option.
|
|
19688
20598
|
* @throws {RequiredError}
|
|
19689
20599
|
*/
|
|
19690
|
-
listWebsitesV1(page?: number, perPage?: number, username?: string | null, orderId?: number | null, isEnabled?: boolean | null, domain?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<HostingListWebsitesV1200Response>;
|
|
20600
|
+
listWebsitesV1(page?: number, perPage?: number, username?: string | null, orderId?: number | null, isEnabled?: boolean | null, domain?: string | null, websiteTypes?: Array<ListWebsitesV1WebsiteTypesEnum>, options?: RawAxiosRequestConfig): AxiosPromise<HostingListWebsitesV1200Response>;
|
|
19691
20601
|
};
|
|
19692
20602
|
/**
|
|
19693
20603
|
* HostingWebsitesApi - object-oriented interface
|
|
@@ -19715,20 +20625,43 @@ export declare class HostingWebsitesApi extends BaseAPI {
|
|
|
19715
20625
|
*/
|
|
19716
20626
|
deleteWebsiteV1(domain: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CommonSuccessEmptyResource, any, {}, any>>;
|
|
19717
20627
|
/**
|
|
19718
|
-
*
|
|
20628
|
+
* Deploy a static application from an archive file. WARNING: this overwrites the website\'s existing contents and cannot be undone — verify this is intended before calling this endpoint. This endpoint allows you to deploy a static application from an archive file that has been uploaded to the website\'s directory. This only works for static sites (pre-built HTML/CSS/JS with no build step). For Node.js applications, use `Create NodeJS build from archive` instead, or `Start Node.js build` if the archive is already uploaded. For WordPress sites, use `Import WordPress website`.
|
|
20629
|
+
* @summary Deploy static site archive
|
|
20630
|
+
* @param {string} username
|
|
20631
|
+
* @param {string} domain Domain name
|
|
20632
|
+
* @param {HostingV1WebsitesDeployArchiveRequest} hostingV1WebsitesDeployArchiveRequest
|
|
20633
|
+
* @param {*} [options] Override http request option.
|
|
20634
|
+
* @throws {RequiredError}
|
|
20635
|
+
* @memberof HostingWebsitesApi
|
|
20636
|
+
*/
|
|
20637
|
+
deployStaticSiteArchiveV1(username: string, domain: string, hostingV1WebsitesDeployArchiveRequest: HostingV1WebsitesDeployArchiveRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CommonSuccessEmptyResource, any, {}, any>>;
|
|
20638
|
+
/**
|
|
20639
|
+
* Retrieve a paginated list of websites (CloudLinux, Builder, and Horizons) accessible to the authenticated client. This endpoint returns websites from your hosting accounts as well as websites from other client hosting accounts that have shared access with you. Each website includes a `website_type` field describing the type of website detected on the underlying platform (`wordpress`, `builder`, `horizons`, `nodejs`, or `other`). Some fields, such as `vhost_type`, `username`, and `root_directory`, only apply to CloudLinux websites and are null for other platforms. Use `website_types` to list only websites of a given detected type, e.g. only WordPress websites (`website_types=wordpress`) or only Node.js websites (`website_types=nodejs`). Combine with the other available query parameters to filter by username, order ID, enabled status, or domain name for more targeted results.
|
|
19719
20640
|
* @summary List websites
|
|
19720
20641
|
* @param {number} [page] Page number
|
|
19721
20642
|
* @param {number} [perPage] Number of items per page
|
|
19722
20643
|
* @param {string | null} [username] Filter by specific username
|
|
19723
20644
|
* @param {number | null} [orderId] Order ID
|
|
19724
20645
|
* @param {boolean | null} [isEnabled] Filter by enabled status
|
|
19725
|
-
* @param {string | null} [domain] Filter by domain name (
|
|
20646
|
+
* @param {string | null} [domain] Filter by domain name (case-insensitive substring match)
|
|
20647
|
+
* @param {Array<ListWebsitesV1WebsiteTypesEnum>} [websiteTypes] Filter by detected website type, e.g. wordpress,nodejs. Accepts a comma-separated list.
|
|
19726
20648
|
* @param {*} [options] Override http request option.
|
|
19727
20649
|
* @throws {RequiredError}
|
|
19728
20650
|
* @memberof HostingWebsitesApi
|
|
19729
20651
|
*/
|
|
19730
|
-
listWebsitesV1(page?: number, perPage?: number, username?: string | null, orderId?: number | null, isEnabled?: boolean | null, domain?: string | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<HostingListWebsitesV1200Response, any, {}, any>>;
|
|
20652
|
+
listWebsitesV1(page?: number, perPage?: number, username?: string | null, orderId?: number | null, isEnabled?: boolean | null, domain?: string | null, websiteTypes?: Array<ListWebsitesV1WebsiteTypesEnum>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<HostingListWebsitesV1200Response, any, {}, any>>;
|
|
19731
20653
|
}
|
|
20654
|
+
/**
|
|
20655
|
+
* @export
|
|
20656
|
+
*/
|
|
20657
|
+
export declare const ListWebsitesV1WebsiteTypesEnum: {
|
|
20658
|
+
readonly Wordpress: "wordpress";
|
|
20659
|
+
readonly Builder: "builder";
|
|
20660
|
+
readonly Horizons: "horizons";
|
|
20661
|
+
readonly Nodejs: "nodejs";
|
|
20662
|
+
readonly Other: "other";
|
|
20663
|
+
};
|
|
20664
|
+
export type ListWebsitesV1WebsiteTypesEnum = typeof ListWebsitesV1WebsiteTypesEnum[keyof typeof ListWebsitesV1WebsiteTypesEnum];
|
|
19732
20665
|
/**
|
|
19733
20666
|
* MailAPITokensApi - axios parameter creator
|
|
19734
20667
|
* @export
|
|
@@ -26310,6 +27243,16 @@ export declare const WordPressInstallationsApiAxiosParamCreator: (configuration?
|
|
|
26310
27243
|
* @throws {RequiredError}
|
|
26311
27244
|
*/
|
|
26312
27245
|
getInstallationJWTTokenV1: (username: string, software: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
27246
|
+
/**
|
|
27247
|
+
* Import WordPress website to the specified domain. WARNING: this overwrites the website\'s existing contents and cannot be undone — verify this is intended before calling this endpoint. This endpoint allows you to import a WordPress website from archive and database files that have been uploaded to the website\'s directory.
|
|
27248
|
+
* @summary Import WordPress website
|
|
27249
|
+
* @param {string} username
|
|
27250
|
+
* @param {string} domain Domain name
|
|
27251
|
+
* @param {WordPressV1InstallationsImportWordPressRequest} wordPressV1InstallationsImportWordPressRequest
|
|
27252
|
+
* @param {*} [options] Override http request option.
|
|
27253
|
+
* @throws {RequiredError}
|
|
27254
|
+
*/
|
|
27255
|
+
importWordPressWebsiteV1: (username: string, domain: string, wordPressV1InstallationsImportWordPressRequest: WordPressV1InstallationsImportWordPressRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
26313
27256
|
/**
|
|
26314
27257
|
* Install WordPress on an existing website. The website must already exist before calling this endpoint. To create a new website first, use POST /api/hosting/v1/websites and poll GET /api/hosting/v1/websites until it appears. Call GET /api/hosting/v1/wordpress/installations filtered by username and domain before proceeding to check whether WordPress is already installed on the target domain/path. If WordPress already exists and `overwrite` is false (the default), the async job will fail. This operation is asynchronous: a successful response only means the install job has been queued, not that WordPress is ready. Installation typically takes 1-2 minutes. Poll GET /api/hosting/v1/wordpress/installations filtered by username and domain to track progress. When the installation appears in that list, WordPress is ready.
|
|
26315
27258
|
* @summary Install WordPress
|
|
@@ -26332,7 +27275,7 @@ export declare const WordPressInstallationsApiAxiosParamCreator: (configuration?
|
|
|
26332
27275
|
* List WordPress installations accessible to the authenticated client. Use this endpoint to discover existing WordPress installations and to poll for installation status after calling the install endpoint. When a newly requested installation appears in this list, WordPress is ready. Filter by username and domain to narrow results to a specific website. Each installation includes a `valid` flag and, when invalid, a `validationError` describing why.
|
|
26333
27276
|
* @summary List WordPress installations
|
|
26334
27277
|
* @param {string | null} [username] Filter by specific username
|
|
26335
|
-
* @param {string | null} [domain] Filter by domain name (
|
|
27278
|
+
* @param {string | null} [domain] Filter by domain name (case-insensitive substring match)
|
|
26336
27279
|
* @param {ListWordPressInstallationsV1OwnershipEnum} [ownership] Filter by ownership type. Defaults to \"owned\". Use \"all\" to include both owned and managed installations.
|
|
26337
27280
|
* @param {*} [options] Override http request option.
|
|
26338
27281
|
* @throws {RequiredError}
|
|
@@ -26399,6 +27342,16 @@ export declare const WordPressInstallationsApiFp: (configuration?: Configuration
|
|
|
26399
27342
|
* @throws {RequiredError}
|
|
26400
27343
|
*/
|
|
26401
27344
|
getInstallationJWTTokenV1(username: string, software: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WordPressV1InstallationsJwtTokenResource>>;
|
|
27345
|
+
/**
|
|
27346
|
+
* Import WordPress website to the specified domain. WARNING: this overwrites the website\'s existing contents and cannot be undone — verify this is intended before calling this endpoint. This endpoint allows you to import a WordPress website from archive and database files that have been uploaded to the website\'s directory.
|
|
27347
|
+
* @summary Import WordPress website
|
|
27348
|
+
* @param {string} username
|
|
27349
|
+
* @param {string} domain Domain name
|
|
27350
|
+
* @param {WordPressV1InstallationsImportWordPressRequest} wordPressV1InstallationsImportWordPressRequest
|
|
27351
|
+
* @param {*} [options] Override http request option.
|
|
27352
|
+
* @throws {RequiredError}
|
|
27353
|
+
*/
|
|
27354
|
+
importWordPressWebsiteV1(username: string, domain: string, wordPressV1InstallationsImportWordPressRequest: WordPressV1InstallationsImportWordPressRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommonSuccessEmptyResource>>;
|
|
26402
27355
|
/**
|
|
26403
27356
|
* Install WordPress on an existing website. The website must already exist before calling this endpoint. To create a new website first, use POST /api/hosting/v1/websites and poll GET /api/hosting/v1/websites until it appears. Call GET /api/hosting/v1/wordpress/installations filtered by username and domain before proceeding to check whether WordPress is already installed on the target domain/path. If WordPress already exists and `overwrite` is false (the default), the async job will fail. This operation is asynchronous: a successful response only means the install job has been queued, not that WordPress is ready. Installation typically takes 1-2 minutes. Poll GET /api/hosting/v1/wordpress/installations filtered by username and domain to track progress. When the installation appears in that list, WordPress is ready.
|
|
26404
27357
|
* @summary Install WordPress
|
|
@@ -26421,7 +27374,7 @@ export declare const WordPressInstallationsApiFp: (configuration?: Configuration
|
|
|
26421
27374
|
* List WordPress installations accessible to the authenticated client. Use this endpoint to discover existing WordPress installations and to poll for installation status after calling the install endpoint. When a newly requested installation appears in this list, WordPress is ready. Filter by username and domain to narrow results to a specific website. Each installation includes a `valid` flag and, when invalid, a `validationError` describing why.
|
|
26422
27375
|
* @summary List WordPress installations
|
|
26423
27376
|
* @param {string | null} [username] Filter by specific username
|
|
26424
|
-
* @param {string | null} [domain] Filter by domain name (
|
|
27377
|
+
* @param {string | null} [domain] Filter by domain name (case-insensitive substring match)
|
|
26425
27378
|
* @param {ListWordPressInstallationsV1OwnershipEnum} [ownership] Filter by ownership type. Defaults to \"owned\". Use \"all\" to include both owned and managed installations.
|
|
26426
27379
|
* @param {*} [options] Override http request option.
|
|
26427
27380
|
* @throws {RequiredError}
|
|
@@ -26488,6 +27441,16 @@ export declare const WordPressInstallationsApiFactory: (configuration?: Configur
|
|
|
26488
27441
|
* @throws {RequiredError}
|
|
26489
27442
|
*/
|
|
26490
27443
|
getInstallationJWTTokenV1(username: string, software: string, options?: RawAxiosRequestConfig): AxiosPromise<WordPressV1InstallationsJwtTokenResource>;
|
|
27444
|
+
/**
|
|
27445
|
+
* Import WordPress website to the specified domain. WARNING: this overwrites the website\'s existing contents and cannot be undone — verify this is intended before calling this endpoint. This endpoint allows you to import a WordPress website from archive and database files that have been uploaded to the website\'s directory.
|
|
27446
|
+
* @summary Import WordPress website
|
|
27447
|
+
* @param {string} username
|
|
27448
|
+
* @param {string} domain Domain name
|
|
27449
|
+
* @param {WordPressV1InstallationsImportWordPressRequest} wordPressV1InstallationsImportWordPressRequest
|
|
27450
|
+
* @param {*} [options] Override http request option.
|
|
27451
|
+
* @throws {RequiredError}
|
|
27452
|
+
*/
|
|
27453
|
+
importWordPressWebsiteV1(username: string, domain: string, wordPressV1InstallationsImportWordPressRequest: WordPressV1InstallationsImportWordPressRequest, options?: RawAxiosRequestConfig): AxiosPromise<CommonSuccessEmptyResource>;
|
|
26491
27454
|
/**
|
|
26492
27455
|
* Install WordPress on an existing website. The website must already exist before calling this endpoint. To create a new website first, use POST /api/hosting/v1/websites and poll GET /api/hosting/v1/websites until it appears. Call GET /api/hosting/v1/wordpress/installations filtered by username and domain before proceeding to check whether WordPress is already installed on the target domain/path. If WordPress already exists and `overwrite` is false (the default), the async job will fail. This operation is asynchronous: a successful response only means the install job has been queued, not that WordPress is ready. Installation typically takes 1-2 minutes. Poll GET /api/hosting/v1/wordpress/installations filtered by username and domain to track progress. When the installation appears in that list, WordPress is ready.
|
|
26493
27456
|
* @summary Install WordPress
|
|
@@ -26510,7 +27473,7 @@ export declare const WordPressInstallationsApiFactory: (configuration?: Configur
|
|
|
26510
27473
|
* List WordPress installations accessible to the authenticated client. Use this endpoint to discover existing WordPress installations and to poll for installation status after calling the install endpoint. When a newly requested installation appears in this list, WordPress is ready. Filter by username and domain to narrow results to a specific website. Each installation includes a `valid` flag and, when invalid, a `validationError` describing why.
|
|
26511
27474
|
* @summary List WordPress installations
|
|
26512
27475
|
* @param {string | null} [username] Filter by specific username
|
|
26513
|
-
* @param {string | null} [domain] Filter by domain name (
|
|
27476
|
+
* @param {string | null} [domain] Filter by domain name (case-insensitive substring match)
|
|
26514
27477
|
* @param {ListWordPressInstallationsV1OwnershipEnum} [ownership] Filter by ownership type. Defaults to \"owned\". Use \"all\" to include both owned and managed installations.
|
|
26515
27478
|
* @param {*} [options] Override http request option.
|
|
26516
27479
|
* @throws {RequiredError}
|
|
@@ -26583,6 +27546,17 @@ export declare class WordPressInstallationsApi extends BaseAPI {
|
|
|
26583
27546
|
* @memberof WordPressInstallationsApi
|
|
26584
27547
|
*/
|
|
26585
27548
|
getInstallationJWTTokenV1(username: string, software: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WordPressV1InstallationsJwtTokenResource, any, {}, any>>;
|
|
27549
|
+
/**
|
|
27550
|
+
* Import WordPress website to the specified domain. WARNING: this overwrites the website\'s existing contents and cannot be undone — verify this is intended before calling this endpoint. This endpoint allows you to import a WordPress website from archive and database files that have been uploaded to the website\'s directory.
|
|
27551
|
+
* @summary Import WordPress website
|
|
27552
|
+
* @param {string} username
|
|
27553
|
+
* @param {string} domain Domain name
|
|
27554
|
+
* @param {WordPressV1InstallationsImportWordPressRequest} wordPressV1InstallationsImportWordPressRequest
|
|
27555
|
+
* @param {*} [options] Override http request option.
|
|
27556
|
+
* @throws {RequiredError}
|
|
27557
|
+
* @memberof WordPressInstallationsApi
|
|
27558
|
+
*/
|
|
27559
|
+
importWordPressWebsiteV1(username: string, domain: string, wordPressV1InstallationsImportWordPressRequest: WordPressV1InstallationsImportWordPressRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CommonSuccessEmptyResource, any, {}, any>>;
|
|
26586
27560
|
/**
|
|
26587
27561
|
* Install WordPress on an existing website. The website must already exist before calling this endpoint. To create a new website first, use POST /api/hosting/v1/websites and poll GET /api/hosting/v1/websites until it appears. Call GET /api/hosting/v1/wordpress/installations filtered by username and domain before proceeding to check whether WordPress is already installed on the target domain/path. If WordPress already exists and `overwrite` is false (the default), the async job will fail. This operation is asynchronous: a successful response only means the install job has been queued, not that WordPress is ready. Installation typically takes 1-2 minutes. Poll GET /api/hosting/v1/wordpress/installations filtered by username and domain to track progress. When the installation appears in that list, WordPress is ready.
|
|
26588
27562
|
* @summary Install WordPress
|
|
@@ -26607,7 +27581,7 @@ export declare class WordPressInstallationsApi extends BaseAPI {
|
|
|
26607
27581
|
* List WordPress installations accessible to the authenticated client. Use this endpoint to discover existing WordPress installations and to poll for installation status after calling the install endpoint. When a newly requested installation appears in this list, WordPress is ready. Filter by username and domain to narrow results to a specific website. Each installation includes a `valid` flag and, when invalid, a `validationError` describing why.
|
|
26608
27582
|
* @summary List WordPress installations
|
|
26609
27583
|
* @param {string | null} [username] Filter by specific username
|
|
26610
|
-
* @param {string | null} [domain] Filter by domain name (
|
|
27584
|
+
* @param {string | null} [domain] Filter by domain name (case-insensitive substring match)
|
|
26611
27585
|
* @param {ListWordPressInstallationsV1OwnershipEnum} [ownership] Filter by ownership type. Defaults to \"owned\". Use \"all\" to include both owned and managed installations.
|
|
26612
27586
|
* @param {*} [options] Override http request option.
|
|
26613
27587
|
* @throws {RequiredError}
|
|
@@ -27034,7 +28008,7 @@ export declare const WordPressPluginsApiAxiosParamCreator: (configuration?: Conf
|
|
|
27034
28008
|
/**
|
|
27035
28009
|
* Check whether WooCommerce is installed on any WordPress installation of a domain. Optionally filter by domain to scope the check.
|
|
27036
28010
|
* @summary Check if WooCommerce is installed
|
|
27037
|
-
* @param {string | null} [domain] Filter by domain name (
|
|
28011
|
+
* @param {string | null} [domain] Filter by domain name (case-insensitive substring match)
|
|
27038
28012
|
* @param {*} [options] Override http request option.
|
|
27039
28013
|
* @throws {RequiredError}
|
|
27040
28014
|
*/
|
|
@@ -27049,6 +28023,16 @@ export declare const WordPressPluginsApiAxiosParamCreator: (configuration?: Conf
|
|
|
27049
28023
|
* @throws {RequiredError}
|
|
27050
28024
|
*/
|
|
27051
28025
|
deactivateWordPressPluginV1: (username: string, software: string, wordPressV1PluginsDeactivatePluginRequest: WordPressV1PluginsDeactivatePluginRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
28026
|
+
/**
|
|
28027
|
+
* Deploy a WordPress plugin from an already uploaded directory. This endpoint allows you to deploy a WordPress plugin that has been uploaded to the website\'s directory. The plugin will be activated and made available in the WordPress admin panel.
|
|
28028
|
+
* @summary Deploy WordPress plugin
|
|
28029
|
+
* @param {string} username
|
|
28030
|
+
* @param {string} domain Domain name
|
|
28031
|
+
* @param {WordPressV1PluginsDeployPluginRequest} wordPressV1PluginsDeployPluginRequest
|
|
28032
|
+
* @param {*} [options] Override http request option.
|
|
28033
|
+
* @throws {RequiredError}
|
|
28034
|
+
*/
|
|
28035
|
+
deployWordPressPluginV1: (username: string, domain: string, wordPressV1PluginsDeployPluginRequest: WordPressV1PluginsDeployPluginRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
27052
28036
|
/**
|
|
27053
28037
|
* Install one or more plugins on an existing WordPress installation. Provide the WordPress installation (software) identifier in the path. It can be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field). Use GET /api/hosting/v1/wordpress/plugins to discover the plugin slugs available for installation. This operation is asynchronous: a successful response only means the install job has been queued, not that the plugins are ready.
|
|
27054
28038
|
* @summary Install WordPress plugins
|
|
@@ -27143,7 +28127,7 @@ export declare const WordPressPluginsApiFp: (configuration?: Configuration) => {
|
|
|
27143
28127
|
/**
|
|
27144
28128
|
* Check whether WooCommerce is installed on any WordPress installation of a domain. Optionally filter by domain to scope the check.
|
|
27145
28129
|
* @summary Check if WooCommerce is installed
|
|
27146
|
-
* @param {string | null} [domain] Filter by domain name (
|
|
28130
|
+
* @param {string | null} [domain] Filter by domain name (case-insensitive substring match)
|
|
27147
28131
|
* @param {*} [options] Override http request option.
|
|
27148
28132
|
* @throws {RequiredError}
|
|
27149
28133
|
*/
|
|
@@ -27158,6 +28142,16 @@ export declare const WordPressPluginsApiFp: (configuration?: Configuration) => {
|
|
|
27158
28142
|
* @throws {RequiredError}
|
|
27159
28143
|
*/
|
|
27160
28144
|
deactivateWordPressPluginV1(username: string, software: string, wordPressV1PluginsDeactivatePluginRequest: WordPressV1PluginsDeactivatePluginRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommonSuccessEmptyResource>>;
|
|
28145
|
+
/**
|
|
28146
|
+
* Deploy a WordPress plugin from an already uploaded directory. This endpoint allows you to deploy a WordPress plugin that has been uploaded to the website\'s directory. The plugin will be activated and made available in the WordPress admin panel.
|
|
28147
|
+
* @summary Deploy WordPress plugin
|
|
28148
|
+
* @param {string} username
|
|
28149
|
+
* @param {string} domain Domain name
|
|
28150
|
+
* @param {WordPressV1PluginsDeployPluginRequest} wordPressV1PluginsDeployPluginRequest
|
|
28151
|
+
* @param {*} [options] Override http request option.
|
|
28152
|
+
* @throws {RequiredError}
|
|
28153
|
+
*/
|
|
28154
|
+
deployWordPressPluginV1(username: string, domain: string, wordPressV1PluginsDeployPluginRequest: WordPressV1PluginsDeployPluginRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommonSuccessEmptyResource>>;
|
|
27161
28155
|
/**
|
|
27162
28156
|
* Install one or more plugins on an existing WordPress installation. Provide the WordPress installation (software) identifier in the path. It can be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field). Use GET /api/hosting/v1/wordpress/plugins to discover the plugin slugs available for installation. This operation is asynchronous: a successful response only means the install job has been queued, not that the plugins are ready.
|
|
27163
28157
|
* @summary Install WordPress plugins
|
|
@@ -27252,7 +28246,7 @@ export declare const WordPressPluginsApiFactory: (configuration?: Configuration,
|
|
|
27252
28246
|
/**
|
|
27253
28247
|
* Check whether WooCommerce is installed on any WordPress installation of a domain. Optionally filter by domain to scope the check.
|
|
27254
28248
|
* @summary Check if WooCommerce is installed
|
|
27255
|
-
* @param {string | null} [domain] Filter by domain name (
|
|
28249
|
+
* @param {string | null} [domain] Filter by domain name (case-insensitive substring match)
|
|
27256
28250
|
* @param {*} [options] Override http request option.
|
|
27257
28251
|
* @throws {RequiredError}
|
|
27258
28252
|
*/
|
|
@@ -27267,6 +28261,16 @@ export declare const WordPressPluginsApiFactory: (configuration?: Configuration,
|
|
|
27267
28261
|
* @throws {RequiredError}
|
|
27268
28262
|
*/
|
|
27269
28263
|
deactivateWordPressPluginV1(username: string, software: string, wordPressV1PluginsDeactivatePluginRequest: WordPressV1PluginsDeactivatePluginRequest, options?: RawAxiosRequestConfig): AxiosPromise<CommonSuccessEmptyResource>;
|
|
28264
|
+
/**
|
|
28265
|
+
* Deploy a WordPress plugin from an already uploaded directory. This endpoint allows you to deploy a WordPress plugin that has been uploaded to the website\'s directory. The plugin will be activated and made available in the WordPress admin panel.
|
|
28266
|
+
* @summary Deploy WordPress plugin
|
|
28267
|
+
* @param {string} username
|
|
28268
|
+
* @param {string} domain Domain name
|
|
28269
|
+
* @param {WordPressV1PluginsDeployPluginRequest} wordPressV1PluginsDeployPluginRequest
|
|
28270
|
+
* @param {*} [options] Override http request option.
|
|
28271
|
+
* @throws {RequiredError}
|
|
28272
|
+
*/
|
|
28273
|
+
deployWordPressPluginV1(username: string, domain: string, wordPressV1PluginsDeployPluginRequest: WordPressV1PluginsDeployPluginRequest, options?: RawAxiosRequestConfig): AxiosPromise<CommonSuccessEmptyResource>;
|
|
27270
28274
|
/**
|
|
27271
28275
|
* Install one or more plugins on an existing WordPress installation. Provide the WordPress installation (software) identifier in the path. It can be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field). Use GET /api/hosting/v1/wordpress/plugins to discover the plugin slugs available for installation. This operation is asynchronous: a successful response only means the install job has been queued, not that the plugins are ready.
|
|
27272
28276
|
* @summary Install WordPress plugins
|
|
@@ -27364,7 +28368,7 @@ export declare class WordPressPluginsApi extends BaseAPI {
|
|
|
27364
28368
|
/**
|
|
27365
28369
|
* Check whether WooCommerce is installed on any WordPress installation of a domain. Optionally filter by domain to scope the check.
|
|
27366
28370
|
* @summary Check if WooCommerce is installed
|
|
27367
|
-
* @param {string | null} [domain] Filter by domain name (
|
|
28371
|
+
* @param {string | null} [domain] Filter by domain name (case-insensitive substring match)
|
|
27368
28372
|
* @param {*} [options] Override http request option.
|
|
27369
28373
|
* @throws {RequiredError}
|
|
27370
28374
|
* @memberof WordPressPluginsApi
|
|
@@ -27381,6 +28385,17 @@ export declare class WordPressPluginsApi extends BaseAPI {
|
|
|
27381
28385
|
* @memberof WordPressPluginsApi
|
|
27382
28386
|
*/
|
|
27383
28387
|
deactivateWordPressPluginV1(username: string, software: string, wordPressV1PluginsDeactivatePluginRequest: WordPressV1PluginsDeactivatePluginRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CommonSuccessEmptyResource, any, {}, any>>;
|
|
28388
|
+
/**
|
|
28389
|
+
* Deploy a WordPress plugin from an already uploaded directory. This endpoint allows you to deploy a WordPress plugin that has been uploaded to the website\'s directory. The plugin will be activated and made available in the WordPress admin panel.
|
|
28390
|
+
* @summary Deploy WordPress plugin
|
|
28391
|
+
* @param {string} username
|
|
28392
|
+
* @param {string} domain Domain name
|
|
28393
|
+
* @param {WordPressV1PluginsDeployPluginRequest} wordPressV1PluginsDeployPluginRequest
|
|
28394
|
+
* @param {*} [options] Override http request option.
|
|
28395
|
+
* @throws {RequiredError}
|
|
28396
|
+
* @memberof WordPressPluginsApi
|
|
28397
|
+
*/
|
|
28398
|
+
deployWordPressPluginV1(username: string, domain: string, wordPressV1PluginsDeployPluginRequest: WordPressV1PluginsDeployPluginRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CommonSuccessEmptyResource, any, {}, any>>;
|
|
27384
28399
|
/**
|
|
27385
28400
|
* Install one or more plugins on an existing WordPress installation. Provide the WordPress installation (software) identifier in the path. It can be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field). Use GET /api/hosting/v1/wordpress/plugins to discover the plugin slugs available for installation. This operation is asynchronous: a successful response only means the install job has been queued, not that the plugins are ready.
|
|
27386
28401
|
* @summary Install WordPress plugins
|
|
@@ -27487,6 +28502,16 @@ export declare const WordPressThemesApiAxiosParamCreator: (configuration?: Confi
|
|
|
27487
28502
|
* @throws {RequiredError}
|
|
27488
28503
|
*/
|
|
27489
28504
|
activateWordPressThemeV1: (username: string, software: string, wordPressV1ThemesActivateThemeRequest: WordPressV1ThemesActivateThemeRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
28505
|
+
/**
|
|
28506
|
+
* Deploy a WordPress theme from an already uploaded directory. This endpoint allows you to deploy a WordPress theme that has been uploaded to the website\'s directory. The theme can be optionally activated after deployment.
|
|
28507
|
+
* @summary Deploy WordPress theme
|
|
28508
|
+
* @param {string} username
|
|
28509
|
+
* @param {string} domain Domain name
|
|
28510
|
+
* @param {WordPressV1ThemesDeployThemeRequest} wordPressV1ThemesDeployThemeRequest
|
|
28511
|
+
* @param {*} [options] Override http request option.
|
|
28512
|
+
* @throws {RequiredError}
|
|
28513
|
+
*/
|
|
28514
|
+
deployWordPressThemeV1: (username: string, domain: string, wordPressV1ThemesDeployThemeRequest: WordPressV1ThemesDeployThemeRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
27490
28515
|
/**
|
|
27491
28516
|
* Install a theme on an existing WordPress installation. Provide the WordPress installation (software) identifier in the path. It can be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field). When the theme is one of the Hostinger themes (hostinger-blog, hostinger-affiliate-theme, hostinger-ai-theme), the optional `palette`, `layout`, and `font` fields are forwarded to the custom installer (defaults: palette1, layout1, default). For any other theme they are ignored. This operation is asynchronous: a successful response only means the install job has been queued, not that the theme is ready.
|
|
27492
28517
|
* @summary Install WordPress theme
|
|
@@ -27551,6 +28576,16 @@ export declare const WordPressThemesApiFp: (configuration?: Configuration) => {
|
|
|
27551
28576
|
* @throws {RequiredError}
|
|
27552
28577
|
*/
|
|
27553
28578
|
activateWordPressThemeV1(username: string, software: string, wordPressV1ThemesActivateThemeRequest: WordPressV1ThemesActivateThemeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommonSuccessEmptyResource>>;
|
|
28579
|
+
/**
|
|
28580
|
+
* Deploy a WordPress theme from an already uploaded directory. This endpoint allows you to deploy a WordPress theme that has been uploaded to the website\'s directory. The theme can be optionally activated after deployment.
|
|
28581
|
+
* @summary Deploy WordPress theme
|
|
28582
|
+
* @param {string} username
|
|
28583
|
+
* @param {string} domain Domain name
|
|
28584
|
+
* @param {WordPressV1ThemesDeployThemeRequest} wordPressV1ThemesDeployThemeRequest
|
|
28585
|
+
* @param {*} [options] Override http request option.
|
|
28586
|
+
* @throws {RequiredError}
|
|
28587
|
+
*/
|
|
28588
|
+
deployWordPressThemeV1(username: string, domain: string, wordPressV1ThemesDeployThemeRequest: WordPressV1ThemesDeployThemeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommonSuccessEmptyResource>>;
|
|
27554
28589
|
/**
|
|
27555
28590
|
* Install a theme on an existing WordPress installation. Provide the WordPress installation (software) identifier in the path. It can be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field). When the theme is one of the Hostinger themes (hostinger-blog, hostinger-affiliate-theme, hostinger-ai-theme), the optional `palette`, `layout`, and `font` fields are forwarded to the custom installer (defaults: palette1, layout1, default). For any other theme they are ignored. This operation is asynchronous: a successful response only means the install job has been queued, not that the theme is ready.
|
|
27556
28591
|
* @summary Install WordPress theme
|
|
@@ -27615,6 +28650,16 @@ export declare const WordPressThemesApiFactory: (configuration?: Configuration,
|
|
|
27615
28650
|
* @throws {RequiredError}
|
|
27616
28651
|
*/
|
|
27617
28652
|
activateWordPressThemeV1(username: string, software: string, wordPressV1ThemesActivateThemeRequest: WordPressV1ThemesActivateThemeRequest, options?: RawAxiosRequestConfig): AxiosPromise<CommonSuccessEmptyResource>;
|
|
28653
|
+
/**
|
|
28654
|
+
* Deploy a WordPress theme from an already uploaded directory. This endpoint allows you to deploy a WordPress theme that has been uploaded to the website\'s directory. The theme can be optionally activated after deployment.
|
|
28655
|
+
* @summary Deploy WordPress theme
|
|
28656
|
+
* @param {string} username
|
|
28657
|
+
* @param {string} domain Domain name
|
|
28658
|
+
* @param {WordPressV1ThemesDeployThemeRequest} wordPressV1ThemesDeployThemeRequest
|
|
28659
|
+
* @param {*} [options] Override http request option.
|
|
28660
|
+
* @throws {RequiredError}
|
|
28661
|
+
*/
|
|
28662
|
+
deployWordPressThemeV1(username: string, domain: string, wordPressV1ThemesDeployThemeRequest: WordPressV1ThemesDeployThemeRequest, options?: RawAxiosRequestConfig): AxiosPromise<CommonSuccessEmptyResource>;
|
|
27618
28663
|
/**
|
|
27619
28664
|
* Install a theme on an existing WordPress installation. Provide the WordPress installation (software) identifier in the path. It can be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field). When the theme is one of the Hostinger themes (hostinger-blog, hostinger-affiliate-theme, hostinger-ai-theme), the optional `palette`, `layout`, and `font` fields are forwarded to the custom installer (defaults: palette1, layout1, default). For any other theme they are ignored. This operation is asynchronous: a successful response only means the install job has been queued, not that the theme is ready.
|
|
27620
28665
|
* @summary Install WordPress theme
|
|
@@ -27682,6 +28727,17 @@ export declare class WordPressThemesApi extends BaseAPI {
|
|
|
27682
28727
|
* @memberof WordPressThemesApi
|
|
27683
28728
|
*/
|
|
27684
28729
|
activateWordPressThemeV1(username: string, software: string, wordPressV1ThemesActivateThemeRequest: WordPressV1ThemesActivateThemeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CommonSuccessEmptyResource, any, {}, any>>;
|
|
28730
|
+
/**
|
|
28731
|
+
* Deploy a WordPress theme from an already uploaded directory. This endpoint allows you to deploy a WordPress theme that has been uploaded to the website\'s directory. The theme can be optionally activated after deployment.
|
|
28732
|
+
* @summary Deploy WordPress theme
|
|
28733
|
+
* @param {string} username
|
|
28734
|
+
* @param {string} domain Domain name
|
|
28735
|
+
* @param {WordPressV1ThemesDeployThemeRequest} wordPressV1ThemesDeployThemeRequest
|
|
28736
|
+
* @param {*} [options] Override http request option.
|
|
28737
|
+
* @throws {RequiredError}
|
|
28738
|
+
* @memberof WordPressThemesApi
|
|
28739
|
+
*/
|
|
28740
|
+
deployWordPressThemeV1(username: string, domain: string, wordPressV1ThemesDeployThemeRequest: WordPressV1ThemesDeployThemeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CommonSuccessEmptyResource, any, {}, any>>;
|
|
27685
28741
|
/**
|
|
27686
28742
|
* Install a theme on an existing WordPress installation. Provide the WordPress installation (software) identifier in the path. It can be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field). When the theme is one of the Hostinger themes (hostinger-blog, hostinger-affiliate-theme, hostinger-ai-theme), the optional `palette`, `layout`, and `font` fields are forwarded to the custom installer (defaults: palette1, layout1, default). For any other theme they are ignored. This operation is asynchronous: a successful response only means the install job has been queued, not that the theme is ready.
|
|
27687
28743
|
* @summary Install WordPress theme
|