hostinger-api-sdk 1.33.1 → 1.35.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 +1179 -72
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +2 -2
- package/dist/api.d.ts +643 -1
- package/dist/api.js +866 -25
- 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 +643 -1
- package/dist/esm/api.js +846 -13
- 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/AgencyHostingPHPApi.md +400 -0
- package/docs/AgencyHostingV1PhpExtensionResource.md +24 -0
- package/docs/AgencyHostingV1PhpOptionResource.md +30 -0
- package/docs/AgencyHostingV1PhpUpdateExtensionsRequest.md +20 -0
- package/docs/AgencyHostingV1PhpUpdateOptionsRequest.md +20 -0
- package/docs/AgencyHostingV1PhpUpdateOptionsRequestOptionsInner.md +22 -0
- package/docs/AgencyHostingV1PhpUpdateVersionRequest.md +20 -0
- package/docs/AgencyHostingV1PhpVersionResource.md +20 -0
- package/docs/HostingListWebsiteRedirectsV1200Response.md +22 -0
- package/docs/HostingRedirectsApi.md +193 -0
- package/docs/HostingV1RedirectsCreateRedirectRequest.md +22 -0
- package/docs/HostingV1RedirectsDeleteRedirectRequest.md +20 -0
- package/docs/HostingV1RedirectsRedirectResource.md +22 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/api.ts
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
/**
|
|
4
4
|
* Hostinger API
|
|
5
5
|
*
|
|
6
|
-
* API Version: 1.
|
|
6
|
+
* API Version: 1.37.0
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
|
|
9
9
|
* If you want to contribute or request a new feature, please create an issue or pull request on https://github.com/hostinger/api
|
|
@@ -322,6 +322,162 @@ export interface AgencyHostingV1OrdersPlanResource {
|
|
|
322
322
|
*/
|
|
323
323
|
'key': string | null;
|
|
324
324
|
}
|
|
325
|
+
/**
|
|
326
|
+
*
|
|
327
|
+
* @export
|
|
328
|
+
* @interface AgencyHostingV1PhpExtensionResource
|
|
329
|
+
*/
|
|
330
|
+
export interface AgencyHostingV1PhpExtensionResource {
|
|
331
|
+
/**
|
|
332
|
+
* PHP extension name.
|
|
333
|
+
* @type {string}
|
|
334
|
+
* @memberof AgencyHostingV1PhpExtensionResource
|
|
335
|
+
*/
|
|
336
|
+
'name': string;
|
|
337
|
+
/**
|
|
338
|
+
* What the extension provides.
|
|
339
|
+
* @type {string}
|
|
340
|
+
* @memberof AgencyHostingV1PhpExtensionResource
|
|
341
|
+
*/
|
|
342
|
+
'description': string;
|
|
343
|
+
/**
|
|
344
|
+
* Whether the extension is currently enabled. Extensions in the \"built-in\" state are compiled into PHP and cannot be turned off.
|
|
345
|
+
* @type {string}
|
|
346
|
+
* @memberof AgencyHostingV1PhpExtensionResource
|
|
347
|
+
*/
|
|
348
|
+
'state': AgencyHostingV1PhpExtensionResourceStateEnum;
|
|
349
|
+
}
|
|
350
|
+
|
|
351
|
+
export const AgencyHostingV1PhpExtensionResourceStateEnum = {
|
|
352
|
+
Enabled: 'enabled',
|
|
353
|
+
Disabled: 'disabled',
|
|
354
|
+
BuiltIn: 'built-in'
|
|
355
|
+
} as const;
|
|
356
|
+
|
|
357
|
+
export type AgencyHostingV1PhpExtensionResourceStateEnum = typeof AgencyHostingV1PhpExtensionResourceStateEnum[keyof typeof AgencyHostingV1PhpExtensionResourceStateEnum];
|
|
358
|
+
|
|
359
|
+
/**
|
|
360
|
+
*
|
|
361
|
+
* @export
|
|
362
|
+
* @interface AgencyHostingV1PhpOptionResource
|
|
363
|
+
*/
|
|
364
|
+
export interface AgencyHostingV1PhpOptionResource {
|
|
365
|
+
/**
|
|
366
|
+
* php.ini directive name.
|
|
367
|
+
* @type {string}
|
|
368
|
+
* @memberof AgencyHostingV1PhpOptionResource
|
|
369
|
+
*/
|
|
370
|
+
'name': string;
|
|
371
|
+
/**
|
|
372
|
+
* What the directive controls.
|
|
373
|
+
* @type {string}
|
|
374
|
+
* @memberof AgencyHostingV1PhpOptionResource
|
|
375
|
+
*/
|
|
376
|
+
'description': string;
|
|
377
|
+
/**
|
|
378
|
+
* Value applied when no custom value is set.
|
|
379
|
+
* @type {string}
|
|
380
|
+
* @memberof AgencyHostingV1PhpOptionResource
|
|
381
|
+
*/
|
|
382
|
+
'default_value': string;
|
|
383
|
+
/**
|
|
384
|
+
* Values this option accepts. Null when the option accepts any value of its type.
|
|
385
|
+
* @type {Array<string>}
|
|
386
|
+
* @memberof AgencyHostingV1PhpOptionResource
|
|
387
|
+
*/
|
|
388
|
+
'allowed_values': Array<string> | null;
|
|
389
|
+
/**
|
|
390
|
+
* Value currently in effect for the website.
|
|
391
|
+
* @type {string}
|
|
392
|
+
* @memberof AgencyHostingV1PhpOptionResource
|
|
393
|
+
*/
|
|
394
|
+
'value': string;
|
|
395
|
+
/**
|
|
396
|
+
* Whether the option takes a single value or a list of values.
|
|
397
|
+
* @type {string}
|
|
398
|
+
* @memberof AgencyHostingV1PhpOptionResource
|
|
399
|
+
*/
|
|
400
|
+
'type': AgencyHostingV1PhpOptionResourceTypeEnum;
|
|
401
|
+
}
|
|
402
|
+
|
|
403
|
+
export const AgencyHostingV1PhpOptionResourceTypeEnum = {
|
|
404
|
+
Value: 'value',
|
|
405
|
+
List: 'list'
|
|
406
|
+
} as const;
|
|
407
|
+
|
|
408
|
+
export type AgencyHostingV1PhpOptionResourceTypeEnum = typeof AgencyHostingV1PhpOptionResourceTypeEnum[keyof typeof AgencyHostingV1PhpOptionResourceTypeEnum];
|
|
409
|
+
|
|
410
|
+
/**
|
|
411
|
+
*
|
|
412
|
+
* @export
|
|
413
|
+
* @interface AgencyHostingV1PhpUpdateExtensionsRequest
|
|
414
|
+
*/
|
|
415
|
+
export interface AgencyHostingV1PhpUpdateExtensionsRequest {
|
|
416
|
+
/**
|
|
417
|
+
* Extension names, exactly as returned by the extensions endpoint.
|
|
418
|
+
* @type {Array<string>}
|
|
419
|
+
* @memberof AgencyHostingV1PhpUpdateExtensionsRequest
|
|
420
|
+
*/
|
|
421
|
+
'extensions': Array<string>;
|
|
422
|
+
}
|
|
423
|
+
/**
|
|
424
|
+
*
|
|
425
|
+
* @export
|
|
426
|
+
* @interface AgencyHostingV1PhpUpdateOptionsRequest
|
|
427
|
+
*/
|
|
428
|
+
export interface AgencyHostingV1PhpUpdateOptionsRequest {
|
|
429
|
+
/**
|
|
430
|
+
* Option names and values. Each name must be one of the options returned by the options endpoint, and each value must satisfy that option\'s allowed_values when it declares them.
|
|
431
|
+
* @type {Array<AgencyHostingV1PhpUpdateOptionsRequestOptionsInner>}
|
|
432
|
+
* @memberof AgencyHostingV1PhpUpdateOptionsRequest
|
|
433
|
+
*/
|
|
434
|
+
'options': Array<AgencyHostingV1PhpUpdateOptionsRequestOptionsInner>;
|
|
435
|
+
}
|
|
436
|
+
/**
|
|
437
|
+
*
|
|
438
|
+
* @export
|
|
439
|
+
* @interface AgencyHostingV1PhpUpdateOptionsRequestOptionsInner
|
|
440
|
+
*/
|
|
441
|
+
export interface AgencyHostingV1PhpUpdateOptionsRequestOptionsInner {
|
|
442
|
+
/**
|
|
443
|
+
* php.ini directive name.
|
|
444
|
+
* @type {string}
|
|
445
|
+
* @memberof AgencyHostingV1PhpUpdateOptionsRequestOptionsInner
|
|
446
|
+
*/
|
|
447
|
+
'name': string;
|
|
448
|
+
/**
|
|
449
|
+
* Value to apply.
|
|
450
|
+
* @type {string}
|
|
451
|
+
* @memberof AgencyHostingV1PhpUpdateOptionsRequestOptionsInner
|
|
452
|
+
*/
|
|
453
|
+
'value': string;
|
|
454
|
+
}
|
|
455
|
+
/**
|
|
456
|
+
*
|
|
457
|
+
* @export
|
|
458
|
+
* @interface AgencyHostingV1PhpUpdateVersionRequest
|
|
459
|
+
*/
|
|
460
|
+
export interface AgencyHostingV1PhpUpdateVersionRequest {
|
|
461
|
+
/**
|
|
462
|
+
* PHP version to switch the website to, as major.minor. Must be one of the versions returned by the available versions endpoint.
|
|
463
|
+
* @type {string}
|
|
464
|
+
* @memberof AgencyHostingV1PhpUpdateVersionRequest
|
|
465
|
+
*/
|
|
466
|
+
'version': string;
|
|
467
|
+
}
|
|
468
|
+
/**
|
|
469
|
+
*
|
|
470
|
+
* @export
|
|
471
|
+
* @interface AgencyHostingV1PhpVersionResource
|
|
472
|
+
*/
|
|
473
|
+
export interface AgencyHostingV1PhpVersionResource {
|
|
474
|
+
/**
|
|
475
|
+
* PHP version available for the website.
|
|
476
|
+
* @type {string}
|
|
477
|
+
* @memberof AgencyHostingV1PhpVersionResource
|
|
478
|
+
*/
|
|
479
|
+
'version': string;
|
|
480
|
+
}
|
|
325
481
|
/**
|
|
326
482
|
* Create a new Agency Plan website setup on the given order
|
|
327
483
|
* @export
|
|
@@ -4350,6 +4506,25 @@ export interface HostingListOrdersV1200Response {
|
|
|
4350
4506
|
*/
|
|
4351
4507
|
'meta': CommonSchemaPaginationMetaSchema;
|
|
4352
4508
|
}
|
|
4509
|
+
/**
|
|
4510
|
+
*
|
|
4511
|
+
* @export
|
|
4512
|
+
* @interface HostingListWebsiteRedirectsV1200Response
|
|
4513
|
+
*/
|
|
4514
|
+
export interface HostingListWebsiteRedirectsV1200Response {
|
|
4515
|
+
/**
|
|
4516
|
+
* Array of [`Hosting.V1.Redirects.RedirectResource`](#model/hostingv1redirectsredirectresource)
|
|
4517
|
+
* @type {Array<HostingV1RedirectsRedirectResource>}
|
|
4518
|
+
* @memberof HostingListWebsiteRedirectsV1200Response
|
|
4519
|
+
*/
|
|
4520
|
+
'data': Array<HostingV1RedirectsRedirectResource>;
|
|
4521
|
+
/**
|
|
4522
|
+
*
|
|
4523
|
+
* @type {CommonSchemaPaginationMetaSchema}
|
|
4524
|
+
* @memberof HostingListWebsiteRedirectsV1200Response
|
|
4525
|
+
*/
|
|
4526
|
+
'meta': CommonSchemaPaginationMetaSchema;
|
|
4527
|
+
}
|
|
4353
4528
|
/**
|
|
4354
4529
|
*
|
|
4355
4530
|
* @export
|
|
@@ -5600,6 +5775,57 @@ export interface HostingV1PhpUpdatePhpVersionRequest {
|
|
|
5600
5775
|
*/
|
|
5601
5776
|
'version': string;
|
|
5602
5777
|
}
|
|
5778
|
+
/**
|
|
5779
|
+
*
|
|
5780
|
+
* @export
|
|
5781
|
+
* @interface HostingV1RedirectsCreateRedirectRequest
|
|
5782
|
+
*/
|
|
5783
|
+
export interface HostingV1RedirectsCreateRedirectRequest {
|
|
5784
|
+
/**
|
|
5785
|
+
* Source URL on the selected website
|
|
5786
|
+
* @type {string}
|
|
5787
|
+
* @memberof HostingV1RedirectsCreateRedirectRequest
|
|
5788
|
+
*/
|
|
5789
|
+
'from': string;
|
|
5790
|
+
/**
|
|
5791
|
+
* Destination URL or IP address
|
|
5792
|
+
* @type {string}
|
|
5793
|
+
* @memberof HostingV1RedirectsCreateRedirectRequest
|
|
5794
|
+
*/
|
|
5795
|
+
'to': string;
|
|
5796
|
+
}
|
|
5797
|
+
/**
|
|
5798
|
+
*
|
|
5799
|
+
* @export
|
|
5800
|
+
* @interface HostingV1RedirectsDeleteRedirectRequest
|
|
5801
|
+
*/
|
|
5802
|
+
export interface HostingV1RedirectsDeleteRedirectRequest {
|
|
5803
|
+
/**
|
|
5804
|
+
* Source URL returned by the list redirects endpoint
|
|
5805
|
+
* @type {string}
|
|
5806
|
+
* @memberof HostingV1RedirectsDeleteRedirectRequest
|
|
5807
|
+
*/
|
|
5808
|
+
'from': string;
|
|
5809
|
+
}
|
|
5810
|
+
/**
|
|
5811
|
+
*
|
|
5812
|
+
* @export
|
|
5813
|
+
* @interface HostingV1RedirectsRedirectResource
|
|
5814
|
+
*/
|
|
5815
|
+
export interface HostingV1RedirectsRedirectResource {
|
|
5816
|
+
/**
|
|
5817
|
+
* Source URL
|
|
5818
|
+
* @type {string}
|
|
5819
|
+
* @memberof HostingV1RedirectsRedirectResource
|
|
5820
|
+
*/
|
|
5821
|
+
'from': string;
|
|
5822
|
+
/**
|
|
5823
|
+
* Destination URL
|
|
5824
|
+
* @type {string}
|
|
5825
|
+
* @memberof HostingV1RedirectsRedirectResource
|
|
5826
|
+
*/
|
|
5827
|
+
'to': string;
|
|
5828
|
+
}
|
|
5603
5829
|
/**
|
|
5604
5830
|
*
|
|
5605
5831
|
* @export
|
|
@@ -14441,26 +14667,23 @@ export class AgencyHostingOrdersApi extends BaseAPI {
|
|
|
14441
14667
|
|
|
14442
14668
|
|
|
14443
14669
|
/**
|
|
14444
|
-
*
|
|
14670
|
+
* AgencyHostingPHPApi - axios parameter creator
|
|
14445
14671
|
* @export
|
|
14446
14672
|
*/
|
|
14447
|
-
export const
|
|
14673
|
+
export const AgencyHostingPHPApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
14448
14674
|
return {
|
|
14449
14675
|
/**
|
|
14450
|
-
*
|
|
14451
|
-
* @summary
|
|
14452
|
-
* @param {
|
|
14453
|
-
* @param {AgencyHostingV1SetupsCreateSetupRequest} agencyHostingV1SetupsCreateSetupRequest
|
|
14676
|
+
* Lists the PHP versions an Agency Plan website can be switched to. The version the website is currently running is returned as settings.php.version by the website details endpoint.
|
|
14677
|
+
* @summary List available PHP versions for a website
|
|
14678
|
+
* @param {string} websiteUid Agency Plan website UID
|
|
14454
14679
|
* @param {*} [options] Override http request option.
|
|
14455
14680
|
* @throws {RequiredError}
|
|
14456
14681
|
*/
|
|
14457
|
-
|
|
14458
|
-
// verify required parameter '
|
|
14459
|
-
assertParamExists('
|
|
14460
|
-
|
|
14461
|
-
|
|
14462
|
-
const localVarPath = `/api/agency-hosting/v1/orders/{order_id}/websites/setups`
|
|
14463
|
-
.replace(`{${"order_id"}}`, encodeURIComponent(String(orderId)));
|
|
14682
|
+
listAvailablePHPVersionsForAWebsiteV1: async (websiteUid: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
14683
|
+
// verify required parameter 'websiteUid' is not null or undefined
|
|
14684
|
+
assertParamExists('listAvailablePHPVersionsForAWebsiteV1', 'websiteUid', websiteUid)
|
|
14685
|
+
const localVarPath = `/api/agency-hosting/v1/websites/{website_uid}/php-settings/versions`
|
|
14686
|
+
.replace(`{${"website_uid"}}`, encodeURIComponent(String(websiteUid)));
|
|
14464
14687
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
14465
14688
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
14466
14689
|
let baseOptions;
|
|
@@ -14468,7 +14691,7 @@ export const AgencyHostingWebsiteSetupsApiAxiosParamCreator = function (configur
|
|
|
14468
14691
|
baseOptions = configuration.baseOptions;
|
|
14469
14692
|
}
|
|
14470
14693
|
|
|
14471
|
-
const localVarRequestOptions = { method: '
|
|
14694
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
14472
14695
|
const localVarHeaderParameter = {} as any;
|
|
14473
14696
|
const localVarQueryParameter = {} as any;
|
|
14474
14697
|
|
|
@@ -14478,12 +14701,9 @@ export const AgencyHostingWebsiteSetupsApiAxiosParamCreator = function (configur
|
|
|
14478
14701
|
|
|
14479
14702
|
|
|
14480
14703
|
|
|
14481
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
14482
|
-
|
|
14483
14704
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
14484
14705
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
14485
14706
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
14486
|
-
localVarRequestOptions.data = serializeDataIfNeeded(agencyHostingV1SetupsCreateSetupRequest, localVarRequestOptions, configuration)
|
|
14487
14707
|
|
|
14488
14708
|
return {
|
|
14489
14709
|
url: toPathString(localVarUrlObj),
|
|
@@ -14491,21 +14711,17 @@ export const AgencyHostingWebsiteSetupsApiAxiosParamCreator = function (configur
|
|
|
14491
14711
|
};
|
|
14492
14712
|
},
|
|
14493
14713
|
/**
|
|
14494
|
-
*
|
|
14495
|
-
* @summary
|
|
14714
|
+
* Lists the PHP versions available to websites created under an Agency Plan order, determined by the server the order is hosted on. Use this before creating a website; for a website that already exists, call the website-scoped versions endpoint instead.
|
|
14715
|
+
* @summary List available PHP versions for an order
|
|
14496
14716
|
* @param {number} orderId Agency Plan order ID
|
|
14497
|
-
* @param {string} setupUuid Website setup UUID
|
|
14498
14717
|
* @param {*} [options] Override http request option.
|
|
14499
14718
|
* @throws {RequiredError}
|
|
14500
14719
|
*/
|
|
14501
|
-
|
|
14720
|
+
listAvailablePHPVersionsForAnOrderV1: async (orderId: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
14502
14721
|
// verify required parameter 'orderId' is not null or undefined
|
|
14503
|
-
assertParamExists('
|
|
14504
|
-
|
|
14505
|
-
|
|
14506
|
-
const localVarPath = `/api/agency-hosting/v1/orders/{order_id}/websites/setups/{setup_uuid}`
|
|
14507
|
-
.replace(`{${"order_id"}}`, encodeURIComponent(String(orderId)))
|
|
14508
|
-
.replace(`{${"setup_uuid"}}`, encodeURIComponent(String(setupUuid)));
|
|
14722
|
+
assertParamExists('listAvailablePHPVersionsForAnOrderV1', 'orderId', orderId)
|
|
14723
|
+
const localVarPath = `/api/agency-hosting/v1/orders/{order_id}/websites/php-settings/versions`
|
|
14724
|
+
.replace(`{${"order_id"}}`, encodeURIComponent(String(orderId)));
|
|
14509
14725
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
14510
14726
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
14511
14727
|
let baseOptions;
|
|
@@ -14532,60 +14748,640 @@ export const AgencyHostingWebsiteSetupsApiAxiosParamCreator = function (configur
|
|
|
14532
14748
|
options: localVarRequestOptions,
|
|
14533
14749
|
};
|
|
14534
14750
|
},
|
|
14535
|
-
}
|
|
14536
|
-
};
|
|
14537
|
-
|
|
14538
|
-
/**
|
|
14539
|
-
* AgencyHostingWebsiteSetupsApi - functional programming interface
|
|
14540
|
-
* @export
|
|
14541
|
-
*/
|
|
14542
|
-
export const AgencyHostingWebsiteSetupsApiFp = function(configuration?: Configuration) {
|
|
14543
|
-
const localVarAxiosParamCreator = AgencyHostingWebsiteSetupsApiAxiosParamCreator(configuration)
|
|
14544
|
-
return {
|
|
14545
14751
|
/**
|
|
14546
|
-
*
|
|
14547
|
-
* @summary
|
|
14548
|
-
* @param {
|
|
14549
|
-
* @param {AgencyHostingV1SetupsCreateSetupRequest} agencyHostingV1SetupsCreateSetupRequest
|
|
14752
|
+
* Lists every PHP extension available to an Agency Plan website and whether it is currently enabled.
|
|
14753
|
+
* @summary List PHP extensions for a website
|
|
14754
|
+
* @param {string} websiteUid Agency Plan website UID
|
|
14550
14755
|
* @param {*} [options] Override http request option.
|
|
14551
14756
|
* @throws {RequiredError}
|
|
14552
14757
|
*/
|
|
14553
|
-
async
|
|
14554
|
-
|
|
14555
|
-
|
|
14556
|
-
|
|
14758
|
+
listPHPExtensionsForAWebsiteV1: async (websiteUid: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
14759
|
+
// verify required parameter 'websiteUid' is not null or undefined
|
|
14760
|
+
assertParamExists('listPHPExtensionsForAWebsiteV1', 'websiteUid', websiteUid)
|
|
14761
|
+
const localVarPath = `/api/agency-hosting/v1/websites/{website_uid}/php-settings/extensions`
|
|
14762
|
+
.replace(`{${"website_uid"}}`, encodeURIComponent(String(websiteUid)));
|
|
14763
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
14764
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
14765
|
+
let baseOptions;
|
|
14766
|
+
if (configuration) {
|
|
14767
|
+
baseOptions = configuration.baseOptions;
|
|
14768
|
+
}
|
|
14769
|
+
|
|
14770
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
14771
|
+
const localVarHeaderParameter = {} as any;
|
|
14772
|
+
const localVarQueryParameter = {} as any;
|
|
14773
|
+
|
|
14774
|
+
// authentication apiToken required
|
|
14775
|
+
// http bearer authentication required
|
|
14776
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
14777
|
+
|
|
14778
|
+
|
|
14779
|
+
|
|
14780
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
14781
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
14782
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
14783
|
+
|
|
14784
|
+
return {
|
|
14785
|
+
url: toPathString(localVarUrlObj),
|
|
14786
|
+
options: localVarRequestOptions,
|
|
14787
|
+
};
|
|
14557
14788
|
},
|
|
14558
14789
|
/**
|
|
14559
|
-
*
|
|
14560
|
-
* @summary
|
|
14561
|
-
* @param {
|
|
14562
|
-
* @param {string} setupUuid Website setup UUID
|
|
14790
|
+
* Lists the php.ini directives that can be configured for an Agency Plan website, each with its default, the value currently in effect, and the values it accepts.
|
|
14791
|
+
* @summary List PHP options for a website
|
|
14792
|
+
* @param {string} websiteUid Agency Plan website UID
|
|
14563
14793
|
* @param {*} [options] Override http request option.
|
|
14564
14794
|
* @throws {RequiredError}
|
|
14565
14795
|
*/
|
|
14566
|
-
async
|
|
14567
|
-
|
|
14568
|
-
|
|
14569
|
-
|
|
14570
|
-
|
|
14571
|
-
|
|
14572
|
-
|
|
14796
|
+
listPHPOptionsForAWebsiteV1: async (websiteUid: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
14797
|
+
// verify required parameter 'websiteUid' is not null or undefined
|
|
14798
|
+
assertParamExists('listPHPOptionsForAWebsiteV1', 'websiteUid', websiteUid)
|
|
14799
|
+
const localVarPath = `/api/agency-hosting/v1/websites/{website_uid}/php-settings/options`
|
|
14800
|
+
.replace(`{${"website_uid"}}`, encodeURIComponent(String(websiteUid)));
|
|
14801
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
14802
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
14803
|
+
let baseOptions;
|
|
14804
|
+
if (configuration) {
|
|
14805
|
+
baseOptions = configuration.baseOptions;
|
|
14806
|
+
}
|
|
14573
14807
|
|
|
14574
|
-
|
|
14575
|
-
|
|
14576
|
-
|
|
14577
|
-
|
|
14578
|
-
|
|
14579
|
-
|
|
14580
|
-
|
|
14581
|
-
|
|
14582
|
-
|
|
14583
|
-
|
|
14584
|
-
|
|
14585
|
-
|
|
14586
|
-
|
|
14587
|
-
|
|
14588
|
-
|
|
14808
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
14809
|
+
const localVarHeaderParameter = {} as any;
|
|
14810
|
+
const localVarQueryParameter = {} as any;
|
|
14811
|
+
|
|
14812
|
+
// authentication apiToken required
|
|
14813
|
+
// http bearer authentication required
|
|
14814
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
14815
|
+
|
|
14816
|
+
|
|
14817
|
+
|
|
14818
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
14819
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
14820
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
14821
|
+
|
|
14822
|
+
return {
|
|
14823
|
+
url: toPathString(localVarUrlObj),
|
|
14824
|
+
options: localVarRequestOptions,
|
|
14825
|
+
};
|
|
14826
|
+
},
|
|
14827
|
+
/**
|
|
14828
|
+
* Replaces the set of PHP extensions enabled on an Agency Plan website with the ones provided. Any toggleable extension not in the request is disabled, so call the extensions endpoint first and send the full desired set. Extensions compiled into PHP, reported with the \"built-in\" state, are always active and are unaffected.
|
|
14829
|
+
* @summary Replace website PHP extensions
|
|
14830
|
+
* @param {string} websiteUid Agency Plan website UID
|
|
14831
|
+
* @param {AgencyHostingV1PhpUpdateExtensionsRequest} agencyHostingV1PhpUpdateExtensionsRequest
|
|
14832
|
+
* @param {*} [options] Override http request option.
|
|
14833
|
+
* @throws {RequiredError}
|
|
14834
|
+
*/
|
|
14835
|
+
replaceWebsitePHPExtensionsV1: async (websiteUid: string, agencyHostingV1PhpUpdateExtensionsRequest: AgencyHostingV1PhpUpdateExtensionsRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
14836
|
+
// verify required parameter 'websiteUid' is not null or undefined
|
|
14837
|
+
assertParamExists('replaceWebsitePHPExtensionsV1', 'websiteUid', websiteUid)
|
|
14838
|
+
// verify required parameter 'agencyHostingV1PhpUpdateExtensionsRequest' is not null or undefined
|
|
14839
|
+
assertParamExists('replaceWebsitePHPExtensionsV1', 'agencyHostingV1PhpUpdateExtensionsRequest', agencyHostingV1PhpUpdateExtensionsRequest)
|
|
14840
|
+
const localVarPath = `/api/agency-hosting/v1/websites/{website_uid}/php-settings/extensions`
|
|
14841
|
+
.replace(`{${"website_uid"}}`, encodeURIComponent(String(websiteUid)));
|
|
14842
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
14843
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
14844
|
+
let baseOptions;
|
|
14845
|
+
if (configuration) {
|
|
14846
|
+
baseOptions = configuration.baseOptions;
|
|
14847
|
+
}
|
|
14848
|
+
|
|
14849
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
14850
|
+
const localVarHeaderParameter = {} as any;
|
|
14851
|
+
const localVarQueryParameter = {} as any;
|
|
14852
|
+
|
|
14853
|
+
// authentication apiToken required
|
|
14854
|
+
// http bearer authentication required
|
|
14855
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
14856
|
+
|
|
14857
|
+
|
|
14858
|
+
|
|
14859
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
14860
|
+
|
|
14861
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
14862
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
14863
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
14864
|
+
localVarRequestOptions.data = serializeDataIfNeeded(agencyHostingV1PhpUpdateExtensionsRequest, localVarRequestOptions, configuration)
|
|
14865
|
+
|
|
14866
|
+
return {
|
|
14867
|
+
url: toPathString(localVarUrlObj),
|
|
14868
|
+
options: localVarRequestOptions,
|
|
14869
|
+
};
|
|
14870
|
+
},
|
|
14871
|
+
/**
|
|
14872
|
+
* Replaces the custom php.ini values on an Agency Plan website with the ones provided. Any option not in the request is reset to its default, so call the options endpoint first and send the full desired set. Sending an empty array resets every option to its default.
|
|
14873
|
+
* @summary Replace website PHP options
|
|
14874
|
+
* @param {string} websiteUid Agency Plan website UID
|
|
14875
|
+
* @param {AgencyHostingV1PhpUpdateOptionsRequest} agencyHostingV1PhpUpdateOptionsRequest
|
|
14876
|
+
* @param {*} [options] Override http request option.
|
|
14877
|
+
* @throws {RequiredError}
|
|
14878
|
+
*/
|
|
14879
|
+
replaceWebsitePHPOptionsV1: async (websiteUid: string, agencyHostingV1PhpUpdateOptionsRequest: AgencyHostingV1PhpUpdateOptionsRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
14880
|
+
// verify required parameter 'websiteUid' is not null or undefined
|
|
14881
|
+
assertParamExists('replaceWebsitePHPOptionsV1', 'websiteUid', websiteUid)
|
|
14882
|
+
// verify required parameter 'agencyHostingV1PhpUpdateOptionsRequest' is not null or undefined
|
|
14883
|
+
assertParamExists('replaceWebsitePHPOptionsV1', 'agencyHostingV1PhpUpdateOptionsRequest', agencyHostingV1PhpUpdateOptionsRequest)
|
|
14884
|
+
const localVarPath = `/api/agency-hosting/v1/websites/{website_uid}/php-settings/options`
|
|
14885
|
+
.replace(`{${"website_uid"}}`, encodeURIComponent(String(websiteUid)));
|
|
14886
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
14887
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
14888
|
+
let baseOptions;
|
|
14889
|
+
if (configuration) {
|
|
14890
|
+
baseOptions = configuration.baseOptions;
|
|
14891
|
+
}
|
|
14892
|
+
|
|
14893
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
14894
|
+
const localVarHeaderParameter = {} as any;
|
|
14895
|
+
const localVarQueryParameter = {} as any;
|
|
14896
|
+
|
|
14897
|
+
// authentication apiToken required
|
|
14898
|
+
// http bearer authentication required
|
|
14899
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
14900
|
+
|
|
14901
|
+
|
|
14902
|
+
|
|
14903
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
14904
|
+
|
|
14905
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
14906
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
14907
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
14908
|
+
localVarRequestOptions.data = serializeDataIfNeeded(agencyHostingV1PhpUpdateOptionsRequest, localVarRequestOptions, configuration)
|
|
14909
|
+
|
|
14910
|
+
return {
|
|
14911
|
+
url: toPathString(localVarUrlObj),
|
|
14912
|
+
options: localVarRequestOptions,
|
|
14913
|
+
};
|
|
14914
|
+
},
|
|
14915
|
+
/**
|
|
14916
|
+
* Switches an Agency Plan website to a different PHP version. Call the available versions endpoint first to see which versions can be selected. The website restarts on the new version, so requests served during the switch may fail and code that is incompatible with the target version will break.
|
|
14917
|
+
* @summary Update website PHP version
|
|
14918
|
+
* @param {string} websiteUid Agency Plan website UID
|
|
14919
|
+
* @param {AgencyHostingV1PhpUpdateVersionRequest} agencyHostingV1PhpUpdateVersionRequest
|
|
14920
|
+
* @param {*} [options] Override http request option.
|
|
14921
|
+
* @throws {RequiredError}
|
|
14922
|
+
*/
|
|
14923
|
+
updateWebsitePHPVersionV1: async (websiteUid: string, agencyHostingV1PhpUpdateVersionRequest: AgencyHostingV1PhpUpdateVersionRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
14924
|
+
// verify required parameter 'websiteUid' is not null or undefined
|
|
14925
|
+
assertParamExists('updateWebsitePHPVersionV1', 'websiteUid', websiteUid)
|
|
14926
|
+
// verify required parameter 'agencyHostingV1PhpUpdateVersionRequest' is not null or undefined
|
|
14927
|
+
assertParamExists('updateWebsitePHPVersionV1', 'agencyHostingV1PhpUpdateVersionRequest', agencyHostingV1PhpUpdateVersionRequest)
|
|
14928
|
+
const localVarPath = `/api/agency-hosting/v1/websites/{website_uid}/php-settings/version`
|
|
14929
|
+
.replace(`{${"website_uid"}}`, encodeURIComponent(String(websiteUid)));
|
|
14930
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
14931
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
14932
|
+
let baseOptions;
|
|
14933
|
+
if (configuration) {
|
|
14934
|
+
baseOptions = configuration.baseOptions;
|
|
14935
|
+
}
|
|
14936
|
+
|
|
14937
|
+
const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
|
|
14938
|
+
const localVarHeaderParameter = {} as any;
|
|
14939
|
+
const localVarQueryParameter = {} as any;
|
|
14940
|
+
|
|
14941
|
+
// authentication apiToken required
|
|
14942
|
+
// http bearer authentication required
|
|
14943
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
14944
|
+
|
|
14945
|
+
|
|
14946
|
+
|
|
14947
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
14948
|
+
|
|
14949
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
14950
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
14951
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
14952
|
+
localVarRequestOptions.data = serializeDataIfNeeded(agencyHostingV1PhpUpdateVersionRequest, localVarRequestOptions, configuration)
|
|
14953
|
+
|
|
14954
|
+
return {
|
|
14955
|
+
url: toPathString(localVarUrlObj),
|
|
14956
|
+
options: localVarRequestOptions,
|
|
14957
|
+
};
|
|
14958
|
+
},
|
|
14959
|
+
}
|
|
14960
|
+
};
|
|
14961
|
+
|
|
14962
|
+
/**
|
|
14963
|
+
* AgencyHostingPHPApi - functional programming interface
|
|
14964
|
+
* @export
|
|
14965
|
+
*/
|
|
14966
|
+
export const AgencyHostingPHPApiFp = function(configuration?: Configuration) {
|
|
14967
|
+
const localVarAxiosParamCreator = AgencyHostingPHPApiAxiosParamCreator(configuration)
|
|
14968
|
+
return {
|
|
14969
|
+
/**
|
|
14970
|
+
* Lists the PHP versions an Agency Plan website can be switched to. The version the website is currently running is returned as settings.php.version by the website details endpoint.
|
|
14971
|
+
* @summary List available PHP versions for a website
|
|
14972
|
+
* @param {string} websiteUid Agency Plan website UID
|
|
14973
|
+
* @param {*} [options] Override http request option.
|
|
14974
|
+
* @throws {RequiredError}
|
|
14975
|
+
*/
|
|
14976
|
+
async listAvailablePHPVersionsForAWebsiteV1(websiteUid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AgencyHostingV1PhpVersionResource>>> {
|
|
14977
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listAvailablePHPVersionsForAWebsiteV1(websiteUid, options);
|
|
14978
|
+
const localVarOperationServerBasePath = operationServerMap['AgencyHostingPHPApi.listAvailablePHPVersionsForAWebsiteV1']?.[0]?.url;
|
|
14979
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
14980
|
+
},
|
|
14981
|
+
/**
|
|
14982
|
+
* Lists the PHP versions available to websites created under an Agency Plan order, determined by the server the order is hosted on. Use this before creating a website; for a website that already exists, call the website-scoped versions endpoint instead.
|
|
14983
|
+
* @summary List available PHP versions for an order
|
|
14984
|
+
* @param {number} orderId Agency Plan order ID
|
|
14985
|
+
* @param {*} [options] Override http request option.
|
|
14986
|
+
* @throws {RequiredError}
|
|
14987
|
+
*/
|
|
14988
|
+
async listAvailablePHPVersionsForAnOrderV1(orderId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AgencyHostingV1PhpVersionResource>>> {
|
|
14989
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listAvailablePHPVersionsForAnOrderV1(orderId, options);
|
|
14990
|
+
const localVarOperationServerBasePath = operationServerMap['AgencyHostingPHPApi.listAvailablePHPVersionsForAnOrderV1']?.[0]?.url;
|
|
14991
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
14992
|
+
},
|
|
14993
|
+
/**
|
|
14994
|
+
* Lists every PHP extension available to an Agency Plan website and whether it is currently enabled.
|
|
14995
|
+
* @summary List PHP extensions for a website
|
|
14996
|
+
* @param {string} websiteUid Agency Plan website UID
|
|
14997
|
+
* @param {*} [options] Override http request option.
|
|
14998
|
+
* @throws {RequiredError}
|
|
14999
|
+
*/
|
|
15000
|
+
async listPHPExtensionsForAWebsiteV1(websiteUid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AgencyHostingV1PhpExtensionResource>>> {
|
|
15001
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listPHPExtensionsForAWebsiteV1(websiteUid, options);
|
|
15002
|
+
const localVarOperationServerBasePath = operationServerMap['AgencyHostingPHPApi.listPHPExtensionsForAWebsiteV1']?.[0]?.url;
|
|
15003
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15004
|
+
},
|
|
15005
|
+
/**
|
|
15006
|
+
* Lists the php.ini directives that can be configured for an Agency Plan website, each with its default, the value currently in effect, and the values it accepts.
|
|
15007
|
+
* @summary List PHP options for a website
|
|
15008
|
+
* @param {string} websiteUid Agency Plan website UID
|
|
15009
|
+
* @param {*} [options] Override http request option.
|
|
15010
|
+
* @throws {RequiredError}
|
|
15011
|
+
*/
|
|
15012
|
+
async listPHPOptionsForAWebsiteV1(websiteUid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AgencyHostingV1PhpOptionResource>>> {
|
|
15013
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listPHPOptionsForAWebsiteV1(websiteUid, options);
|
|
15014
|
+
const localVarOperationServerBasePath = operationServerMap['AgencyHostingPHPApi.listPHPOptionsForAWebsiteV1']?.[0]?.url;
|
|
15015
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15016
|
+
},
|
|
15017
|
+
/**
|
|
15018
|
+
* Replaces the set of PHP extensions enabled on an Agency Plan website with the ones provided. Any toggleable extension not in the request is disabled, so call the extensions endpoint first and send the full desired set. Extensions compiled into PHP, reported with the \"built-in\" state, are always active and are unaffected.
|
|
15019
|
+
* @summary Replace website PHP extensions
|
|
15020
|
+
* @param {string} websiteUid Agency Plan website UID
|
|
15021
|
+
* @param {AgencyHostingV1PhpUpdateExtensionsRequest} agencyHostingV1PhpUpdateExtensionsRequest
|
|
15022
|
+
* @param {*} [options] Override http request option.
|
|
15023
|
+
* @throws {RequiredError}
|
|
15024
|
+
*/
|
|
15025
|
+
async replaceWebsitePHPExtensionsV1(websiteUid: string, agencyHostingV1PhpUpdateExtensionsRequest: AgencyHostingV1PhpUpdateExtensionsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommonSuccessEmptyResource>> {
|
|
15026
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.replaceWebsitePHPExtensionsV1(websiteUid, agencyHostingV1PhpUpdateExtensionsRequest, options);
|
|
15027
|
+
const localVarOperationServerBasePath = operationServerMap['AgencyHostingPHPApi.replaceWebsitePHPExtensionsV1']?.[0]?.url;
|
|
15028
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15029
|
+
},
|
|
15030
|
+
/**
|
|
15031
|
+
* Replaces the custom php.ini values on an Agency Plan website with the ones provided. Any option not in the request is reset to its default, so call the options endpoint first and send the full desired set. Sending an empty array resets every option to its default.
|
|
15032
|
+
* @summary Replace website PHP options
|
|
15033
|
+
* @param {string} websiteUid Agency Plan website UID
|
|
15034
|
+
* @param {AgencyHostingV1PhpUpdateOptionsRequest} agencyHostingV1PhpUpdateOptionsRequest
|
|
15035
|
+
* @param {*} [options] Override http request option.
|
|
15036
|
+
* @throws {RequiredError}
|
|
15037
|
+
*/
|
|
15038
|
+
async replaceWebsitePHPOptionsV1(websiteUid: string, agencyHostingV1PhpUpdateOptionsRequest: AgencyHostingV1PhpUpdateOptionsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommonSuccessEmptyResource>> {
|
|
15039
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.replaceWebsitePHPOptionsV1(websiteUid, agencyHostingV1PhpUpdateOptionsRequest, options);
|
|
15040
|
+
const localVarOperationServerBasePath = operationServerMap['AgencyHostingPHPApi.replaceWebsitePHPOptionsV1']?.[0]?.url;
|
|
15041
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15042
|
+
},
|
|
15043
|
+
/**
|
|
15044
|
+
* Switches an Agency Plan website to a different PHP version. Call the available versions endpoint first to see which versions can be selected. The website restarts on the new version, so requests served during the switch may fail and code that is incompatible with the target version will break.
|
|
15045
|
+
* @summary Update website PHP version
|
|
15046
|
+
* @param {string} websiteUid Agency Plan website UID
|
|
15047
|
+
* @param {AgencyHostingV1PhpUpdateVersionRequest} agencyHostingV1PhpUpdateVersionRequest
|
|
15048
|
+
* @param {*} [options] Override http request option.
|
|
15049
|
+
* @throws {RequiredError}
|
|
15050
|
+
*/
|
|
15051
|
+
async updateWebsitePHPVersionV1(websiteUid: string, agencyHostingV1PhpUpdateVersionRequest: AgencyHostingV1PhpUpdateVersionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommonSuccessEmptyResource>> {
|
|
15052
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updateWebsitePHPVersionV1(websiteUid, agencyHostingV1PhpUpdateVersionRequest, options);
|
|
15053
|
+
const localVarOperationServerBasePath = operationServerMap['AgencyHostingPHPApi.updateWebsitePHPVersionV1']?.[0]?.url;
|
|
15054
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15055
|
+
},
|
|
15056
|
+
}
|
|
15057
|
+
};
|
|
15058
|
+
|
|
15059
|
+
/**
|
|
15060
|
+
* AgencyHostingPHPApi - factory interface
|
|
15061
|
+
* @export
|
|
15062
|
+
*/
|
|
15063
|
+
export const AgencyHostingPHPApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
15064
|
+
const localVarFp = AgencyHostingPHPApiFp(configuration)
|
|
15065
|
+
return {
|
|
15066
|
+
/**
|
|
15067
|
+
* Lists the PHP versions an Agency Plan website can be switched to. The version the website is currently running is returned as settings.php.version by the website details endpoint.
|
|
15068
|
+
* @summary List available PHP versions for a website
|
|
15069
|
+
* @param {string} websiteUid Agency Plan website UID
|
|
15070
|
+
* @param {*} [options] Override http request option.
|
|
15071
|
+
* @throws {RequiredError}
|
|
15072
|
+
*/
|
|
15073
|
+
listAvailablePHPVersionsForAWebsiteV1(websiteUid: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<AgencyHostingV1PhpVersionResource>> {
|
|
15074
|
+
return localVarFp.listAvailablePHPVersionsForAWebsiteV1(websiteUid, options).then((request) => request(axios, basePath));
|
|
15075
|
+
},
|
|
15076
|
+
/**
|
|
15077
|
+
* Lists the PHP versions available to websites created under an Agency Plan order, determined by the server the order is hosted on. Use this before creating a website; for a website that already exists, call the website-scoped versions endpoint instead.
|
|
15078
|
+
* @summary List available PHP versions for an order
|
|
15079
|
+
* @param {number} orderId Agency Plan order ID
|
|
15080
|
+
* @param {*} [options] Override http request option.
|
|
15081
|
+
* @throws {RequiredError}
|
|
15082
|
+
*/
|
|
15083
|
+
listAvailablePHPVersionsForAnOrderV1(orderId: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<AgencyHostingV1PhpVersionResource>> {
|
|
15084
|
+
return localVarFp.listAvailablePHPVersionsForAnOrderV1(orderId, options).then((request) => request(axios, basePath));
|
|
15085
|
+
},
|
|
15086
|
+
/**
|
|
15087
|
+
* Lists every PHP extension available to an Agency Plan website and whether it is currently enabled.
|
|
15088
|
+
* @summary List PHP extensions for a website
|
|
15089
|
+
* @param {string} websiteUid Agency Plan website UID
|
|
15090
|
+
* @param {*} [options] Override http request option.
|
|
15091
|
+
* @throws {RequiredError}
|
|
15092
|
+
*/
|
|
15093
|
+
listPHPExtensionsForAWebsiteV1(websiteUid: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<AgencyHostingV1PhpExtensionResource>> {
|
|
15094
|
+
return localVarFp.listPHPExtensionsForAWebsiteV1(websiteUid, options).then((request) => request(axios, basePath));
|
|
15095
|
+
},
|
|
15096
|
+
/**
|
|
15097
|
+
* Lists the php.ini directives that can be configured for an Agency Plan website, each with its default, the value currently in effect, and the values it accepts.
|
|
15098
|
+
* @summary List PHP options for a website
|
|
15099
|
+
* @param {string} websiteUid Agency Plan website UID
|
|
15100
|
+
* @param {*} [options] Override http request option.
|
|
15101
|
+
* @throws {RequiredError}
|
|
15102
|
+
*/
|
|
15103
|
+
listPHPOptionsForAWebsiteV1(websiteUid: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<AgencyHostingV1PhpOptionResource>> {
|
|
15104
|
+
return localVarFp.listPHPOptionsForAWebsiteV1(websiteUid, options).then((request) => request(axios, basePath));
|
|
15105
|
+
},
|
|
15106
|
+
/**
|
|
15107
|
+
* Replaces the set of PHP extensions enabled on an Agency Plan website with the ones provided. Any toggleable extension not in the request is disabled, so call the extensions endpoint first and send the full desired set. Extensions compiled into PHP, reported with the \"built-in\" state, are always active and are unaffected.
|
|
15108
|
+
* @summary Replace website PHP extensions
|
|
15109
|
+
* @param {string} websiteUid Agency Plan website UID
|
|
15110
|
+
* @param {AgencyHostingV1PhpUpdateExtensionsRequest} agencyHostingV1PhpUpdateExtensionsRequest
|
|
15111
|
+
* @param {*} [options] Override http request option.
|
|
15112
|
+
* @throws {RequiredError}
|
|
15113
|
+
*/
|
|
15114
|
+
replaceWebsitePHPExtensionsV1(websiteUid: string, agencyHostingV1PhpUpdateExtensionsRequest: AgencyHostingV1PhpUpdateExtensionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<CommonSuccessEmptyResource> {
|
|
15115
|
+
return localVarFp.replaceWebsitePHPExtensionsV1(websiteUid, agencyHostingV1PhpUpdateExtensionsRequest, options).then((request) => request(axios, basePath));
|
|
15116
|
+
},
|
|
15117
|
+
/**
|
|
15118
|
+
* Replaces the custom php.ini values on an Agency Plan website with the ones provided. Any option not in the request is reset to its default, so call the options endpoint first and send the full desired set. Sending an empty array resets every option to its default.
|
|
15119
|
+
* @summary Replace website PHP options
|
|
15120
|
+
* @param {string} websiteUid Agency Plan website UID
|
|
15121
|
+
* @param {AgencyHostingV1PhpUpdateOptionsRequest} agencyHostingV1PhpUpdateOptionsRequest
|
|
15122
|
+
* @param {*} [options] Override http request option.
|
|
15123
|
+
* @throws {RequiredError}
|
|
15124
|
+
*/
|
|
15125
|
+
replaceWebsitePHPOptionsV1(websiteUid: string, agencyHostingV1PhpUpdateOptionsRequest: AgencyHostingV1PhpUpdateOptionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<CommonSuccessEmptyResource> {
|
|
15126
|
+
return localVarFp.replaceWebsitePHPOptionsV1(websiteUid, agencyHostingV1PhpUpdateOptionsRequest, options).then((request) => request(axios, basePath));
|
|
15127
|
+
},
|
|
15128
|
+
/**
|
|
15129
|
+
* Switches an Agency Plan website to a different PHP version. Call the available versions endpoint first to see which versions can be selected. The website restarts on the new version, so requests served during the switch may fail and code that is incompatible with the target version will break.
|
|
15130
|
+
* @summary Update website PHP version
|
|
15131
|
+
* @param {string} websiteUid Agency Plan website UID
|
|
15132
|
+
* @param {AgencyHostingV1PhpUpdateVersionRequest} agencyHostingV1PhpUpdateVersionRequest
|
|
15133
|
+
* @param {*} [options] Override http request option.
|
|
15134
|
+
* @throws {RequiredError}
|
|
15135
|
+
*/
|
|
15136
|
+
updateWebsitePHPVersionV1(websiteUid: string, agencyHostingV1PhpUpdateVersionRequest: AgencyHostingV1PhpUpdateVersionRequest, options?: RawAxiosRequestConfig): AxiosPromise<CommonSuccessEmptyResource> {
|
|
15137
|
+
return localVarFp.updateWebsitePHPVersionV1(websiteUid, agencyHostingV1PhpUpdateVersionRequest, options).then((request) => request(axios, basePath));
|
|
15138
|
+
},
|
|
15139
|
+
};
|
|
15140
|
+
};
|
|
15141
|
+
|
|
15142
|
+
/**
|
|
15143
|
+
* AgencyHostingPHPApi - object-oriented interface
|
|
15144
|
+
* @export
|
|
15145
|
+
* @class AgencyHostingPHPApi
|
|
15146
|
+
* @extends {BaseAPI}
|
|
15147
|
+
*/
|
|
15148
|
+
export class AgencyHostingPHPApi extends BaseAPI {
|
|
15149
|
+
/**
|
|
15150
|
+
* Lists the PHP versions an Agency Plan website can be switched to. The version the website is currently running is returned as settings.php.version by the website details endpoint.
|
|
15151
|
+
* @summary List available PHP versions for a website
|
|
15152
|
+
* @param {string} websiteUid Agency Plan website UID
|
|
15153
|
+
* @param {*} [options] Override http request option.
|
|
15154
|
+
* @throws {RequiredError}
|
|
15155
|
+
* @memberof AgencyHostingPHPApi
|
|
15156
|
+
*/
|
|
15157
|
+
public listAvailablePHPVersionsForAWebsiteV1(websiteUid: string, options?: RawAxiosRequestConfig) {
|
|
15158
|
+
return AgencyHostingPHPApiFp(this.configuration).listAvailablePHPVersionsForAWebsiteV1(websiteUid, options).then((request) => request(this.axios, this.basePath));
|
|
15159
|
+
}
|
|
15160
|
+
|
|
15161
|
+
/**
|
|
15162
|
+
* Lists the PHP versions available to websites created under an Agency Plan order, determined by the server the order is hosted on. Use this before creating a website; for a website that already exists, call the website-scoped versions endpoint instead.
|
|
15163
|
+
* @summary List available PHP versions for an order
|
|
15164
|
+
* @param {number} orderId Agency Plan order ID
|
|
15165
|
+
* @param {*} [options] Override http request option.
|
|
15166
|
+
* @throws {RequiredError}
|
|
15167
|
+
* @memberof AgencyHostingPHPApi
|
|
15168
|
+
*/
|
|
15169
|
+
public listAvailablePHPVersionsForAnOrderV1(orderId: number, options?: RawAxiosRequestConfig) {
|
|
15170
|
+
return AgencyHostingPHPApiFp(this.configuration).listAvailablePHPVersionsForAnOrderV1(orderId, options).then((request) => request(this.axios, this.basePath));
|
|
15171
|
+
}
|
|
15172
|
+
|
|
15173
|
+
/**
|
|
15174
|
+
* Lists every PHP extension available to an Agency Plan website and whether it is currently enabled.
|
|
15175
|
+
* @summary List PHP extensions for a website
|
|
15176
|
+
* @param {string} websiteUid Agency Plan website UID
|
|
15177
|
+
* @param {*} [options] Override http request option.
|
|
15178
|
+
* @throws {RequiredError}
|
|
15179
|
+
* @memberof AgencyHostingPHPApi
|
|
15180
|
+
*/
|
|
15181
|
+
public listPHPExtensionsForAWebsiteV1(websiteUid: string, options?: RawAxiosRequestConfig) {
|
|
15182
|
+
return AgencyHostingPHPApiFp(this.configuration).listPHPExtensionsForAWebsiteV1(websiteUid, options).then((request) => request(this.axios, this.basePath));
|
|
15183
|
+
}
|
|
15184
|
+
|
|
15185
|
+
/**
|
|
15186
|
+
* Lists the php.ini directives that can be configured for an Agency Plan website, each with its default, the value currently in effect, and the values it accepts.
|
|
15187
|
+
* @summary List PHP options for a website
|
|
15188
|
+
* @param {string} websiteUid Agency Plan website UID
|
|
15189
|
+
* @param {*} [options] Override http request option.
|
|
15190
|
+
* @throws {RequiredError}
|
|
15191
|
+
* @memberof AgencyHostingPHPApi
|
|
15192
|
+
*/
|
|
15193
|
+
public listPHPOptionsForAWebsiteV1(websiteUid: string, options?: RawAxiosRequestConfig) {
|
|
15194
|
+
return AgencyHostingPHPApiFp(this.configuration).listPHPOptionsForAWebsiteV1(websiteUid, options).then((request) => request(this.axios, this.basePath));
|
|
15195
|
+
}
|
|
15196
|
+
|
|
15197
|
+
/**
|
|
15198
|
+
* Replaces the set of PHP extensions enabled on an Agency Plan website with the ones provided. Any toggleable extension not in the request is disabled, so call the extensions endpoint first and send the full desired set. Extensions compiled into PHP, reported with the \"built-in\" state, are always active and are unaffected.
|
|
15199
|
+
* @summary Replace website PHP extensions
|
|
15200
|
+
* @param {string} websiteUid Agency Plan website UID
|
|
15201
|
+
* @param {AgencyHostingV1PhpUpdateExtensionsRequest} agencyHostingV1PhpUpdateExtensionsRequest
|
|
15202
|
+
* @param {*} [options] Override http request option.
|
|
15203
|
+
* @throws {RequiredError}
|
|
15204
|
+
* @memberof AgencyHostingPHPApi
|
|
15205
|
+
*/
|
|
15206
|
+
public replaceWebsitePHPExtensionsV1(websiteUid: string, agencyHostingV1PhpUpdateExtensionsRequest: AgencyHostingV1PhpUpdateExtensionsRequest, options?: RawAxiosRequestConfig) {
|
|
15207
|
+
return AgencyHostingPHPApiFp(this.configuration).replaceWebsitePHPExtensionsV1(websiteUid, agencyHostingV1PhpUpdateExtensionsRequest, options).then((request) => request(this.axios, this.basePath));
|
|
15208
|
+
}
|
|
15209
|
+
|
|
15210
|
+
/**
|
|
15211
|
+
* Replaces the custom php.ini values on an Agency Plan website with the ones provided. Any option not in the request is reset to its default, so call the options endpoint first and send the full desired set. Sending an empty array resets every option to its default.
|
|
15212
|
+
* @summary Replace website PHP options
|
|
15213
|
+
* @param {string} websiteUid Agency Plan website UID
|
|
15214
|
+
* @param {AgencyHostingV1PhpUpdateOptionsRequest} agencyHostingV1PhpUpdateOptionsRequest
|
|
15215
|
+
* @param {*} [options] Override http request option.
|
|
15216
|
+
* @throws {RequiredError}
|
|
15217
|
+
* @memberof AgencyHostingPHPApi
|
|
15218
|
+
*/
|
|
15219
|
+
public replaceWebsitePHPOptionsV1(websiteUid: string, agencyHostingV1PhpUpdateOptionsRequest: AgencyHostingV1PhpUpdateOptionsRequest, options?: RawAxiosRequestConfig) {
|
|
15220
|
+
return AgencyHostingPHPApiFp(this.configuration).replaceWebsitePHPOptionsV1(websiteUid, agencyHostingV1PhpUpdateOptionsRequest, options).then((request) => request(this.axios, this.basePath));
|
|
15221
|
+
}
|
|
15222
|
+
|
|
15223
|
+
/**
|
|
15224
|
+
* Switches an Agency Plan website to a different PHP version. Call the available versions endpoint first to see which versions can be selected. The website restarts on the new version, so requests served during the switch may fail and code that is incompatible with the target version will break.
|
|
15225
|
+
* @summary Update website PHP version
|
|
15226
|
+
* @param {string} websiteUid Agency Plan website UID
|
|
15227
|
+
* @param {AgencyHostingV1PhpUpdateVersionRequest} agencyHostingV1PhpUpdateVersionRequest
|
|
15228
|
+
* @param {*} [options] Override http request option.
|
|
15229
|
+
* @throws {RequiredError}
|
|
15230
|
+
* @memberof AgencyHostingPHPApi
|
|
15231
|
+
*/
|
|
15232
|
+
public updateWebsitePHPVersionV1(websiteUid: string, agencyHostingV1PhpUpdateVersionRequest: AgencyHostingV1PhpUpdateVersionRequest, options?: RawAxiosRequestConfig) {
|
|
15233
|
+
return AgencyHostingPHPApiFp(this.configuration).updateWebsitePHPVersionV1(websiteUid, agencyHostingV1PhpUpdateVersionRequest, options).then((request) => request(this.axios, this.basePath));
|
|
15234
|
+
}
|
|
15235
|
+
}
|
|
15236
|
+
|
|
15237
|
+
|
|
15238
|
+
|
|
15239
|
+
/**
|
|
15240
|
+
* AgencyHostingWebsiteSetupsApi - axios parameter creator
|
|
15241
|
+
* @export
|
|
15242
|
+
*/
|
|
15243
|
+
export const AgencyHostingWebsiteSetupsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
15244
|
+
return {
|
|
15245
|
+
/**
|
|
15246
|
+
* Provisions a new website on one of your Agency Plan hosting orders. Choose the datacenter, stack (`flavor`), and PHP version for the site. Optionally attach your own `domain` — omit it, set it to `null`, or leave it unavailable and a free `*.hostingersite.com` subdomain is generated instead — and/or install WordPress by supplying the `wordpress` details (admin account, site title, and language). Common setups: - **Plain PHP site**: `flavor` set to `php-fpm`, with `settings.php.version`; omit `wordpress` and `type`. - **WordPress site**: `flavor` set to the desired WordPress version (e.g. `wp-7.0`), plus the `wordpress` block (admin account, title, language). - **Static/Node.js frontend app**: `flavor` set to `php-fpm` and `type` set to `node-static`. Provisioning runs in the background, so the response returns immediately with a setup UUID that identifies the job. The new website becomes reachable once provisioning finishes.
|
|
15247
|
+
* @summary Create a new website
|
|
15248
|
+
* @param {number} orderId Agency Plan order ID
|
|
15249
|
+
* @param {AgencyHostingV1SetupsCreateSetupRequest} agencyHostingV1SetupsCreateSetupRequest
|
|
15250
|
+
* @param {*} [options] Override http request option.
|
|
15251
|
+
* @throws {RequiredError}
|
|
15252
|
+
*/
|
|
15253
|
+
createANewWebsiteV1: async (orderId: number, agencyHostingV1SetupsCreateSetupRequest: AgencyHostingV1SetupsCreateSetupRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
15254
|
+
// verify required parameter 'orderId' is not null or undefined
|
|
15255
|
+
assertParamExists('createANewWebsiteV1', 'orderId', orderId)
|
|
15256
|
+
// verify required parameter 'agencyHostingV1SetupsCreateSetupRequest' is not null or undefined
|
|
15257
|
+
assertParamExists('createANewWebsiteV1', 'agencyHostingV1SetupsCreateSetupRequest', agencyHostingV1SetupsCreateSetupRequest)
|
|
15258
|
+
const localVarPath = `/api/agency-hosting/v1/orders/{order_id}/websites/setups`
|
|
15259
|
+
.replace(`{${"order_id"}}`, encodeURIComponent(String(orderId)));
|
|
15260
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
15261
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
15262
|
+
let baseOptions;
|
|
15263
|
+
if (configuration) {
|
|
15264
|
+
baseOptions = configuration.baseOptions;
|
|
15265
|
+
}
|
|
15266
|
+
|
|
15267
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
15268
|
+
const localVarHeaderParameter = {} as any;
|
|
15269
|
+
const localVarQueryParameter = {} as any;
|
|
15270
|
+
|
|
15271
|
+
// authentication apiToken required
|
|
15272
|
+
// http bearer authentication required
|
|
15273
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
15274
|
+
|
|
15275
|
+
|
|
15276
|
+
|
|
15277
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
15278
|
+
|
|
15279
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
15280
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
15281
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
15282
|
+
localVarRequestOptions.data = serializeDataIfNeeded(agencyHostingV1SetupsCreateSetupRequest, localVarRequestOptions, configuration)
|
|
15283
|
+
|
|
15284
|
+
return {
|
|
15285
|
+
url: toPathString(localVarUrlObj),
|
|
15286
|
+
options: localVarRequestOptions,
|
|
15287
|
+
};
|
|
15288
|
+
},
|
|
15289
|
+
/**
|
|
15290
|
+
* Returns the current status of an Agency Plan website setup started via the setups endpoint. Poll this endpoint using the `setup_uuid` returned from the provisioning request until `status` becomes `completed`, at which point `website_uid` identifies the new website.
|
|
15291
|
+
* @summary Get website setup status
|
|
15292
|
+
* @param {number} orderId Agency Plan order ID
|
|
15293
|
+
* @param {string} setupUuid Website setup UUID
|
|
15294
|
+
* @param {*} [options] Override http request option.
|
|
15295
|
+
* @throws {RequiredError}
|
|
15296
|
+
*/
|
|
15297
|
+
getWebsiteSetupStatusV1: async (orderId: number, setupUuid: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
15298
|
+
// verify required parameter 'orderId' is not null or undefined
|
|
15299
|
+
assertParamExists('getWebsiteSetupStatusV1', 'orderId', orderId)
|
|
15300
|
+
// verify required parameter 'setupUuid' is not null or undefined
|
|
15301
|
+
assertParamExists('getWebsiteSetupStatusV1', 'setupUuid', setupUuid)
|
|
15302
|
+
const localVarPath = `/api/agency-hosting/v1/orders/{order_id}/websites/setups/{setup_uuid}`
|
|
15303
|
+
.replace(`{${"order_id"}}`, encodeURIComponent(String(orderId)))
|
|
15304
|
+
.replace(`{${"setup_uuid"}}`, encodeURIComponent(String(setupUuid)));
|
|
15305
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
15306
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
15307
|
+
let baseOptions;
|
|
15308
|
+
if (configuration) {
|
|
15309
|
+
baseOptions = configuration.baseOptions;
|
|
15310
|
+
}
|
|
15311
|
+
|
|
15312
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
15313
|
+
const localVarHeaderParameter = {} as any;
|
|
15314
|
+
const localVarQueryParameter = {} as any;
|
|
15315
|
+
|
|
15316
|
+
// authentication apiToken required
|
|
15317
|
+
// http bearer authentication required
|
|
15318
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
15319
|
+
|
|
15320
|
+
|
|
15321
|
+
|
|
15322
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
15323
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
15324
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
15325
|
+
|
|
15326
|
+
return {
|
|
15327
|
+
url: toPathString(localVarUrlObj),
|
|
15328
|
+
options: localVarRequestOptions,
|
|
15329
|
+
};
|
|
15330
|
+
},
|
|
15331
|
+
}
|
|
15332
|
+
};
|
|
15333
|
+
|
|
15334
|
+
/**
|
|
15335
|
+
* AgencyHostingWebsiteSetupsApi - functional programming interface
|
|
15336
|
+
* @export
|
|
15337
|
+
*/
|
|
15338
|
+
export const AgencyHostingWebsiteSetupsApiFp = function(configuration?: Configuration) {
|
|
15339
|
+
const localVarAxiosParamCreator = AgencyHostingWebsiteSetupsApiAxiosParamCreator(configuration)
|
|
15340
|
+
return {
|
|
15341
|
+
/**
|
|
15342
|
+
* Provisions a new website on one of your Agency Plan hosting orders. Choose the datacenter, stack (`flavor`), and PHP version for the site. Optionally attach your own `domain` — omit it, set it to `null`, or leave it unavailable and a free `*.hostingersite.com` subdomain is generated instead — and/or install WordPress by supplying the `wordpress` details (admin account, site title, and language). Common setups: - **Plain PHP site**: `flavor` set to `php-fpm`, with `settings.php.version`; omit `wordpress` and `type`. - **WordPress site**: `flavor` set to the desired WordPress version (e.g. `wp-7.0`), plus the `wordpress` block (admin account, title, language). - **Static/Node.js frontend app**: `flavor` set to `php-fpm` and `type` set to `node-static`. Provisioning runs in the background, so the response returns immediately with a setup UUID that identifies the job. The new website becomes reachable once provisioning finishes.
|
|
15343
|
+
* @summary Create a new website
|
|
15344
|
+
* @param {number} orderId Agency Plan order ID
|
|
15345
|
+
* @param {AgencyHostingV1SetupsCreateSetupRequest} agencyHostingV1SetupsCreateSetupRequest
|
|
15346
|
+
* @param {*} [options] Override http request option.
|
|
15347
|
+
* @throws {RequiredError}
|
|
15348
|
+
*/
|
|
15349
|
+
async createANewWebsiteV1(orderId: number, agencyHostingV1SetupsCreateSetupRequest: AgencyHostingV1SetupsCreateSetupRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AgencyHostingV1SetupsWebsiteSetupResource>> {
|
|
15350
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createANewWebsiteV1(orderId, agencyHostingV1SetupsCreateSetupRequest, options);
|
|
15351
|
+
const localVarOperationServerBasePath = operationServerMap['AgencyHostingWebsiteSetupsApi.createANewWebsiteV1']?.[0]?.url;
|
|
15352
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15353
|
+
},
|
|
15354
|
+
/**
|
|
15355
|
+
* Returns the current status of an Agency Plan website setup started via the setups endpoint. Poll this endpoint using the `setup_uuid` returned from the provisioning request until `status` becomes `completed`, at which point `website_uid` identifies the new website.
|
|
15356
|
+
* @summary Get website setup status
|
|
15357
|
+
* @param {number} orderId Agency Plan order ID
|
|
15358
|
+
* @param {string} setupUuid Website setup UUID
|
|
15359
|
+
* @param {*} [options] Override http request option.
|
|
15360
|
+
* @throws {RequiredError}
|
|
15361
|
+
*/
|
|
15362
|
+
async getWebsiteSetupStatusV1(orderId: number, setupUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AgencyHostingV1SetupsWebsiteSetupStatusResource>> {
|
|
15363
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getWebsiteSetupStatusV1(orderId, setupUuid, options);
|
|
15364
|
+
const localVarOperationServerBasePath = operationServerMap['AgencyHostingWebsiteSetupsApi.getWebsiteSetupStatusV1']?.[0]?.url;
|
|
15365
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15366
|
+
},
|
|
15367
|
+
}
|
|
15368
|
+
};
|
|
15369
|
+
|
|
15370
|
+
/**
|
|
15371
|
+
* AgencyHostingWebsiteSetupsApi - factory interface
|
|
15372
|
+
* @export
|
|
15373
|
+
*/
|
|
15374
|
+
export const AgencyHostingWebsiteSetupsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
15375
|
+
const localVarFp = AgencyHostingWebsiteSetupsApiFp(configuration)
|
|
15376
|
+
return {
|
|
15377
|
+
/**
|
|
15378
|
+
* Provisions a new website on one of your Agency Plan hosting orders. Choose the datacenter, stack (`flavor`), and PHP version for the site. Optionally attach your own `domain` — omit it, set it to `null`, or leave it unavailable and a free `*.hostingersite.com` subdomain is generated instead — and/or install WordPress by supplying the `wordpress` details (admin account, site title, and language). Common setups: - **Plain PHP site**: `flavor` set to `php-fpm`, with `settings.php.version`; omit `wordpress` and `type`. - **WordPress site**: `flavor` set to the desired WordPress version (e.g. `wp-7.0`), plus the `wordpress` block (admin account, title, language). - **Static/Node.js frontend app**: `flavor` set to `php-fpm` and `type` set to `node-static`. Provisioning runs in the background, so the response returns immediately with a setup UUID that identifies the job. The new website becomes reachable once provisioning finishes.
|
|
15379
|
+
* @summary Create a new website
|
|
15380
|
+
* @param {number} orderId Agency Plan order ID
|
|
15381
|
+
* @param {AgencyHostingV1SetupsCreateSetupRequest} agencyHostingV1SetupsCreateSetupRequest
|
|
15382
|
+
* @param {*} [options] Override http request option.
|
|
15383
|
+
* @throws {RequiredError}
|
|
15384
|
+
*/
|
|
14589
15385
|
createANewWebsiteV1(orderId: number, agencyHostingV1SetupsCreateSetupRequest: AgencyHostingV1SetupsCreateSetupRequest, options?: RawAxiosRequestConfig): AxiosPromise<AgencyHostingV1SetupsWebsiteSetupResource> {
|
|
14590
15386
|
return localVarFp.createANewWebsiteV1(orderId, agencyHostingV1SetupsCreateSetupRequest, options).then((request) => request(axios, basePath));
|
|
14591
15387
|
},
|
|
@@ -25279,6 +26075,317 @@ export class HostingPHPApi extends BaseAPI {
|
|
|
25279
26075
|
|
|
25280
26076
|
|
|
25281
26077
|
|
|
26078
|
+
/**
|
|
26079
|
+
* HostingRedirectsApi - axios parameter creator
|
|
26080
|
+
* @export
|
|
26081
|
+
*/
|
|
26082
|
+
export const HostingRedirectsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
26083
|
+
return {
|
|
26084
|
+
/**
|
|
26085
|
+
* Creates a redirect from a URL on the selected website to another URL or IP address.
|
|
26086
|
+
* @summary Create website redirect
|
|
26087
|
+
* @param {string} username
|
|
26088
|
+
* @param {string} domain Domain name
|
|
26089
|
+
* @param {HostingV1RedirectsCreateRedirectRequest} hostingV1RedirectsCreateRedirectRequest
|
|
26090
|
+
* @param {*} [options] Override http request option.
|
|
26091
|
+
* @throws {RequiredError}
|
|
26092
|
+
*/
|
|
26093
|
+
createWebsiteRedirectV1: async (username: string, domain: string, hostingV1RedirectsCreateRedirectRequest: HostingV1RedirectsCreateRedirectRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
26094
|
+
// verify required parameter 'username' is not null or undefined
|
|
26095
|
+
assertParamExists('createWebsiteRedirectV1', 'username', username)
|
|
26096
|
+
// verify required parameter 'domain' is not null or undefined
|
|
26097
|
+
assertParamExists('createWebsiteRedirectV1', 'domain', domain)
|
|
26098
|
+
// verify required parameter 'hostingV1RedirectsCreateRedirectRequest' is not null or undefined
|
|
26099
|
+
assertParamExists('createWebsiteRedirectV1', 'hostingV1RedirectsCreateRedirectRequest', hostingV1RedirectsCreateRedirectRequest)
|
|
26100
|
+
const localVarPath = `/api/hosting/v1/accounts/{username}/websites/{domain}/redirects`
|
|
26101
|
+
.replace(`{${"username"}}`, encodeURIComponent(String(username)))
|
|
26102
|
+
.replace(`{${"domain"}}`, encodeURIComponent(String(domain)));
|
|
26103
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
26104
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
26105
|
+
let baseOptions;
|
|
26106
|
+
if (configuration) {
|
|
26107
|
+
baseOptions = configuration.baseOptions;
|
|
26108
|
+
}
|
|
26109
|
+
|
|
26110
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
26111
|
+
const localVarHeaderParameter = {} as any;
|
|
26112
|
+
const localVarQueryParameter = {} as any;
|
|
26113
|
+
|
|
26114
|
+
// authentication apiToken required
|
|
26115
|
+
// http bearer authentication required
|
|
26116
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
26117
|
+
|
|
26118
|
+
|
|
26119
|
+
|
|
26120
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
26121
|
+
|
|
26122
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
26123
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
26124
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
26125
|
+
localVarRequestOptions.data = serializeDataIfNeeded(hostingV1RedirectsCreateRedirectRequest, localVarRequestOptions, configuration)
|
|
26126
|
+
|
|
26127
|
+
return {
|
|
26128
|
+
url: toPathString(localVarUrlObj),
|
|
26129
|
+
options: localVarRequestOptions,
|
|
26130
|
+
};
|
|
26131
|
+
},
|
|
26132
|
+
/**
|
|
26133
|
+
* Permanently deletes the redirect identified by its source URL. Pass the `from` value exactly as returned by the list redirects endpoint.
|
|
26134
|
+
* @summary Delete website redirect
|
|
26135
|
+
* @param {string} username
|
|
26136
|
+
* @param {string} domain Domain name
|
|
26137
|
+
* @param {string} from Source URL returned by the list redirects endpoint.
|
|
26138
|
+
* @param {*} [options] Override http request option.
|
|
26139
|
+
* @throws {RequiredError}
|
|
26140
|
+
*/
|
|
26141
|
+
deleteWebsiteRedirectV1: async (username: string, domain: string, from: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
26142
|
+
// verify required parameter 'username' is not null or undefined
|
|
26143
|
+
assertParamExists('deleteWebsiteRedirectV1', 'username', username)
|
|
26144
|
+
// verify required parameter 'domain' is not null or undefined
|
|
26145
|
+
assertParamExists('deleteWebsiteRedirectV1', 'domain', domain)
|
|
26146
|
+
// verify required parameter 'from' is not null or undefined
|
|
26147
|
+
assertParamExists('deleteWebsiteRedirectV1', 'from', from)
|
|
26148
|
+
const localVarPath = `/api/hosting/v1/accounts/{username}/websites/{domain}/redirects`
|
|
26149
|
+
.replace(`{${"username"}}`, encodeURIComponent(String(username)))
|
|
26150
|
+
.replace(`{${"domain"}}`, encodeURIComponent(String(domain)));
|
|
26151
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
26152
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
26153
|
+
let baseOptions;
|
|
26154
|
+
if (configuration) {
|
|
26155
|
+
baseOptions = configuration.baseOptions;
|
|
26156
|
+
}
|
|
26157
|
+
|
|
26158
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
26159
|
+
const localVarHeaderParameter = {} as any;
|
|
26160
|
+
const localVarQueryParameter = {} as any;
|
|
26161
|
+
|
|
26162
|
+
// authentication apiToken required
|
|
26163
|
+
// http bearer authentication required
|
|
26164
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
26165
|
+
|
|
26166
|
+
if (from !== undefined) {
|
|
26167
|
+
localVarQueryParameter['from'] = from;
|
|
26168
|
+
}
|
|
26169
|
+
|
|
26170
|
+
|
|
26171
|
+
|
|
26172
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
26173
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
26174
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
26175
|
+
|
|
26176
|
+
return {
|
|
26177
|
+
url: toPathString(localVarUrlObj),
|
|
26178
|
+
options: localVarRequestOptions,
|
|
26179
|
+
};
|
|
26180
|
+
},
|
|
26181
|
+
/**
|
|
26182
|
+
* Returns a paginated list of redirects configured for the selected website.
|
|
26183
|
+
* @summary List website redirects
|
|
26184
|
+
* @param {string} username
|
|
26185
|
+
* @param {string} domain Domain name
|
|
26186
|
+
* @param {number} [page] Page number
|
|
26187
|
+
* @param {number} [perPage] Number of items per page
|
|
26188
|
+
* @param {*} [options] Override http request option.
|
|
26189
|
+
* @throws {RequiredError}
|
|
26190
|
+
*/
|
|
26191
|
+
listWebsiteRedirectsV1: async (username: string, domain: string, page?: number, perPage?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
26192
|
+
// verify required parameter 'username' is not null or undefined
|
|
26193
|
+
assertParamExists('listWebsiteRedirectsV1', 'username', username)
|
|
26194
|
+
// verify required parameter 'domain' is not null or undefined
|
|
26195
|
+
assertParamExists('listWebsiteRedirectsV1', 'domain', domain)
|
|
26196
|
+
const localVarPath = `/api/hosting/v1/accounts/{username}/websites/{domain}/redirects`
|
|
26197
|
+
.replace(`{${"username"}}`, encodeURIComponent(String(username)))
|
|
26198
|
+
.replace(`{${"domain"}}`, encodeURIComponent(String(domain)));
|
|
26199
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
26200
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
26201
|
+
let baseOptions;
|
|
26202
|
+
if (configuration) {
|
|
26203
|
+
baseOptions = configuration.baseOptions;
|
|
26204
|
+
}
|
|
26205
|
+
|
|
26206
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
26207
|
+
const localVarHeaderParameter = {} as any;
|
|
26208
|
+
const localVarQueryParameter = {} as any;
|
|
26209
|
+
|
|
26210
|
+
// authentication apiToken required
|
|
26211
|
+
// http bearer authentication required
|
|
26212
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
26213
|
+
|
|
26214
|
+
if (page !== undefined) {
|
|
26215
|
+
localVarQueryParameter['page'] = page;
|
|
26216
|
+
}
|
|
26217
|
+
|
|
26218
|
+
if (perPage !== undefined) {
|
|
26219
|
+
localVarQueryParameter['per_page'] = perPage;
|
|
26220
|
+
}
|
|
26221
|
+
|
|
26222
|
+
|
|
26223
|
+
|
|
26224
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
26225
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
26226
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
26227
|
+
|
|
26228
|
+
return {
|
|
26229
|
+
url: toPathString(localVarUrlObj),
|
|
26230
|
+
options: localVarRequestOptions,
|
|
26231
|
+
};
|
|
26232
|
+
},
|
|
26233
|
+
}
|
|
26234
|
+
};
|
|
26235
|
+
|
|
26236
|
+
/**
|
|
26237
|
+
* HostingRedirectsApi - functional programming interface
|
|
26238
|
+
* @export
|
|
26239
|
+
*/
|
|
26240
|
+
export const HostingRedirectsApiFp = function(configuration?: Configuration) {
|
|
26241
|
+
const localVarAxiosParamCreator = HostingRedirectsApiAxiosParamCreator(configuration)
|
|
26242
|
+
return {
|
|
26243
|
+
/**
|
|
26244
|
+
* Creates a redirect from a URL on the selected website to another URL or IP address.
|
|
26245
|
+
* @summary Create website redirect
|
|
26246
|
+
* @param {string} username
|
|
26247
|
+
* @param {string} domain Domain name
|
|
26248
|
+
* @param {HostingV1RedirectsCreateRedirectRequest} hostingV1RedirectsCreateRedirectRequest
|
|
26249
|
+
* @param {*} [options] Override http request option.
|
|
26250
|
+
* @throws {RequiredError}
|
|
26251
|
+
*/
|
|
26252
|
+
async createWebsiteRedirectV1(username: string, domain: string, hostingV1RedirectsCreateRedirectRequest: HostingV1RedirectsCreateRedirectRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<HostingV1RedirectsRedirectResource>> {
|
|
26253
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createWebsiteRedirectV1(username, domain, hostingV1RedirectsCreateRedirectRequest, options);
|
|
26254
|
+
const localVarOperationServerBasePath = operationServerMap['HostingRedirectsApi.createWebsiteRedirectV1']?.[0]?.url;
|
|
26255
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
26256
|
+
},
|
|
26257
|
+
/**
|
|
26258
|
+
* Permanently deletes the redirect identified by its source URL. Pass the `from` value exactly as returned by the list redirects endpoint.
|
|
26259
|
+
* @summary Delete website redirect
|
|
26260
|
+
* @param {string} username
|
|
26261
|
+
* @param {string} domain Domain name
|
|
26262
|
+
* @param {string} from Source URL returned by the list redirects endpoint.
|
|
26263
|
+
* @param {*} [options] Override http request option.
|
|
26264
|
+
* @throws {RequiredError}
|
|
26265
|
+
*/
|
|
26266
|
+
async deleteWebsiteRedirectV1(username: string, domain: string, from: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommonSuccessEmptyResource>> {
|
|
26267
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteWebsiteRedirectV1(username, domain, from, options);
|
|
26268
|
+
const localVarOperationServerBasePath = operationServerMap['HostingRedirectsApi.deleteWebsiteRedirectV1']?.[0]?.url;
|
|
26269
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
26270
|
+
},
|
|
26271
|
+
/**
|
|
26272
|
+
* Returns a paginated list of redirects configured for the selected website.
|
|
26273
|
+
* @summary List website redirects
|
|
26274
|
+
* @param {string} username
|
|
26275
|
+
* @param {string} domain Domain name
|
|
26276
|
+
* @param {number} [page] Page number
|
|
26277
|
+
* @param {number} [perPage] Number of items per page
|
|
26278
|
+
* @param {*} [options] Override http request option.
|
|
26279
|
+
* @throws {RequiredError}
|
|
26280
|
+
*/
|
|
26281
|
+
async listWebsiteRedirectsV1(username: string, domain: string, page?: number, perPage?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<HostingListWebsiteRedirectsV1200Response>> {
|
|
26282
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listWebsiteRedirectsV1(username, domain, page, perPage, options);
|
|
26283
|
+
const localVarOperationServerBasePath = operationServerMap['HostingRedirectsApi.listWebsiteRedirectsV1']?.[0]?.url;
|
|
26284
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
26285
|
+
},
|
|
26286
|
+
}
|
|
26287
|
+
};
|
|
26288
|
+
|
|
26289
|
+
/**
|
|
26290
|
+
* HostingRedirectsApi - factory interface
|
|
26291
|
+
* @export
|
|
26292
|
+
*/
|
|
26293
|
+
export const HostingRedirectsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
26294
|
+
const localVarFp = HostingRedirectsApiFp(configuration)
|
|
26295
|
+
return {
|
|
26296
|
+
/**
|
|
26297
|
+
* Creates a redirect from a URL on the selected website to another URL or IP address.
|
|
26298
|
+
* @summary Create website redirect
|
|
26299
|
+
* @param {string} username
|
|
26300
|
+
* @param {string} domain Domain name
|
|
26301
|
+
* @param {HostingV1RedirectsCreateRedirectRequest} hostingV1RedirectsCreateRedirectRequest
|
|
26302
|
+
* @param {*} [options] Override http request option.
|
|
26303
|
+
* @throws {RequiredError}
|
|
26304
|
+
*/
|
|
26305
|
+
createWebsiteRedirectV1(username: string, domain: string, hostingV1RedirectsCreateRedirectRequest: HostingV1RedirectsCreateRedirectRequest, options?: RawAxiosRequestConfig): AxiosPromise<HostingV1RedirectsRedirectResource> {
|
|
26306
|
+
return localVarFp.createWebsiteRedirectV1(username, domain, hostingV1RedirectsCreateRedirectRequest, options).then((request) => request(axios, basePath));
|
|
26307
|
+
},
|
|
26308
|
+
/**
|
|
26309
|
+
* Permanently deletes the redirect identified by its source URL. Pass the `from` value exactly as returned by the list redirects endpoint.
|
|
26310
|
+
* @summary Delete website redirect
|
|
26311
|
+
* @param {string} username
|
|
26312
|
+
* @param {string} domain Domain name
|
|
26313
|
+
* @param {string} from Source URL returned by the list redirects endpoint.
|
|
26314
|
+
* @param {*} [options] Override http request option.
|
|
26315
|
+
* @throws {RequiredError}
|
|
26316
|
+
*/
|
|
26317
|
+
deleteWebsiteRedirectV1(username: string, domain: string, from: string, options?: RawAxiosRequestConfig): AxiosPromise<CommonSuccessEmptyResource> {
|
|
26318
|
+
return localVarFp.deleteWebsiteRedirectV1(username, domain, from, options).then((request) => request(axios, basePath));
|
|
26319
|
+
},
|
|
26320
|
+
/**
|
|
26321
|
+
* Returns a paginated list of redirects configured for the selected website.
|
|
26322
|
+
* @summary List website redirects
|
|
26323
|
+
* @param {string} username
|
|
26324
|
+
* @param {string} domain Domain name
|
|
26325
|
+
* @param {number} [page] Page number
|
|
26326
|
+
* @param {number} [perPage] Number of items per page
|
|
26327
|
+
* @param {*} [options] Override http request option.
|
|
26328
|
+
* @throws {RequiredError}
|
|
26329
|
+
*/
|
|
26330
|
+
listWebsiteRedirectsV1(username: string, domain: string, page?: number, perPage?: number, options?: RawAxiosRequestConfig): AxiosPromise<HostingListWebsiteRedirectsV1200Response> {
|
|
26331
|
+
return localVarFp.listWebsiteRedirectsV1(username, domain, page, perPage, options).then((request) => request(axios, basePath));
|
|
26332
|
+
},
|
|
26333
|
+
};
|
|
26334
|
+
};
|
|
26335
|
+
|
|
26336
|
+
/**
|
|
26337
|
+
* HostingRedirectsApi - object-oriented interface
|
|
26338
|
+
* @export
|
|
26339
|
+
* @class HostingRedirectsApi
|
|
26340
|
+
* @extends {BaseAPI}
|
|
26341
|
+
*/
|
|
26342
|
+
export class HostingRedirectsApi extends BaseAPI {
|
|
26343
|
+
/**
|
|
26344
|
+
* Creates a redirect from a URL on the selected website to another URL or IP address.
|
|
26345
|
+
* @summary Create website redirect
|
|
26346
|
+
* @param {string} username
|
|
26347
|
+
* @param {string} domain Domain name
|
|
26348
|
+
* @param {HostingV1RedirectsCreateRedirectRequest} hostingV1RedirectsCreateRedirectRequest
|
|
26349
|
+
* @param {*} [options] Override http request option.
|
|
26350
|
+
* @throws {RequiredError}
|
|
26351
|
+
* @memberof HostingRedirectsApi
|
|
26352
|
+
*/
|
|
26353
|
+
public createWebsiteRedirectV1(username: string, domain: string, hostingV1RedirectsCreateRedirectRequest: HostingV1RedirectsCreateRedirectRequest, options?: RawAxiosRequestConfig) {
|
|
26354
|
+
return HostingRedirectsApiFp(this.configuration).createWebsiteRedirectV1(username, domain, hostingV1RedirectsCreateRedirectRequest, options).then((request) => request(this.axios, this.basePath));
|
|
26355
|
+
}
|
|
26356
|
+
|
|
26357
|
+
/**
|
|
26358
|
+
* Permanently deletes the redirect identified by its source URL. Pass the `from` value exactly as returned by the list redirects endpoint.
|
|
26359
|
+
* @summary Delete website redirect
|
|
26360
|
+
* @param {string} username
|
|
26361
|
+
* @param {string} domain Domain name
|
|
26362
|
+
* @param {string} from Source URL returned by the list redirects endpoint.
|
|
26363
|
+
* @param {*} [options] Override http request option.
|
|
26364
|
+
* @throws {RequiredError}
|
|
26365
|
+
* @memberof HostingRedirectsApi
|
|
26366
|
+
*/
|
|
26367
|
+
public deleteWebsiteRedirectV1(username: string, domain: string, from: string, options?: RawAxiosRequestConfig) {
|
|
26368
|
+
return HostingRedirectsApiFp(this.configuration).deleteWebsiteRedirectV1(username, domain, from, options).then((request) => request(this.axios, this.basePath));
|
|
26369
|
+
}
|
|
26370
|
+
|
|
26371
|
+
/**
|
|
26372
|
+
* Returns a paginated list of redirects configured for the selected website.
|
|
26373
|
+
* @summary List website redirects
|
|
26374
|
+
* @param {string} username
|
|
26375
|
+
* @param {string} domain Domain name
|
|
26376
|
+
* @param {number} [page] Page number
|
|
26377
|
+
* @param {number} [perPage] Number of items per page
|
|
26378
|
+
* @param {*} [options] Override http request option.
|
|
26379
|
+
* @throws {RequiredError}
|
|
26380
|
+
* @memberof HostingRedirectsApi
|
|
26381
|
+
*/
|
|
26382
|
+
public listWebsiteRedirectsV1(username: string, domain: string, page?: number, perPage?: number, options?: RawAxiosRequestConfig) {
|
|
26383
|
+
return HostingRedirectsApiFp(this.configuration).listWebsiteRedirectsV1(username, domain, page, perPage, options).then((request) => request(this.axios, this.basePath));
|
|
26384
|
+
}
|
|
26385
|
+
}
|
|
26386
|
+
|
|
26387
|
+
|
|
26388
|
+
|
|
25282
26389
|
/**
|
|
25283
26390
|
* HostingWebsitesApi - axios parameter creator
|
|
25284
26391
|
* @export
|