@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,24 @@
|
|
|
1
|
+
# ActivateFreeDNS
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**domain** | **string** | Domain name or primary key of the domain to activate. | [default to undefined]
|
|
9
|
+
**source** | [**SourceEnum**](SourceEnum.md) | \'internal\' for domains purchased on PidginHost, \'external\' for user-added domains. * `internal` - Internal * `external` - External | [default to undefined]
|
|
10
|
+
**ip** | **string** | IPv4 address to use as the default A record for the zone. | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { ActivateFreeDNS } from '@pidginhost/sdk';
|
|
16
|
+
|
|
17
|
+
const instance: ActivateFreeDNS = {
|
|
18
|
+
domain,
|
|
19
|
+
source,
|
|
20
|
+
ip,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[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,24 @@
|
|
|
1
|
+
# ActivateFreeDNSResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**message** | **string** | | [default to undefined]
|
|
9
|
+
**domain** | **string** | | [default to undefined]
|
|
10
|
+
**source** | **string** | | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { ActivateFreeDNSResponse } from '@pidginhost/sdk';
|
|
16
|
+
|
|
17
|
+
const instance: ActivateFreeDNSResponse = {
|
|
18
|
+
message,
|
|
19
|
+
domain,
|
|
20
|
+
source,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[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,22 @@
|
|
|
1
|
+
# ActivityLogEntry
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**message** | **string** | | [default to undefined]
|
|
9
|
+
**date** | **string** | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { ActivityLogEntry } from '@pidginhost/sdk';
|
|
15
|
+
|
|
16
|
+
const instance: ActivityLogEntry = {
|
|
17
|
+
message,
|
|
18
|
+
date,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[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
|
+
# ActivityLogResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**logs** | [**Array<ActivityLogEntry>**](ActivityLogEntry.md) | | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { ActivityLogResponse } from '@pidginhost/sdk';
|
|
14
|
+
|
|
15
|
+
const instance: ActivityLogResponse = {
|
|
16
|
+
logs,
|
|
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,20 @@
|
|
|
1
|
+
# AddServerResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**created** | **boolean** | | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { AddServerResponse } from '@pidginhost/sdk';
|
|
14
|
+
|
|
15
|
+
const instance: AddServerResponse = {
|
|
16
|
+
created,
|
|
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)
|
package/docs/Address.md
ADDED
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# Address
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **number** | | [readonly] [default to undefined]
|
|
9
|
+
**country** | [**CountryEnum**](CountryEnum.md) | | [default to undefined]
|
|
10
|
+
**city** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**region** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**zipcode** | **string** | | [optional] [default to undefined]
|
|
13
|
+
**address** | **string** | | [optional] [default to undefined]
|
|
14
|
+
**region_fk** | **number** | | [optional] [default to undefined]
|
|
15
|
+
**locality_fk** | **number** | | [optional] [default to undefined]
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import { Address } from '@pidginhost/sdk';
|
|
21
|
+
|
|
22
|
+
const instance: Address = {
|
|
23
|
+
id,
|
|
24
|
+
country,
|
|
25
|
+
city,
|
|
26
|
+
region,
|
|
27
|
+
zipcode,
|
|
28
|
+
address,
|
|
29
|
+
region_fk,
|
|
30
|
+
locality_fk,
|
|
31
|
+
};
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
[[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
|
+
# AttachIPv4
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**ipv4** | **string** | ID or slug | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { AttachIPv4 } from '@pidginhost/sdk';
|
|
14
|
+
|
|
15
|
+
const instance: AttachIPv4 = {
|
|
16
|
+
ipv4,
|
|
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,20 @@
|
|
|
1
|
+
# AttachIPv6
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**ipv6** | **string** | ID or slug | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { AttachIPv6 } from '@pidginhost/sdk';
|
|
14
|
+
|
|
15
|
+
const instance: AttachIPv6 = {
|
|
16
|
+
ipv6,
|
|
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,20 @@
|
|
|
1
|
+
# AttachVolume
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**vm** | **number** | Server ID | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { AttachVolume } from '@pidginhost/sdk';
|
|
14
|
+
|
|
15
|
+
const instance: AttachVolume = {
|
|
16
|
+
vm,
|
|
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)
|