@pidginhost/sdk 0.2.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/.openapi-generator/FILES +223 -0
- package/.openapi-generator/VERSION +1 -0
- package/.openapi-generator-ignore +23 -0
- package/README.md +727 -0
- package/api.ts +33802 -0
- package/base.ts +62 -0
- package/common.ts +128 -0
- package/configuration.ts +121 -0
- package/dist/api.d.ts +15244 -0
- package/dist/api.js +30223 -0
- package/dist/base.d.ts +42 -0
- package/dist/base.js +46 -0
- package/dist/common.d.ts +35 -0
- package/dist/common.js +140 -0
- package/dist/configuration.d.ts +98 -0
- package/dist/configuration.js +44 -0
- package/dist/esm/api.d.ts +15244 -0
- package/dist/esm/api.js +30179 -0
- package/dist/esm/base.d.ts +42 -0
- package/dist/esm/base.js +41 -0
- package/dist/esm/common.d.ts +35 -0
- package/dist/esm/common.js +127 -0
- package/dist/esm/configuration.d.ts +98 -0
- package/dist/esm/configuration.js +40 -0
- package/dist/esm/index.d.ts +14 -0
- package/dist/esm/index.js +16 -0
- package/dist/esm/pidginhost.d.ts +8 -0
- package/dist/esm/pidginhost.js +13 -0
- package/dist/index.d.ts +14 -0
- package/dist/index.js +34 -0
- package/dist/pidginhost.d.ts +8 -0
- package/dist/pidginhost.js +17 -0
- package/docs/APITokenCreate.md +28 -0
- package/docs/APITokenList.md +32 -0
- package/docs/AccountApi.md +1999 -0
- package/docs/ActivateFreeDNS.md +24 -0
- package/docs/ActivateFreeDNSResponse.md +24 -0
- package/docs/ActivityLogEntry.md +22 -0
- package/docs/ActivityLogResponse.md +20 -0
- package/docs/AddServerResponse.md +20 -0
- package/docs/Address.md +34 -0
- package/docs/AttachIPv4.md +20 -0
- package/docs/AttachIPv6.md +20 -0
- package/docs/AttachVolume.md +20 -0
- package/docs/BillingApi.md +1885 -0
- package/docs/CancelServiceResponse.md +22 -0
- package/docs/ChangeBillingCycle.md +20 -0
- package/docs/ChangeBillingCycleResponse.md +22 -0
- package/docs/ChangeCompany.md +20 -0
- package/docs/ChangeCompanyResponse.md +22 -0
- package/docs/ChangePassword.md +20 -0
- package/docs/CheckAvailability.md +20 -0
- package/docs/CloudApi.md +8433 -0
- package/docs/ClusterAdd.md +32 -0
- package/docs/ClusterAddResponse.md +20 -0
- package/docs/ClusterDetail.md +48 -0
- package/docs/ClusterPackage.md +24 -0
- package/docs/ClusterType.md +26 -0
- package/docs/ClusterTypeEnum.md +11 -0
- package/docs/Company.md +36 -0
- package/docs/ConnectVMRequest.md +20 -0
- package/docs/ConnectVMResponse.md +22 -0
- package/docs/ConnectedVM.md +24 -0
- package/docs/ConnectedVMsResponse.md +20 -0
- package/docs/ConsoleToken.md +22 -0
- package/docs/ContactTypeEnum.md +15 -0
- package/docs/ContactsUpdate.md +22 -0
- package/docs/ContactsUpdateResponse.md +20 -0
- package/docs/CountryEnum.md +515 -0
- package/docs/DNSRecord.md +53 -0
- package/docs/DNSRecordCreate.md +53 -0
- package/docs/DNSRecordCreateTypeEnum.md +21 -0
- package/docs/DNSRecordMutateResponse.md +22 -0
- package/docs/DeactivateFreeDNS.md +22 -0
- package/docs/DeactivateFreeDNSResponse.md +20 -0
- package/docs/DedicatedApi.md +551 -0
- package/docs/DedicatedRDNS.md +22 -0
- package/docs/DedicatedServer.md +39 -0
- package/docs/DeleteRecord.md +20 -0
- package/docs/DeleteRecordResponse.md +22 -0
- package/docs/Department.md +22 -0
- package/docs/Deposit.md +32 -0
- package/docs/DepositCreate.md +20 -0
- package/docs/DepositStatusEnum.md +15 -0
- package/docs/DestroyProtection.md +20 -0
- package/docs/DetachIPv4.md +20 -0
- package/docs/DetachIPv4Response.md +20 -0
- package/docs/DetachIPv6.md +20 -0
- package/docs/DetachIPv6Response.md +20 -0
- package/docs/DetachVolume.md +20 -0
- package/docs/DisconnectVMRequest.md +20 -0
- package/docs/DisconnectVMResponse.md +22 -0
- package/docs/Domain.md +42 -0
- package/docs/DomainApi.md +2047 -0
- package/docs/DomainCancelResponse.md +22 -0
- package/docs/DomainCreate.md +24 -0
- package/docs/DomainRegistrant.md +44 -0
- package/docs/EmailHistory.md +28 -0
- package/docs/FeatureUpgradeRequest.md +22 -0
- package/docs/FeatureUpgradeResponse.md +22 -0
- package/docs/FeaturesEnum.md +17 -0
- package/docs/FirewallRule.md +42 -0
- package/docs/FirewallRuleDirectionEnum.md +11 -0
- package/docs/FirewallRulesSet.md +28 -0
- package/docs/FirewallRulesSetStatusEnum.md +13 -0
- package/docs/FreeDNSDomain.md +24 -0
- package/docs/FreednsApi.md +655 -0
- package/docs/FundsBalanceResponse.md +26 -0
- package/docs/FundsLog.md +30 -0
- package/docs/FwPolicyOutEnum.md +13 -0
- package/docs/HTTPRoute.md +45 -0
- package/docs/HostingApi.md +327 -0
- package/docs/HostingChangePasswordResponse.md +20 -0
- package/docs/HostingService.md +39 -0
- package/docs/InvoiceDetail.md +50 -0
- package/docs/InvoiceList.md +40 -0
- package/docs/KubeUpgradeResponse.md +20 -0
- package/docs/KubeVersionEnum.md +13 -0
- package/docs/KubernetesApi.md +6209 -0
- package/docs/LBFirewallRule.md +44 -0
- package/docs/LBFirewallRuleActionEnum.md +13 -0
- package/docs/LBFirewallRuleDirectionEnum.md +11 -0
- package/docs/LowBalanceSettings.md +24 -0
- package/docs/NameserversUpdate.md +20 -0
- package/docs/NameserversUpdateResponse.md +20 -0
- package/docs/NodeMetricsResponse.md +32 -0
- package/docs/NodeRRDResponse.md +22 -0
- package/docs/NotificationSettingsResponse.md +26 -0
- package/docs/OSImage.md +28 -0
- package/docs/OperationEnum.md +27 -0
- package/docs/PaginatedAPITokenListList.md +26 -0
- package/docs/PaginatedClusterDetailList.md +26 -0
- package/docs/PaginatedClusterTypeList.md +26 -0
- package/docs/PaginatedCompanyList.md +26 -0
- package/docs/PaginatedDedicatedServerList.md +26 -0
- package/docs/PaginatedDepositList.md +26 -0
- package/docs/PaginatedDomainList.md +26 -0
- package/docs/PaginatedDomainRegistrantList.md +26 -0
- package/docs/PaginatedEmailHistoryList.md +26 -0
- package/docs/PaginatedFundsLogList.md +26 -0
- package/docs/PaginatedHostingServiceList.md +26 -0
- package/docs/PaginatedInvoiceListList.md +26 -0
- package/docs/PaginatedLBFirewallRuleList.md +26 -0
- package/docs/PaginatedOSImageList.md +26 -0
- package/docs/PaginatedPrivateNetworkList.md +26 -0
- package/docs/PaginatedPublicIPv4List.md +26 -0
- package/docs/PaginatedPublicIPv6List.md +26 -0
- package/docs/PaginatedResourcePoolList.md +26 -0
- package/docs/PaginatedResourcePoolNodeList.md +26 -0
- package/docs/PaginatedSSHKeyList.md +26 -0
- package/docs/PaginatedServerList.md +26 -0
- package/docs/PaginatedServerProductList.md +26 -0
- package/docs/PaginatedServiceListList.md +26 -0
- package/docs/PaginatedSnapshotList.md +26 -0
- package/docs/PaginatedStorageProductList.md +26 -0
- package/docs/PaginatedSubscriptionList.md +26 -0
- package/docs/PaginatedTLDList.md +26 -0
- package/docs/PaginatedTicketListList.md +26 -0
- package/docs/PatchedClusterDetail.md +48 -0
- package/docs/PatchedCompany.md +36 -0
- package/docs/PatchedDomain.md +42 -0
- package/docs/PatchedDomainRegistrant.md +44 -0
- package/docs/PatchedFirewallRule.md +42 -0
- package/docs/PatchedFirewallRulesSet.md +28 -0
- package/docs/PatchedHTTPRoute.md +45 -0
- package/docs/PatchedLBFirewallRule.md +44 -0
- package/docs/PatchedPrivateNetwork.md +30 -0
- package/docs/PatchedProfile.md +26 -0
- package/docs/PatchedResourcePool.md +28 -0
- package/docs/PatchedSSHKey.md +26 -0
- package/docs/PatchedTCPRoute.md +41 -0
- package/docs/PatchedUDPRoute.md +41 -0
- package/docs/PatchedVolume.md +32 -0
- package/docs/PayWithFundsResponse.md +22 -0
- package/docs/PowerAction.md +20 -0
- package/docs/PowerActionActionEnum.md +15 -0
- package/docs/PowerActionResponse.md +20 -0
- package/docs/PowerManagement.md +20 -0
- package/docs/PowerManagementRequest.md +20 -0
- package/docs/PowerManagementRequestActionEnum.md +15 -0
- package/docs/Priority3cdEnum.md +13 -0
- package/docs/PrivateNetwork.md +30 -0
- package/docs/PrivateNetworkAddHost.md +22 -0
- package/docs/PrivateNetworkRemoveHost.md +20 -0
- package/docs/Profile.md +26 -0
- package/docs/PublicIPv4.md +32 -0
- package/docs/PublicIPv6.md +32 -0
- package/docs/PublicInterface.md +30 -0
- package/docs/RDNSUpdateResponse.md +20 -0
- package/docs/Reinstall.md +20 -0
- package/docs/ReinstallResponse.md +20 -0
- package/docs/RemoveServerResponse.md +20 -0
- package/docs/RenewDomain.md +20 -0
- package/docs/ResourcePool.md +28 -0
- package/docs/ResourcePoolAdd.md +22 -0
- package/docs/ResourcePoolAddResponse.md +20 -0
- package/docs/ResourcePoolNode.md +24 -0
- package/docs/RetryProvision.md +20 -0
- package/docs/ReverseDNS.md +20 -0
- package/docs/SSHKey.md +26 -0
- package/docs/SchemaApi.md +117 -0
- package/docs/ScopeEnum.md +11 -0
- package/docs/Server.md +42 -0
- package/docs/ServerAdd.md +58 -0
- package/docs/ServerAddResponse.md +20 -0
- package/docs/ServerProduct.md +24 -0
- package/docs/ServerProductUpgrade.md +20 -0
- package/docs/ServerUpgradeResponse.md +20 -0
- package/docs/ServerUsageResponse.md +28 -0
- package/docs/Service.md +40 -0
- package/docs/ServiceList.md +36 -0
- package/docs/Snapshot.md +30 -0
- package/docs/SnapshotCreate.md +24 -0
- package/docs/SnapshotCreateQueued.md +20 -0
- package/docs/SnapshotDeleteQueued.md +20 -0
- package/docs/SnapshotRollbackQueued.md +20 -0
- package/docs/SourceEnum.md +11 -0
- package/docs/Status03cEnum.md +21 -0
- package/docs/Status63aEnum.md +23 -0
- package/docs/StatusA57Enum.md +31 -0
- package/docs/StatusEf2Enum.md +15 -0
- package/docs/StorageProduct.md +34 -0
- package/docs/Subscription.md +34 -0
- package/docs/SubscriptionStatusEnum.md +15 -0
- package/docs/SupportApi.md +841 -0
- package/docs/TCPRoute.md +41 -0
- package/docs/TLD.md +38 -0
- package/docs/TalosUpgradeResponse.md +20 -0
- package/docs/ThresholdTypeEnum.md +13 -0
- package/docs/TicketCloseResponse.md +22 -0
- package/docs/TicketCreate.md +30 -0
- package/docs/TicketCreatePriorityEnum.md +13 -0
- package/docs/TicketDetail.md +34 -0
- package/docs/TicketList.md +32 -0
- package/docs/TicketReopenResponse.md +22 -0
- package/docs/TicketReply.md +22 -0
- package/docs/TicketReplyResponse.md +20 -0
- package/docs/ToggleAutoPaymentResponse.md +22 -0
- package/docs/TransferRoDomain.md +22 -0
- package/docs/Type2faEnum.md +11 -0
- package/docs/UDPRoute.md +41 -0
- package/docs/Volume.md +32 -0
- package/git_push.sh +57 -0
- package/index.ts +19 -0
- package/package.json +33 -0
- package/pidginhost.ts +20 -0
- package/tsconfig.esm.json +7 -0
- package/tsconfig.json +18 -0
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# FwPolicyOutEnum
|
|
2
|
+
|
|
3
|
+
* `ACCEPT` - ACCEPT * `DROP` - DROP * `REJECT` - REJECT
|
|
4
|
+
|
|
5
|
+
## Enum
|
|
6
|
+
|
|
7
|
+
* `Accept` (value: `'ACCEPT'`)
|
|
8
|
+
|
|
9
|
+
* `Drop` (value: `'DROP'`)
|
|
10
|
+
|
|
11
|
+
* `Reject` (value: `'REJECT'`)
|
|
12
|
+
|
|
13
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# HTTPRoute
|
|
2
|
+
|
|
3
|
+
Serializer for HTTPRoute resources with automatic certificate issuance.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **number** | | [readonly] [default to undefined]
|
|
10
|
+
**name** | **string** | | [default to undefined]
|
|
11
|
+
**namespace** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**hostnames** | **Array<string>** | List of hostnames to route (e.g., [\"example.com\", \"www.example.com\"]) | [default to undefined]
|
|
13
|
+
**backend_service_name** | **string** | Name of the backend Kubernetes Service | [default to undefined]
|
|
14
|
+
**backend_service_port** | **number** | Port of the backend Service | [default to undefined]
|
|
15
|
+
**backend_namespace** | **string** | Namespace of the backend Service | [optional] [default to 'default']
|
|
16
|
+
**path_prefix** | **string** | Path prefix to match (default: /) | [optional] [default to '/']
|
|
17
|
+
**enable_tls** | **boolean** | Enable TLS termination with automatic certificate issuance | [optional] [default to true]
|
|
18
|
+
**status_ready** | **boolean** | | [readonly] [default to undefined]
|
|
19
|
+
**status_message** | **string** | | [readonly] [default to undefined]
|
|
20
|
+
**created** | **string** | | [readonly] [default to undefined]
|
|
21
|
+
**updated** | **string** | | [readonly] [default to undefined]
|
|
22
|
+
|
|
23
|
+
## Example
|
|
24
|
+
|
|
25
|
+
```typescript
|
|
26
|
+
import { HTTPRoute } from '@pidginhost/sdk';
|
|
27
|
+
|
|
28
|
+
const instance: HTTPRoute = {
|
|
29
|
+
id,
|
|
30
|
+
name,
|
|
31
|
+
namespace,
|
|
32
|
+
hostnames,
|
|
33
|
+
backend_service_name,
|
|
34
|
+
backend_service_port,
|
|
35
|
+
backend_namespace,
|
|
36
|
+
path_prefix,
|
|
37
|
+
enable_tls,
|
|
38
|
+
status_ready,
|
|
39
|
+
status_message,
|
|
40
|
+
created,
|
|
41
|
+
updated,
|
|
42
|
+
};
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,327 @@
|
|
|
1
|
+
# HostingApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://www.pidginhost.com*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**hostingHostingChangePasswordCreate**](#hostinghostingchangepasswordcreate) | **POST** /api/hosting/hosting/{id}/change-password/ | |
|
|
8
|
+
|[**hostingHostingChangePasswordCreate2**](#hostinghostingchangepasswordcreate2) | **POST** /api/v1/hosting/hosting/{id}/change-password/ | |
|
|
9
|
+
|[**hostingHostingList**](#hostinghostinglist) | **GET** /api/hosting/hosting/ | |
|
|
10
|
+
|[**hostingHostingList2**](#hostinghostinglist2) | **GET** /api/v1/hosting/hosting/ | |
|
|
11
|
+
|[**hostingHostingRetrieve**](#hostinghostingretrieve) | **GET** /api/hosting/hosting/{id}/ | |
|
|
12
|
+
|[**hostingHostingRetrieve2**](#hostinghostingretrieve2) | **GET** /api/v1/hosting/hosting/{id}/ | |
|
|
13
|
+
|
|
14
|
+
# **hostingHostingChangePasswordCreate**
|
|
15
|
+
> HostingChangePasswordResponse hostingHostingChangePasswordCreate(changePassword)
|
|
16
|
+
|
|
17
|
+
Change the cPanel password for this hosting service.
|
|
18
|
+
|
|
19
|
+
### Example
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import {
|
|
23
|
+
HostingApi,
|
|
24
|
+
Configuration,
|
|
25
|
+
ChangePassword
|
|
26
|
+
} from '@pidginhost/sdk';
|
|
27
|
+
|
|
28
|
+
const configuration = new Configuration();
|
|
29
|
+
const apiInstance = new HostingApi(configuration);
|
|
30
|
+
|
|
31
|
+
let id: string; // (default to undefined)
|
|
32
|
+
let changePassword: ChangePassword; //
|
|
33
|
+
|
|
34
|
+
const { status, data } = await apiInstance.hostingHostingChangePasswordCreate(
|
|
35
|
+
id,
|
|
36
|
+
changePassword
|
|
37
|
+
);
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
### Parameters
|
|
41
|
+
|
|
42
|
+
|Name | Type | Description | Notes|
|
|
43
|
+
|------------- | ------------- | ------------- | -------------|
|
|
44
|
+
| **changePassword** | **ChangePassword**| | |
|
|
45
|
+
| **id** | [**string**] | | defaults to undefined|
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
### Return type
|
|
49
|
+
|
|
50
|
+
**HostingChangePasswordResponse**
|
|
51
|
+
|
|
52
|
+
### Authorization
|
|
53
|
+
|
|
54
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
55
|
+
|
|
56
|
+
### HTTP request headers
|
|
57
|
+
|
|
58
|
+
- **Content-Type**: application/json
|
|
59
|
+
- **Accept**: application/json
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
### HTTP response details
|
|
63
|
+
| Status code | Description | Response headers |
|
|
64
|
+
|-------------|-------------|------------------|
|
|
65
|
+
|**200** | | - |
|
|
66
|
+
|
|
67
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
68
|
+
|
|
69
|
+
# **hostingHostingChangePasswordCreate2**
|
|
70
|
+
> HostingChangePasswordResponse hostingHostingChangePasswordCreate2(changePassword)
|
|
71
|
+
|
|
72
|
+
Change the cPanel password for this hosting service.
|
|
73
|
+
|
|
74
|
+
### Example
|
|
75
|
+
|
|
76
|
+
```typescript
|
|
77
|
+
import {
|
|
78
|
+
HostingApi,
|
|
79
|
+
Configuration,
|
|
80
|
+
ChangePassword
|
|
81
|
+
} from '@pidginhost/sdk';
|
|
82
|
+
|
|
83
|
+
const configuration = new Configuration();
|
|
84
|
+
const apiInstance = new HostingApi(configuration);
|
|
85
|
+
|
|
86
|
+
let id: string; // (default to undefined)
|
|
87
|
+
let changePassword: ChangePassword; //
|
|
88
|
+
|
|
89
|
+
const { status, data } = await apiInstance.hostingHostingChangePasswordCreate2(
|
|
90
|
+
id,
|
|
91
|
+
changePassword
|
|
92
|
+
);
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
### Parameters
|
|
96
|
+
|
|
97
|
+
|Name | Type | Description | Notes|
|
|
98
|
+
|------------- | ------------- | ------------- | -------------|
|
|
99
|
+
| **changePassword** | **ChangePassword**| | |
|
|
100
|
+
| **id** | [**string**] | | defaults to undefined|
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
### Return type
|
|
104
|
+
|
|
105
|
+
**HostingChangePasswordResponse**
|
|
106
|
+
|
|
107
|
+
### Authorization
|
|
108
|
+
|
|
109
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
110
|
+
|
|
111
|
+
### HTTP request headers
|
|
112
|
+
|
|
113
|
+
- **Content-Type**: application/json
|
|
114
|
+
- **Accept**: application/json
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
### HTTP response details
|
|
118
|
+
| Status code | Description | Response headers |
|
|
119
|
+
|-------------|-------------|------------------|
|
|
120
|
+
|**200** | | - |
|
|
121
|
+
|
|
122
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
123
|
+
|
|
124
|
+
# **hostingHostingList**
|
|
125
|
+
> PaginatedHostingServiceList hostingHostingList()
|
|
126
|
+
|
|
127
|
+
List and manage cPanel/shared hosting services.
|
|
128
|
+
|
|
129
|
+
### Example
|
|
130
|
+
|
|
131
|
+
```typescript
|
|
132
|
+
import {
|
|
133
|
+
HostingApi,
|
|
134
|
+
Configuration
|
|
135
|
+
} from '@pidginhost/sdk';
|
|
136
|
+
|
|
137
|
+
const configuration = new Configuration();
|
|
138
|
+
const apiInstance = new HostingApi(configuration);
|
|
139
|
+
|
|
140
|
+
let page: number; //A page number within the paginated result set. (optional) (default to undefined)
|
|
141
|
+
|
|
142
|
+
const { status, data } = await apiInstance.hostingHostingList(
|
|
143
|
+
page
|
|
144
|
+
);
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
### Parameters
|
|
148
|
+
|
|
149
|
+
|Name | Type | Description | Notes|
|
|
150
|
+
|------------- | ------------- | ------------- | -------------|
|
|
151
|
+
| **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
### Return type
|
|
155
|
+
|
|
156
|
+
**PaginatedHostingServiceList**
|
|
157
|
+
|
|
158
|
+
### Authorization
|
|
159
|
+
|
|
160
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
161
|
+
|
|
162
|
+
### HTTP request headers
|
|
163
|
+
|
|
164
|
+
- **Content-Type**: Not defined
|
|
165
|
+
- **Accept**: application/json
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
### HTTP response details
|
|
169
|
+
| Status code | Description | Response headers |
|
|
170
|
+
|-------------|-------------|------------------|
|
|
171
|
+
|**200** | | - |
|
|
172
|
+
|
|
173
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
174
|
+
|
|
175
|
+
# **hostingHostingList2**
|
|
176
|
+
> PaginatedHostingServiceList hostingHostingList2()
|
|
177
|
+
|
|
178
|
+
List and manage cPanel/shared hosting services.
|
|
179
|
+
|
|
180
|
+
### Example
|
|
181
|
+
|
|
182
|
+
```typescript
|
|
183
|
+
import {
|
|
184
|
+
HostingApi,
|
|
185
|
+
Configuration
|
|
186
|
+
} from '@pidginhost/sdk';
|
|
187
|
+
|
|
188
|
+
const configuration = new Configuration();
|
|
189
|
+
const apiInstance = new HostingApi(configuration);
|
|
190
|
+
|
|
191
|
+
let page: number; //A page number within the paginated result set. (optional) (default to undefined)
|
|
192
|
+
|
|
193
|
+
const { status, data } = await apiInstance.hostingHostingList2(
|
|
194
|
+
page
|
|
195
|
+
);
|
|
196
|
+
```
|
|
197
|
+
|
|
198
|
+
### Parameters
|
|
199
|
+
|
|
200
|
+
|Name | Type | Description | Notes|
|
|
201
|
+
|------------- | ------------- | ------------- | -------------|
|
|
202
|
+
| **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
### Return type
|
|
206
|
+
|
|
207
|
+
**PaginatedHostingServiceList**
|
|
208
|
+
|
|
209
|
+
### Authorization
|
|
210
|
+
|
|
211
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
212
|
+
|
|
213
|
+
### HTTP request headers
|
|
214
|
+
|
|
215
|
+
- **Content-Type**: Not defined
|
|
216
|
+
- **Accept**: application/json
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
### HTTP response details
|
|
220
|
+
| Status code | Description | Response headers |
|
|
221
|
+
|-------------|-------------|------------------|
|
|
222
|
+
|**200** | | - |
|
|
223
|
+
|
|
224
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
225
|
+
|
|
226
|
+
# **hostingHostingRetrieve**
|
|
227
|
+
> HostingService hostingHostingRetrieve()
|
|
228
|
+
|
|
229
|
+
List and manage cPanel/shared hosting services.
|
|
230
|
+
|
|
231
|
+
### Example
|
|
232
|
+
|
|
233
|
+
```typescript
|
|
234
|
+
import {
|
|
235
|
+
HostingApi,
|
|
236
|
+
Configuration
|
|
237
|
+
} from '@pidginhost/sdk';
|
|
238
|
+
|
|
239
|
+
const configuration = new Configuration();
|
|
240
|
+
const apiInstance = new HostingApi(configuration);
|
|
241
|
+
|
|
242
|
+
let id: string; // (default to undefined)
|
|
243
|
+
|
|
244
|
+
const { status, data } = await apiInstance.hostingHostingRetrieve(
|
|
245
|
+
id
|
|
246
|
+
);
|
|
247
|
+
```
|
|
248
|
+
|
|
249
|
+
### Parameters
|
|
250
|
+
|
|
251
|
+
|Name | Type | Description | Notes|
|
|
252
|
+
|------------- | ------------- | ------------- | -------------|
|
|
253
|
+
| **id** | [**string**] | | defaults to undefined|
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
### Return type
|
|
257
|
+
|
|
258
|
+
**HostingService**
|
|
259
|
+
|
|
260
|
+
### Authorization
|
|
261
|
+
|
|
262
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
263
|
+
|
|
264
|
+
### HTTP request headers
|
|
265
|
+
|
|
266
|
+
- **Content-Type**: Not defined
|
|
267
|
+
- **Accept**: application/json
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
### HTTP response details
|
|
271
|
+
| Status code | Description | Response headers |
|
|
272
|
+
|-------------|-------------|------------------|
|
|
273
|
+
|**200** | | - |
|
|
274
|
+
|
|
275
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
276
|
+
|
|
277
|
+
# **hostingHostingRetrieve2**
|
|
278
|
+
> HostingService hostingHostingRetrieve2()
|
|
279
|
+
|
|
280
|
+
List and manage cPanel/shared hosting services.
|
|
281
|
+
|
|
282
|
+
### Example
|
|
283
|
+
|
|
284
|
+
```typescript
|
|
285
|
+
import {
|
|
286
|
+
HostingApi,
|
|
287
|
+
Configuration
|
|
288
|
+
} from '@pidginhost/sdk';
|
|
289
|
+
|
|
290
|
+
const configuration = new Configuration();
|
|
291
|
+
const apiInstance = new HostingApi(configuration);
|
|
292
|
+
|
|
293
|
+
let id: string; // (default to undefined)
|
|
294
|
+
|
|
295
|
+
const { status, data } = await apiInstance.hostingHostingRetrieve2(
|
|
296
|
+
id
|
|
297
|
+
);
|
|
298
|
+
```
|
|
299
|
+
|
|
300
|
+
### Parameters
|
|
301
|
+
|
|
302
|
+
|Name | Type | Description | Notes|
|
|
303
|
+
|------------- | ------------- | ------------- | -------------|
|
|
304
|
+
| **id** | [**string**] | | defaults to undefined|
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
### Return type
|
|
308
|
+
|
|
309
|
+
**HostingService**
|
|
310
|
+
|
|
311
|
+
### Authorization
|
|
312
|
+
|
|
313
|
+
[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
|
|
314
|
+
|
|
315
|
+
### HTTP request headers
|
|
316
|
+
|
|
317
|
+
- **Content-Type**: Not defined
|
|
318
|
+
- **Accept**: application/json
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
### HTTP response details
|
|
322
|
+
| Status code | Description | Response headers |
|
|
323
|
+
|-------------|-------------|------------------|
|
|
324
|
+
|**200** | | - |
|
|
325
|
+
|
|
326
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
327
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# HostingChangePasswordResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**message** | **string** | | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { HostingChangePasswordResponse } from '@pidginhost/sdk';
|
|
14
|
+
|
|
15
|
+
const instance: HostingChangePasswordResponse = {
|
|
16
|
+
message,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# HostingService
|
|
2
|
+
|
|
3
|
+
Read-only serializer for shared/cPanel hosting services.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **number** | | [readonly] [default to undefined]
|
|
10
|
+
**hostname** | **string** | | [readonly] [default to undefined]
|
|
11
|
+
**status** | [**Status63aEnum**](Status63aEnum.md) | | [readonly] [default to undefined]
|
|
12
|
+
**price** | **string** | Euro without TVA | [readonly] [default to undefined]
|
|
13
|
+
**next_invoice** | **string** | | [readonly] [default to undefined]
|
|
14
|
+
**created** | **string** | | [readonly] [default to undefined]
|
|
15
|
+
**billing_cycle** | **string** | | [readonly] [default to undefined]
|
|
16
|
+
**package_name** | **string** | | [readonly] [default to undefined]
|
|
17
|
+
**node_url** | **string** | | [readonly] [default to undefined]
|
|
18
|
+
**username** | **string** | | [readonly] [default to undefined]
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
```typescript
|
|
23
|
+
import { HostingService } from '@pidginhost/sdk';
|
|
24
|
+
|
|
25
|
+
const instance: HostingService = {
|
|
26
|
+
id,
|
|
27
|
+
hostname,
|
|
28
|
+
status,
|
|
29
|
+
price,
|
|
30
|
+
next_invoice,
|
|
31
|
+
created,
|
|
32
|
+
billing_cycle,
|
|
33
|
+
package_name,
|
|
34
|
+
node_url,
|
|
35
|
+
username,
|
|
36
|
+
};
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# InvoiceDetail
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **number** | | [readonly] [default to undefined]
|
|
9
|
+
**number_proforma** | **string** | | [readonly] [default to undefined]
|
|
10
|
+
**number_fiscal** | **string** | | [readonly] [default to undefined]
|
|
11
|
+
**status** | [**Status03cEnum**](Status03cEnum.md) | | [readonly] [default to undefined]
|
|
12
|
+
**subtotal** | **string** | | [readonly] [default to undefined]
|
|
13
|
+
**vat_value** | **string** | | [readonly] [default to undefined]
|
|
14
|
+
**vat_percentage** | **number** | | [readonly] [default to undefined]
|
|
15
|
+
**total** | **string** | | [readonly] [default to undefined]
|
|
16
|
+
**invoice_date** | **string** | | [readonly] [default to undefined]
|
|
17
|
+
**due_date** | **string** | | [readonly] [default to undefined]
|
|
18
|
+
**payment_date** | **string** | | [readonly] [default to undefined]
|
|
19
|
+
**product_info** | **any** | | [readonly] [default to undefined]
|
|
20
|
+
**client_info** | **any** | | [readonly] [default to undefined]
|
|
21
|
+
**invoice_info** | **any** | | [readonly] [default to undefined]
|
|
22
|
+
**payment_method** | **string** | | [readonly] [default to undefined]
|
|
23
|
+
**services** | **string** | | [readonly] [default to undefined]
|
|
24
|
+
|
|
25
|
+
## Example
|
|
26
|
+
|
|
27
|
+
```typescript
|
|
28
|
+
import { InvoiceDetail } from '@pidginhost/sdk';
|
|
29
|
+
|
|
30
|
+
const instance: InvoiceDetail = {
|
|
31
|
+
id,
|
|
32
|
+
number_proforma,
|
|
33
|
+
number_fiscal,
|
|
34
|
+
status,
|
|
35
|
+
subtotal,
|
|
36
|
+
vat_value,
|
|
37
|
+
vat_percentage,
|
|
38
|
+
total,
|
|
39
|
+
invoice_date,
|
|
40
|
+
due_date,
|
|
41
|
+
payment_date,
|
|
42
|
+
product_info,
|
|
43
|
+
client_info,
|
|
44
|
+
invoice_info,
|
|
45
|
+
payment_method,
|
|
46
|
+
services,
|
|
47
|
+
};
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# InvoiceList
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **number** | | [readonly] [default to undefined]
|
|
9
|
+
**number_proforma** | **string** | | [readonly] [default to undefined]
|
|
10
|
+
**number_fiscal** | **string** | | [readonly] [default to undefined]
|
|
11
|
+
**status** | [**Status03cEnum**](Status03cEnum.md) | | [readonly] [default to undefined]
|
|
12
|
+
**subtotal** | **string** | | [readonly] [default to undefined]
|
|
13
|
+
**vat_value** | **string** | | [readonly] [default to undefined]
|
|
14
|
+
**vat_percentage** | **number** | | [readonly] [default to undefined]
|
|
15
|
+
**total** | **string** | | [readonly] [default to undefined]
|
|
16
|
+
**invoice_date** | **string** | | [readonly] [default to undefined]
|
|
17
|
+
**due_date** | **string** | | [readonly] [default to undefined]
|
|
18
|
+
**payment_date** | **string** | | [readonly] [default to undefined]
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
```typescript
|
|
23
|
+
import { InvoiceList } from '@pidginhost/sdk';
|
|
24
|
+
|
|
25
|
+
const instance: InvoiceList = {
|
|
26
|
+
id,
|
|
27
|
+
number_proforma,
|
|
28
|
+
number_fiscal,
|
|
29
|
+
status,
|
|
30
|
+
subtotal,
|
|
31
|
+
vat_value,
|
|
32
|
+
vat_percentage,
|
|
33
|
+
total,
|
|
34
|
+
invoice_date,
|
|
35
|
+
due_date,
|
|
36
|
+
payment_date,
|
|
37
|
+
};
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# KubeUpgradeResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**status** | **string** | | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { KubeUpgradeResponse } from '@pidginhost/sdk';
|
|
14
|
+
|
|
15
|
+
const instance: KubeUpgradeResponse = {
|
|
16
|
+
status,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# KubeVersionEnum
|
|
2
|
+
|
|
3
|
+
* `1.33.8` - 1.33.8 * `1.34.4` - 1.34.4 * `1.35.1` - 1.35.1
|
|
4
|
+
|
|
5
|
+
## Enum
|
|
6
|
+
|
|
7
|
+
* `_1338` (value: `'1.33.8'`)
|
|
8
|
+
|
|
9
|
+
* `_1344` (value: `'1.34.4'`)
|
|
10
|
+
|
|
11
|
+
* `_1351` (value: `'1.35.1'`)
|
|
12
|
+
|
|
13
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|