hostinger-api-sdk 1.33.1 → 1.34.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/api.ts CHANGED
@@ -3,7 +3,7 @@
3
3
  /**
4
4
  * Hostinger API
5
5
  *
6
- * API Version: 1.35.1
6
+ * API Version: 1.36.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
@@ -14440,6 +14596,576 @@ export class AgencyHostingOrdersApi extends BaseAPI {
14440
14596
 
14441
14597
 
14442
14598
 
14599
+ /**
14600
+ * AgencyHostingPHPApi - axios parameter creator
14601
+ * @export
14602
+ */
14603
+ export const AgencyHostingPHPApiAxiosParamCreator = function (configuration?: Configuration) {
14604
+ return {
14605
+ /**
14606
+ * 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.
14607
+ * @summary List available PHP versions for a website
14608
+ * @param {string} websiteUid Agency Plan website UID
14609
+ * @param {*} [options] Override http request option.
14610
+ * @throws {RequiredError}
14611
+ */
14612
+ listAvailablePHPVersionsForAWebsiteV1: async (websiteUid: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
14613
+ // verify required parameter 'websiteUid' is not null or undefined
14614
+ assertParamExists('listAvailablePHPVersionsForAWebsiteV1', 'websiteUid', websiteUid)
14615
+ const localVarPath = `/api/agency-hosting/v1/websites/{website_uid}/php-settings/versions`
14616
+ .replace(`{${"website_uid"}}`, encodeURIComponent(String(websiteUid)));
14617
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
14618
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
14619
+ let baseOptions;
14620
+ if (configuration) {
14621
+ baseOptions = configuration.baseOptions;
14622
+ }
14623
+
14624
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
14625
+ const localVarHeaderParameter = {} as any;
14626
+ const localVarQueryParameter = {} as any;
14627
+
14628
+ // authentication apiToken required
14629
+ // http bearer authentication required
14630
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
14631
+
14632
+
14633
+
14634
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
14635
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
14636
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
14637
+
14638
+ return {
14639
+ url: toPathString(localVarUrlObj),
14640
+ options: localVarRequestOptions,
14641
+ };
14642
+ },
14643
+ /**
14644
+ * 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.
14645
+ * @summary List available PHP versions for an order
14646
+ * @param {number} orderId Agency Plan order ID
14647
+ * @param {*} [options] Override http request option.
14648
+ * @throws {RequiredError}
14649
+ */
14650
+ listAvailablePHPVersionsForAnOrderV1: async (orderId: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
14651
+ // verify required parameter 'orderId' is not null or undefined
14652
+ assertParamExists('listAvailablePHPVersionsForAnOrderV1', 'orderId', orderId)
14653
+ const localVarPath = `/api/agency-hosting/v1/orders/{order_id}/websites/php-settings/versions`
14654
+ .replace(`{${"order_id"}}`, encodeURIComponent(String(orderId)));
14655
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
14656
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
14657
+ let baseOptions;
14658
+ if (configuration) {
14659
+ baseOptions = configuration.baseOptions;
14660
+ }
14661
+
14662
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
14663
+ const localVarHeaderParameter = {} as any;
14664
+ const localVarQueryParameter = {} as any;
14665
+
14666
+ // authentication apiToken required
14667
+ // http bearer authentication required
14668
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
14669
+
14670
+
14671
+
14672
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
14673
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
14674
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
14675
+
14676
+ return {
14677
+ url: toPathString(localVarUrlObj),
14678
+ options: localVarRequestOptions,
14679
+ };
14680
+ },
14681
+ /**
14682
+ * Lists every PHP extension available to an Agency Plan website and whether it is currently enabled.
14683
+ * @summary List PHP extensions for a website
14684
+ * @param {string} websiteUid Agency Plan website UID
14685
+ * @param {*} [options] Override http request option.
14686
+ * @throws {RequiredError}
14687
+ */
14688
+ listPHPExtensionsForAWebsiteV1: async (websiteUid: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
14689
+ // verify required parameter 'websiteUid' is not null or undefined
14690
+ assertParamExists('listPHPExtensionsForAWebsiteV1', 'websiteUid', websiteUid)
14691
+ const localVarPath = `/api/agency-hosting/v1/websites/{website_uid}/php-settings/extensions`
14692
+ .replace(`{${"website_uid"}}`, encodeURIComponent(String(websiteUid)));
14693
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
14694
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
14695
+ let baseOptions;
14696
+ if (configuration) {
14697
+ baseOptions = configuration.baseOptions;
14698
+ }
14699
+
14700
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
14701
+ const localVarHeaderParameter = {} as any;
14702
+ const localVarQueryParameter = {} as any;
14703
+
14704
+ // authentication apiToken required
14705
+ // http bearer authentication required
14706
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
14707
+
14708
+
14709
+
14710
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
14711
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
14712
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
14713
+
14714
+ return {
14715
+ url: toPathString(localVarUrlObj),
14716
+ options: localVarRequestOptions,
14717
+ };
14718
+ },
14719
+ /**
14720
+ * 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.
14721
+ * @summary List PHP options for a website
14722
+ * @param {string} websiteUid Agency Plan website UID
14723
+ * @param {*} [options] Override http request option.
14724
+ * @throws {RequiredError}
14725
+ */
14726
+ listPHPOptionsForAWebsiteV1: async (websiteUid: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
14727
+ // verify required parameter 'websiteUid' is not null or undefined
14728
+ assertParamExists('listPHPOptionsForAWebsiteV1', 'websiteUid', websiteUid)
14729
+ const localVarPath = `/api/agency-hosting/v1/websites/{website_uid}/php-settings/options`
14730
+ .replace(`{${"website_uid"}}`, encodeURIComponent(String(websiteUid)));
14731
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
14732
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
14733
+ let baseOptions;
14734
+ if (configuration) {
14735
+ baseOptions = configuration.baseOptions;
14736
+ }
14737
+
14738
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
14739
+ const localVarHeaderParameter = {} as any;
14740
+ const localVarQueryParameter = {} as any;
14741
+
14742
+ // authentication apiToken required
14743
+ // http bearer authentication required
14744
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
14745
+
14746
+
14747
+
14748
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
14749
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
14750
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
14751
+
14752
+ return {
14753
+ url: toPathString(localVarUrlObj),
14754
+ options: localVarRequestOptions,
14755
+ };
14756
+ },
14757
+ /**
14758
+ * 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.
14759
+ * @summary Replace website PHP extensions
14760
+ * @param {string} websiteUid Agency Plan website UID
14761
+ * @param {AgencyHostingV1PhpUpdateExtensionsRequest} agencyHostingV1PhpUpdateExtensionsRequest
14762
+ * @param {*} [options] Override http request option.
14763
+ * @throws {RequiredError}
14764
+ */
14765
+ replaceWebsitePHPExtensionsV1: async (websiteUid: string, agencyHostingV1PhpUpdateExtensionsRequest: AgencyHostingV1PhpUpdateExtensionsRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
14766
+ // verify required parameter 'websiteUid' is not null or undefined
14767
+ assertParamExists('replaceWebsitePHPExtensionsV1', 'websiteUid', websiteUid)
14768
+ // verify required parameter 'agencyHostingV1PhpUpdateExtensionsRequest' is not null or undefined
14769
+ assertParamExists('replaceWebsitePHPExtensionsV1', 'agencyHostingV1PhpUpdateExtensionsRequest', agencyHostingV1PhpUpdateExtensionsRequest)
14770
+ const localVarPath = `/api/agency-hosting/v1/websites/{website_uid}/php-settings/extensions`
14771
+ .replace(`{${"website_uid"}}`, encodeURIComponent(String(websiteUid)));
14772
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
14773
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
14774
+ let baseOptions;
14775
+ if (configuration) {
14776
+ baseOptions = configuration.baseOptions;
14777
+ }
14778
+
14779
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
14780
+ const localVarHeaderParameter = {} as any;
14781
+ const localVarQueryParameter = {} as any;
14782
+
14783
+ // authentication apiToken required
14784
+ // http bearer authentication required
14785
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
14786
+
14787
+
14788
+
14789
+ localVarHeaderParameter['Content-Type'] = 'application/json';
14790
+
14791
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
14792
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
14793
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
14794
+ localVarRequestOptions.data = serializeDataIfNeeded(agencyHostingV1PhpUpdateExtensionsRequest, localVarRequestOptions, configuration)
14795
+
14796
+ return {
14797
+ url: toPathString(localVarUrlObj),
14798
+ options: localVarRequestOptions,
14799
+ };
14800
+ },
14801
+ /**
14802
+ * 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.
14803
+ * @summary Replace website PHP options
14804
+ * @param {string} websiteUid Agency Plan website UID
14805
+ * @param {AgencyHostingV1PhpUpdateOptionsRequest} agencyHostingV1PhpUpdateOptionsRequest
14806
+ * @param {*} [options] Override http request option.
14807
+ * @throws {RequiredError}
14808
+ */
14809
+ replaceWebsitePHPOptionsV1: async (websiteUid: string, agencyHostingV1PhpUpdateOptionsRequest: AgencyHostingV1PhpUpdateOptionsRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
14810
+ // verify required parameter 'websiteUid' is not null or undefined
14811
+ assertParamExists('replaceWebsitePHPOptionsV1', 'websiteUid', websiteUid)
14812
+ // verify required parameter 'agencyHostingV1PhpUpdateOptionsRequest' is not null or undefined
14813
+ assertParamExists('replaceWebsitePHPOptionsV1', 'agencyHostingV1PhpUpdateOptionsRequest', agencyHostingV1PhpUpdateOptionsRequest)
14814
+ const localVarPath = `/api/agency-hosting/v1/websites/{website_uid}/php-settings/options`
14815
+ .replace(`{${"website_uid"}}`, encodeURIComponent(String(websiteUid)));
14816
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
14817
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
14818
+ let baseOptions;
14819
+ if (configuration) {
14820
+ baseOptions = configuration.baseOptions;
14821
+ }
14822
+
14823
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
14824
+ const localVarHeaderParameter = {} as any;
14825
+ const localVarQueryParameter = {} as any;
14826
+
14827
+ // authentication apiToken required
14828
+ // http bearer authentication required
14829
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
14830
+
14831
+
14832
+
14833
+ localVarHeaderParameter['Content-Type'] = 'application/json';
14834
+
14835
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
14836
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
14837
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
14838
+ localVarRequestOptions.data = serializeDataIfNeeded(agencyHostingV1PhpUpdateOptionsRequest, localVarRequestOptions, configuration)
14839
+
14840
+ return {
14841
+ url: toPathString(localVarUrlObj),
14842
+ options: localVarRequestOptions,
14843
+ };
14844
+ },
14845
+ /**
14846
+ * 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.
14847
+ * @summary Update website PHP version
14848
+ * @param {string} websiteUid Agency Plan website UID
14849
+ * @param {AgencyHostingV1PhpUpdateVersionRequest} agencyHostingV1PhpUpdateVersionRequest
14850
+ * @param {*} [options] Override http request option.
14851
+ * @throws {RequiredError}
14852
+ */
14853
+ updateWebsitePHPVersionV1: async (websiteUid: string, agencyHostingV1PhpUpdateVersionRequest: AgencyHostingV1PhpUpdateVersionRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
14854
+ // verify required parameter 'websiteUid' is not null or undefined
14855
+ assertParamExists('updateWebsitePHPVersionV1', 'websiteUid', websiteUid)
14856
+ // verify required parameter 'agencyHostingV1PhpUpdateVersionRequest' is not null or undefined
14857
+ assertParamExists('updateWebsitePHPVersionV1', 'agencyHostingV1PhpUpdateVersionRequest', agencyHostingV1PhpUpdateVersionRequest)
14858
+ const localVarPath = `/api/agency-hosting/v1/websites/{website_uid}/php-settings/version`
14859
+ .replace(`{${"website_uid"}}`, encodeURIComponent(String(websiteUid)));
14860
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
14861
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
14862
+ let baseOptions;
14863
+ if (configuration) {
14864
+ baseOptions = configuration.baseOptions;
14865
+ }
14866
+
14867
+ const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
14868
+ const localVarHeaderParameter = {} as any;
14869
+ const localVarQueryParameter = {} as any;
14870
+
14871
+ // authentication apiToken required
14872
+ // http bearer authentication required
14873
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
14874
+
14875
+
14876
+
14877
+ localVarHeaderParameter['Content-Type'] = 'application/json';
14878
+
14879
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
14880
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
14881
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
14882
+ localVarRequestOptions.data = serializeDataIfNeeded(agencyHostingV1PhpUpdateVersionRequest, localVarRequestOptions, configuration)
14883
+
14884
+ return {
14885
+ url: toPathString(localVarUrlObj),
14886
+ options: localVarRequestOptions,
14887
+ };
14888
+ },
14889
+ }
14890
+ };
14891
+
14892
+ /**
14893
+ * AgencyHostingPHPApi - functional programming interface
14894
+ * @export
14895
+ */
14896
+ export const AgencyHostingPHPApiFp = function(configuration?: Configuration) {
14897
+ const localVarAxiosParamCreator = AgencyHostingPHPApiAxiosParamCreator(configuration)
14898
+ return {
14899
+ /**
14900
+ * 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.
14901
+ * @summary List available PHP versions for a website
14902
+ * @param {string} websiteUid Agency Plan website UID
14903
+ * @param {*} [options] Override http request option.
14904
+ * @throws {RequiredError}
14905
+ */
14906
+ async listAvailablePHPVersionsForAWebsiteV1(websiteUid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AgencyHostingV1PhpVersionResource>>> {
14907
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listAvailablePHPVersionsForAWebsiteV1(websiteUid, options);
14908
+ const localVarOperationServerBasePath = operationServerMap['AgencyHostingPHPApi.listAvailablePHPVersionsForAWebsiteV1']?.[0]?.url;
14909
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
14910
+ },
14911
+ /**
14912
+ * 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.
14913
+ * @summary List available PHP versions for an order
14914
+ * @param {number} orderId Agency Plan order ID
14915
+ * @param {*} [options] Override http request option.
14916
+ * @throws {RequiredError}
14917
+ */
14918
+ async listAvailablePHPVersionsForAnOrderV1(orderId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AgencyHostingV1PhpVersionResource>>> {
14919
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listAvailablePHPVersionsForAnOrderV1(orderId, options);
14920
+ const localVarOperationServerBasePath = operationServerMap['AgencyHostingPHPApi.listAvailablePHPVersionsForAnOrderV1']?.[0]?.url;
14921
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
14922
+ },
14923
+ /**
14924
+ * Lists every PHP extension available to an Agency Plan website and whether it is currently enabled.
14925
+ * @summary List PHP extensions for a website
14926
+ * @param {string} websiteUid Agency Plan website UID
14927
+ * @param {*} [options] Override http request option.
14928
+ * @throws {RequiredError}
14929
+ */
14930
+ async listPHPExtensionsForAWebsiteV1(websiteUid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AgencyHostingV1PhpExtensionResource>>> {
14931
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listPHPExtensionsForAWebsiteV1(websiteUid, options);
14932
+ const localVarOperationServerBasePath = operationServerMap['AgencyHostingPHPApi.listPHPExtensionsForAWebsiteV1']?.[0]?.url;
14933
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
14934
+ },
14935
+ /**
14936
+ * 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.
14937
+ * @summary List PHP options for a website
14938
+ * @param {string} websiteUid Agency Plan website UID
14939
+ * @param {*} [options] Override http request option.
14940
+ * @throws {RequiredError}
14941
+ */
14942
+ async listPHPOptionsForAWebsiteV1(websiteUid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AgencyHostingV1PhpOptionResource>>> {
14943
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listPHPOptionsForAWebsiteV1(websiteUid, options);
14944
+ const localVarOperationServerBasePath = operationServerMap['AgencyHostingPHPApi.listPHPOptionsForAWebsiteV1']?.[0]?.url;
14945
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
14946
+ },
14947
+ /**
14948
+ * 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.
14949
+ * @summary Replace website PHP extensions
14950
+ * @param {string} websiteUid Agency Plan website UID
14951
+ * @param {AgencyHostingV1PhpUpdateExtensionsRequest} agencyHostingV1PhpUpdateExtensionsRequest
14952
+ * @param {*} [options] Override http request option.
14953
+ * @throws {RequiredError}
14954
+ */
14955
+ async replaceWebsitePHPExtensionsV1(websiteUid: string, agencyHostingV1PhpUpdateExtensionsRequest: AgencyHostingV1PhpUpdateExtensionsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommonSuccessEmptyResource>> {
14956
+ const localVarAxiosArgs = await localVarAxiosParamCreator.replaceWebsitePHPExtensionsV1(websiteUid, agencyHostingV1PhpUpdateExtensionsRequest, options);
14957
+ const localVarOperationServerBasePath = operationServerMap['AgencyHostingPHPApi.replaceWebsitePHPExtensionsV1']?.[0]?.url;
14958
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
14959
+ },
14960
+ /**
14961
+ * 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.
14962
+ * @summary Replace website PHP options
14963
+ * @param {string} websiteUid Agency Plan website UID
14964
+ * @param {AgencyHostingV1PhpUpdateOptionsRequest} agencyHostingV1PhpUpdateOptionsRequest
14965
+ * @param {*} [options] Override http request option.
14966
+ * @throws {RequiredError}
14967
+ */
14968
+ async replaceWebsitePHPOptionsV1(websiteUid: string, agencyHostingV1PhpUpdateOptionsRequest: AgencyHostingV1PhpUpdateOptionsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommonSuccessEmptyResource>> {
14969
+ const localVarAxiosArgs = await localVarAxiosParamCreator.replaceWebsitePHPOptionsV1(websiteUid, agencyHostingV1PhpUpdateOptionsRequest, options);
14970
+ const localVarOperationServerBasePath = operationServerMap['AgencyHostingPHPApi.replaceWebsitePHPOptionsV1']?.[0]?.url;
14971
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
14972
+ },
14973
+ /**
14974
+ * 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.
14975
+ * @summary Update website PHP version
14976
+ * @param {string} websiteUid Agency Plan website UID
14977
+ * @param {AgencyHostingV1PhpUpdateVersionRequest} agencyHostingV1PhpUpdateVersionRequest
14978
+ * @param {*} [options] Override http request option.
14979
+ * @throws {RequiredError}
14980
+ */
14981
+ async updateWebsitePHPVersionV1(websiteUid: string, agencyHostingV1PhpUpdateVersionRequest: AgencyHostingV1PhpUpdateVersionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommonSuccessEmptyResource>> {
14982
+ const localVarAxiosArgs = await localVarAxiosParamCreator.updateWebsitePHPVersionV1(websiteUid, agencyHostingV1PhpUpdateVersionRequest, options);
14983
+ const localVarOperationServerBasePath = operationServerMap['AgencyHostingPHPApi.updateWebsitePHPVersionV1']?.[0]?.url;
14984
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
14985
+ },
14986
+ }
14987
+ };
14988
+
14989
+ /**
14990
+ * AgencyHostingPHPApi - factory interface
14991
+ * @export
14992
+ */
14993
+ export const AgencyHostingPHPApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
14994
+ const localVarFp = AgencyHostingPHPApiFp(configuration)
14995
+ return {
14996
+ /**
14997
+ * 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.
14998
+ * @summary List available PHP versions for a website
14999
+ * @param {string} websiteUid Agency Plan website UID
15000
+ * @param {*} [options] Override http request option.
15001
+ * @throws {RequiredError}
15002
+ */
15003
+ listAvailablePHPVersionsForAWebsiteV1(websiteUid: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<AgencyHostingV1PhpVersionResource>> {
15004
+ return localVarFp.listAvailablePHPVersionsForAWebsiteV1(websiteUid, options).then((request) => request(axios, basePath));
15005
+ },
15006
+ /**
15007
+ * 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.
15008
+ * @summary List available PHP versions for an order
15009
+ * @param {number} orderId Agency Plan order ID
15010
+ * @param {*} [options] Override http request option.
15011
+ * @throws {RequiredError}
15012
+ */
15013
+ listAvailablePHPVersionsForAnOrderV1(orderId: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<AgencyHostingV1PhpVersionResource>> {
15014
+ return localVarFp.listAvailablePHPVersionsForAnOrderV1(orderId, options).then((request) => request(axios, basePath));
15015
+ },
15016
+ /**
15017
+ * Lists every PHP extension available to an Agency Plan website and whether it is currently enabled.
15018
+ * @summary List PHP extensions for a website
15019
+ * @param {string} websiteUid Agency Plan website UID
15020
+ * @param {*} [options] Override http request option.
15021
+ * @throws {RequiredError}
15022
+ */
15023
+ listPHPExtensionsForAWebsiteV1(websiteUid: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<AgencyHostingV1PhpExtensionResource>> {
15024
+ return localVarFp.listPHPExtensionsForAWebsiteV1(websiteUid, options).then((request) => request(axios, basePath));
15025
+ },
15026
+ /**
15027
+ * 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.
15028
+ * @summary List PHP options for a website
15029
+ * @param {string} websiteUid Agency Plan website UID
15030
+ * @param {*} [options] Override http request option.
15031
+ * @throws {RequiredError}
15032
+ */
15033
+ listPHPOptionsForAWebsiteV1(websiteUid: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<AgencyHostingV1PhpOptionResource>> {
15034
+ return localVarFp.listPHPOptionsForAWebsiteV1(websiteUid, options).then((request) => request(axios, basePath));
15035
+ },
15036
+ /**
15037
+ * 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.
15038
+ * @summary Replace website PHP extensions
15039
+ * @param {string} websiteUid Agency Plan website UID
15040
+ * @param {AgencyHostingV1PhpUpdateExtensionsRequest} agencyHostingV1PhpUpdateExtensionsRequest
15041
+ * @param {*} [options] Override http request option.
15042
+ * @throws {RequiredError}
15043
+ */
15044
+ replaceWebsitePHPExtensionsV1(websiteUid: string, agencyHostingV1PhpUpdateExtensionsRequest: AgencyHostingV1PhpUpdateExtensionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<CommonSuccessEmptyResource> {
15045
+ return localVarFp.replaceWebsitePHPExtensionsV1(websiteUid, agencyHostingV1PhpUpdateExtensionsRequest, options).then((request) => request(axios, basePath));
15046
+ },
15047
+ /**
15048
+ * 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.
15049
+ * @summary Replace website PHP options
15050
+ * @param {string} websiteUid Agency Plan website UID
15051
+ * @param {AgencyHostingV1PhpUpdateOptionsRequest} agencyHostingV1PhpUpdateOptionsRequest
15052
+ * @param {*} [options] Override http request option.
15053
+ * @throws {RequiredError}
15054
+ */
15055
+ replaceWebsitePHPOptionsV1(websiteUid: string, agencyHostingV1PhpUpdateOptionsRequest: AgencyHostingV1PhpUpdateOptionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<CommonSuccessEmptyResource> {
15056
+ return localVarFp.replaceWebsitePHPOptionsV1(websiteUid, agencyHostingV1PhpUpdateOptionsRequest, options).then((request) => request(axios, basePath));
15057
+ },
15058
+ /**
15059
+ * 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.
15060
+ * @summary Update website PHP version
15061
+ * @param {string} websiteUid Agency Plan website UID
15062
+ * @param {AgencyHostingV1PhpUpdateVersionRequest} agencyHostingV1PhpUpdateVersionRequest
15063
+ * @param {*} [options] Override http request option.
15064
+ * @throws {RequiredError}
15065
+ */
15066
+ updateWebsitePHPVersionV1(websiteUid: string, agencyHostingV1PhpUpdateVersionRequest: AgencyHostingV1PhpUpdateVersionRequest, options?: RawAxiosRequestConfig): AxiosPromise<CommonSuccessEmptyResource> {
15067
+ return localVarFp.updateWebsitePHPVersionV1(websiteUid, agencyHostingV1PhpUpdateVersionRequest, options).then((request) => request(axios, basePath));
15068
+ },
15069
+ };
15070
+ };
15071
+
15072
+ /**
15073
+ * AgencyHostingPHPApi - object-oriented interface
15074
+ * @export
15075
+ * @class AgencyHostingPHPApi
15076
+ * @extends {BaseAPI}
15077
+ */
15078
+ export class AgencyHostingPHPApi extends BaseAPI {
15079
+ /**
15080
+ * 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.
15081
+ * @summary List available PHP versions for a website
15082
+ * @param {string} websiteUid Agency Plan website UID
15083
+ * @param {*} [options] Override http request option.
15084
+ * @throws {RequiredError}
15085
+ * @memberof AgencyHostingPHPApi
15086
+ */
15087
+ public listAvailablePHPVersionsForAWebsiteV1(websiteUid: string, options?: RawAxiosRequestConfig) {
15088
+ return AgencyHostingPHPApiFp(this.configuration).listAvailablePHPVersionsForAWebsiteV1(websiteUid, options).then((request) => request(this.axios, this.basePath));
15089
+ }
15090
+
15091
+ /**
15092
+ * 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.
15093
+ * @summary List available PHP versions for an order
15094
+ * @param {number} orderId Agency Plan order ID
15095
+ * @param {*} [options] Override http request option.
15096
+ * @throws {RequiredError}
15097
+ * @memberof AgencyHostingPHPApi
15098
+ */
15099
+ public listAvailablePHPVersionsForAnOrderV1(orderId: number, options?: RawAxiosRequestConfig) {
15100
+ return AgencyHostingPHPApiFp(this.configuration).listAvailablePHPVersionsForAnOrderV1(orderId, options).then((request) => request(this.axios, this.basePath));
15101
+ }
15102
+
15103
+ /**
15104
+ * Lists every PHP extension available to an Agency Plan website and whether it is currently enabled.
15105
+ * @summary List PHP extensions for a website
15106
+ * @param {string} websiteUid Agency Plan website UID
15107
+ * @param {*} [options] Override http request option.
15108
+ * @throws {RequiredError}
15109
+ * @memberof AgencyHostingPHPApi
15110
+ */
15111
+ public listPHPExtensionsForAWebsiteV1(websiteUid: string, options?: RawAxiosRequestConfig) {
15112
+ return AgencyHostingPHPApiFp(this.configuration).listPHPExtensionsForAWebsiteV1(websiteUid, options).then((request) => request(this.axios, this.basePath));
15113
+ }
15114
+
15115
+ /**
15116
+ * 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.
15117
+ * @summary List PHP options for a website
15118
+ * @param {string} websiteUid Agency Plan website UID
15119
+ * @param {*} [options] Override http request option.
15120
+ * @throws {RequiredError}
15121
+ * @memberof AgencyHostingPHPApi
15122
+ */
15123
+ public listPHPOptionsForAWebsiteV1(websiteUid: string, options?: RawAxiosRequestConfig) {
15124
+ return AgencyHostingPHPApiFp(this.configuration).listPHPOptionsForAWebsiteV1(websiteUid, options).then((request) => request(this.axios, this.basePath));
15125
+ }
15126
+
15127
+ /**
15128
+ * 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.
15129
+ * @summary Replace website PHP extensions
15130
+ * @param {string} websiteUid Agency Plan website UID
15131
+ * @param {AgencyHostingV1PhpUpdateExtensionsRequest} agencyHostingV1PhpUpdateExtensionsRequest
15132
+ * @param {*} [options] Override http request option.
15133
+ * @throws {RequiredError}
15134
+ * @memberof AgencyHostingPHPApi
15135
+ */
15136
+ public replaceWebsitePHPExtensionsV1(websiteUid: string, agencyHostingV1PhpUpdateExtensionsRequest: AgencyHostingV1PhpUpdateExtensionsRequest, options?: RawAxiosRequestConfig) {
15137
+ return AgencyHostingPHPApiFp(this.configuration).replaceWebsitePHPExtensionsV1(websiteUid, agencyHostingV1PhpUpdateExtensionsRequest, options).then((request) => request(this.axios, this.basePath));
15138
+ }
15139
+
15140
+ /**
15141
+ * 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.
15142
+ * @summary Replace website PHP options
15143
+ * @param {string} websiteUid Agency Plan website UID
15144
+ * @param {AgencyHostingV1PhpUpdateOptionsRequest} agencyHostingV1PhpUpdateOptionsRequest
15145
+ * @param {*} [options] Override http request option.
15146
+ * @throws {RequiredError}
15147
+ * @memberof AgencyHostingPHPApi
15148
+ */
15149
+ public replaceWebsitePHPOptionsV1(websiteUid: string, agencyHostingV1PhpUpdateOptionsRequest: AgencyHostingV1PhpUpdateOptionsRequest, options?: RawAxiosRequestConfig) {
15150
+ return AgencyHostingPHPApiFp(this.configuration).replaceWebsitePHPOptionsV1(websiteUid, agencyHostingV1PhpUpdateOptionsRequest, options).then((request) => request(this.axios, this.basePath));
15151
+ }
15152
+
15153
+ /**
15154
+ * 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.
15155
+ * @summary Update website PHP version
15156
+ * @param {string} websiteUid Agency Plan website UID
15157
+ * @param {AgencyHostingV1PhpUpdateVersionRequest} agencyHostingV1PhpUpdateVersionRequest
15158
+ * @param {*} [options] Override http request option.
15159
+ * @throws {RequiredError}
15160
+ * @memberof AgencyHostingPHPApi
15161
+ */
15162
+ public updateWebsitePHPVersionV1(websiteUid: string, agencyHostingV1PhpUpdateVersionRequest: AgencyHostingV1PhpUpdateVersionRequest, options?: RawAxiosRequestConfig) {
15163
+ return AgencyHostingPHPApiFp(this.configuration).updateWebsitePHPVersionV1(websiteUid, agencyHostingV1PhpUpdateVersionRequest, options).then((request) => request(this.axios, this.basePath));
15164
+ }
15165
+ }
15166
+
15167
+
15168
+
14443
15169
  /**
14444
15170
  * AgencyHostingWebsiteSetupsApi - axios parameter creator
14445
15171
  * @export