hostinger-api-sdk 1.39.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 +518 -28
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +2 -2
- package/dist/api.d.ts +440 -25
- package/dist/api.js +199 -38
- 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 +440 -25
- package/dist/esm/api.js +189 -28
- 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/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/HostingWebsitesApi.md +7 -4
- package/docs/WordPressInstallationsApi.md +2 -2
- package/docs/WordPressPluginsApi.md +2 -2
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/esm/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
|
|
@@ -14655,6 +14980,19 @@ export declare const AgencyHostingWebsitesApiAxiosParamCreator: (configuration?:
|
|
|
14655
14980
|
* @throws {RequiredError}
|
|
14656
14981
|
*/
|
|
14657
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>;
|
|
14658
14996
|
/**
|
|
14659
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.
|
|
14660
14998
|
* @summary List website processes
|
|
@@ -14694,6 +15032,19 @@ export declare const AgencyHostingWebsitesApiFp: (configuration?: Configuration)
|
|
|
14694
15032
|
* @throws {RequiredError}
|
|
14695
15033
|
*/
|
|
14696
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>>;
|
|
14697
15048
|
/**
|
|
14698
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.
|
|
14699
15050
|
* @summary List website processes
|
|
@@ -14733,6 +15084,19 @@ export declare const AgencyHostingWebsitesApiFactory: (configuration?: Configura
|
|
|
14733
15084
|
* @throws {RequiredError}
|
|
14734
15085
|
*/
|
|
14735
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>;
|
|
14736
15100
|
/**
|
|
14737
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.
|
|
14738
15102
|
* @summary List website processes
|
|
@@ -14777,6 +15141,20 @@ export declare class AgencyHostingWebsitesApi extends BaseAPI {
|
|
|
14777
15141
|
* @memberof AgencyHostingWebsitesApi
|
|
14778
15142
|
*/
|
|
14779
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>>;
|
|
14780
15158
|
/**
|
|
14781
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.
|
|
14782
15160
|
* @summary List website processes
|
|
@@ -14787,6 +15165,28 @@ export declare class AgencyHostingWebsitesApi extends BaseAPI {
|
|
|
14787
15165
|
*/
|
|
14788
15166
|
listWebsiteProcessesV1(websiteUid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AgencyHostingV1WebsitesWebsiteProcessResource[], any, {}, any>>;
|
|
14789
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];
|
|
14790
15190
|
/**
|
|
14791
15191
|
* AgencyHostingWordPressApi - axios parameter creator
|
|
14792
15192
|
* @export
|
|
@@ -18305,7 +18705,7 @@ export declare const HostingDatabasesApiAxiosParamCreator: (configuration?: Conf
|
|
|
18305
18705
|
* @param {string} username
|
|
18306
18706
|
* @param {number} [page] Page number
|
|
18307
18707
|
* @param {number} [perPage] Number of items per page
|
|
18308
|
-
* @param {string | null} [domain] Filter by domain name (
|
|
18708
|
+
* @param {string | null} [domain] Filter by domain name (case-insensitive substring match)
|
|
18309
18709
|
* @param {boolean | null} [isAssigned] When used with domain, return only databases assigned to that domain.
|
|
18310
18710
|
* @param {string | null} [search] Search databases by name, user, or creation date.
|
|
18311
18711
|
* @param {*} [options] Override http request option.
|
|
@@ -18399,7 +18799,7 @@ export declare const HostingDatabasesApiFp: (configuration?: Configuration) => {
|
|
|
18399
18799
|
* @param {string} username
|
|
18400
18800
|
* @param {number} [page] Page number
|
|
18401
18801
|
* @param {number} [perPage] Number of items per page
|
|
18402
|
-
* @param {string | null} [domain] Filter by domain name (
|
|
18802
|
+
* @param {string | null} [domain] Filter by domain name (case-insensitive substring match)
|
|
18403
18803
|
* @param {boolean | null} [isAssigned] When used with domain, return only databases assigned to that domain.
|
|
18404
18804
|
* @param {string | null} [search] Search databases by name, user, or creation date.
|
|
18405
18805
|
* @param {*} [options] Override http request option.
|
|
@@ -18493,7 +18893,7 @@ export declare const HostingDatabasesApiFactory: (configuration?: Configuration,
|
|
|
18493
18893
|
* @param {string} username
|
|
18494
18894
|
* @param {number} [page] Page number
|
|
18495
18895
|
* @param {number} [perPage] Number of items per page
|
|
18496
|
-
* @param {string | null} [domain] Filter by domain name (
|
|
18896
|
+
* @param {string | null} [domain] Filter by domain name (case-insensitive substring match)
|
|
18497
18897
|
* @param {boolean | null} [isAssigned] When used with domain, return only databases assigned to that domain.
|
|
18498
18898
|
* @param {string | null} [search] Search databases by name, user, or creation date.
|
|
18499
18899
|
* @param {*} [options] Override http request option.
|
|
@@ -18595,7 +18995,7 @@ export declare class HostingDatabasesApi extends BaseAPI {
|
|
|
18595
18995
|
* @param {string} username
|
|
18596
18996
|
* @param {number} [page] Page number
|
|
18597
18997
|
* @param {number} [perPage] Number of items per page
|
|
18598
|
-
* @param {string | null} [domain] Filter by domain name (
|
|
18998
|
+
* @param {string | null} [domain] Filter by domain name (case-insensitive substring match)
|
|
18599
18999
|
* @param {boolean | null} [isAssigned] When used with domain, return only databases assigned to that domain.
|
|
18600
19000
|
* @param {string | null} [search] Search databases by name, user, or creation date.
|
|
18601
19001
|
* @param {*} [options] Override http request option.
|
|
@@ -20093,18 +20493,19 @@ export declare const HostingWebsitesApiAxiosParamCreator: (configuration?: Confi
|
|
|
20093
20493
|
*/
|
|
20094
20494
|
deployStaticSiteArchiveV1: (username: string, domain: string, hostingV1WebsitesDeployArchiveRequest: HostingV1WebsitesDeployArchiveRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
20095
20495
|
/**
|
|
20096
|
-
* 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 the available query parameters to filter
|
|
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.
|
|
20097
20497
|
* @summary List websites
|
|
20098
20498
|
* @param {number} [page] Page number
|
|
20099
20499
|
* @param {number} [perPage] Number of items per page
|
|
20100
20500
|
* @param {string | null} [username] Filter by specific username
|
|
20101
20501
|
* @param {number | null} [orderId] Order ID
|
|
20102
20502
|
* @param {boolean | null} [isEnabled] Filter by enabled status
|
|
20103
|
-
* @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.
|
|
20104
20505
|
* @param {*} [options] Override http request option.
|
|
20105
20506
|
* @throws {RequiredError}
|
|
20106
20507
|
*/
|
|
20107
|
-
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>;
|
|
20108
20509
|
};
|
|
20109
20510
|
/**
|
|
20110
20511
|
* HostingWebsitesApi - functional programming interface
|
|
@@ -20138,18 +20539,19 @@ export declare const HostingWebsitesApiFp: (configuration?: Configuration) => {
|
|
|
20138
20539
|
*/
|
|
20139
20540
|
deployStaticSiteArchiveV1(username: string, domain: string, hostingV1WebsitesDeployArchiveRequest: HostingV1WebsitesDeployArchiveRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommonSuccessEmptyResource>>;
|
|
20140
20541
|
/**
|
|
20141
|
-
* 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 the available query parameters to filter
|
|
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.
|
|
20142
20543
|
* @summary List websites
|
|
20143
20544
|
* @param {number} [page] Page number
|
|
20144
20545
|
* @param {number} [perPage] Number of items per page
|
|
20145
20546
|
* @param {string | null} [username] Filter by specific username
|
|
20146
20547
|
* @param {number | null} [orderId] Order ID
|
|
20147
20548
|
* @param {boolean | null} [isEnabled] Filter by enabled status
|
|
20148
|
-
* @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.
|
|
20149
20551
|
* @param {*} [options] Override http request option.
|
|
20150
20552
|
* @throws {RequiredError}
|
|
20151
20553
|
*/
|
|
20152
|
-
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>>;
|
|
20153
20555
|
};
|
|
20154
20556
|
/**
|
|
20155
20557
|
* HostingWebsitesApi - factory interface
|
|
@@ -20183,18 +20585,19 @@ export declare const HostingWebsitesApiFactory: (configuration?: Configuration,
|
|
|
20183
20585
|
*/
|
|
20184
20586
|
deployStaticSiteArchiveV1(username: string, domain: string, hostingV1WebsitesDeployArchiveRequest: HostingV1WebsitesDeployArchiveRequest, options?: RawAxiosRequestConfig): AxiosPromise<CommonSuccessEmptyResource>;
|
|
20185
20587
|
/**
|
|
20186
|
-
* 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 the available query parameters to filter
|
|
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.
|
|
20187
20589
|
* @summary List websites
|
|
20188
20590
|
* @param {number} [page] Page number
|
|
20189
20591
|
* @param {number} [perPage] Number of items per page
|
|
20190
20592
|
* @param {string | null} [username] Filter by specific username
|
|
20191
20593
|
* @param {number | null} [orderId] Order ID
|
|
20192
20594
|
* @param {boolean | null} [isEnabled] Filter by enabled status
|
|
20193
|
-
* @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.
|
|
20194
20597
|
* @param {*} [options] Override http request option.
|
|
20195
20598
|
* @throws {RequiredError}
|
|
20196
20599
|
*/
|
|
20197
|
-
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>;
|
|
20198
20601
|
};
|
|
20199
20602
|
/**
|
|
20200
20603
|
* HostingWebsitesApi - object-oriented interface
|
|
@@ -20233,20 +20636,32 @@ export declare class HostingWebsitesApi extends BaseAPI {
|
|
|
20233
20636
|
*/
|
|
20234
20637
|
deployStaticSiteArchiveV1(username: string, domain: string, hostingV1WebsitesDeployArchiveRequest: HostingV1WebsitesDeployArchiveRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CommonSuccessEmptyResource, any, {}, any>>;
|
|
20235
20638
|
/**
|
|
20236
|
-
* 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 the available query parameters to filter
|
|
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.
|
|
20237
20640
|
* @summary List websites
|
|
20238
20641
|
* @param {number} [page] Page number
|
|
20239
20642
|
* @param {number} [perPage] Number of items per page
|
|
20240
20643
|
* @param {string | null} [username] Filter by specific username
|
|
20241
20644
|
* @param {number | null} [orderId] Order ID
|
|
20242
20645
|
* @param {boolean | null} [isEnabled] Filter by enabled status
|
|
20243
|
-
* @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.
|
|
20244
20648
|
* @param {*} [options] Override http request option.
|
|
20245
20649
|
* @throws {RequiredError}
|
|
20246
20650
|
* @memberof HostingWebsitesApi
|
|
20247
20651
|
*/
|
|
20248
|
-
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>>;
|
|
20249
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];
|
|
20250
20665
|
/**
|
|
20251
20666
|
* MailAPITokensApi - axios parameter creator
|
|
20252
20667
|
* @export
|
|
@@ -26860,7 +27275,7 @@ export declare const WordPressInstallationsApiAxiosParamCreator: (configuration?
|
|
|
26860
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.
|
|
26861
27276
|
* @summary List WordPress installations
|
|
26862
27277
|
* @param {string | null} [username] Filter by specific username
|
|
26863
|
-
* @param {string | null} [domain] Filter by domain name (
|
|
27278
|
+
* @param {string | null} [domain] Filter by domain name (case-insensitive substring match)
|
|
26864
27279
|
* @param {ListWordPressInstallationsV1OwnershipEnum} [ownership] Filter by ownership type. Defaults to \"owned\". Use \"all\" to include both owned and managed installations.
|
|
26865
27280
|
* @param {*} [options] Override http request option.
|
|
26866
27281
|
* @throws {RequiredError}
|
|
@@ -26959,7 +27374,7 @@ export declare const WordPressInstallationsApiFp: (configuration?: Configuration
|
|
|
26959
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.
|
|
26960
27375
|
* @summary List WordPress installations
|
|
26961
27376
|
* @param {string | null} [username] Filter by specific username
|
|
26962
|
-
* @param {string | null} [domain] Filter by domain name (
|
|
27377
|
+
* @param {string | null} [domain] Filter by domain name (case-insensitive substring match)
|
|
26963
27378
|
* @param {ListWordPressInstallationsV1OwnershipEnum} [ownership] Filter by ownership type. Defaults to \"owned\". Use \"all\" to include both owned and managed installations.
|
|
26964
27379
|
* @param {*} [options] Override http request option.
|
|
26965
27380
|
* @throws {RequiredError}
|
|
@@ -27058,7 +27473,7 @@ export declare const WordPressInstallationsApiFactory: (configuration?: Configur
|
|
|
27058
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.
|
|
27059
27474
|
* @summary List WordPress installations
|
|
27060
27475
|
* @param {string | null} [username] Filter by specific username
|
|
27061
|
-
* @param {string | null} [domain] Filter by domain name (
|
|
27476
|
+
* @param {string | null} [domain] Filter by domain name (case-insensitive substring match)
|
|
27062
27477
|
* @param {ListWordPressInstallationsV1OwnershipEnum} [ownership] Filter by ownership type. Defaults to \"owned\". Use \"all\" to include both owned and managed installations.
|
|
27063
27478
|
* @param {*} [options] Override http request option.
|
|
27064
27479
|
* @throws {RequiredError}
|
|
@@ -27166,7 +27581,7 @@ export declare class WordPressInstallationsApi extends BaseAPI {
|
|
|
27166
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.
|
|
27167
27582
|
* @summary List WordPress installations
|
|
27168
27583
|
* @param {string | null} [username] Filter by specific username
|
|
27169
|
-
* @param {string | null} [domain] Filter by domain name (
|
|
27584
|
+
* @param {string | null} [domain] Filter by domain name (case-insensitive substring match)
|
|
27170
27585
|
* @param {ListWordPressInstallationsV1OwnershipEnum} [ownership] Filter by ownership type. Defaults to \"owned\". Use \"all\" to include both owned and managed installations.
|
|
27171
27586
|
* @param {*} [options] Override http request option.
|
|
27172
27587
|
* @throws {RequiredError}
|
|
@@ -27593,7 +28008,7 @@ export declare const WordPressPluginsApiAxiosParamCreator: (configuration?: Conf
|
|
|
27593
28008
|
/**
|
|
27594
28009
|
* Check whether WooCommerce is installed on any WordPress installation of a domain. Optionally filter by domain to scope the check.
|
|
27595
28010
|
* @summary Check if WooCommerce is installed
|
|
27596
|
-
* @param {string | null} [domain] Filter by domain name (
|
|
28011
|
+
* @param {string | null} [domain] Filter by domain name (case-insensitive substring match)
|
|
27597
28012
|
* @param {*} [options] Override http request option.
|
|
27598
28013
|
* @throws {RequiredError}
|
|
27599
28014
|
*/
|
|
@@ -27712,7 +28127,7 @@ export declare const WordPressPluginsApiFp: (configuration?: Configuration) => {
|
|
|
27712
28127
|
/**
|
|
27713
28128
|
* Check whether WooCommerce is installed on any WordPress installation of a domain. Optionally filter by domain to scope the check.
|
|
27714
28129
|
* @summary Check if WooCommerce is installed
|
|
27715
|
-
* @param {string | null} [domain] Filter by domain name (
|
|
28130
|
+
* @param {string | null} [domain] Filter by domain name (case-insensitive substring match)
|
|
27716
28131
|
* @param {*} [options] Override http request option.
|
|
27717
28132
|
* @throws {RequiredError}
|
|
27718
28133
|
*/
|
|
@@ -27831,7 +28246,7 @@ export declare const WordPressPluginsApiFactory: (configuration?: Configuration,
|
|
|
27831
28246
|
/**
|
|
27832
28247
|
* Check whether WooCommerce is installed on any WordPress installation of a domain. Optionally filter by domain to scope the check.
|
|
27833
28248
|
* @summary Check if WooCommerce is installed
|
|
27834
|
-
* @param {string | null} [domain] Filter by domain name (
|
|
28249
|
+
* @param {string | null} [domain] Filter by domain name (case-insensitive substring match)
|
|
27835
28250
|
* @param {*} [options] Override http request option.
|
|
27836
28251
|
* @throws {RequiredError}
|
|
27837
28252
|
*/
|
|
@@ -27953,7 +28368,7 @@ export declare class WordPressPluginsApi extends BaseAPI {
|
|
|
27953
28368
|
/**
|
|
27954
28369
|
* Check whether WooCommerce is installed on any WordPress installation of a domain. Optionally filter by domain to scope the check.
|
|
27955
28370
|
* @summary Check if WooCommerce is installed
|
|
27956
|
-
* @param {string | null} [domain] Filter by domain name (
|
|
28371
|
+
* @param {string | null} [domain] Filter by domain name (case-insensitive substring match)
|
|
27957
28372
|
* @param {*} [options] Override http request option.
|
|
27958
28373
|
* @throws {RequiredError}
|
|
27959
28374
|
* @memberof WordPressPluginsApi
|