@hostinger/sdk 1.52.1 → 1.53.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 +891 -18
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +2 -2
- package/dist/api.d.ts +568 -16
- package/dist/api.js +621 -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 +568 -16
- package/dist/esm/api.js +607 -15
- 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/HostingGitApi.md +178 -2
- package/docs/HostingNodeJSApi.md +1 -1
- package/docs/HostingSSLApi.md +242 -0
- package/docs/HostingV1GitGitAutoDeploymentSettingsResource.md +31 -0
- package/docs/HostingV1GitGitCommitAuthorResource.md +22 -0
- package/docs/HostingV1GitGitCommitResource.md +24 -0
- package/docs/HostingV1GitUpdateGitAutoDeploymentSettingsRequest.md +30 -0
- package/docs/HostingV1NodeJsSourceOptionsResource.md +11 -0
- package/docs/HostingV1NodeJsStartBuildRequest.md +1 -1
- package/docs/HostingV1NodeJsStartBuildRequestSourceOptions.md +9 -1
- package/docs/HostingV1SslSslStatusResource.md +30 -0
- package/docs/HostingV1SslToggleHttpsRedirectRequest.md +20 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/esm/api.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Hostinger API
|
|
3
3
|
*
|
|
4
|
-
* API Version: 1.
|
|
4
|
+
* API Version: 1.53.0
|
|
5
5
|
*
|
|
6
6
|
* NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
|
|
7
7
|
* If you want to contribute or request a new feature, please create an issue or pull request on https://github.com/hostinger/api
|
|
@@ -7209,6 +7209,93 @@ export interface HostingV1FilesUploadUrlResource {
|
|
|
7209
7209
|
*/
|
|
7210
7210
|
'rest_auth_key': string;
|
|
7211
7211
|
}
|
|
7212
|
+
/**
|
|
7213
|
+
* Every field is null when the website has no Git auto-deployment configured.
|
|
7214
|
+
* @export
|
|
7215
|
+
* @interface HostingV1GitGitAutoDeploymentSettingsResource
|
|
7216
|
+
*/
|
|
7217
|
+
export interface HostingV1GitGitAutoDeploymentSettingsResource {
|
|
7218
|
+
/**
|
|
7219
|
+
* Git installation the repository is accessed through
|
|
7220
|
+
* @type {string}
|
|
7221
|
+
* @memberof HostingV1GitGitAutoDeploymentSettingsResource
|
|
7222
|
+
*/
|
|
7223
|
+
'installation_uuid': string | null;
|
|
7224
|
+
/**
|
|
7225
|
+
* Whether pushes to the branch deploy automatically
|
|
7226
|
+
* @type {boolean}
|
|
7227
|
+
* @memberof HostingV1GitGitAutoDeploymentSettingsResource
|
|
7228
|
+
*/
|
|
7229
|
+
'is_enabled': boolean | null;
|
|
7230
|
+
/**
|
|
7231
|
+
* Repository owner login
|
|
7232
|
+
* @type {string}
|
|
7233
|
+
* @memberof HostingV1GitGitAutoDeploymentSettingsResource
|
|
7234
|
+
*/
|
|
7235
|
+
'owner': string | null;
|
|
7236
|
+
/**
|
|
7237
|
+
* Repository name
|
|
7238
|
+
* @type {string}
|
|
7239
|
+
* @memberof HostingV1GitGitAutoDeploymentSettingsResource
|
|
7240
|
+
*/
|
|
7241
|
+
'repository': string | null;
|
|
7242
|
+
/**
|
|
7243
|
+
* Branch that is deployed
|
|
7244
|
+
* @type {string}
|
|
7245
|
+
* @memberof HostingV1GitGitAutoDeploymentSettingsResource
|
|
7246
|
+
*/
|
|
7247
|
+
'branch': string | null;
|
|
7248
|
+
/**
|
|
7249
|
+
* Subdirectory under the website document root the repository deploys into. Empty means the document root.
|
|
7250
|
+
* @type {string}
|
|
7251
|
+
* @memberof HostingV1GitGitAutoDeploymentSettingsResource
|
|
7252
|
+
*/
|
|
7253
|
+
'directory': string | null;
|
|
7254
|
+
}
|
|
7255
|
+
/**
|
|
7256
|
+
*
|
|
7257
|
+
* @export
|
|
7258
|
+
* @interface HostingV1GitGitCommitAuthorResource
|
|
7259
|
+
*/
|
|
7260
|
+
export interface HostingV1GitGitCommitAuthorResource {
|
|
7261
|
+
/**
|
|
7262
|
+
* Author name as recorded in the commit
|
|
7263
|
+
* @type {string}
|
|
7264
|
+
* @memberof HostingV1GitGitCommitAuthorResource
|
|
7265
|
+
*/
|
|
7266
|
+
'name': string;
|
|
7267
|
+
/**
|
|
7268
|
+
* Avatar URL of the author on the Git provider
|
|
7269
|
+
* @type {string}
|
|
7270
|
+
* @memberof HostingV1GitGitCommitAuthorResource
|
|
7271
|
+
*/
|
|
7272
|
+
'avatar_url': string | null;
|
|
7273
|
+
}
|
|
7274
|
+
/**
|
|
7275
|
+
*
|
|
7276
|
+
* @export
|
|
7277
|
+
* @interface HostingV1GitGitCommitResource
|
|
7278
|
+
*/
|
|
7279
|
+
export interface HostingV1GitGitCommitResource {
|
|
7280
|
+
/**
|
|
7281
|
+
* Full commit SHA
|
|
7282
|
+
* @type {string}
|
|
7283
|
+
* @memberof HostingV1GitGitCommitResource
|
|
7284
|
+
*/
|
|
7285
|
+
'hash': string;
|
|
7286
|
+
/**
|
|
7287
|
+
* Commit message
|
|
7288
|
+
* @type {string}
|
|
7289
|
+
* @memberof HostingV1GitGitCommitResource
|
|
7290
|
+
*/
|
|
7291
|
+
'message': string;
|
|
7292
|
+
/**
|
|
7293
|
+
*
|
|
7294
|
+
* @type {HostingV1GitGitCommitAuthorResource}
|
|
7295
|
+
* @memberof HostingV1GitGitCommitResource
|
|
7296
|
+
*/
|
|
7297
|
+
'author': HostingV1GitGitCommitAuthorResource;
|
|
7298
|
+
}
|
|
7212
7299
|
/**
|
|
7213
7300
|
*
|
|
7214
7301
|
* @export
|
|
@@ -7342,6 +7429,49 @@ export interface HostingV1GitGitRepositoryResource {
|
|
|
7342
7429
|
*/
|
|
7343
7430
|
'default_branch': string;
|
|
7344
7431
|
}
|
|
7432
|
+
/**
|
|
7433
|
+
*
|
|
7434
|
+
* @export
|
|
7435
|
+
* @interface HostingV1GitUpdateGitAutoDeploymentSettingsRequest
|
|
7436
|
+
*/
|
|
7437
|
+
export interface HostingV1GitUpdateGitAutoDeploymentSettingsRequest {
|
|
7438
|
+
/**
|
|
7439
|
+
* Active Git installation from `List Git installations`
|
|
7440
|
+
* @type {string}
|
|
7441
|
+
* @memberof HostingV1GitUpdateGitAutoDeploymentSettingsRequest
|
|
7442
|
+
*/
|
|
7443
|
+
'installation_uuid': string;
|
|
7444
|
+
/**
|
|
7445
|
+
* Repository owner login, as returned by `List Git installation repositories`. GitLab group paths use slashes.
|
|
7446
|
+
* @type {string}
|
|
7447
|
+
* @memberof HostingV1GitUpdateGitAutoDeploymentSettingsRequest
|
|
7448
|
+
*/
|
|
7449
|
+
'owner': string;
|
|
7450
|
+
/**
|
|
7451
|
+
* Repository name without the .git suffix
|
|
7452
|
+
* @type {string}
|
|
7453
|
+
* @memberof HostingV1GitUpdateGitAutoDeploymentSettingsRequest
|
|
7454
|
+
*/
|
|
7455
|
+
'repository': string;
|
|
7456
|
+
/**
|
|
7457
|
+
* Branch to deploy
|
|
7458
|
+
* @type {string}
|
|
7459
|
+
* @memberof HostingV1GitUpdateGitAutoDeploymentSettingsRequest
|
|
7460
|
+
*/
|
|
7461
|
+
'branch': string;
|
|
7462
|
+
/**
|
|
7463
|
+
* Subdirectory under the website document root to deploy into. Empty, null or omitted means the document root.
|
|
7464
|
+
* @type {string}
|
|
7465
|
+
* @memberof HostingV1GitUpdateGitAutoDeploymentSettingsRequest
|
|
7466
|
+
*/
|
|
7467
|
+
'directory': string | null;
|
|
7468
|
+
/**
|
|
7469
|
+
* Whether pushes to the branch deploy automatically
|
|
7470
|
+
* @type {boolean}
|
|
7471
|
+
* @memberof HostingV1GitUpdateGitAutoDeploymentSettingsRequest
|
|
7472
|
+
*/
|
|
7473
|
+
'is_enabled': boolean;
|
|
7474
|
+
}
|
|
7345
7475
|
/**
|
|
7346
7476
|
*
|
|
7347
7477
|
* @export
|
|
@@ -7471,6 +7601,7 @@ export declare const HostingV1NodeJsBuildOptionsResourcePackageManagerEnum: {
|
|
|
7471
7601
|
export type HostingV1NodeJsBuildOptionsResourcePackageManagerEnum = typeof HostingV1NodeJsBuildOptionsResourcePackageManagerEnum[keyof typeof HostingV1NodeJsBuildOptionsResourcePackageManagerEnum];
|
|
7472
7602
|
export declare const HostingV1NodeJsBuildOptionsResourceSourceTypeEnum: {
|
|
7473
7603
|
readonly Archive: "archive";
|
|
7604
|
+
readonly Git: "git";
|
|
7474
7605
|
};
|
|
7475
7606
|
export type HostingV1NodeJsBuildOptionsResourceSourceTypeEnum = typeof HostingV1NodeJsBuildOptionsResourceSourceTypeEnum[keyof typeof HostingV1NodeJsBuildOptionsResourceSourceTypeEnum];
|
|
7476
7607
|
/**
|
|
@@ -7855,7 +7986,7 @@ export interface HostingV1NodeJsSetBuildEnvVarsRequestEnvVarsInner {
|
|
|
7855
7986
|
'value': string;
|
|
7856
7987
|
}
|
|
7857
7988
|
/**
|
|
7858
|
-
*
|
|
7989
|
+
* Which keys carry values depends on the parent source_type; the others are null.
|
|
7859
7990
|
* @export
|
|
7860
7991
|
* @interface HostingV1NodeJsSourceOptionsResource
|
|
7861
7992
|
*/
|
|
@@ -7866,6 +7997,36 @@ export interface HostingV1NodeJsSourceOptionsResource {
|
|
|
7866
7997
|
* @memberof HostingV1NodeJsSourceOptionsResource
|
|
7867
7998
|
*/
|
|
7868
7999
|
'archive_path': string | null;
|
|
8000
|
+
/**
|
|
8001
|
+
* Repository owner login (present if source_type is \"git\")
|
|
8002
|
+
* @type {string}
|
|
8003
|
+
* @memberof HostingV1NodeJsSourceOptionsResource
|
|
8004
|
+
*/
|
|
8005
|
+
'owner': string | null;
|
|
8006
|
+
/**
|
|
8007
|
+
* Repository name without the .git suffix (present if source_type is \"git\")
|
|
8008
|
+
* @type {string}
|
|
8009
|
+
* @memberof HostingV1NodeJsSourceOptionsResource
|
|
8010
|
+
*/
|
|
8011
|
+
'repository': string | null;
|
|
8012
|
+
/**
|
|
8013
|
+
* Branch that was built (present if source_type is \"git\")
|
|
8014
|
+
* @type {string}
|
|
8015
|
+
* @memberof HostingV1NodeJsSourceOptionsResource
|
|
8016
|
+
*/
|
|
8017
|
+
'branch': string | null;
|
|
8018
|
+
/**
|
|
8019
|
+
* Git installation used to access the repository (present if source_type is \"git\")
|
|
8020
|
+
* @type {string}
|
|
8021
|
+
* @memberof HostingV1NodeJsSourceOptionsResource
|
|
8022
|
+
*/
|
|
8023
|
+
'installation_uuid': string | null;
|
|
8024
|
+
/**
|
|
8025
|
+
*
|
|
8026
|
+
* @type {HostingV1GitGitCommitResource}
|
|
8027
|
+
* @memberof HostingV1NodeJsSourceOptionsResource
|
|
8028
|
+
*/
|
|
8029
|
+
'commit': HostingV1GitGitCommitResource | null;
|
|
7869
8030
|
}
|
|
7870
8031
|
/**
|
|
7871
8032
|
*
|
|
@@ -7916,7 +8077,7 @@ export interface HostingV1NodeJsStartBuildRequest {
|
|
|
7916
8077
|
*/
|
|
7917
8078
|
'package_manager': HostingV1NodeJsStartBuildRequestPackageManagerEnum | null;
|
|
7918
8079
|
/**
|
|
7919
|
-
*
|
|
8080
|
+
* Where the files come from: `archive` (an uploaded archive on the website) or `git` (a branch of a repository reachable through a Git installation).
|
|
7920
8081
|
* @type {string}
|
|
7921
8082
|
* @memberof HostingV1NodeJsStartBuildRequest
|
|
7922
8083
|
*/
|
|
@@ -7965,10 +8126,11 @@ export declare const HostingV1NodeJsStartBuildRequestPackageManagerEnum: {
|
|
|
7965
8126
|
export type HostingV1NodeJsStartBuildRequestPackageManagerEnum = typeof HostingV1NodeJsStartBuildRequestPackageManagerEnum[keyof typeof HostingV1NodeJsStartBuildRequestPackageManagerEnum];
|
|
7966
8127
|
export declare const HostingV1NodeJsStartBuildRequestSourceTypeEnum: {
|
|
7967
8128
|
readonly Archive: "archive";
|
|
8129
|
+
readonly Git: "git";
|
|
7968
8130
|
};
|
|
7969
8131
|
export type HostingV1NodeJsStartBuildRequestSourceTypeEnum = typeof HostingV1NodeJsStartBuildRequestSourceTypeEnum[keyof typeof HostingV1NodeJsStartBuildRequestSourceTypeEnum];
|
|
7970
8132
|
/**
|
|
7971
|
-
* Source-specific options
|
|
8133
|
+
* Source-specific options. For `archive` send `archive_path`. For `git` send `owner`, `repository`, `branch` and `installation_uuid`, taken from `List Git installations` and `List Git installation repositories`.
|
|
7972
8134
|
* @export
|
|
7973
8135
|
* @interface HostingV1NodeJsStartBuildRequestSourceOptions
|
|
7974
8136
|
*/
|
|
@@ -7979,6 +8141,30 @@ export interface HostingV1NodeJsStartBuildRequestSourceOptions {
|
|
|
7979
8141
|
* @memberof HostingV1NodeJsStartBuildRequestSourceOptions
|
|
7980
8142
|
*/
|
|
7981
8143
|
'archive_path': string;
|
|
8144
|
+
/**
|
|
8145
|
+
* Repository owner login (required if source is \"git\"). GitLab group paths use slashes.
|
|
8146
|
+
* @type {string}
|
|
8147
|
+
* @memberof HostingV1NodeJsStartBuildRequestSourceOptions
|
|
8148
|
+
*/
|
|
8149
|
+
'owner': string;
|
|
8150
|
+
/**
|
|
8151
|
+
* Repository name without the .git suffix (required if source is \"git\")
|
|
8152
|
+
* @type {string}
|
|
8153
|
+
* @memberof HostingV1NodeJsStartBuildRequestSourceOptions
|
|
8154
|
+
*/
|
|
8155
|
+
'repository': string;
|
|
8156
|
+
/**
|
|
8157
|
+
* Branch to build (required if source is \"git\")
|
|
8158
|
+
* @type {string}
|
|
8159
|
+
* @memberof HostingV1NodeJsStartBuildRequestSourceOptions
|
|
8160
|
+
*/
|
|
8161
|
+
'branch': string;
|
|
8162
|
+
/**
|
|
8163
|
+
* Git installation used to access the repository (required if source is \"git\")
|
|
8164
|
+
* @type {string}
|
|
8165
|
+
* @memberof HostingV1NodeJsStartBuildRequestSourceOptions
|
|
8166
|
+
*/
|
|
8167
|
+
'installation_uuid': string;
|
|
7982
8168
|
}
|
|
7983
8169
|
/**
|
|
7984
8170
|
*
|
|
@@ -8525,6 +8711,79 @@ export interface HostingV1RedirectsRedirectResource {
|
|
|
8525
8711
|
*/
|
|
8526
8712
|
'to': string;
|
|
8527
8713
|
}
|
|
8714
|
+
/**
|
|
8715
|
+
*
|
|
8716
|
+
* @export
|
|
8717
|
+
* @interface HostingV1SslSslStatusResource
|
|
8718
|
+
*/
|
|
8719
|
+
export interface HostingV1SslSslStatusResource {
|
|
8720
|
+
/**
|
|
8721
|
+
* Current certificate status
|
|
8722
|
+
* @type {string}
|
|
8723
|
+
* @memberof HostingV1SslSslStatusResource
|
|
8724
|
+
*/
|
|
8725
|
+
'status': HostingV1SslSslStatusResourceStatusEnum;
|
|
8726
|
+
/**
|
|
8727
|
+
* Provider of the assigned certificate, or of the last recorded installation when none is assigned. `custom` means an uploaded certificate. Null when no certificate is assigned and no installation is recorded, which is also the case for free subdomains on the platform-managed certificate.
|
|
8728
|
+
* @type {string}
|
|
8729
|
+
* @memberof HostingV1SslSslStatusResource
|
|
8730
|
+
*/
|
|
8731
|
+
'provider': HostingV1SslSslStatusResourceProviderEnum | null;
|
|
8732
|
+
/**
|
|
8733
|
+
* Whether the certificate comes from a lifetime provider managed by the platform, not an uploaded one. Follows `provider`: it reflects the last recorded installation when no certificate is assigned, and is false when `provider` is null.
|
|
8734
|
+
* @type {boolean}
|
|
8735
|
+
* @memberof HostingV1SslSslStatusResource
|
|
8736
|
+
*/
|
|
8737
|
+
'is_lifetime': boolean;
|
|
8738
|
+
/**
|
|
8739
|
+
* Whether HTTP requests to the website are redirected to HTTPS
|
|
8740
|
+
* @type {boolean}
|
|
8741
|
+
* @memberof HostingV1SslSslStatusResource
|
|
8742
|
+
*/
|
|
8743
|
+
'is_https_redirect_enabled': boolean;
|
|
8744
|
+
/**
|
|
8745
|
+
* End of the assigned certificate validity period; null when no certificate details are available.
|
|
8746
|
+
* @type {string}
|
|
8747
|
+
* @memberof HostingV1SslSslStatusResource
|
|
8748
|
+
*/
|
|
8749
|
+
'expires_at': string | null;
|
|
8750
|
+
/**
|
|
8751
|
+
* Last installation error, when it is one of the known displayable messages
|
|
8752
|
+
* @type {string}
|
|
8753
|
+
* @memberof HostingV1SslSslStatusResource
|
|
8754
|
+
*/
|
|
8755
|
+
'last_error': string | null;
|
|
8756
|
+
}
|
|
8757
|
+
export declare const HostingV1SslSslStatusResourceStatusEnum: {
|
|
8758
|
+
readonly NotInstalled: "not_installed";
|
|
8759
|
+
readonly Installing: "installing";
|
|
8760
|
+
readonly WaitingForRetry: "waiting_for_retry";
|
|
8761
|
+
readonly Active: "active";
|
|
8762
|
+
readonly Expired: "expired";
|
|
8763
|
+
readonly Failed: "failed";
|
|
8764
|
+
};
|
|
8765
|
+
export type HostingV1SslSslStatusResourceStatusEnum = typeof HostingV1SslSslStatusResourceStatusEnum[keyof typeof HostingV1SslSslStatusResourceStatusEnum];
|
|
8766
|
+
export declare const HostingV1SslSslStatusResourceProviderEnum: {
|
|
8767
|
+
readonly Custom: "custom";
|
|
8768
|
+
readonly Letsencrypt: "letsencrypt";
|
|
8769
|
+
readonly Zerossl: "zerossl";
|
|
8770
|
+
readonly Googlessl: "googlessl";
|
|
8771
|
+
readonly Hssl: "hssl";
|
|
8772
|
+
};
|
|
8773
|
+
export type HostingV1SslSslStatusResourceProviderEnum = typeof HostingV1SslSslStatusResourceProviderEnum[keyof typeof HostingV1SslSslStatusResourceProviderEnum];
|
|
8774
|
+
/**
|
|
8775
|
+
*
|
|
8776
|
+
* @export
|
|
8777
|
+
* @interface HostingV1SslToggleHttpsRedirectRequest
|
|
8778
|
+
*/
|
|
8779
|
+
export interface HostingV1SslToggleHttpsRedirectRequest {
|
|
8780
|
+
/**
|
|
8781
|
+
* Turn the HTTP to HTTPS redirect on (true) or off (false) for the website.
|
|
8782
|
+
* @type {boolean}
|
|
8783
|
+
* @memberof HostingV1SslToggleHttpsRedirectRequest
|
|
8784
|
+
*/
|
|
8785
|
+
'is_enabled': boolean;
|
|
8786
|
+
}
|
|
8528
8787
|
/**
|
|
8529
8788
|
*
|
|
8530
8789
|
* @export
|
|
@@ -23204,7 +23463,25 @@ export type ListWebsiteFilesAndDirectoriesV1FileTypesEnum = typeof ListWebsiteFi
|
|
|
23204
23463
|
*/
|
|
23205
23464
|
export declare const HostingGitApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
23206
23465
|
/**
|
|
23207
|
-
*
|
|
23466
|
+
* Removes the Git auto-deployment settings of the website. Files already deployed stay on the website; pushes stop deploying until settings are saved again. Succeeds also when nothing is configured.
|
|
23467
|
+
* @summary Delete Git auto-deployment settings
|
|
23468
|
+
* @param {string} username
|
|
23469
|
+
* @param {string} domain Domain name
|
|
23470
|
+
* @param {*} [options] Override http request option.
|
|
23471
|
+
* @throws {RequiredError}
|
|
23472
|
+
*/
|
|
23473
|
+
deleteGitAutoDeploymentSettingsV1: (username: string, domain: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
23474
|
+
/**
|
|
23475
|
+
* Returns the Git auto-deployment settings of the website: which repository and branch deploy into which directory, and whether pushes trigger a deployment. `is_enabled` false keeps the repository link but ignores pushes. When the website has no auto-deployment configured every field is null. Save settings with `Update Git auto-deployment settings`.
|
|
23476
|
+
* @summary Get Git auto-deployment settings
|
|
23477
|
+
* @param {string} username
|
|
23478
|
+
* @param {string} domain Domain name
|
|
23479
|
+
* @param {*} [options] Override http request option.
|
|
23480
|
+
* @throws {RequiredError}
|
|
23481
|
+
*/
|
|
23482
|
+
getGitAutoDeploymentSettingsV1: (username: string, domain: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
23483
|
+
/**
|
|
23484
|
+
* Lists the repositories the Git installation can access, read live from the provider. Works for github and gitlab installations. Use an active installation: a suspended or pending one is still queried and the call fails with whatever the provider answers. The list is cut at the first 500 repositories in the order the provider returns them; when the account has more, name the repository directly instead of searching this list. `owner`, `name` and a branch (`default_branch` or another one) go into `source_options` of `Start Node.js build` or into `Update Git auto-deployment settings`. Returns 404 when the installation does not belong to the customer. Limited to 10 calls per minute per API client (429 above that).
|
|
23208
23485
|
* @summary List Git installation repositories
|
|
23209
23486
|
* @param {string} uuid Git installation UUID from the List Git installations endpoint
|
|
23210
23487
|
* @param {*} [options] Override http request option.
|
|
@@ -23212,7 +23489,7 @@ export declare const HostingGitApiAxiosParamCreator: (configuration?: Configurat
|
|
|
23212
23489
|
*/
|
|
23213
23490
|
listGitInstallationRepositoriesV1: (uuid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
23214
23491
|
/**
|
|
23215
|
-
* Lists the Git provider accounts the customer has connected. Only installations with status `active` are returned unless the `status` filter says otherwise. An empty list means the customer has no active installation. Check `status=suspended` and `status=pending` as well. If there is none at all, GitHub has to be connected once in hPanel (Websites, Manage, Advanced, Git
|
|
23492
|
+
* Lists the Git provider accounts the customer has connected. Only installations with status `active` are returned unless the `status` filter says otherwise. An empty list means the customer has no active installation. Check `status=suspended` and `status=pending` as well. If there is none at all, a Git provider (GitHub or GitLab) has to be connected once in hPanel (Websites, Manage, Advanced, Git; or Add Website, Node.js Web App, Import Git Repository); this endpoint then lists the new installation. Use `uuid` as the path parameter of `List Git installation repositories`, and as `installation_uuid` in `Start Node.js build` with `source_type` `git` and in `Update Git auto-deployment settings`.
|
|
23216
23493
|
* @summary List Git installations
|
|
23217
23494
|
* @param {ListGitInstallationsV1ProviderEnum} [provider] Filter by Git provider
|
|
23218
23495
|
* @param {ListGitInstallationsV1StatusEnum} [status] Filter by installation status
|
|
@@ -23220,6 +23497,16 @@ export declare const HostingGitApiAxiosParamCreator: (configuration?: Configurat
|
|
|
23220
23497
|
* @throws {RequiredError}
|
|
23221
23498
|
*/
|
|
23222
23499
|
listGitInstallationsV1: (provider?: ListGitInstallationsV1ProviderEnum, status?: ListGitInstallationsV1StatusEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
23500
|
+
/**
|
|
23501
|
+
* Creates or replaces the Git auto-deployment settings of the website: repository, branch, the directory under the document root to deploy into, and `is_enabled`. Send the full set; `is_enabled` defaults to true and `directory` to the document root. `installation_uuid` must be an installation from `List Git installations` that belongs to the same customer as the website. For PHP and static websites, saving with `is_enabled` true deploys the branch right away and every later push to that branch deploys again. For Node.js and Website Builder websites saving does not clone anything. On a Node.js website start the first deploy with `Start Node.js build` using `source_type` `git`; pushes then trigger new builds with the build settings stored for the website.
|
|
23502
|
+
* @summary Update Git auto-deployment settings
|
|
23503
|
+
* @param {string} username
|
|
23504
|
+
* @param {string} domain Domain name
|
|
23505
|
+
* @param {HostingV1GitUpdateGitAutoDeploymentSettingsRequest} hostingV1GitUpdateGitAutoDeploymentSettingsRequest
|
|
23506
|
+
* @param {*} [options] Override http request option.
|
|
23507
|
+
* @throws {RequiredError}
|
|
23508
|
+
*/
|
|
23509
|
+
updateGitAutoDeploymentSettingsV1: (username: string, domain: string, hostingV1GitUpdateGitAutoDeploymentSettingsRequest: HostingV1GitUpdateGitAutoDeploymentSettingsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
23223
23510
|
};
|
|
23224
23511
|
/**
|
|
23225
23512
|
* HostingGitApi - functional programming interface
|
|
@@ -23227,7 +23514,25 @@ export declare const HostingGitApiAxiosParamCreator: (configuration?: Configurat
|
|
|
23227
23514
|
*/
|
|
23228
23515
|
export declare const HostingGitApiFp: (configuration?: Configuration) => {
|
|
23229
23516
|
/**
|
|
23230
|
-
*
|
|
23517
|
+
* Removes the Git auto-deployment settings of the website. Files already deployed stay on the website; pushes stop deploying until settings are saved again. Succeeds also when nothing is configured.
|
|
23518
|
+
* @summary Delete Git auto-deployment settings
|
|
23519
|
+
* @param {string} username
|
|
23520
|
+
* @param {string} domain Domain name
|
|
23521
|
+
* @param {*} [options] Override http request option.
|
|
23522
|
+
* @throws {RequiredError}
|
|
23523
|
+
*/
|
|
23524
|
+
deleteGitAutoDeploymentSettingsV1(username: string, domain: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommonSuccessEmptyResource>>;
|
|
23525
|
+
/**
|
|
23526
|
+
* Returns the Git auto-deployment settings of the website: which repository and branch deploy into which directory, and whether pushes trigger a deployment. `is_enabled` false keeps the repository link but ignores pushes. When the website has no auto-deployment configured every field is null. Save settings with `Update Git auto-deployment settings`.
|
|
23527
|
+
* @summary Get Git auto-deployment settings
|
|
23528
|
+
* @param {string} username
|
|
23529
|
+
* @param {string} domain Domain name
|
|
23530
|
+
* @param {*} [options] Override http request option.
|
|
23531
|
+
* @throws {RequiredError}
|
|
23532
|
+
*/
|
|
23533
|
+
getGitAutoDeploymentSettingsV1(username: string, domain: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<HostingV1GitGitAutoDeploymentSettingsResource>>;
|
|
23534
|
+
/**
|
|
23535
|
+
* Lists the repositories the Git installation can access, read live from the provider. Works for github and gitlab installations. Use an active installation: a suspended or pending one is still queried and the call fails with whatever the provider answers. The list is cut at the first 500 repositories in the order the provider returns them; when the account has more, name the repository directly instead of searching this list. `owner`, `name` and a branch (`default_branch` or another one) go into `source_options` of `Start Node.js build` or into `Update Git auto-deployment settings`. Returns 404 when the installation does not belong to the customer. Limited to 10 calls per minute per API client (429 above that).
|
|
23231
23536
|
* @summary List Git installation repositories
|
|
23232
23537
|
* @param {string} uuid Git installation UUID from the List Git installations endpoint
|
|
23233
23538
|
* @param {*} [options] Override http request option.
|
|
@@ -23235,7 +23540,7 @@ export declare const HostingGitApiFp: (configuration?: Configuration) => {
|
|
|
23235
23540
|
*/
|
|
23236
23541
|
listGitInstallationRepositoriesV1(uuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<HostingV1GitGitRepositoryResource>>>;
|
|
23237
23542
|
/**
|
|
23238
|
-
* Lists the Git provider accounts the customer has connected. Only installations with status `active` are returned unless the `status` filter says otherwise. An empty list means the customer has no active installation. Check `status=suspended` and `status=pending` as well. If there is none at all, GitHub has to be connected once in hPanel (Websites, Manage, Advanced, Git
|
|
23543
|
+
* Lists the Git provider accounts the customer has connected. Only installations with status `active` are returned unless the `status` filter says otherwise. An empty list means the customer has no active installation. Check `status=suspended` and `status=pending` as well. If there is none at all, a Git provider (GitHub or GitLab) has to be connected once in hPanel (Websites, Manage, Advanced, Git; or Add Website, Node.js Web App, Import Git Repository); this endpoint then lists the new installation. Use `uuid` as the path parameter of `List Git installation repositories`, and as `installation_uuid` in `Start Node.js build` with `source_type` `git` and in `Update Git auto-deployment settings`.
|
|
23239
23544
|
* @summary List Git installations
|
|
23240
23545
|
* @param {ListGitInstallationsV1ProviderEnum} [provider] Filter by Git provider
|
|
23241
23546
|
* @param {ListGitInstallationsV1StatusEnum} [status] Filter by installation status
|
|
@@ -23243,6 +23548,16 @@ export declare const HostingGitApiFp: (configuration?: Configuration) => {
|
|
|
23243
23548
|
* @throws {RequiredError}
|
|
23244
23549
|
*/
|
|
23245
23550
|
listGitInstallationsV1(provider?: ListGitInstallationsV1ProviderEnum, status?: ListGitInstallationsV1StatusEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<HostingV1GitGitInstallationResource>>>;
|
|
23551
|
+
/**
|
|
23552
|
+
* Creates or replaces the Git auto-deployment settings of the website: repository, branch, the directory under the document root to deploy into, and `is_enabled`. Send the full set; `is_enabled` defaults to true and `directory` to the document root. `installation_uuid` must be an installation from `List Git installations` that belongs to the same customer as the website. For PHP and static websites, saving with `is_enabled` true deploys the branch right away and every later push to that branch deploys again. For Node.js and Website Builder websites saving does not clone anything. On a Node.js website start the first deploy with `Start Node.js build` using `source_type` `git`; pushes then trigger new builds with the build settings stored for the website.
|
|
23553
|
+
* @summary Update Git auto-deployment settings
|
|
23554
|
+
* @param {string} username
|
|
23555
|
+
* @param {string} domain Domain name
|
|
23556
|
+
* @param {HostingV1GitUpdateGitAutoDeploymentSettingsRequest} hostingV1GitUpdateGitAutoDeploymentSettingsRequest
|
|
23557
|
+
* @param {*} [options] Override http request option.
|
|
23558
|
+
* @throws {RequiredError}
|
|
23559
|
+
*/
|
|
23560
|
+
updateGitAutoDeploymentSettingsV1(username: string, domain: string, hostingV1GitUpdateGitAutoDeploymentSettingsRequest: HostingV1GitUpdateGitAutoDeploymentSettingsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommonSuccessEmptyResource>>;
|
|
23246
23561
|
};
|
|
23247
23562
|
/**
|
|
23248
23563
|
* HostingGitApi - factory interface
|
|
@@ -23250,7 +23565,25 @@ export declare const HostingGitApiFp: (configuration?: Configuration) => {
|
|
|
23250
23565
|
*/
|
|
23251
23566
|
export declare const HostingGitApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
23252
23567
|
/**
|
|
23253
|
-
*
|
|
23568
|
+
* Removes the Git auto-deployment settings of the website. Files already deployed stay on the website; pushes stop deploying until settings are saved again. Succeeds also when nothing is configured.
|
|
23569
|
+
* @summary Delete Git auto-deployment settings
|
|
23570
|
+
* @param {string} username
|
|
23571
|
+
* @param {string} domain Domain name
|
|
23572
|
+
* @param {*} [options] Override http request option.
|
|
23573
|
+
* @throws {RequiredError}
|
|
23574
|
+
*/
|
|
23575
|
+
deleteGitAutoDeploymentSettingsV1(username: string, domain: string, options?: RawAxiosRequestConfig): AxiosPromise<CommonSuccessEmptyResource>;
|
|
23576
|
+
/**
|
|
23577
|
+
* Returns the Git auto-deployment settings of the website: which repository and branch deploy into which directory, and whether pushes trigger a deployment. `is_enabled` false keeps the repository link but ignores pushes. When the website has no auto-deployment configured every field is null. Save settings with `Update Git auto-deployment settings`.
|
|
23578
|
+
* @summary Get Git auto-deployment settings
|
|
23579
|
+
* @param {string} username
|
|
23580
|
+
* @param {string} domain Domain name
|
|
23581
|
+
* @param {*} [options] Override http request option.
|
|
23582
|
+
* @throws {RequiredError}
|
|
23583
|
+
*/
|
|
23584
|
+
getGitAutoDeploymentSettingsV1(username: string, domain: string, options?: RawAxiosRequestConfig): AxiosPromise<HostingV1GitGitAutoDeploymentSettingsResource>;
|
|
23585
|
+
/**
|
|
23586
|
+
* Lists the repositories the Git installation can access, read live from the provider. Works for github and gitlab installations. Use an active installation: a suspended or pending one is still queried and the call fails with whatever the provider answers. The list is cut at the first 500 repositories in the order the provider returns them; when the account has more, name the repository directly instead of searching this list. `owner`, `name` and a branch (`default_branch` or another one) go into `source_options` of `Start Node.js build` or into `Update Git auto-deployment settings`. Returns 404 when the installation does not belong to the customer. Limited to 10 calls per minute per API client (429 above that).
|
|
23254
23587
|
* @summary List Git installation repositories
|
|
23255
23588
|
* @param {string} uuid Git installation UUID from the List Git installations endpoint
|
|
23256
23589
|
* @param {*} [options] Override http request option.
|
|
@@ -23258,7 +23591,7 @@ export declare const HostingGitApiFactory: (configuration?: Configuration, baseP
|
|
|
23258
23591
|
*/
|
|
23259
23592
|
listGitInstallationRepositoriesV1(uuid: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<HostingV1GitGitRepositoryResource>>;
|
|
23260
23593
|
/**
|
|
23261
|
-
* Lists the Git provider accounts the customer has connected. Only installations with status `active` are returned unless the `status` filter says otherwise. An empty list means the customer has no active installation. Check `status=suspended` and `status=pending` as well. If there is none at all, GitHub has to be connected once in hPanel (Websites, Manage, Advanced, Git
|
|
23594
|
+
* Lists the Git provider accounts the customer has connected. Only installations with status `active` are returned unless the `status` filter says otherwise. An empty list means the customer has no active installation. Check `status=suspended` and `status=pending` as well. If there is none at all, a Git provider (GitHub or GitLab) has to be connected once in hPanel (Websites, Manage, Advanced, Git; or Add Website, Node.js Web App, Import Git Repository); this endpoint then lists the new installation. Use `uuid` as the path parameter of `List Git installation repositories`, and as `installation_uuid` in `Start Node.js build` with `source_type` `git` and in `Update Git auto-deployment settings`.
|
|
23262
23595
|
* @summary List Git installations
|
|
23263
23596
|
* @param {ListGitInstallationsV1ProviderEnum} [provider] Filter by Git provider
|
|
23264
23597
|
* @param {ListGitInstallationsV1StatusEnum} [status] Filter by installation status
|
|
@@ -23266,6 +23599,16 @@ export declare const HostingGitApiFactory: (configuration?: Configuration, baseP
|
|
|
23266
23599
|
* @throws {RequiredError}
|
|
23267
23600
|
*/
|
|
23268
23601
|
listGitInstallationsV1(provider?: ListGitInstallationsV1ProviderEnum, status?: ListGitInstallationsV1StatusEnum, options?: RawAxiosRequestConfig): AxiosPromise<Array<HostingV1GitGitInstallationResource>>;
|
|
23602
|
+
/**
|
|
23603
|
+
* Creates or replaces the Git auto-deployment settings of the website: repository, branch, the directory under the document root to deploy into, and `is_enabled`. Send the full set; `is_enabled` defaults to true and `directory` to the document root. `installation_uuid` must be an installation from `List Git installations` that belongs to the same customer as the website. For PHP and static websites, saving with `is_enabled` true deploys the branch right away and every later push to that branch deploys again. For Node.js and Website Builder websites saving does not clone anything. On a Node.js website start the first deploy with `Start Node.js build` using `source_type` `git`; pushes then trigger new builds with the build settings stored for the website.
|
|
23604
|
+
* @summary Update Git auto-deployment settings
|
|
23605
|
+
* @param {string} username
|
|
23606
|
+
* @param {string} domain Domain name
|
|
23607
|
+
* @param {HostingV1GitUpdateGitAutoDeploymentSettingsRequest} hostingV1GitUpdateGitAutoDeploymentSettingsRequest
|
|
23608
|
+
* @param {*} [options] Override http request option.
|
|
23609
|
+
* @throws {RequiredError}
|
|
23610
|
+
*/
|
|
23611
|
+
updateGitAutoDeploymentSettingsV1(username: string, domain: string, hostingV1GitUpdateGitAutoDeploymentSettingsRequest: HostingV1GitUpdateGitAutoDeploymentSettingsRequest, options?: RawAxiosRequestConfig): AxiosPromise<CommonSuccessEmptyResource>;
|
|
23269
23612
|
};
|
|
23270
23613
|
/**
|
|
23271
23614
|
* HostingGitApi - object-oriented interface
|
|
@@ -23275,7 +23618,27 @@ export declare const HostingGitApiFactory: (configuration?: Configuration, baseP
|
|
|
23275
23618
|
*/
|
|
23276
23619
|
export declare class HostingGitApi extends BaseAPI {
|
|
23277
23620
|
/**
|
|
23278
|
-
*
|
|
23621
|
+
* Removes the Git auto-deployment settings of the website. Files already deployed stay on the website; pushes stop deploying until settings are saved again. Succeeds also when nothing is configured.
|
|
23622
|
+
* @summary Delete Git auto-deployment settings
|
|
23623
|
+
* @param {string} username
|
|
23624
|
+
* @param {string} domain Domain name
|
|
23625
|
+
* @param {*} [options] Override http request option.
|
|
23626
|
+
* @throws {RequiredError}
|
|
23627
|
+
* @memberof HostingGitApi
|
|
23628
|
+
*/
|
|
23629
|
+
deleteGitAutoDeploymentSettingsV1(username: string, domain: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CommonSuccessEmptyResource, any, {}, any>>;
|
|
23630
|
+
/**
|
|
23631
|
+
* Returns the Git auto-deployment settings of the website: which repository and branch deploy into which directory, and whether pushes trigger a deployment. `is_enabled` false keeps the repository link but ignores pushes. When the website has no auto-deployment configured every field is null. Save settings with `Update Git auto-deployment settings`.
|
|
23632
|
+
* @summary Get Git auto-deployment settings
|
|
23633
|
+
* @param {string} username
|
|
23634
|
+
* @param {string} domain Domain name
|
|
23635
|
+
* @param {*} [options] Override http request option.
|
|
23636
|
+
* @throws {RequiredError}
|
|
23637
|
+
* @memberof HostingGitApi
|
|
23638
|
+
*/
|
|
23639
|
+
getGitAutoDeploymentSettingsV1(username: string, domain: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<HostingV1GitGitAutoDeploymentSettingsResource, any, {}, any>>;
|
|
23640
|
+
/**
|
|
23641
|
+
* Lists the repositories the Git installation can access, read live from the provider. Works for github and gitlab installations. Use an active installation: a suspended or pending one is still queried and the call fails with whatever the provider answers. The list is cut at the first 500 repositories in the order the provider returns them; when the account has more, name the repository directly instead of searching this list. `owner`, `name` and a branch (`default_branch` or another one) go into `source_options` of `Start Node.js build` or into `Update Git auto-deployment settings`. Returns 404 when the installation does not belong to the customer. Limited to 10 calls per minute per API client (429 above that).
|
|
23279
23642
|
* @summary List Git installation repositories
|
|
23280
23643
|
* @param {string} uuid Git installation UUID from the List Git installations endpoint
|
|
23281
23644
|
* @param {*} [options] Override http request option.
|
|
@@ -23284,7 +23647,7 @@ export declare class HostingGitApi extends BaseAPI {
|
|
|
23284
23647
|
*/
|
|
23285
23648
|
listGitInstallationRepositoriesV1(uuid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<HostingV1GitGitRepositoryResource[], any, {}, any>>;
|
|
23286
23649
|
/**
|
|
23287
|
-
* Lists the Git provider accounts the customer has connected. Only installations with status `active` are returned unless the `status` filter says otherwise. An empty list means the customer has no active installation. Check `status=suspended` and `status=pending` as well. If there is none at all, GitHub has to be connected once in hPanel (Websites, Manage, Advanced, Git
|
|
23650
|
+
* Lists the Git provider accounts the customer has connected. Only installations with status `active` are returned unless the `status` filter says otherwise. An empty list means the customer has no active installation. Check `status=suspended` and `status=pending` as well. If there is none at all, a Git provider (GitHub or GitLab) has to be connected once in hPanel (Websites, Manage, Advanced, Git; or Add Website, Node.js Web App, Import Git Repository); this endpoint then lists the new installation. Use `uuid` as the path parameter of `List Git installation repositories`, and as `installation_uuid` in `Start Node.js build` with `source_type` `git` and in `Update Git auto-deployment settings`.
|
|
23288
23651
|
* @summary List Git installations
|
|
23289
23652
|
* @param {ListGitInstallationsV1ProviderEnum} [provider] Filter by Git provider
|
|
23290
23653
|
* @param {ListGitInstallationsV1StatusEnum} [status] Filter by installation status
|
|
@@ -23293,6 +23656,17 @@ export declare class HostingGitApi extends BaseAPI {
|
|
|
23293
23656
|
* @memberof HostingGitApi
|
|
23294
23657
|
*/
|
|
23295
23658
|
listGitInstallationsV1(provider?: ListGitInstallationsV1ProviderEnum, status?: ListGitInstallationsV1StatusEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<HostingV1GitGitInstallationResource[], any, {}, any>>;
|
|
23659
|
+
/**
|
|
23660
|
+
* Creates or replaces the Git auto-deployment settings of the website: repository, branch, the directory under the document root to deploy into, and `is_enabled`. Send the full set; `is_enabled` defaults to true and `directory` to the document root. `installation_uuid` must be an installation from `List Git installations` that belongs to the same customer as the website. For PHP and static websites, saving with `is_enabled` true deploys the branch right away and every later push to that branch deploys again. For Node.js and Website Builder websites saving does not clone anything. On a Node.js website start the first deploy with `Start Node.js build` using `source_type` `git`; pushes then trigger new builds with the build settings stored for the website.
|
|
23661
|
+
* @summary Update Git auto-deployment settings
|
|
23662
|
+
* @param {string} username
|
|
23663
|
+
* @param {string} domain Domain name
|
|
23664
|
+
* @param {HostingV1GitUpdateGitAutoDeploymentSettingsRequest} hostingV1GitUpdateGitAutoDeploymentSettingsRequest
|
|
23665
|
+
* @param {*} [options] Override http request option.
|
|
23666
|
+
* @throws {RequiredError}
|
|
23667
|
+
* @memberof HostingGitApi
|
|
23668
|
+
*/
|
|
23669
|
+
updateGitAutoDeploymentSettingsV1(username: string, domain: string, hostingV1GitUpdateGitAutoDeploymentSettingsRequest: HostingV1GitUpdateGitAutoDeploymentSettingsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CommonSuccessEmptyResource, any, {}, any>>;
|
|
23296
23670
|
}
|
|
23297
23671
|
/**
|
|
23298
23672
|
* @export
|
|
@@ -23450,7 +23824,7 @@ export declare const HostingNodeJSApiAxiosParamCreator: (configuration?: Configu
|
|
|
23450
23824
|
*/
|
|
23451
23825
|
restartNodeJsApplicationV1: (username: string, domain: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
23452
23826
|
/**
|
|
23453
|
-
* Start a Node.js build process using files already present on the website\'s file storage. WARNING: on success this overwrites the website\'s existing contents and cannot be undone — verify this is intended before calling this endpoint.
|
|
23827
|
+
* Start a Node.js build process using files already present on the website\'s file storage. WARNING: on success this overwrites the website\'s existing contents and cannot be undone — verify this is intended before calling this endpoint. With `source_type` `archive`, `source_options.archive_path` must point to an existing archive file on the server (relative to the website document root). Use the `Generate Upload URL` endpoint to obtain credentials and upload the archive first. To auto-detect build settings from an archive before starting, first call the `Get Node.js Build Settings from Archive` endpoint. With `source_type` `git`, `source_options` carries `owner`, `repository`, `branch` and `installation_uuid`. Take the installation from `List Git installations` and the owner and repository from `List Git installation repositories`; the branch is cloned at its current head. The installation must belong to the same customer as the website. The returned build `uuid` can be used to poll progress and retrieve logs via the `Get Node.js Build Logs` endpoint.
|
|
23454
23828
|
* @summary Start Node.js build
|
|
23455
23829
|
* @param {string} username
|
|
23456
23830
|
* @param {string} domain Domain name
|
|
@@ -23608,7 +23982,7 @@ export declare const HostingNodeJSApiFp: (configuration?: Configuration) => {
|
|
|
23608
23982
|
*/
|
|
23609
23983
|
restartNodeJsApplicationV1(username: string, domain: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommonSuccessEmptyResource>>;
|
|
23610
23984
|
/**
|
|
23611
|
-
* Start a Node.js build process using files already present on the website\'s file storage. WARNING: on success this overwrites the website\'s existing contents and cannot be undone — verify this is intended before calling this endpoint.
|
|
23985
|
+
* Start a Node.js build process using files already present on the website\'s file storage. WARNING: on success this overwrites the website\'s existing contents and cannot be undone — verify this is intended before calling this endpoint. With `source_type` `archive`, `source_options.archive_path` must point to an existing archive file on the server (relative to the website document root). Use the `Generate Upload URL` endpoint to obtain credentials and upload the archive first. To auto-detect build settings from an archive before starting, first call the `Get Node.js Build Settings from Archive` endpoint. With `source_type` `git`, `source_options` carries `owner`, `repository`, `branch` and `installation_uuid`. Take the installation from `List Git installations` and the owner and repository from `List Git installation repositories`; the branch is cloned at its current head. The installation must belong to the same customer as the website. The returned build `uuid` can be used to poll progress and retrieve logs via the `Get Node.js Build Logs` endpoint.
|
|
23612
23986
|
* @summary Start Node.js build
|
|
23613
23987
|
* @param {string} username
|
|
23614
23988
|
* @param {string} domain Domain name
|
|
@@ -23766,7 +24140,7 @@ export declare const HostingNodeJSApiFactory: (configuration?: Configuration, ba
|
|
|
23766
24140
|
*/
|
|
23767
24141
|
restartNodeJsApplicationV1(username: string, domain: string, options?: RawAxiosRequestConfig): AxiosPromise<CommonSuccessEmptyResource>;
|
|
23768
24142
|
/**
|
|
23769
|
-
* Start a Node.js build process using files already present on the website\'s file storage. WARNING: on success this overwrites the website\'s existing contents and cannot be undone — verify this is intended before calling this endpoint.
|
|
24143
|
+
* Start a Node.js build process using files already present on the website\'s file storage. WARNING: on success this overwrites the website\'s existing contents and cannot be undone — verify this is intended before calling this endpoint. With `source_type` `archive`, `source_options.archive_path` must point to an existing archive file on the server (relative to the website document root). Use the `Generate Upload URL` endpoint to obtain credentials and upload the archive first. To auto-detect build settings from an archive before starting, first call the `Get Node.js Build Settings from Archive` endpoint. With `source_type` `git`, `source_options` carries `owner`, `repository`, `branch` and `installation_uuid`. Take the installation from `List Git installations` and the owner and repository from `List Git installation repositories`; the branch is cloned at its current head. The installation must belong to the same customer as the website. The returned build `uuid` can be used to poll progress and retrieve logs via the `Get Node.js Build Logs` endpoint.
|
|
23770
24144
|
* @summary Start Node.js build
|
|
23771
24145
|
* @param {string} username
|
|
23772
24146
|
* @param {string} domain Domain name
|
|
@@ -23939,7 +24313,7 @@ export declare class HostingNodeJSApi extends BaseAPI {
|
|
|
23939
24313
|
*/
|
|
23940
24314
|
restartNodeJsApplicationV1(username: string, domain: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CommonSuccessEmptyResource, any, {}, any>>;
|
|
23941
24315
|
/**
|
|
23942
|
-
* Start a Node.js build process using files already present on the website\'s file storage. WARNING: on success this overwrites the website\'s existing contents and cannot be undone — verify this is intended before calling this endpoint.
|
|
24316
|
+
* Start a Node.js build process using files already present on the website\'s file storage. WARNING: on success this overwrites the website\'s existing contents and cannot be undone — verify this is intended before calling this endpoint. With `source_type` `archive`, `source_options.archive_path` must point to an existing archive file on the server (relative to the website document root). Use the `Generate Upload URL` endpoint to obtain credentials and upload the archive first. To auto-detect build settings from an archive before starting, first call the `Get Node.js Build Settings from Archive` endpoint. With `source_type` `git`, `source_options` carries `owner`, `repository`, `branch` and `installation_uuid`. Take the installation from `List Git installations` and the owner and repository from `List Git installation repositories`; the branch is cloned at its current head. The installation must belong to the same customer as the website. The returned build `uuid` can be used to poll progress and retrieve logs via the `Get Node.js Build Logs` endpoint.
|
|
23943
24317
|
* @summary Start Node.js build
|
|
23944
24318
|
* @param {string} username
|
|
23945
24319
|
* @param {string} domain Domain name
|
|
@@ -24498,6 +24872,184 @@ export declare class HostingRedirectsApi extends BaseAPI {
|
|
|
24498
24872
|
*/
|
|
24499
24873
|
listWebsiteRedirectsV1(username: string, domain: string, page?: number, perPage?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<HostingListWebsiteRedirectsV1200Response, any, {}, any>>;
|
|
24500
24874
|
}
|
|
24875
|
+
/**
|
|
24876
|
+
* HostingSSLApi - axios parameter creator
|
|
24877
|
+
* @export
|
|
24878
|
+
*/
|
|
24879
|
+
export declare const HostingSSLApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
24880
|
+
/**
|
|
24881
|
+
* Returns the SSL state of the website: the certificate `status` and `provider`, whether the certificate is a lifetime one managed by the platform, whether HTTP requests are redirected to HTTPS, when the certificate stops being valid and the last installation error. `installing` and `waiting_for_retry` mean an installation is in progress. `failed` means the last installation gave up, or the website was not updated for 60 minutes while `installing`; `last_error` holds the reason when it is a known message, otherwise it is null. `expired` means the assigned certificate\'s validity has ended. `not_installed` means no certificate is assigned. Free subdomains use a platform-managed certificate: with no installation recorded they report `active` with `provider` and `expires_at` null.
|
|
24882
|
+
* @summary Get SSL status
|
|
24883
|
+
* @param {string} username
|
|
24884
|
+
* @param {string} domain Domain name
|
|
24885
|
+
* @param {*} [options] Override http request option.
|
|
24886
|
+
* @throws {RequiredError}
|
|
24887
|
+
*/
|
|
24888
|
+
getSSLStatusV1: (username: string, domain: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
24889
|
+
/**
|
|
24890
|
+
* Requests a lifetime SSL certificate for the website. The installation runs in the background; `Get SSL status` reports `active` or `failed` when it ends. An `active` lifetime certificate does not block the request: a new installation is requested, which is how a certificate is reinstalled. Returns 422 for free subdomains (their certificate is managed by the platform), while an installation is `installing` or `waiting_for_retry`, when the website\'s certificate was revoked (it cannot be reissued), and when an uploaded custom certificate is installed; that one has to be uninstalled first.
|
|
24891
|
+
* @summary Install SSL
|
|
24892
|
+
* @param {string} username
|
|
24893
|
+
* @param {string} domain Domain name
|
|
24894
|
+
* @param {*} [options] Override http request option.
|
|
24895
|
+
* @throws {RequiredError}
|
|
24896
|
+
*/
|
|
24897
|
+
installSSLV1: (username: string, domain: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
24898
|
+
/**
|
|
24899
|
+
* Turns the HTTP to HTTPS redirect of the website on or off, based on `is_enabled`. Does nothing when the redirect is already in the requested state. Turning it on requires an installed certificate (`status` `active` or `expired` on `Get SSL status`) and returns 422 when there is none; turning it off is always accepted.
|
|
24900
|
+
* @summary Toggle HTTPS redirect
|
|
24901
|
+
* @param {string} username
|
|
24902
|
+
* @param {string} domain Domain name
|
|
24903
|
+
* @param {HostingV1SslToggleHttpsRedirectRequest} hostingV1SslToggleHttpsRedirectRequest
|
|
24904
|
+
* @param {*} [options] Override http request option.
|
|
24905
|
+
* @throws {RequiredError}
|
|
24906
|
+
*/
|
|
24907
|
+
toggleHTTPSRedirectV1: (username: string, domain: string, hostingV1SslToggleHttpsRedirectRequest: HostingV1SslToggleHttpsRedirectRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
24908
|
+
/**
|
|
24909
|
+
* Removes the SSL certificate assigned to the website, turns the HTTPS redirect off and cancels a pending installation retry. The website serves plain HTTP until a new installation completes. `Get SSL status` reports `not_installed` as soon as the call returns; the call also succeeds when no certificate is assigned, so repeating it is safe. Returns 422 for free subdomains (their certificate is managed by the platform) and while an installation is `installing`.
|
|
24910
|
+
* @summary Uninstall SSL
|
|
24911
|
+
* @param {string} username
|
|
24912
|
+
* @param {string} domain Domain name
|
|
24913
|
+
* @param {*} [options] Override http request option.
|
|
24914
|
+
* @throws {RequiredError}
|
|
24915
|
+
*/
|
|
24916
|
+
uninstallSSLV1: (username: string, domain: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
24917
|
+
};
|
|
24918
|
+
/**
|
|
24919
|
+
* HostingSSLApi - functional programming interface
|
|
24920
|
+
* @export
|
|
24921
|
+
*/
|
|
24922
|
+
export declare const HostingSSLApiFp: (configuration?: Configuration) => {
|
|
24923
|
+
/**
|
|
24924
|
+
* Returns the SSL state of the website: the certificate `status` and `provider`, whether the certificate is a lifetime one managed by the platform, whether HTTP requests are redirected to HTTPS, when the certificate stops being valid and the last installation error. `installing` and `waiting_for_retry` mean an installation is in progress. `failed` means the last installation gave up, or the website was not updated for 60 minutes while `installing`; `last_error` holds the reason when it is a known message, otherwise it is null. `expired` means the assigned certificate\'s validity has ended. `not_installed` means no certificate is assigned. Free subdomains use a platform-managed certificate: with no installation recorded they report `active` with `provider` and `expires_at` null.
|
|
24925
|
+
* @summary Get SSL status
|
|
24926
|
+
* @param {string} username
|
|
24927
|
+
* @param {string} domain Domain name
|
|
24928
|
+
* @param {*} [options] Override http request option.
|
|
24929
|
+
* @throws {RequiredError}
|
|
24930
|
+
*/
|
|
24931
|
+
getSSLStatusV1(username: string, domain: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<HostingV1SslSslStatusResource>>;
|
|
24932
|
+
/**
|
|
24933
|
+
* Requests a lifetime SSL certificate for the website. The installation runs in the background; `Get SSL status` reports `active` or `failed` when it ends. An `active` lifetime certificate does not block the request: a new installation is requested, which is how a certificate is reinstalled. Returns 422 for free subdomains (their certificate is managed by the platform), while an installation is `installing` or `waiting_for_retry`, when the website\'s certificate was revoked (it cannot be reissued), and when an uploaded custom certificate is installed; that one has to be uninstalled first.
|
|
24934
|
+
* @summary Install SSL
|
|
24935
|
+
* @param {string} username
|
|
24936
|
+
* @param {string} domain Domain name
|
|
24937
|
+
* @param {*} [options] Override http request option.
|
|
24938
|
+
* @throws {RequiredError}
|
|
24939
|
+
*/
|
|
24940
|
+
installSSLV1(username: string, domain: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommonSuccessEmptyResource>>;
|
|
24941
|
+
/**
|
|
24942
|
+
* Turns the HTTP to HTTPS redirect of the website on or off, based on `is_enabled`. Does nothing when the redirect is already in the requested state. Turning it on requires an installed certificate (`status` `active` or `expired` on `Get SSL status`) and returns 422 when there is none; turning it off is always accepted.
|
|
24943
|
+
* @summary Toggle HTTPS redirect
|
|
24944
|
+
* @param {string} username
|
|
24945
|
+
* @param {string} domain Domain name
|
|
24946
|
+
* @param {HostingV1SslToggleHttpsRedirectRequest} hostingV1SslToggleHttpsRedirectRequest
|
|
24947
|
+
* @param {*} [options] Override http request option.
|
|
24948
|
+
* @throws {RequiredError}
|
|
24949
|
+
*/
|
|
24950
|
+
toggleHTTPSRedirectV1(username: string, domain: string, hostingV1SslToggleHttpsRedirectRequest: HostingV1SslToggleHttpsRedirectRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommonSuccessEmptyResource>>;
|
|
24951
|
+
/**
|
|
24952
|
+
* Removes the SSL certificate assigned to the website, turns the HTTPS redirect off and cancels a pending installation retry. The website serves plain HTTP until a new installation completes. `Get SSL status` reports `not_installed` as soon as the call returns; the call also succeeds when no certificate is assigned, so repeating it is safe. Returns 422 for free subdomains (their certificate is managed by the platform) and while an installation is `installing`.
|
|
24953
|
+
* @summary Uninstall SSL
|
|
24954
|
+
* @param {string} username
|
|
24955
|
+
* @param {string} domain Domain name
|
|
24956
|
+
* @param {*} [options] Override http request option.
|
|
24957
|
+
* @throws {RequiredError}
|
|
24958
|
+
*/
|
|
24959
|
+
uninstallSSLV1(username: string, domain: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommonSuccessEmptyResource>>;
|
|
24960
|
+
};
|
|
24961
|
+
/**
|
|
24962
|
+
* HostingSSLApi - factory interface
|
|
24963
|
+
* @export
|
|
24964
|
+
*/
|
|
24965
|
+
export declare const HostingSSLApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
24966
|
+
/**
|
|
24967
|
+
* Returns the SSL state of the website: the certificate `status` and `provider`, whether the certificate is a lifetime one managed by the platform, whether HTTP requests are redirected to HTTPS, when the certificate stops being valid and the last installation error. `installing` and `waiting_for_retry` mean an installation is in progress. `failed` means the last installation gave up, or the website was not updated for 60 minutes while `installing`; `last_error` holds the reason when it is a known message, otherwise it is null. `expired` means the assigned certificate\'s validity has ended. `not_installed` means no certificate is assigned. Free subdomains use a platform-managed certificate: with no installation recorded they report `active` with `provider` and `expires_at` null.
|
|
24968
|
+
* @summary Get SSL status
|
|
24969
|
+
* @param {string} username
|
|
24970
|
+
* @param {string} domain Domain name
|
|
24971
|
+
* @param {*} [options] Override http request option.
|
|
24972
|
+
* @throws {RequiredError}
|
|
24973
|
+
*/
|
|
24974
|
+
getSSLStatusV1(username: string, domain: string, options?: RawAxiosRequestConfig): AxiosPromise<HostingV1SslSslStatusResource>;
|
|
24975
|
+
/**
|
|
24976
|
+
* Requests a lifetime SSL certificate for the website. The installation runs in the background; `Get SSL status` reports `active` or `failed` when it ends. An `active` lifetime certificate does not block the request: a new installation is requested, which is how a certificate is reinstalled. Returns 422 for free subdomains (their certificate is managed by the platform), while an installation is `installing` or `waiting_for_retry`, when the website\'s certificate was revoked (it cannot be reissued), and when an uploaded custom certificate is installed; that one has to be uninstalled first.
|
|
24977
|
+
* @summary Install SSL
|
|
24978
|
+
* @param {string} username
|
|
24979
|
+
* @param {string} domain Domain name
|
|
24980
|
+
* @param {*} [options] Override http request option.
|
|
24981
|
+
* @throws {RequiredError}
|
|
24982
|
+
*/
|
|
24983
|
+
installSSLV1(username: string, domain: string, options?: RawAxiosRequestConfig): AxiosPromise<CommonSuccessEmptyResource>;
|
|
24984
|
+
/**
|
|
24985
|
+
* Turns the HTTP to HTTPS redirect of the website on or off, based on `is_enabled`. Does nothing when the redirect is already in the requested state. Turning it on requires an installed certificate (`status` `active` or `expired` on `Get SSL status`) and returns 422 when there is none; turning it off is always accepted.
|
|
24986
|
+
* @summary Toggle HTTPS redirect
|
|
24987
|
+
* @param {string} username
|
|
24988
|
+
* @param {string} domain Domain name
|
|
24989
|
+
* @param {HostingV1SslToggleHttpsRedirectRequest} hostingV1SslToggleHttpsRedirectRequest
|
|
24990
|
+
* @param {*} [options] Override http request option.
|
|
24991
|
+
* @throws {RequiredError}
|
|
24992
|
+
*/
|
|
24993
|
+
toggleHTTPSRedirectV1(username: string, domain: string, hostingV1SslToggleHttpsRedirectRequest: HostingV1SslToggleHttpsRedirectRequest, options?: RawAxiosRequestConfig): AxiosPromise<CommonSuccessEmptyResource>;
|
|
24994
|
+
/**
|
|
24995
|
+
* Removes the SSL certificate assigned to the website, turns the HTTPS redirect off and cancels a pending installation retry. The website serves plain HTTP until a new installation completes. `Get SSL status` reports `not_installed` as soon as the call returns; the call also succeeds when no certificate is assigned, so repeating it is safe. Returns 422 for free subdomains (their certificate is managed by the platform) and while an installation is `installing`.
|
|
24996
|
+
* @summary Uninstall SSL
|
|
24997
|
+
* @param {string} username
|
|
24998
|
+
* @param {string} domain Domain name
|
|
24999
|
+
* @param {*} [options] Override http request option.
|
|
25000
|
+
* @throws {RequiredError}
|
|
25001
|
+
*/
|
|
25002
|
+
uninstallSSLV1(username: string, domain: string, options?: RawAxiosRequestConfig): AxiosPromise<CommonSuccessEmptyResource>;
|
|
25003
|
+
};
|
|
25004
|
+
/**
|
|
25005
|
+
* HostingSSLApi - object-oriented interface
|
|
25006
|
+
* @export
|
|
25007
|
+
* @class HostingSSLApi
|
|
25008
|
+
* @extends {BaseAPI}
|
|
25009
|
+
*/
|
|
25010
|
+
export declare class HostingSSLApi extends BaseAPI {
|
|
25011
|
+
/**
|
|
25012
|
+
* Returns the SSL state of the website: the certificate `status` and `provider`, whether the certificate is a lifetime one managed by the platform, whether HTTP requests are redirected to HTTPS, when the certificate stops being valid and the last installation error. `installing` and `waiting_for_retry` mean an installation is in progress. `failed` means the last installation gave up, or the website was not updated for 60 minutes while `installing`; `last_error` holds the reason when it is a known message, otherwise it is null. `expired` means the assigned certificate\'s validity has ended. `not_installed` means no certificate is assigned. Free subdomains use a platform-managed certificate: with no installation recorded they report `active` with `provider` and `expires_at` null.
|
|
25013
|
+
* @summary Get SSL status
|
|
25014
|
+
* @param {string} username
|
|
25015
|
+
* @param {string} domain Domain name
|
|
25016
|
+
* @param {*} [options] Override http request option.
|
|
25017
|
+
* @throws {RequiredError}
|
|
25018
|
+
* @memberof HostingSSLApi
|
|
25019
|
+
*/
|
|
25020
|
+
getSSLStatusV1(username: string, domain: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<HostingV1SslSslStatusResource, any, {}, any>>;
|
|
25021
|
+
/**
|
|
25022
|
+
* Requests a lifetime SSL certificate for the website. The installation runs in the background; `Get SSL status` reports `active` or `failed` when it ends. An `active` lifetime certificate does not block the request: a new installation is requested, which is how a certificate is reinstalled. Returns 422 for free subdomains (their certificate is managed by the platform), while an installation is `installing` or `waiting_for_retry`, when the website\'s certificate was revoked (it cannot be reissued), and when an uploaded custom certificate is installed; that one has to be uninstalled first.
|
|
25023
|
+
* @summary Install SSL
|
|
25024
|
+
* @param {string} username
|
|
25025
|
+
* @param {string} domain Domain name
|
|
25026
|
+
* @param {*} [options] Override http request option.
|
|
25027
|
+
* @throws {RequiredError}
|
|
25028
|
+
* @memberof HostingSSLApi
|
|
25029
|
+
*/
|
|
25030
|
+
installSSLV1(username: string, domain: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CommonSuccessEmptyResource, any, {}, any>>;
|
|
25031
|
+
/**
|
|
25032
|
+
* Turns the HTTP to HTTPS redirect of the website on or off, based on `is_enabled`. Does nothing when the redirect is already in the requested state. Turning it on requires an installed certificate (`status` `active` or `expired` on `Get SSL status`) and returns 422 when there is none; turning it off is always accepted.
|
|
25033
|
+
* @summary Toggle HTTPS redirect
|
|
25034
|
+
* @param {string} username
|
|
25035
|
+
* @param {string} domain Domain name
|
|
25036
|
+
* @param {HostingV1SslToggleHttpsRedirectRequest} hostingV1SslToggleHttpsRedirectRequest
|
|
25037
|
+
* @param {*} [options] Override http request option.
|
|
25038
|
+
* @throws {RequiredError}
|
|
25039
|
+
* @memberof HostingSSLApi
|
|
25040
|
+
*/
|
|
25041
|
+
toggleHTTPSRedirectV1(username: string, domain: string, hostingV1SslToggleHttpsRedirectRequest: HostingV1SslToggleHttpsRedirectRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CommonSuccessEmptyResource, any, {}, any>>;
|
|
25042
|
+
/**
|
|
25043
|
+
* Removes the SSL certificate assigned to the website, turns the HTTPS redirect off and cancels a pending installation retry. The website serves plain HTTP until a new installation completes. `Get SSL status` reports `not_installed` as soon as the call returns; the call also succeeds when no certificate is assigned, so repeating it is safe. Returns 422 for free subdomains (their certificate is managed by the platform) and while an installation is `installing`.
|
|
25044
|
+
* @summary Uninstall SSL
|
|
25045
|
+
* @param {string} username
|
|
25046
|
+
* @param {string} domain Domain name
|
|
25047
|
+
* @param {*} [options] Override http request option.
|
|
25048
|
+
* @throws {RequiredError}
|
|
25049
|
+
* @memberof HostingSSLApi
|
|
25050
|
+
*/
|
|
25051
|
+
uninstallSSLV1(username: string, domain: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CommonSuccessEmptyResource, any, {}, any>>;
|
|
25052
|
+
}
|
|
24501
25053
|
/**
|
|
24502
25054
|
* HostingWebsitesApi - axios parameter creator
|
|
24503
25055
|
* @export
|