@hostinger/sdk 1.52.0 → 1.52.2
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 +790 -10
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +2 -2
- package/dist/api.d.ts +556 -8
- package/dist/api.js +463 -17
- 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 +556 -8
- package/dist/esm/api.js +449 -7
- 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 +297 -0
- package/docs/HostingNodeJSApi.md +1 -1
- package/docs/HostingV1GitGitAutoDeploymentSettingsResource.md +31 -0
- package/docs/HostingV1GitGitCommitAuthorResource.md +22 -0
- package/docs/HostingV1GitGitCommitResource.md +24 -0
- package/docs/HostingV1GitGitInstallationResource.md +36 -0
- package/docs/HostingV1GitGitRepositoryResource.md +34 -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/index.ts +1 -1
- package/package.json +1 -1
package/api.ts
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
/**
|
|
4
4
|
* Hostinger API
|
|
5
5
|
*
|
|
6
|
-
* API Version: 1.52.
|
|
6
|
+
* API Version: 1.52.2
|
|
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
|
|
@@ -7358,6 +7358,274 @@ export interface HostingV1FilesUploadUrlResource {
|
|
|
7358
7358
|
*/
|
|
7359
7359
|
'rest_auth_key': string;
|
|
7360
7360
|
}
|
|
7361
|
+
/**
|
|
7362
|
+
* Every field is null when the website has no Git auto-deployment configured.
|
|
7363
|
+
* @export
|
|
7364
|
+
* @interface HostingV1GitGitAutoDeploymentSettingsResource
|
|
7365
|
+
*/
|
|
7366
|
+
export interface HostingV1GitGitAutoDeploymentSettingsResource {
|
|
7367
|
+
/**
|
|
7368
|
+
* Git installation the repository is accessed through
|
|
7369
|
+
* @type {string}
|
|
7370
|
+
* @memberof HostingV1GitGitAutoDeploymentSettingsResource
|
|
7371
|
+
*/
|
|
7372
|
+
'installation_uuid': string | null;
|
|
7373
|
+
/**
|
|
7374
|
+
* Whether pushes to the branch deploy automatically
|
|
7375
|
+
* @type {boolean}
|
|
7376
|
+
* @memberof HostingV1GitGitAutoDeploymentSettingsResource
|
|
7377
|
+
*/
|
|
7378
|
+
'is_enabled': boolean | null;
|
|
7379
|
+
/**
|
|
7380
|
+
* Repository owner login
|
|
7381
|
+
* @type {string}
|
|
7382
|
+
* @memberof HostingV1GitGitAutoDeploymentSettingsResource
|
|
7383
|
+
*/
|
|
7384
|
+
'owner': string | null;
|
|
7385
|
+
/**
|
|
7386
|
+
* Repository name
|
|
7387
|
+
* @type {string}
|
|
7388
|
+
* @memberof HostingV1GitGitAutoDeploymentSettingsResource
|
|
7389
|
+
*/
|
|
7390
|
+
'repository': string | null;
|
|
7391
|
+
/**
|
|
7392
|
+
* Branch that is deployed
|
|
7393
|
+
* @type {string}
|
|
7394
|
+
* @memberof HostingV1GitGitAutoDeploymentSettingsResource
|
|
7395
|
+
*/
|
|
7396
|
+
'branch': string | null;
|
|
7397
|
+
/**
|
|
7398
|
+
* Subdirectory under the website document root the repository deploys into. Empty means the document root.
|
|
7399
|
+
* @type {string}
|
|
7400
|
+
* @memberof HostingV1GitGitAutoDeploymentSettingsResource
|
|
7401
|
+
*/
|
|
7402
|
+
'directory': string | null;
|
|
7403
|
+
}
|
|
7404
|
+
/**
|
|
7405
|
+
*
|
|
7406
|
+
* @export
|
|
7407
|
+
* @interface HostingV1GitGitCommitAuthorResource
|
|
7408
|
+
*/
|
|
7409
|
+
export interface HostingV1GitGitCommitAuthorResource {
|
|
7410
|
+
/**
|
|
7411
|
+
* Author name as recorded in the commit
|
|
7412
|
+
* @type {string}
|
|
7413
|
+
* @memberof HostingV1GitGitCommitAuthorResource
|
|
7414
|
+
*/
|
|
7415
|
+
'name': string;
|
|
7416
|
+
/**
|
|
7417
|
+
* Avatar URL of the author on the Git provider
|
|
7418
|
+
* @type {string}
|
|
7419
|
+
* @memberof HostingV1GitGitCommitAuthorResource
|
|
7420
|
+
*/
|
|
7421
|
+
'avatar_url': string | null;
|
|
7422
|
+
}
|
|
7423
|
+
/**
|
|
7424
|
+
*
|
|
7425
|
+
* @export
|
|
7426
|
+
* @interface HostingV1GitGitCommitResource
|
|
7427
|
+
*/
|
|
7428
|
+
export interface HostingV1GitGitCommitResource {
|
|
7429
|
+
/**
|
|
7430
|
+
* Full commit SHA
|
|
7431
|
+
* @type {string}
|
|
7432
|
+
* @memberof HostingV1GitGitCommitResource
|
|
7433
|
+
*/
|
|
7434
|
+
'hash': string;
|
|
7435
|
+
/**
|
|
7436
|
+
* Commit message
|
|
7437
|
+
* @type {string}
|
|
7438
|
+
* @memberof HostingV1GitGitCommitResource
|
|
7439
|
+
*/
|
|
7440
|
+
'message': string;
|
|
7441
|
+
/**
|
|
7442
|
+
*
|
|
7443
|
+
* @type {HostingV1GitGitCommitAuthorResource}
|
|
7444
|
+
* @memberof HostingV1GitGitCommitResource
|
|
7445
|
+
*/
|
|
7446
|
+
'author': HostingV1GitGitCommitAuthorResource;
|
|
7447
|
+
}
|
|
7448
|
+
/**
|
|
7449
|
+
*
|
|
7450
|
+
* @export
|
|
7451
|
+
* @interface HostingV1GitGitInstallationResource
|
|
7452
|
+
*/
|
|
7453
|
+
export interface HostingV1GitGitInstallationResource {
|
|
7454
|
+
/**
|
|
7455
|
+
* Installation identifier. Use it as the path parameter of List Git installation repositories.
|
|
7456
|
+
* @type {string}
|
|
7457
|
+
* @memberof HostingV1GitGitInstallationResource
|
|
7458
|
+
*/
|
|
7459
|
+
'uuid': string;
|
|
7460
|
+
/**
|
|
7461
|
+
* Git provider the account belongs to
|
|
7462
|
+
* @type {string}
|
|
7463
|
+
* @memberof HostingV1GitGitInstallationResource
|
|
7464
|
+
*/
|
|
7465
|
+
'provider': HostingV1GitGitInstallationResourceProviderEnum;
|
|
7466
|
+
/**
|
|
7467
|
+
* Login of the connected provider account (user or organization)
|
|
7468
|
+
* @type {string}
|
|
7469
|
+
* @memberof HostingV1GitGitInstallationResource
|
|
7470
|
+
*/
|
|
7471
|
+
'account_login': string | null;
|
|
7472
|
+
/**
|
|
7473
|
+
* Whether the connected account is a user or an organization
|
|
7474
|
+
* @type {string}
|
|
7475
|
+
* @memberof HostingV1GitGitInstallationResource
|
|
7476
|
+
*/
|
|
7477
|
+
'account_type': HostingV1GitGitInstallationResourceAccountTypeEnum | null;
|
|
7478
|
+
/**
|
|
7479
|
+
* Avatar URL of the connected provider account
|
|
7480
|
+
* @type {string}
|
|
7481
|
+
* @memberof HostingV1GitGitInstallationResource
|
|
7482
|
+
*/
|
|
7483
|
+
'account_avatar_url': string | null;
|
|
7484
|
+
/**
|
|
7485
|
+
* Installation status. Only active installations are listed unless the status filter says otherwise.
|
|
7486
|
+
* @type {string}
|
|
7487
|
+
* @memberof HostingV1GitGitInstallationResource
|
|
7488
|
+
*/
|
|
7489
|
+
'status': HostingV1GitGitInstallationResourceStatusEnum;
|
|
7490
|
+
/**
|
|
7491
|
+
* When the provider app was installed on the account
|
|
7492
|
+
* @type {string}
|
|
7493
|
+
* @memberof HostingV1GitGitInstallationResource
|
|
7494
|
+
*/
|
|
7495
|
+
'installed_at': string | null;
|
|
7496
|
+
/**
|
|
7497
|
+
* When the installation record was created
|
|
7498
|
+
* @type {string}
|
|
7499
|
+
* @memberof HostingV1GitGitInstallationResource
|
|
7500
|
+
*/
|
|
7501
|
+
'created_at': string;
|
|
7502
|
+
/**
|
|
7503
|
+
* True when the GitHub user account has a stored OAuth token whose refresh token is still valid, false when the token is missing or its refresh token expired. Null for organization accounts and for providers other than GitHub.
|
|
7504
|
+
* @type {boolean}
|
|
7505
|
+
* @memberof HostingV1GitGitInstallationResource
|
|
7506
|
+
*/
|
|
7507
|
+
'has_oauth': boolean | null;
|
|
7508
|
+
}
|
|
7509
|
+
|
|
7510
|
+
export const HostingV1GitGitInstallationResourceProviderEnum = {
|
|
7511
|
+
Github: 'github',
|
|
7512
|
+
Gitlab: 'gitlab',
|
|
7513
|
+
Bitbucket: 'bitbucket'
|
|
7514
|
+
} as const;
|
|
7515
|
+
|
|
7516
|
+
export type HostingV1GitGitInstallationResourceProviderEnum = typeof HostingV1GitGitInstallationResourceProviderEnum[keyof typeof HostingV1GitGitInstallationResourceProviderEnum];
|
|
7517
|
+
export const HostingV1GitGitInstallationResourceAccountTypeEnum = {
|
|
7518
|
+
User: 'User',
|
|
7519
|
+
Organization: 'Organization'
|
|
7520
|
+
} as const;
|
|
7521
|
+
|
|
7522
|
+
export type HostingV1GitGitInstallationResourceAccountTypeEnum = typeof HostingV1GitGitInstallationResourceAccountTypeEnum[keyof typeof HostingV1GitGitInstallationResourceAccountTypeEnum];
|
|
7523
|
+
export const HostingV1GitGitInstallationResourceStatusEnum = {
|
|
7524
|
+
Pending: 'pending',
|
|
7525
|
+
Active: 'active',
|
|
7526
|
+
Suspended: 'suspended'
|
|
7527
|
+
} as const;
|
|
7528
|
+
|
|
7529
|
+
export type HostingV1GitGitInstallationResourceStatusEnum = typeof HostingV1GitGitInstallationResourceStatusEnum[keyof typeof HostingV1GitGitInstallationResourceStatusEnum];
|
|
7530
|
+
|
|
7531
|
+
/**
|
|
7532
|
+
*
|
|
7533
|
+
* @export
|
|
7534
|
+
* @interface HostingV1GitGitRepositoryResource
|
|
7535
|
+
*/
|
|
7536
|
+
export interface HostingV1GitGitRepositoryResource {
|
|
7537
|
+
/**
|
|
7538
|
+
* Repository identifier assigned by the Git provider
|
|
7539
|
+
* @type {number}
|
|
7540
|
+
* @memberof HostingV1GitGitRepositoryResource
|
|
7541
|
+
*/
|
|
7542
|
+
'id': number;
|
|
7543
|
+
/**
|
|
7544
|
+
* Repository name without the .git suffix
|
|
7545
|
+
* @type {string}
|
|
7546
|
+
* @memberof HostingV1GitGitRepositoryResource
|
|
7547
|
+
*/
|
|
7548
|
+
'name': string;
|
|
7549
|
+
/**
|
|
7550
|
+
* Owner and repository name joined with a slash
|
|
7551
|
+
* @type {string}
|
|
7552
|
+
* @memberof HostingV1GitGitRepositoryResource
|
|
7553
|
+
*/
|
|
7554
|
+
'full_name': string;
|
|
7555
|
+
/**
|
|
7556
|
+
* Repository owner login
|
|
7557
|
+
* @type {string}
|
|
7558
|
+
* @memberof HostingV1GitGitRepositoryResource
|
|
7559
|
+
*/
|
|
7560
|
+
'owner': string;
|
|
7561
|
+
/**
|
|
7562
|
+
* Whether the repository is private
|
|
7563
|
+
* @type {boolean}
|
|
7564
|
+
* @memberof HostingV1GitGitRepositoryResource
|
|
7565
|
+
*/
|
|
7566
|
+
'is_private': boolean;
|
|
7567
|
+
/**
|
|
7568
|
+
* Repository page URL
|
|
7569
|
+
* @type {string}
|
|
7570
|
+
* @memberof HostingV1GitGitRepositoryResource
|
|
7571
|
+
*/
|
|
7572
|
+
'html_url': string;
|
|
7573
|
+
/**
|
|
7574
|
+
* HTTPS clone URL
|
|
7575
|
+
* @type {string}
|
|
7576
|
+
* @memberof HostingV1GitGitRepositoryResource
|
|
7577
|
+
*/
|
|
7578
|
+
'clone_url': string;
|
|
7579
|
+
/**
|
|
7580
|
+
* Default branch of the repository
|
|
7581
|
+
* @type {string}
|
|
7582
|
+
* @memberof HostingV1GitGitRepositoryResource
|
|
7583
|
+
*/
|
|
7584
|
+
'default_branch': string;
|
|
7585
|
+
}
|
|
7586
|
+
/**
|
|
7587
|
+
*
|
|
7588
|
+
* @export
|
|
7589
|
+
* @interface HostingV1GitUpdateGitAutoDeploymentSettingsRequest
|
|
7590
|
+
*/
|
|
7591
|
+
export interface HostingV1GitUpdateGitAutoDeploymentSettingsRequest {
|
|
7592
|
+
/**
|
|
7593
|
+
* Active Git installation from `List Git installations`
|
|
7594
|
+
* @type {string}
|
|
7595
|
+
* @memberof HostingV1GitUpdateGitAutoDeploymentSettingsRequest
|
|
7596
|
+
*/
|
|
7597
|
+
'installation_uuid': string;
|
|
7598
|
+
/**
|
|
7599
|
+
* Repository owner login, as returned by `List Git installation repositories`. GitLab group paths use slashes.
|
|
7600
|
+
* @type {string}
|
|
7601
|
+
* @memberof HostingV1GitUpdateGitAutoDeploymentSettingsRequest
|
|
7602
|
+
*/
|
|
7603
|
+
'owner': string;
|
|
7604
|
+
/**
|
|
7605
|
+
* Repository name without the .git suffix
|
|
7606
|
+
* @type {string}
|
|
7607
|
+
* @memberof HostingV1GitUpdateGitAutoDeploymentSettingsRequest
|
|
7608
|
+
*/
|
|
7609
|
+
'repository': string;
|
|
7610
|
+
/**
|
|
7611
|
+
* Branch to deploy
|
|
7612
|
+
* @type {string}
|
|
7613
|
+
* @memberof HostingV1GitUpdateGitAutoDeploymentSettingsRequest
|
|
7614
|
+
*/
|
|
7615
|
+
'branch': string;
|
|
7616
|
+
/**
|
|
7617
|
+
* Subdirectory under the website document root to deploy into. Empty, null or omitted means the document root.
|
|
7618
|
+
* @type {string}
|
|
7619
|
+
* @memberof HostingV1GitUpdateGitAutoDeploymentSettingsRequest
|
|
7620
|
+
*/
|
|
7621
|
+
'directory': string | null;
|
|
7622
|
+
/**
|
|
7623
|
+
* Whether pushes to the branch deploy automatically
|
|
7624
|
+
* @type {boolean}
|
|
7625
|
+
* @memberof HostingV1GitUpdateGitAutoDeploymentSettingsRequest
|
|
7626
|
+
*/
|
|
7627
|
+
'is_enabled': boolean;
|
|
7628
|
+
}
|
|
7361
7629
|
/**
|
|
7362
7630
|
*
|
|
7363
7631
|
* @export
|
|
@@ -7489,7 +7757,8 @@ export const HostingV1NodeJsBuildOptionsResourcePackageManagerEnum = {
|
|
|
7489
7757
|
|
|
7490
7758
|
export type HostingV1NodeJsBuildOptionsResourcePackageManagerEnum = typeof HostingV1NodeJsBuildOptionsResourcePackageManagerEnum[keyof typeof HostingV1NodeJsBuildOptionsResourcePackageManagerEnum];
|
|
7491
7759
|
export const HostingV1NodeJsBuildOptionsResourceSourceTypeEnum = {
|
|
7492
|
-
Archive: 'archive'
|
|
7760
|
+
Archive: 'archive',
|
|
7761
|
+
Git: 'git'
|
|
7493
7762
|
} as const;
|
|
7494
7763
|
|
|
7495
7764
|
export type HostingV1NodeJsBuildOptionsResourceSourceTypeEnum = typeof HostingV1NodeJsBuildOptionsResourceSourceTypeEnum[keyof typeof HostingV1NodeJsBuildOptionsResourceSourceTypeEnum];
|
|
@@ -7888,7 +8157,7 @@ export interface HostingV1NodeJsSetBuildEnvVarsRequestEnvVarsInner {
|
|
|
7888
8157
|
'value': string;
|
|
7889
8158
|
}
|
|
7890
8159
|
/**
|
|
7891
|
-
*
|
|
8160
|
+
* Which keys carry values depends on the parent source_type; the others are null.
|
|
7892
8161
|
* @export
|
|
7893
8162
|
* @interface HostingV1NodeJsSourceOptionsResource
|
|
7894
8163
|
*/
|
|
@@ -7899,6 +8168,36 @@ export interface HostingV1NodeJsSourceOptionsResource {
|
|
|
7899
8168
|
* @memberof HostingV1NodeJsSourceOptionsResource
|
|
7900
8169
|
*/
|
|
7901
8170
|
'archive_path': string | null;
|
|
8171
|
+
/**
|
|
8172
|
+
* Repository owner login (present if source_type is \"git\")
|
|
8173
|
+
* @type {string}
|
|
8174
|
+
* @memberof HostingV1NodeJsSourceOptionsResource
|
|
8175
|
+
*/
|
|
8176
|
+
'owner': string | null;
|
|
8177
|
+
/**
|
|
8178
|
+
* Repository name without the .git suffix (present if source_type is \"git\")
|
|
8179
|
+
* @type {string}
|
|
8180
|
+
* @memberof HostingV1NodeJsSourceOptionsResource
|
|
8181
|
+
*/
|
|
8182
|
+
'repository': string | null;
|
|
8183
|
+
/**
|
|
8184
|
+
* Branch that was built (present if source_type is \"git\")
|
|
8185
|
+
* @type {string}
|
|
8186
|
+
* @memberof HostingV1NodeJsSourceOptionsResource
|
|
8187
|
+
*/
|
|
8188
|
+
'branch': string | null;
|
|
8189
|
+
/**
|
|
8190
|
+
* Git installation used to access the repository (present if source_type is \"git\")
|
|
8191
|
+
* @type {string}
|
|
8192
|
+
* @memberof HostingV1NodeJsSourceOptionsResource
|
|
8193
|
+
*/
|
|
8194
|
+
'installation_uuid': string | null;
|
|
8195
|
+
/**
|
|
8196
|
+
*
|
|
8197
|
+
* @type {HostingV1GitGitCommitResource}
|
|
8198
|
+
* @memberof HostingV1NodeJsSourceOptionsResource
|
|
8199
|
+
*/
|
|
8200
|
+
'commit': HostingV1GitGitCommitResource | null;
|
|
7902
8201
|
}
|
|
7903
8202
|
/**
|
|
7904
8203
|
*
|
|
@@ -7949,7 +8248,7 @@ export interface HostingV1NodeJsStartBuildRequest {
|
|
|
7949
8248
|
*/
|
|
7950
8249
|
'package_manager': HostingV1NodeJsStartBuildRequestPackageManagerEnum | null;
|
|
7951
8250
|
/**
|
|
7952
|
-
*
|
|
8251
|
+
* Where the files come from: `archive` (an uploaded archive on the website) or `git` (a branch of a repository reachable through a Git installation).
|
|
7953
8252
|
* @type {string}
|
|
7954
8253
|
* @memberof HostingV1NodeJsStartBuildRequest
|
|
7955
8254
|
*/
|
|
@@ -8001,13 +8300,14 @@ export const HostingV1NodeJsStartBuildRequestPackageManagerEnum = {
|
|
|
8001
8300
|
|
|
8002
8301
|
export type HostingV1NodeJsStartBuildRequestPackageManagerEnum = typeof HostingV1NodeJsStartBuildRequestPackageManagerEnum[keyof typeof HostingV1NodeJsStartBuildRequestPackageManagerEnum];
|
|
8003
8302
|
export const HostingV1NodeJsStartBuildRequestSourceTypeEnum = {
|
|
8004
|
-
Archive: 'archive'
|
|
8303
|
+
Archive: 'archive',
|
|
8304
|
+
Git: 'git'
|
|
8005
8305
|
} as const;
|
|
8006
8306
|
|
|
8007
8307
|
export type HostingV1NodeJsStartBuildRequestSourceTypeEnum = typeof HostingV1NodeJsStartBuildRequestSourceTypeEnum[keyof typeof HostingV1NodeJsStartBuildRequestSourceTypeEnum];
|
|
8008
8308
|
|
|
8009
8309
|
/**
|
|
8010
|
-
* Source-specific options
|
|
8310
|
+
* 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`.
|
|
8011
8311
|
* @export
|
|
8012
8312
|
* @interface HostingV1NodeJsStartBuildRequestSourceOptions
|
|
8013
8313
|
*/
|
|
@@ -8018,6 +8318,30 @@ export interface HostingV1NodeJsStartBuildRequestSourceOptions {
|
|
|
8018
8318
|
* @memberof HostingV1NodeJsStartBuildRequestSourceOptions
|
|
8019
8319
|
*/
|
|
8020
8320
|
'archive_path': string;
|
|
8321
|
+
/**
|
|
8322
|
+
* Repository owner login (required if source is \"git\"). GitLab group paths use slashes.
|
|
8323
|
+
* @type {string}
|
|
8324
|
+
* @memberof HostingV1NodeJsStartBuildRequestSourceOptions
|
|
8325
|
+
*/
|
|
8326
|
+
'owner': string;
|
|
8327
|
+
/**
|
|
8328
|
+
* Repository name without the .git suffix (required if source is \"git\")
|
|
8329
|
+
* @type {string}
|
|
8330
|
+
* @memberof HostingV1NodeJsStartBuildRequestSourceOptions
|
|
8331
|
+
*/
|
|
8332
|
+
'repository': string;
|
|
8333
|
+
/**
|
|
8334
|
+
* Branch to build (required if source is \"git\")
|
|
8335
|
+
* @type {string}
|
|
8336
|
+
* @memberof HostingV1NodeJsStartBuildRequestSourceOptions
|
|
8337
|
+
*/
|
|
8338
|
+
'branch': string;
|
|
8339
|
+
/**
|
|
8340
|
+
* Git installation used to access the repository (required if source is \"git\")
|
|
8341
|
+
* @type {string}
|
|
8342
|
+
* @memberof HostingV1NodeJsStartBuildRequestSourceOptions
|
|
8343
|
+
*/
|
|
8344
|
+
'installation_uuid': string;
|
|
8021
8345
|
}
|
|
8022
8346
|
/**
|
|
8023
8347
|
*
|
|
@@ -30667,6 +30991,462 @@ export const ListWebsiteFilesAndDirectoriesV1FileTypesEnum = {
|
|
|
30667
30991
|
export type ListWebsiteFilesAndDirectoriesV1FileTypesEnum = typeof ListWebsiteFilesAndDirectoriesV1FileTypesEnum[keyof typeof ListWebsiteFilesAndDirectoriesV1FileTypesEnum];
|
|
30668
30992
|
|
|
30669
30993
|
|
|
30994
|
+
/**
|
|
30995
|
+
* HostingGitApi - axios parameter creator
|
|
30996
|
+
* @export
|
|
30997
|
+
*/
|
|
30998
|
+
export const HostingGitApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
30999
|
+
return {
|
|
31000
|
+
/**
|
|
31001
|
+
* 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.
|
|
31002
|
+
* @summary Delete Git auto-deployment settings
|
|
31003
|
+
* @param {string} username
|
|
31004
|
+
* @param {string} domain Domain name
|
|
31005
|
+
* @param {*} [options] Override http request option.
|
|
31006
|
+
* @throws {RequiredError}
|
|
31007
|
+
*/
|
|
31008
|
+
deleteGitAutoDeploymentSettingsV1: async (username: string, domain: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
31009
|
+
// verify required parameter 'username' is not null or undefined
|
|
31010
|
+
assertParamExists('deleteGitAutoDeploymentSettingsV1', 'username', username)
|
|
31011
|
+
// verify required parameter 'domain' is not null or undefined
|
|
31012
|
+
assertParamExists('deleteGitAutoDeploymentSettingsV1', 'domain', domain)
|
|
31013
|
+
const localVarPath = `/api/hosting/v1/accounts/{username}/websites/{domain}/git/auto-deployments/settings`
|
|
31014
|
+
.replace(`{${"username"}}`, encodeURIComponent(String(username)))
|
|
31015
|
+
.replace(`{${"domain"}}`, encodeURIComponent(String(domain)));
|
|
31016
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
31017
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
31018
|
+
let baseOptions;
|
|
31019
|
+
if (configuration) {
|
|
31020
|
+
baseOptions = configuration.baseOptions;
|
|
31021
|
+
}
|
|
31022
|
+
|
|
31023
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
31024
|
+
const localVarHeaderParameter = {} as any;
|
|
31025
|
+
const localVarQueryParameter = {} as any;
|
|
31026
|
+
|
|
31027
|
+
// authentication apiToken required
|
|
31028
|
+
// http bearer authentication required
|
|
31029
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
31030
|
+
|
|
31031
|
+
|
|
31032
|
+
|
|
31033
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
31034
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
31035
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
31036
|
+
|
|
31037
|
+
return {
|
|
31038
|
+
url: toPathString(localVarUrlObj),
|
|
31039
|
+
options: localVarRequestOptions,
|
|
31040
|
+
};
|
|
31041
|
+
},
|
|
31042
|
+
/**
|
|
31043
|
+
* 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`.
|
|
31044
|
+
* @summary Get Git auto-deployment settings
|
|
31045
|
+
* @param {string} username
|
|
31046
|
+
* @param {string} domain Domain name
|
|
31047
|
+
* @param {*} [options] Override http request option.
|
|
31048
|
+
* @throws {RequiredError}
|
|
31049
|
+
*/
|
|
31050
|
+
getGitAutoDeploymentSettingsV1: async (username: string, domain: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
31051
|
+
// verify required parameter 'username' is not null or undefined
|
|
31052
|
+
assertParamExists('getGitAutoDeploymentSettingsV1', 'username', username)
|
|
31053
|
+
// verify required parameter 'domain' is not null or undefined
|
|
31054
|
+
assertParamExists('getGitAutoDeploymentSettingsV1', 'domain', domain)
|
|
31055
|
+
const localVarPath = `/api/hosting/v1/accounts/{username}/websites/{domain}/git/auto-deployments/settings`
|
|
31056
|
+
.replace(`{${"username"}}`, encodeURIComponent(String(username)))
|
|
31057
|
+
.replace(`{${"domain"}}`, encodeURIComponent(String(domain)));
|
|
31058
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
31059
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
31060
|
+
let baseOptions;
|
|
31061
|
+
if (configuration) {
|
|
31062
|
+
baseOptions = configuration.baseOptions;
|
|
31063
|
+
}
|
|
31064
|
+
|
|
31065
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
31066
|
+
const localVarHeaderParameter = {} as any;
|
|
31067
|
+
const localVarQueryParameter = {} as any;
|
|
31068
|
+
|
|
31069
|
+
// authentication apiToken required
|
|
31070
|
+
// http bearer authentication required
|
|
31071
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
31072
|
+
|
|
31073
|
+
|
|
31074
|
+
|
|
31075
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
31076
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
31077
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
31078
|
+
|
|
31079
|
+
return {
|
|
31080
|
+
url: toPathString(localVarUrlObj),
|
|
31081
|
+
options: localVarRequestOptions,
|
|
31082
|
+
};
|
|
31083
|
+
},
|
|
31084
|
+
/**
|
|
31085
|
+
* 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).
|
|
31086
|
+
* @summary List Git installation repositories
|
|
31087
|
+
* @param {string} uuid Git installation UUID from the List Git installations endpoint
|
|
31088
|
+
* @param {*} [options] Override http request option.
|
|
31089
|
+
* @throws {RequiredError}
|
|
31090
|
+
*/
|
|
31091
|
+
listGitInstallationRepositoriesV1: async (uuid: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
31092
|
+
// verify required parameter 'uuid' is not null or undefined
|
|
31093
|
+
assertParamExists('listGitInstallationRepositoriesV1', 'uuid', uuid)
|
|
31094
|
+
const localVarPath = `/api/hosting/v1/git/installations/{uuid}/repositories`
|
|
31095
|
+
.replace(`{${"uuid"}}`, encodeURIComponent(String(uuid)));
|
|
31096
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
31097
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
31098
|
+
let baseOptions;
|
|
31099
|
+
if (configuration) {
|
|
31100
|
+
baseOptions = configuration.baseOptions;
|
|
31101
|
+
}
|
|
31102
|
+
|
|
31103
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
31104
|
+
const localVarHeaderParameter = {} as any;
|
|
31105
|
+
const localVarQueryParameter = {} as any;
|
|
31106
|
+
|
|
31107
|
+
// authentication apiToken required
|
|
31108
|
+
// http bearer authentication required
|
|
31109
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
31110
|
+
|
|
31111
|
+
|
|
31112
|
+
|
|
31113
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
31114
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
31115
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
31116
|
+
|
|
31117
|
+
return {
|
|
31118
|
+
url: toPathString(localVarUrlObj),
|
|
31119
|
+
options: localVarRequestOptions,
|
|
31120
|
+
};
|
|
31121
|
+
},
|
|
31122
|
+
/**
|
|
31123
|
+
* 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`.
|
|
31124
|
+
* @summary List Git installations
|
|
31125
|
+
* @param {ListGitInstallationsV1ProviderEnum} [provider] Filter by Git provider
|
|
31126
|
+
* @param {ListGitInstallationsV1StatusEnum} [status] Filter by installation status
|
|
31127
|
+
* @param {*} [options] Override http request option.
|
|
31128
|
+
* @throws {RequiredError}
|
|
31129
|
+
*/
|
|
31130
|
+
listGitInstallationsV1: async (provider?: ListGitInstallationsV1ProviderEnum, status?: ListGitInstallationsV1StatusEnum, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
31131
|
+
const localVarPath = `/api/hosting/v1/git/installations`;
|
|
31132
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
31133
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
31134
|
+
let baseOptions;
|
|
31135
|
+
if (configuration) {
|
|
31136
|
+
baseOptions = configuration.baseOptions;
|
|
31137
|
+
}
|
|
31138
|
+
|
|
31139
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
31140
|
+
const localVarHeaderParameter = {} as any;
|
|
31141
|
+
const localVarQueryParameter = {} as any;
|
|
31142
|
+
|
|
31143
|
+
// authentication apiToken required
|
|
31144
|
+
// http bearer authentication required
|
|
31145
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
31146
|
+
|
|
31147
|
+
if (provider !== undefined) {
|
|
31148
|
+
localVarQueryParameter['provider'] = provider;
|
|
31149
|
+
}
|
|
31150
|
+
|
|
31151
|
+
if (status !== undefined) {
|
|
31152
|
+
localVarQueryParameter['status'] = status;
|
|
31153
|
+
}
|
|
31154
|
+
|
|
31155
|
+
|
|
31156
|
+
|
|
31157
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
31158
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
31159
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
31160
|
+
|
|
31161
|
+
return {
|
|
31162
|
+
url: toPathString(localVarUrlObj),
|
|
31163
|
+
options: localVarRequestOptions,
|
|
31164
|
+
};
|
|
31165
|
+
},
|
|
31166
|
+
/**
|
|
31167
|
+
* 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.
|
|
31168
|
+
* @summary Update Git auto-deployment settings
|
|
31169
|
+
* @param {string} username
|
|
31170
|
+
* @param {string} domain Domain name
|
|
31171
|
+
* @param {HostingV1GitUpdateGitAutoDeploymentSettingsRequest} hostingV1GitUpdateGitAutoDeploymentSettingsRequest
|
|
31172
|
+
* @param {*} [options] Override http request option.
|
|
31173
|
+
* @throws {RequiredError}
|
|
31174
|
+
*/
|
|
31175
|
+
updateGitAutoDeploymentSettingsV1: async (username: string, domain: string, hostingV1GitUpdateGitAutoDeploymentSettingsRequest: HostingV1GitUpdateGitAutoDeploymentSettingsRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
31176
|
+
// verify required parameter 'username' is not null or undefined
|
|
31177
|
+
assertParamExists('updateGitAutoDeploymentSettingsV1', 'username', username)
|
|
31178
|
+
// verify required parameter 'domain' is not null or undefined
|
|
31179
|
+
assertParamExists('updateGitAutoDeploymentSettingsV1', 'domain', domain)
|
|
31180
|
+
// verify required parameter 'hostingV1GitUpdateGitAutoDeploymentSettingsRequest' is not null or undefined
|
|
31181
|
+
assertParamExists('updateGitAutoDeploymentSettingsV1', 'hostingV1GitUpdateGitAutoDeploymentSettingsRequest', hostingV1GitUpdateGitAutoDeploymentSettingsRequest)
|
|
31182
|
+
const localVarPath = `/api/hosting/v1/accounts/{username}/websites/{domain}/git/auto-deployments/settings`
|
|
31183
|
+
.replace(`{${"username"}}`, encodeURIComponent(String(username)))
|
|
31184
|
+
.replace(`{${"domain"}}`, encodeURIComponent(String(domain)));
|
|
31185
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
31186
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
31187
|
+
let baseOptions;
|
|
31188
|
+
if (configuration) {
|
|
31189
|
+
baseOptions = configuration.baseOptions;
|
|
31190
|
+
}
|
|
31191
|
+
|
|
31192
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
31193
|
+
const localVarHeaderParameter = {} as any;
|
|
31194
|
+
const localVarQueryParameter = {} as any;
|
|
31195
|
+
|
|
31196
|
+
// authentication apiToken required
|
|
31197
|
+
// http bearer authentication required
|
|
31198
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
31199
|
+
|
|
31200
|
+
|
|
31201
|
+
|
|
31202
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
31203
|
+
|
|
31204
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
31205
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
31206
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
31207
|
+
localVarRequestOptions.data = serializeDataIfNeeded(hostingV1GitUpdateGitAutoDeploymentSettingsRequest, localVarRequestOptions, configuration)
|
|
31208
|
+
|
|
31209
|
+
return {
|
|
31210
|
+
url: toPathString(localVarUrlObj),
|
|
31211
|
+
options: localVarRequestOptions,
|
|
31212
|
+
};
|
|
31213
|
+
},
|
|
31214
|
+
}
|
|
31215
|
+
};
|
|
31216
|
+
|
|
31217
|
+
/**
|
|
31218
|
+
* HostingGitApi - functional programming interface
|
|
31219
|
+
* @export
|
|
31220
|
+
*/
|
|
31221
|
+
export const HostingGitApiFp = function(configuration?: Configuration) {
|
|
31222
|
+
const localVarAxiosParamCreator = HostingGitApiAxiosParamCreator(configuration)
|
|
31223
|
+
return {
|
|
31224
|
+
/**
|
|
31225
|
+
* 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.
|
|
31226
|
+
* @summary Delete Git auto-deployment settings
|
|
31227
|
+
* @param {string} username
|
|
31228
|
+
* @param {string} domain Domain name
|
|
31229
|
+
* @param {*} [options] Override http request option.
|
|
31230
|
+
* @throws {RequiredError}
|
|
31231
|
+
*/
|
|
31232
|
+
async deleteGitAutoDeploymentSettingsV1(username: string, domain: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommonSuccessEmptyResource>> {
|
|
31233
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteGitAutoDeploymentSettingsV1(username, domain, options);
|
|
31234
|
+
const localVarOperationServerBasePath = operationServerMap['HostingGitApi.deleteGitAutoDeploymentSettingsV1']?.[0]?.url;
|
|
31235
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
31236
|
+
},
|
|
31237
|
+
/**
|
|
31238
|
+
* 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`.
|
|
31239
|
+
* @summary Get Git auto-deployment settings
|
|
31240
|
+
* @param {string} username
|
|
31241
|
+
* @param {string} domain Domain name
|
|
31242
|
+
* @param {*} [options] Override http request option.
|
|
31243
|
+
* @throws {RequiredError}
|
|
31244
|
+
*/
|
|
31245
|
+
async getGitAutoDeploymentSettingsV1(username: string, domain: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<HostingV1GitGitAutoDeploymentSettingsResource>> {
|
|
31246
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getGitAutoDeploymentSettingsV1(username, domain, options);
|
|
31247
|
+
const localVarOperationServerBasePath = operationServerMap['HostingGitApi.getGitAutoDeploymentSettingsV1']?.[0]?.url;
|
|
31248
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
31249
|
+
},
|
|
31250
|
+
/**
|
|
31251
|
+
* 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).
|
|
31252
|
+
* @summary List Git installation repositories
|
|
31253
|
+
* @param {string} uuid Git installation UUID from the List Git installations endpoint
|
|
31254
|
+
* @param {*} [options] Override http request option.
|
|
31255
|
+
* @throws {RequiredError}
|
|
31256
|
+
*/
|
|
31257
|
+
async listGitInstallationRepositoriesV1(uuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<HostingV1GitGitRepositoryResource>>> {
|
|
31258
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listGitInstallationRepositoriesV1(uuid, options);
|
|
31259
|
+
const localVarOperationServerBasePath = operationServerMap['HostingGitApi.listGitInstallationRepositoriesV1']?.[0]?.url;
|
|
31260
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
31261
|
+
},
|
|
31262
|
+
/**
|
|
31263
|
+
* 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`.
|
|
31264
|
+
* @summary List Git installations
|
|
31265
|
+
* @param {ListGitInstallationsV1ProviderEnum} [provider] Filter by Git provider
|
|
31266
|
+
* @param {ListGitInstallationsV1StatusEnum} [status] Filter by installation status
|
|
31267
|
+
* @param {*} [options] Override http request option.
|
|
31268
|
+
* @throws {RequiredError}
|
|
31269
|
+
*/
|
|
31270
|
+
async listGitInstallationsV1(provider?: ListGitInstallationsV1ProviderEnum, status?: ListGitInstallationsV1StatusEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<HostingV1GitGitInstallationResource>>> {
|
|
31271
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listGitInstallationsV1(provider, status, options);
|
|
31272
|
+
const localVarOperationServerBasePath = operationServerMap['HostingGitApi.listGitInstallationsV1']?.[0]?.url;
|
|
31273
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
31274
|
+
},
|
|
31275
|
+
/**
|
|
31276
|
+
* 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.
|
|
31277
|
+
* @summary Update Git auto-deployment settings
|
|
31278
|
+
* @param {string} username
|
|
31279
|
+
* @param {string} domain Domain name
|
|
31280
|
+
* @param {HostingV1GitUpdateGitAutoDeploymentSettingsRequest} hostingV1GitUpdateGitAutoDeploymentSettingsRequest
|
|
31281
|
+
* @param {*} [options] Override http request option.
|
|
31282
|
+
* @throws {RequiredError}
|
|
31283
|
+
*/
|
|
31284
|
+
async updateGitAutoDeploymentSettingsV1(username: string, domain: string, hostingV1GitUpdateGitAutoDeploymentSettingsRequest: HostingV1GitUpdateGitAutoDeploymentSettingsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommonSuccessEmptyResource>> {
|
|
31285
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updateGitAutoDeploymentSettingsV1(username, domain, hostingV1GitUpdateGitAutoDeploymentSettingsRequest, options);
|
|
31286
|
+
const localVarOperationServerBasePath = operationServerMap['HostingGitApi.updateGitAutoDeploymentSettingsV1']?.[0]?.url;
|
|
31287
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
31288
|
+
},
|
|
31289
|
+
}
|
|
31290
|
+
};
|
|
31291
|
+
|
|
31292
|
+
/**
|
|
31293
|
+
* HostingGitApi - factory interface
|
|
31294
|
+
* @export
|
|
31295
|
+
*/
|
|
31296
|
+
export const HostingGitApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
31297
|
+
const localVarFp = HostingGitApiFp(configuration)
|
|
31298
|
+
return {
|
|
31299
|
+
/**
|
|
31300
|
+
* 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.
|
|
31301
|
+
* @summary Delete Git auto-deployment settings
|
|
31302
|
+
* @param {string} username
|
|
31303
|
+
* @param {string} domain Domain name
|
|
31304
|
+
* @param {*} [options] Override http request option.
|
|
31305
|
+
* @throws {RequiredError}
|
|
31306
|
+
*/
|
|
31307
|
+
deleteGitAutoDeploymentSettingsV1(username: string, domain: string, options?: RawAxiosRequestConfig): AxiosPromise<CommonSuccessEmptyResource> {
|
|
31308
|
+
return localVarFp.deleteGitAutoDeploymentSettingsV1(username, domain, options).then((request) => request(axios, basePath));
|
|
31309
|
+
},
|
|
31310
|
+
/**
|
|
31311
|
+
* 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`.
|
|
31312
|
+
* @summary Get Git auto-deployment settings
|
|
31313
|
+
* @param {string} username
|
|
31314
|
+
* @param {string} domain Domain name
|
|
31315
|
+
* @param {*} [options] Override http request option.
|
|
31316
|
+
* @throws {RequiredError}
|
|
31317
|
+
*/
|
|
31318
|
+
getGitAutoDeploymentSettingsV1(username: string, domain: string, options?: RawAxiosRequestConfig): AxiosPromise<HostingV1GitGitAutoDeploymentSettingsResource> {
|
|
31319
|
+
return localVarFp.getGitAutoDeploymentSettingsV1(username, domain, options).then((request) => request(axios, basePath));
|
|
31320
|
+
},
|
|
31321
|
+
/**
|
|
31322
|
+
* 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).
|
|
31323
|
+
* @summary List Git installation repositories
|
|
31324
|
+
* @param {string} uuid Git installation UUID from the List Git installations endpoint
|
|
31325
|
+
* @param {*} [options] Override http request option.
|
|
31326
|
+
* @throws {RequiredError}
|
|
31327
|
+
*/
|
|
31328
|
+
listGitInstallationRepositoriesV1(uuid: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<HostingV1GitGitRepositoryResource>> {
|
|
31329
|
+
return localVarFp.listGitInstallationRepositoriesV1(uuid, options).then((request) => request(axios, basePath));
|
|
31330
|
+
},
|
|
31331
|
+
/**
|
|
31332
|
+
* 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`.
|
|
31333
|
+
* @summary List Git installations
|
|
31334
|
+
* @param {ListGitInstallationsV1ProviderEnum} [provider] Filter by Git provider
|
|
31335
|
+
* @param {ListGitInstallationsV1StatusEnum} [status] Filter by installation status
|
|
31336
|
+
* @param {*} [options] Override http request option.
|
|
31337
|
+
* @throws {RequiredError}
|
|
31338
|
+
*/
|
|
31339
|
+
listGitInstallationsV1(provider?: ListGitInstallationsV1ProviderEnum, status?: ListGitInstallationsV1StatusEnum, options?: RawAxiosRequestConfig): AxiosPromise<Array<HostingV1GitGitInstallationResource>> {
|
|
31340
|
+
return localVarFp.listGitInstallationsV1(provider, status, options).then((request) => request(axios, basePath));
|
|
31341
|
+
},
|
|
31342
|
+
/**
|
|
31343
|
+
* 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.
|
|
31344
|
+
* @summary Update Git auto-deployment settings
|
|
31345
|
+
* @param {string} username
|
|
31346
|
+
* @param {string} domain Domain name
|
|
31347
|
+
* @param {HostingV1GitUpdateGitAutoDeploymentSettingsRequest} hostingV1GitUpdateGitAutoDeploymentSettingsRequest
|
|
31348
|
+
* @param {*} [options] Override http request option.
|
|
31349
|
+
* @throws {RequiredError}
|
|
31350
|
+
*/
|
|
31351
|
+
updateGitAutoDeploymentSettingsV1(username: string, domain: string, hostingV1GitUpdateGitAutoDeploymentSettingsRequest: HostingV1GitUpdateGitAutoDeploymentSettingsRequest, options?: RawAxiosRequestConfig): AxiosPromise<CommonSuccessEmptyResource> {
|
|
31352
|
+
return localVarFp.updateGitAutoDeploymentSettingsV1(username, domain, hostingV1GitUpdateGitAutoDeploymentSettingsRequest, options).then((request) => request(axios, basePath));
|
|
31353
|
+
},
|
|
31354
|
+
};
|
|
31355
|
+
};
|
|
31356
|
+
|
|
31357
|
+
/**
|
|
31358
|
+
* HostingGitApi - object-oriented interface
|
|
31359
|
+
* @export
|
|
31360
|
+
* @class HostingGitApi
|
|
31361
|
+
* @extends {BaseAPI}
|
|
31362
|
+
*/
|
|
31363
|
+
export class HostingGitApi extends BaseAPI {
|
|
31364
|
+
/**
|
|
31365
|
+
* 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.
|
|
31366
|
+
* @summary Delete Git auto-deployment settings
|
|
31367
|
+
* @param {string} username
|
|
31368
|
+
* @param {string} domain Domain name
|
|
31369
|
+
* @param {*} [options] Override http request option.
|
|
31370
|
+
* @throws {RequiredError}
|
|
31371
|
+
* @memberof HostingGitApi
|
|
31372
|
+
*/
|
|
31373
|
+
public deleteGitAutoDeploymentSettingsV1(username: string, domain: string, options?: RawAxiosRequestConfig) {
|
|
31374
|
+
return HostingGitApiFp(this.configuration).deleteGitAutoDeploymentSettingsV1(username, domain, options).then((request) => request(this.axios, this.basePath));
|
|
31375
|
+
}
|
|
31376
|
+
|
|
31377
|
+
/**
|
|
31378
|
+
* 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`.
|
|
31379
|
+
* @summary Get Git auto-deployment settings
|
|
31380
|
+
* @param {string} username
|
|
31381
|
+
* @param {string} domain Domain name
|
|
31382
|
+
* @param {*} [options] Override http request option.
|
|
31383
|
+
* @throws {RequiredError}
|
|
31384
|
+
* @memberof HostingGitApi
|
|
31385
|
+
*/
|
|
31386
|
+
public getGitAutoDeploymentSettingsV1(username: string, domain: string, options?: RawAxiosRequestConfig) {
|
|
31387
|
+
return HostingGitApiFp(this.configuration).getGitAutoDeploymentSettingsV1(username, domain, options).then((request) => request(this.axios, this.basePath));
|
|
31388
|
+
}
|
|
31389
|
+
|
|
31390
|
+
/**
|
|
31391
|
+
* 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).
|
|
31392
|
+
* @summary List Git installation repositories
|
|
31393
|
+
* @param {string} uuid Git installation UUID from the List Git installations endpoint
|
|
31394
|
+
* @param {*} [options] Override http request option.
|
|
31395
|
+
* @throws {RequiredError}
|
|
31396
|
+
* @memberof HostingGitApi
|
|
31397
|
+
*/
|
|
31398
|
+
public listGitInstallationRepositoriesV1(uuid: string, options?: RawAxiosRequestConfig) {
|
|
31399
|
+
return HostingGitApiFp(this.configuration).listGitInstallationRepositoriesV1(uuid, options).then((request) => request(this.axios, this.basePath));
|
|
31400
|
+
}
|
|
31401
|
+
|
|
31402
|
+
/**
|
|
31403
|
+
* 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`.
|
|
31404
|
+
* @summary List Git installations
|
|
31405
|
+
* @param {ListGitInstallationsV1ProviderEnum} [provider] Filter by Git provider
|
|
31406
|
+
* @param {ListGitInstallationsV1StatusEnum} [status] Filter by installation status
|
|
31407
|
+
* @param {*} [options] Override http request option.
|
|
31408
|
+
* @throws {RequiredError}
|
|
31409
|
+
* @memberof HostingGitApi
|
|
31410
|
+
*/
|
|
31411
|
+
public listGitInstallationsV1(provider?: ListGitInstallationsV1ProviderEnum, status?: ListGitInstallationsV1StatusEnum, options?: RawAxiosRequestConfig) {
|
|
31412
|
+
return HostingGitApiFp(this.configuration).listGitInstallationsV1(provider, status, options).then((request) => request(this.axios, this.basePath));
|
|
31413
|
+
}
|
|
31414
|
+
|
|
31415
|
+
/**
|
|
31416
|
+
* 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.
|
|
31417
|
+
* @summary Update Git auto-deployment settings
|
|
31418
|
+
* @param {string} username
|
|
31419
|
+
* @param {string} domain Domain name
|
|
31420
|
+
* @param {HostingV1GitUpdateGitAutoDeploymentSettingsRequest} hostingV1GitUpdateGitAutoDeploymentSettingsRequest
|
|
31421
|
+
* @param {*} [options] Override http request option.
|
|
31422
|
+
* @throws {RequiredError}
|
|
31423
|
+
* @memberof HostingGitApi
|
|
31424
|
+
*/
|
|
31425
|
+
public updateGitAutoDeploymentSettingsV1(username: string, domain: string, hostingV1GitUpdateGitAutoDeploymentSettingsRequest: HostingV1GitUpdateGitAutoDeploymentSettingsRequest, options?: RawAxiosRequestConfig) {
|
|
31426
|
+
return HostingGitApiFp(this.configuration).updateGitAutoDeploymentSettingsV1(username, domain, hostingV1GitUpdateGitAutoDeploymentSettingsRequest, options).then((request) => request(this.axios, this.basePath));
|
|
31427
|
+
}
|
|
31428
|
+
}
|
|
31429
|
+
|
|
31430
|
+
/**
|
|
31431
|
+
* @export
|
|
31432
|
+
*/
|
|
31433
|
+
export const ListGitInstallationsV1ProviderEnum = {
|
|
31434
|
+
Github: 'github',
|
|
31435
|
+
Gitlab: 'gitlab',
|
|
31436
|
+
Bitbucket: 'bitbucket'
|
|
31437
|
+
} as const;
|
|
31438
|
+
export type ListGitInstallationsV1ProviderEnum = typeof ListGitInstallationsV1ProviderEnum[keyof typeof ListGitInstallationsV1ProviderEnum];
|
|
31439
|
+
/**
|
|
31440
|
+
* @export
|
|
31441
|
+
*/
|
|
31442
|
+
export const ListGitInstallationsV1StatusEnum = {
|
|
31443
|
+
Pending: 'pending',
|
|
31444
|
+
Active: 'active',
|
|
31445
|
+
Suspended: 'suspended'
|
|
31446
|
+
} as const;
|
|
31447
|
+
export type ListGitInstallationsV1StatusEnum = typeof ListGitInstallationsV1StatusEnum[keyof typeof ListGitInstallationsV1StatusEnum];
|
|
31448
|
+
|
|
31449
|
+
|
|
30670
31450
|
/**
|
|
30671
31451
|
* HostingNodeJSApi - axios parameter creator
|
|
30672
31452
|
* @export
|
|
@@ -31296,7 +32076,7 @@ export const HostingNodeJSApiAxiosParamCreator = function (configuration?: Confi
|
|
|
31296
32076
|
};
|
|
31297
32077
|
},
|
|
31298
32078
|
/**
|
|
31299
|
-
* 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.
|
|
32079
|
+
* 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.
|
|
31300
32080
|
* @summary Start Node.js build
|
|
31301
32081
|
* @param {string} username
|
|
31302
32082
|
* @param {string} domain Domain name
|
|
@@ -31586,7 +32366,7 @@ export const HostingNodeJSApiFp = function(configuration?: Configuration) {
|
|
|
31586
32366
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
31587
32367
|
},
|
|
31588
32368
|
/**
|
|
31589
|
-
* 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.
|
|
32369
|
+
* 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.
|
|
31590
32370
|
* @summary Start Node.js build
|
|
31591
32371
|
* @param {string} username
|
|
31592
32372
|
* @param {string} domain Domain name
|
|
@@ -31782,7 +32562,7 @@ export const HostingNodeJSApiFactory = function (configuration?: Configuration,
|
|
|
31782
32562
|
return localVarFp.restartNodeJsApplicationV1(username, domain, options).then((request) => request(axios, basePath));
|
|
31783
32563
|
},
|
|
31784
32564
|
/**
|
|
31785
|
-
* 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.
|
|
32565
|
+
* 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.
|
|
31786
32566
|
* @summary Start Node.js build
|
|
31787
32567
|
* @param {string} username
|
|
31788
32568
|
* @param {string} domain Domain name
|
|
@@ -32000,7 +32780,7 @@ export class HostingNodeJSApi extends BaseAPI {
|
|
|
32000
32780
|
}
|
|
32001
32781
|
|
|
32002
32782
|
/**
|
|
32003
|
-
* 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.
|
|
32783
|
+
* 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.
|
|
32004
32784
|
* @summary Start Node.js build
|
|
32005
32785
|
* @param {string} username
|
|
32006
32786
|
* @param {string} domain Domain name
|