@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.
Files changed (248) hide show
  1. package/.openapi-generator/FILES +223 -0
  2. package/.openapi-generator/VERSION +1 -0
  3. package/.openapi-generator-ignore +23 -0
  4. package/README.md +727 -0
  5. package/api.ts +33802 -0
  6. package/base.ts +62 -0
  7. package/common.ts +128 -0
  8. package/configuration.ts +121 -0
  9. package/dist/api.d.ts +15244 -0
  10. package/dist/api.js +30223 -0
  11. package/dist/base.d.ts +42 -0
  12. package/dist/base.js +46 -0
  13. package/dist/common.d.ts +35 -0
  14. package/dist/common.js +140 -0
  15. package/dist/configuration.d.ts +98 -0
  16. package/dist/configuration.js +44 -0
  17. package/dist/esm/api.d.ts +15244 -0
  18. package/dist/esm/api.js +30179 -0
  19. package/dist/esm/base.d.ts +42 -0
  20. package/dist/esm/base.js +41 -0
  21. package/dist/esm/common.d.ts +35 -0
  22. package/dist/esm/common.js +127 -0
  23. package/dist/esm/configuration.d.ts +98 -0
  24. package/dist/esm/configuration.js +40 -0
  25. package/dist/esm/index.d.ts +14 -0
  26. package/dist/esm/index.js +16 -0
  27. package/dist/esm/pidginhost.d.ts +8 -0
  28. package/dist/esm/pidginhost.js +13 -0
  29. package/dist/index.d.ts +14 -0
  30. package/dist/index.js +34 -0
  31. package/dist/pidginhost.d.ts +8 -0
  32. package/dist/pidginhost.js +17 -0
  33. package/docs/APITokenCreate.md +28 -0
  34. package/docs/APITokenList.md +32 -0
  35. package/docs/AccountApi.md +1999 -0
  36. package/docs/ActivateFreeDNS.md +24 -0
  37. package/docs/ActivateFreeDNSResponse.md +24 -0
  38. package/docs/ActivityLogEntry.md +22 -0
  39. package/docs/ActivityLogResponse.md +20 -0
  40. package/docs/AddServerResponse.md +20 -0
  41. package/docs/Address.md +34 -0
  42. package/docs/AttachIPv4.md +20 -0
  43. package/docs/AttachIPv6.md +20 -0
  44. package/docs/AttachVolume.md +20 -0
  45. package/docs/BillingApi.md +1885 -0
  46. package/docs/CancelServiceResponse.md +22 -0
  47. package/docs/ChangeBillingCycle.md +20 -0
  48. package/docs/ChangeBillingCycleResponse.md +22 -0
  49. package/docs/ChangeCompany.md +20 -0
  50. package/docs/ChangeCompanyResponse.md +22 -0
  51. package/docs/ChangePassword.md +20 -0
  52. package/docs/CheckAvailability.md +20 -0
  53. package/docs/CloudApi.md +8433 -0
  54. package/docs/ClusterAdd.md +32 -0
  55. package/docs/ClusterAddResponse.md +20 -0
  56. package/docs/ClusterDetail.md +48 -0
  57. package/docs/ClusterPackage.md +24 -0
  58. package/docs/ClusterType.md +26 -0
  59. package/docs/ClusterTypeEnum.md +11 -0
  60. package/docs/Company.md +36 -0
  61. package/docs/ConnectVMRequest.md +20 -0
  62. package/docs/ConnectVMResponse.md +22 -0
  63. package/docs/ConnectedVM.md +24 -0
  64. package/docs/ConnectedVMsResponse.md +20 -0
  65. package/docs/ConsoleToken.md +22 -0
  66. package/docs/ContactTypeEnum.md +15 -0
  67. package/docs/ContactsUpdate.md +22 -0
  68. package/docs/ContactsUpdateResponse.md +20 -0
  69. package/docs/CountryEnum.md +515 -0
  70. package/docs/DNSRecord.md +53 -0
  71. package/docs/DNSRecordCreate.md +53 -0
  72. package/docs/DNSRecordCreateTypeEnum.md +21 -0
  73. package/docs/DNSRecordMutateResponse.md +22 -0
  74. package/docs/DeactivateFreeDNS.md +22 -0
  75. package/docs/DeactivateFreeDNSResponse.md +20 -0
  76. package/docs/DedicatedApi.md +551 -0
  77. package/docs/DedicatedRDNS.md +22 -0
  78. package/docs/DedicatedServer.md +39 -0
  79. package/docs/DeleteRecord.md +20 -0
  80. package/docs/DeleteRecordResponse.md +22 -0
  81. package/docs/Department.md +22 -0
  82. package/docs/Deposit.md +32 -0
  83. package/docs/DepositCreate.md +20 -0
  84. package/docs/DepositStatusEnum.md +15 -0
  85. package/docs/DestroyProtection.md +20 -0
  86. package/docs/DetachIPv4.md +20 -0
  87. package/docs/DetachIPv4Response.md +20 -0
  88. package/docs/DetachIPv6.md +20 -0
  89. package/docs/DetachIPv6Response.md +20 -0
  90. package/docs/DetachVolume.md +20 -0
  91. package/docs/DisconnectVMRequest.md +20 -0
  92. package/docs/DisconnectVMResponse.md +22 -0
  93. package/docs/Domain.md +42 -0
  94. package/docs/DomainApi.md +2047 -0
  95. package/docs/DomainCancelResponse.md +22 -0
  96. package/docs/DomainCreate.md +24 -0
  97. package/docs/DomainRegistrant.md +44 -0
  98. package/docs/EmailHistory.md +28 -0
  99. package/docs/FeatureUpgradeRequest.md +22 -0
  100. package/docs/FeatureUpgradeResponse.md +22 -0
  101. package/docs/FeaturesEnum.md +17 -0
  102. package/docs/FirewallRule.md +42 -0
  103. package/docs/FirewallRuleDirectionEnum.md +11 -0
  104. package/docs/FirewallRulesSet.md +28 -0
  105. package/docs/FirewallRulesSetStatusEnum.md +13 -0
  106. package/docs/FreeDNSDomain.md +24 -0
  107. package/docs/FreednsApi.md +655 -0
  108. package/docs/FundsBalanceResponse.md +26 -0
  109. package/docs/FundsLog.md +30 -0
  110. package/docs/FwPolicyOutEnum.md +13 -0
  111. package/docs/HTTPRoute.md +45 -0
  112. package/docs/HostingApi.md +327 -0
  113. package/docs/HostingChangePasswordResponse.md +20 -0
  114. package/docs/HostingService.md +39 -0
  115. package/docs/InvoiceDetail.md +50 -0
  116. package/docs/InvoiceList.md +40 -0
  117. package/docs/KubeUpgradeResponse.md +20 -0
  118. package/docs/KubeVersionEnum.md +13 -0
  119. package/docs/KubernetesApi.md +6209 -0
  120. package/docs/LBFirewallRule.md +44 -0
  121. package/docs/LBFirewallRuleActionEnum.md +13 -0
  122. package/docs/LBFirewallRuleDirectionEnum.md +11 -0
  123. package/docs/LowBalanceSettings.md +24 -0
  124. package/docs/NameserversUpdate.md +20 -0
  125. package/docs/NameserversUpdateResponse.md +20 -0
  126. package/docs/NodeMetricsResponse.md +32 -0
  127. package/docs/NodeRRDResponse.md +22 -0
  128. package/docs/NotificationSettingsResponse.md +26 -0
  129. package/docs/OSImage.md +28 -0
  130. package/docs/OperationEnum.md +27 -0
  131. package/docs/PaginatedAPITokenListList.md +26 -0
  132. package/docs/PaginatedClusterDetailList.md +26 -0
  133. package/docs/PaginatedClusterTypeList.md +26 -0
  134. package/docs/PaginatedCompanyList.md +26 -0
  135. package/docs/PaginatedDedicatedServerList.md +26 -0
  136. package/docs/PaginatedDepositList.md +26 -0
  137. package/docs/PaginatedDomainList.md +26 -0
  138. package/docs/PaginatedDomainRegistrantList.md +26 -0
  139. package/docs/PaginatedEmailHistoryList.md +26 -0
  140. package/docs/PaginatedFundsLogList.md +26 -0
  141. package/docs/PaginatedHostingServiceList.md +26 -0
  142. package/docs/PaginatedInvoiceListList.md +26 -0
  143. package/docs/PaginatedLBFirewallRuleList.md +26 -0
  144. package/docs/PaginatedOSImageList.md +26 -0
  145. package/docs/PaginatedPrivateNetworkList.md +26 -0
  146. package/docs/PaginatedPublicIPv4List.md +26 -0
  147. package/docs/PaginatedPublicIPv6List.md +26 -0
  148. package/docs/PaginatedResourcePoolList.md +26 -0
  149. package/docs/PaginatedResourcePoolNodeList.md +26 -0
  150. package/docs/PaginatedSSHKeyList.md +26 -0
  151. package/docs/PaginatedServerList.md +26 -0
  152. package/docs/PaginatedServerProductList.md +26 -0
  153. package/docs/PaginatedServiceListList.md +26 -0
  154. package/docs/PaginatedSnapshotList.md +26 -0
  155. package/docs/PaginatedStorageProductList.md +26 -0
  156. package/docs/PaginatedSubscriptionList.md +26 -0
  157. package/docs/PaginatedTLDList.md +26 -0
  158. package/docs/PaginatedTicketListList.md +26 -0
  159. package/docs/PatchedClusterDetail.md +48 -0
  160. package/docs/PatchedCompany.md +36 -0
  161. package/docs/PatchedDomain.md +42 -0
  162. package/docs/PatchedDomainRegistrant.md +44 -0
  163. package/docs/PatchedFirewallRule.md +42 -0
  164. package/docs/PatchedFirewallRulesSet.md +28 -0
  165. package/docs/PatchedHTTPRoute.md +45 -0
  166. package/docs/PatchedLBFirewallRule.md +44 -0
  167. package/docs/PatchedPrivateNetwork.md +30 -0
  168. package/docs/PatchedProfile.md +26 -0
  169. package/docs/PatchedResourcePool.md +28 -0
  170. package/docs/PatchedSSHKey.md +26 -0
  171. package/docs/PatchedTCPRoute.md +41 -0
  172. package/docs/PatchedUDPRoute.md +41 -0
  173. package/docs/PatchedVolume.md +32 -0
  174. package/docs/PayWithFundsResponse.md +22 -0
  175. package/docs/PowerAction.md +20 -0
  176. package/docs/PowerActionActionEnum.md +15 -0
  177. package/docs/PowerActionResponse.md +20 -0
  178. package/docs/PowerManagement.md +20 -0
  179. package/docs/PowerManagementRequest.md +20 -0
  180. package/docs/PowerManagementRequestActionEnum.md +15 -0
  181. package/docs/Priority3cdEnum.md +13 -0
  182. package/docs/PrivateNetwork.md +30 -0
  183. package/docs/PrivateNetworkAddHost.md +22 -0
  184. package/docs/PrivateNetworkRemoveHost.md +20 -0
  185. package/docs/Profile.md +26 -0
  186. package/docs/PublicIPv4.md +32 -0
  187. package/docs/PublicIPv6.md +32 -0
  188. package/docs/PublicInterface.md +30 -0
  189. package/docs/RDNSUpdateResponse.md +20 -0
  190. package/docs/Reinstall.md +20 -0
  191. package/docs/ReinstallResponse.md +20 -0
  192. package/docs/RemoveServerResponse.md +20 -0
  193. package/docs/RenewDomain.md +20 -0
  194. package/docs/ResourcePool.md +28 -0
  195. package/docs/ResourcePoolAdd.md +22 -0
  196. package/docs/ResourcePoolAddResponse.md +20 -0
  197. package/docs/ResourcePoolNode.md +24 -0
  198. package/docs/RetryProvision.md +20 -0
  199. package/docs/ReverseDNS.md +20 -0
  200. package/docs/SSHKey.md +26 -0
  201. package/docs/SchemaApi.md +117 -0
  202. package/docs/ScopeEnum.md +11 -0
  203. package/docs/Server.md +42 -0
  204. package/docs/ServerAdd.md +58 -0
  205. package/docs/ServerAddResponse.md +20 -0
  206. package/docs/ServerProduct.md +24 -0
  207. package/docs/ServerProductUpgrade.md +20 -0
  208. package/docs/ServerUpgradeResponse.md +20 -0
  209. package/docs/ServerUsageResponse.md +28 -0
  210. package/docs/Service.md +40 -0
  211. package/docs/ServiceList.md +36 -0
  212. package/docs/Snapshot.md +30 -0
  213. package/docs/SnapshotCreate.md +24 -0
  214. package/docs/SnapshotCreateQueued.md +20 -0
  215. package/docs/SnapshotDeleteQueued.md +20 -0
  216. package/docs/SnapshotRollbackQueued.md +20 -0
  217. package/docs/SourceEnum.md +11 -0
  218. package/docs/Status03cEnum.md +21 -0
  219. package/docs/Status63aEnum.md +23 -0
  220. package/docs/StatusA57Enum.md +31 -0
  221. package/docs/StatusEf2Enum.md +15 -0
  222. package/docs/StorageProduct.md +34 -0
  223. package/docs/Subscription.md +34 -0
  224. package/docs/SubscriptionStatusEnum.md +15 -0
  225. package/docs/SupportApi.md +841 -0
  226. package/docs/TCPRoute.md +41 -0
  227. package/docs/TLD.md +38 -0
  228. package/docs/TalosUpgradeResponse.md +20 -0
  229. package/docs/ThresholdTypeEnum.md +13 -0
  230. package/docs/TicketCloseResponse.md +22 -0
  231. package/docs/TicketCreate.md +30 -0
  232. package/docs/TicketCreatePriorityEnum.md +13 -0
  233. package/docs/TicketDetail.md +34 -0
  234. package/docs/TicketList.md +32 -0
  235. package/docs/TicketReopenResponse.md +22 -0
  236. package/docs/TicketReply.md +22 -0
  237. package/docs/TicketReplyResponse.md +20 -0
  238. package/docs/ToggleAutoPaymentResponse.md +22 -0
  239. package/docs/TransferRoDomain.md +22 -0
  240. package/docs/Type2faEnum.md +11 -0
  241. package/docs/UDPRoute.md +41 -0
  242. package/docs/Volume.md +32 -0
  243. package/git_push.sh +57 -0
  244. package/index.ts +19 -0
  245. package/package.json +33 -0
  246. package/pidginhost.ts +20 -0
  247. package/tsconfig.esm.json +7 -0
  248. package/tsconfig.json +18 -0
@@ -0,0 +1,515 @@
1
+ # CountryEnum
2
+
3
+ * `AF` - Afghanistan * `AL` - Albania * `DZ` - Algeria * `AS` - American Samoa * `AD` - Andorra * `AO` - Angola * `AI` - Anguilla * `AQ` - Antarctica * `AG` - Antigua and Barbuda * `AR` - Argentina * `AM` - Armenia * `AW` - Aruba * `AC` - Ascension Island * `AU` - Australia * `AT` - Austria * `AZ` - Azerbaijan * `BS` - Bahamas * `BH` - Bahrain * `BD` - Bangladesh * `BB` - Barbados * `BY` - Belarus * `BE` - Belgium * `BZ` - Belize * `BJ` - Benin * `BM` - Bermuda * `BT` - Bhutan * `BO` - Bolivia, Plurinational State of * `BQ` - Bonaire, Sint Eustatius and Saba * `BA` - Bosnia and Herzegovina * `BW` - Botswana * `BV` - Bouvet Island * `BR` - Brazil * `IO` - British Indian Ocean Territory * `BN` - Brunei Darussalam * `BG` - Bulgaria * `BF` - Burkina Faso * `BI` - Burundi * `KH` - Cambodia * `CM` - Cameroon * `CA` - Canada * `CV` - Cape Verde * `KY` - Cayman Islands * `CF` - Central African Republic * `TD` - Chad * `CL` - Chile * `CN` - China * `CX` - Christmas Island * `CC` - Cocos (Keeling) Islands * `CO` - Colombia * `KM` - Comoros * `CG` - Congo * `CD` - Congo, The Democratic Republic of the * `CK` - Cook Islands * `CR` - Costa Rica * `HR` - Croatia * `CU` - Cuba * `CW` - Curaçao * `CY` - Cyprus * `CZ` - Czech Republic * `CI` - Côte d\'Ivoire * `DK` - Denmark * `DJ` - Djibouti * `DM` - Dominica * `DO` - Dominican Republic * `EC` - Ecuador * `EG` - Egypt * `SV` - El Salvador * `GQ` - Equatorial Guinea * `ER` - Eritrea * `EE` - Estonia * `ET` - Ethiopia * `FK` - Falkland Islands (Malvinas) * `FO` - Faroe Islands * `FJ` - Fiji * `FI` - Finland * `FR` - France * `GF` - French Guiana * `PF` - French Polynesia * `TF` - French Southern Territories * `GA` - Gabon * `GM` - Gambia * `GE` - Georgia * `DE` - Germany * `GH` - Ghana * `GI` - Gibraltar * `GR` - Greece * `GL` - Greenland * `GD` - Grenada * `GP` - Guadeloupe * `GU` - Guam * `GT` - Guatemala * `GG` - Guernsey * `GN` - Guinea * `GW` - Guinea-Bissau * `GY` - Guyana * `HT` - Haiti * `HM` - Heard Island and McDonald Islands * `VA` - Holy See (Vatican City State) * `HN` - Honduras * `HK` - Hong Kong * `HU` - Hungary * `IS` - Iceland * `IN` - India * `ID` - Indonesia * `IR` - Iran, Islamic Republic of * `IQ` - Iraq * `IE` - Ireland * `IM` - Isle of Man * `IL` - Israel * `IT` - Italy * `JM` - Jamaica * `JP` - Japan * `JE` - Jersey * `JO` - Jordan * `KZ` - Kazakhstan * `KE` - Kenya * `KI` - Kiribati * `KP` - Korea, Democratic People\'s Republic of * `KR` - Korea, Republic of * `XK` - Kosovo * `KW` - Kuwait * `KG` - Kyrgyzstan * `LA` - Lao People\'s Democratic Republic * `LV` - Latvia * `LB` - Lebanon * `LS` - Lesotho * `LR` - Liberia * `LY` - Libya * `LI` - Liechtenstein * `LT` - Lithuania * `LU` - Luxembourg * `MO` - Macao * `MG` - Madagascar * `MW` - Malawi * `MY` - Malaysia * `MV` - Maldives * `ML` - Mali * `MT` - Malta * `MH` - Marshall Islands * `MQ` - Martinique * `MR` - Mauritania * `MU` - Mauritius * `YT` - Mayotte * `MX` - Mexico * `FM` - Micronesia, Federated States of * `MD` - Moldova, Republic of * `MC` - Monaco * `MN` - Mongolia * `ME` - Montenegro * `MS` - Montserrat * `MA` - Morocco * `MZ` - Mozambique * `MM` - Myanmar * `QN` - Nagomo-Karabakh * `NA` - Namibia * `NR` - Nauru * `NP` - Nepal * `NL` - Netherlands * `NC` - New Caledonia * `NZ` - New Zealand * `NI` - Nicaragua * `NE` - Niger * `NG` - Nigeria * `NU` - Niue * `NF` - Norfolk Island * `MK` - North Macedonia, Republic of * `MP` - Northern Mariana Islands * `NO` - Norway * `OM` - Oman * `PK` - Pakistan * `PW` - Palau * `PS` - Palestine, State of * `PA` - Panama * `PG` - Papua New Guinea * `PY` - Paraguay * `PE` - Peru * `PH` - Philippines * `PN` - Pitcairn * `PL` - Poland * `PT` - Portugal * `PR` - Puerto Rico * `QA` - Qatar * `RO` - Romania * `RU` - Russian Federation * `RW` - Rwanda * `RE` - Réunion * `BL` - Saint Barthélemy * `SH` - Saint Helena, Ascension and Tristan da Cunha * `KN` - Saint Kitts and Nevis * `LC` - Saint Lucia * `MF` - Saint Martin (French part) * `PM` - Saint Pierre and Miquelon * `VC` - Saint Vincent and the Grenadines * `WS` - Samoa * `SM` - San Marino * `ST` - Sao Tome and Principe * `SA` - Saudi Arabia * `SN` - Senegal * `RS` - Serbia * `SC` - Seychelles * `SL` - Sierra Leone * `SG` - Singapore * `SX` - Sint Maarten (Dutch part) * `SK` - Slovakia * `SI` - Slovenia * `SB` - Solomon Islands * `SO` - Somalia * `QS` - Somaliland * `ZA` - South Africa * `GS` - South Georgia and the South Sandwich Islands * `SS` - South Sudan * `ES` - Spain * `LK` - Sri Lanka * `SD` - Sudan * `SR` - Suriname * `SJ` - Svalbard and Jan Mayen * `SZ` - Swaziland * `SE` - Sweden * `CH` - Switzerland * `SY` - Syrian Arab Republic * `TW` - Taiwan, Province of China * `TJ` - Tajikistan * `TZ` - Tanzania, United Republic of * `TH` - Thailand * `TL` - Timor-Leste * `TG` - Togo * `TK` - Tokelau * `TO` - Tonga * `TT` - Trinidad and Tobago * `TA` - Tristan da Cunha * `TN` - Tunisia * `TR` - Turkey * `TM` - Turkmenistan * `TC` - Turks and Caicos Islands * `TV` - Tuvalu * `UG` - Uganda * `UA` - Ukraine * `AE` - United Arab Emirates * `GB` - United Kingdom * `US` - United States * `UM` - United States Minor Outlying Islands * `UY` - Uruguay * `UZ` - Uzbekistan * `VU` - Vanuatu * `VE` - Venezuela, Bolivarian Republic of * `VN` - Viet Nam * `VG` - Virgin Islands, British * `VI` - Virgin Islands, U.S. * `WF` - Wallis and Futuna * `EH` - Western Sahara * `YE` - Yemen * `ZM` - Zambia * `ZW` - Zimbabwe * `AX` - Åland Islands
4
+
5
+ ## Enum
6
+
7
+ * `Af` (value: `'AF'`)
8
+
9
+ * `Al` (value: `'AL'`)
10
+
11
+ * `Dz` (value: `'DZ'`)
12
+
13
+ * `As` (value: `'AS'`)
14
+
15
+ * `Ad` (value: `'AD'`)
16
+
17
+ * `Ao` (value: `'AO'`)
18
+
19
+ * `Ai` (value: `'AI'`)
20
+
21
+ * `Aq` (value: `'AQ'`)
22
+
23
+ * `Ag` (value: `'AG'`)
24
+
25
+ * `Ar` (value: `'AR'`)
26
+
27
+ * `Am` (value: `'AM'`)
28
+
29
+ * `Aw` (value: `'AW'`)
30
+
31
+ * `Ac` (value: `'AC'`)
32
+
33
+ * `Au` (value: `'AU'`)
34
+
35
+ * `At` (value: `'AT'`)
36
+
37
+ * `Az` (value: `'AZ'`)
38
+
39
+ * `Bs` (value: `'BS'`)
40
+
41
+ * `Bh` (value: `'BH'`)
42
+
43
+ * `Bd` (value: `'BD'`)
44
+
45
+ * `Bb` (value: `'BB'`)
46
+
47
+ * `By` (value: `'BY'`)
48
+
49
+ * `Be` (value: `'BE'`)
50
+
51
+ * `Bz` (value: `'BZ'`)
52
+
53
+ * `Bj` (value: `'BJ'`)
54
+
55
+ * `Bm` (value: `'BM'`)
56
+
57
+ * `Bt` (value: `'BT'`)
58
+
59
+ * `Bo` (value: `'BO'`)
60
+
61
+ * `Bq` (value: `'BQ'`)
62
+
63
+ * `Ba` (value: `'BA'`)
64
+
65
+ * `Bw` (value: `'BW'`)
66
+
67
+ * `Bv` (value: `'BV'`)
68
+
69
+ * `Br` (value: `'BR'`)
70
+
71
+ * `Io` (value: `'IO'`)
72
+
73
+ * `Bn` (value: `'BN'`)
74
+
75
+ * `Bg` (value: `'BG'`)
76
+
77
+ * `Bf` (value: `'BF'`)
78
+
79
+ * `Bi` (value: `'BI'`)
80
+
81
+ * `Kh` (value: `'KH'`)
82
+
83
+ * `Cm` (value: `'CM'`)
84
+
85
+ * `Ca` (value: `'CA'`)
86
+
87
+ * `Cv` (value: `'CV'`)
88
+
89
+ * `Ky` (value: `'KY'`)
90
+
91
+ * `Cf` (value: `'CF'`)
92
+
93
+ * `Td` (value: `'TD'`)
94
+
95
+ * `Cl` (value: `'CL'`)
96
+
97
+ * `Cn` (value: `'CN'`)
98
+
99
+ * `Cx` (value: `'CX'`)
100
+
101
+ * `Cc` (value: `'CC'`)
102
+
103
+ * `Co` (value: `'CO'`)
104
+
105
+ * `Km` (value: `'KM'`)
106
+
107
+ * `Cg` (value: `'CG'`)
108
+
109
+ * `Cd` (value: `'CD'`)
110
+
111
+ * `Ck` (value: `'CK'`)
112
+
113
+ * `Cr` (value: `'CR'`)
114
+
115
+ * `Hr` (value: `'HR'`)
116
+
117
+ * `Cu` (value: `'CU'`)
118
+
119
+ * `Cw` (value: `'CW'`)
120
+
121
+ * `Cy` (value: `'CY'`)
122
+
123
+ * `Cz` (value: `'CZ'`)
124
+
125
+ * `Ci` (value: `'CI'`)
126
+
127
+ * `Dk` (value: `'DK'`)
128
+
129
+ * `Dj` (value: `'DJ'`)
130
+
131
+ * `Dm` (value: `'DM'`)
132
+
133
+ * `Do` (value: `'DO'`)
134
+
135
+ * `Ec` (value: `'EC'`)
136
+
137
+ * `Eg` (value: `'EG'`)
138
+
139
+ * `Sv` (value: `'SV'`)
140
+
141
+ * `Gq` (value: `'GQ'`)
142
+
143
+ * `Er` (value: `'ER'`)
144
+
145
+ * `Ee` (value: `'EE'`)
146
+
147
+ * `Et` (value: `'ET'`)
148
+
149
+ * `Fk` (value: `'FK'`)
150
+
151
+ * `Fo` (value: `'FO'`)
152
+
153
+ * `Fj` (value: `'FJ'`)
154
+
155
+ * `Fi` (value: `'FI'`)
156
+
157
+ * `Fr` (value: `'FR'`)
158
+
159
+ * `Gf` (value: `'GF'`)
160
+
161
+ * `Pf` (value: `'PF'`)
162
+
163
+ * `Tf` (value: `'TF'`)
164
+
165
+ * `Ga` (value: `'GA'`)
166
+
167
+ * `Gm` (value: `'GM'`)
168
+
169
+ * `Ge` (value: `'GE'`)
170
+
171
+ * `De` (value: `'DE'`)
172
+
173
+ * `Gh` (value: `'GH'`)
174
+
175
+ * `Gi` (value: `'GI'`)
176
+
177
+ * `Gr` (value: `'GR'`)
178
+
179
+ * `Gl` (value: `'GL'`)
180
+
181
+ * `Gd` (value: `'GD'`)
182
+
183
+ * `Gp` (value: `'GP'`)
184
+
185
+ * `Gu` (value: `'GU'`)
186
+
187
+ * `Gt` (value: `'GT'`)
188
+
189
+ * `Gg` (value: `'GG'`)
190
+
191
+ * `Gn` (value: `'GN'`)
192
+
193
+ * `Gw` (value: `'GW'`)
194
+
195
+ * `Gy` (value: `'GY'`)
196
+
197
+ * `Ht` (value: `'HT'`)
198
+
199
+ * `Hm` (value: `'HM'`)
200
+
201
+ * `Va` (value: `'VA'`)
202
+
203
+ * `Hn` (value: `'HN'`)
204
+
205
+ * `Hk` (value: `'HK'`)
206
+
207
+ * `Hu` (value: `'HU'`)
208
+
209
+ * `Is` (value: `'IS'`)
210
+
211
+ * `In` (value: `'IN'`)
212
+
213
+ * `Id` (value: `'ID'`)
214
+
215
+ * `Ir` (value: `'IR'`)
216
+
217
+ * `Iq` (value: `'IQ'`)
218
+
219
+ * `Ie` (value: `'IE'`)
220
+
221
+ * `Im` (value: `'IM'`)
222
+
223
+ * `Il` (value: `'IL'`)
224
+
225
+ * `It` (value: `'IT'`)
226
+
227
+ * `Jm` (value: `'JM'`)
228
+
229
+ * `Jp` (value: `'JP'`)
230
+
231
+ * `Je` (value: `'JE'`)
232
+
233
+ * `Jo` (value: `'JO'`)
234
+
235
+ * `Kz` (value: `'KZ'`)
236
+
237
+ * `Ke` (value: `'KE'`)
238
+
239
+ * `Ki` (value: `'KI'`)
240
+
241
+ * `Kp` (value: `'KP'`)
242
+
243
+ * `Kr` (value: `'KR'`)
244
+
245
+ * `Xk` (value: `'XK'`)
246
+
247
+ * `Kw` (value: `'KW'`)
248
+
249
+ * `Kg` (value: `'KG'`)
250
+
251
+ * `La` (value: `'LA'`)
252
+
253
+ * `Lv` (value: `'LV'`)
254
+
255
+ * `Lb` (value: `'LB'`)
256
+
257
+ * `Ls` (value: `'LS'`)
258
+
259
+ * `Lr` (value: `'LR'`)
260
+
261
+ * `Ly` (value: `'LY'`)
262
+
263
+ * `Li` (value: `'LI'`)
264
+
265
+ * `Lt` (value: `'LT'`)
266
+
267
+ * `Lu` (value: `'LU'`)
268
+
269
+ * `Mo` (value: `'MO'`)
270
+
271
+ * `Mg` (value: `'MG'`)
272
+
273
+ * `Mw` (value: `'MW'`)
274
+
275
+ * `My` (value: `'MY'`)
276
+
277
+ * `Mv` (value: `'MV'`)
278
+
279
+ * `Ml` (value: `'ML'`)
280
+
281
+ * `Mt` (value: `'MT'`)
282
+
283
+ * `Mh` (value: `'MH'`)
284
+
285
+ * `Mq` (value: `'MQ'`)
286
+
287
+ * `Mr` (value: `'MR'`)
288
+
289
+ * `Mu` (value: `'MU'`)
290
+
291
+ * `Yt` (value: `'YT'`)
292
+
293
+ * `Mx` (value: `'MX'`)
294
+
295
+ * `Fm` (value: `'FM'`)
296
+
297
+ * `Md` (value: `'MD'`)
298
+
299
+ * `Mc` (value: `'MC'`)
300
+
301
+ * `Mn` (value: `'MN'`)
302
+
303
+ * `Me` (value: `'ME'`)
304
+
305
+ * `Ms` (value: `'MS'`)
306
+
307
+ * `Ma` (value: `'MA'`)
308
+
309
+ * `Mz` (value: `'MZ'`)
310
+
311
+ * `Mm` (value: `'MM'`)
312
+
313
+ * `Qn` (value: `'QN'`)
314
+
315
+ * `Na` (value: `'NA'`)
316
+
317
+ * `Nr` (value: `'NR'`)
318
+
319
+ * `Np` (value: `'NP'`)
320
+
321
+ * `Nl` (value: `'NL'`)
322
+
323
+ * `Nc` (value: `'NC'`)
324
+
325
+ * `Nz` (value: `'NZ'`)
326
+
327
+ * `Ni` (value: `'NI'`)
328
+
329
+ * `Ne` (value: `'NE'`)
330
+
331
+ * `Ng` (value: `'NG'`)
332
+
333
+ * `Nu` (value: `'NU'`)
334
+
335
+ * `Nf` (value: `'NF'`)
336
+
337
+ * `Mk` (value: `'MK'`)
338
+
339
+ * `Mp` (value: `'MP'`)
340
+
341
+ * `No` (value: `'NO'`)
342
+
343
+ * `Om` (value: `'OM'`)
344
+
345
+ * `Pk` (value: `'PK'`)
346
+
347
+ * `Pw` (value: `'PW'`)
348
+
349
+ * `Ps` (value: `'PS'`)
350
+
351
+ * `Pa` (value: `'PA'`)
352
+
353
+ * `Pg` (value: `'PG'`)
354
+
355
+ * `Py` (value: `'PY'`)
356
+
357
+ * `Pe` (value: `'PE'`)
358
+
359
+ * `Ph` (value: `'PH'`)
360
+
361
+ * `Pn` (value: `'PN'`)
362
+
363
+ * `Pl` (value: `'PL'`)
364
+
365
+ * `Pt` (value: `'PT'`)
366
+
367
+ * `Pr` (value: `'PR'`)
368
+
369
+ * `Qa` (value: `'QA'`)
370
+
371
+ * `Ro` (value: `'RO'`)
372
+
373
+ * `Ru` (value: `'RU'`)
374
+
375
+ * `Rw` (value: `'RW'`)
376
+
377
+ * `Re` (value: `'RE'`)
378
+
379
+ * `Bl` (value: `'BL'`)
380
+
381
+ * `Sh` (value: `'SH'`)
382
+
383
+ * `Kn` (value: `'KN'`)
384
+
385
+ * `Lc` (value: `'LC'`)
386
+
387
+ * `Mf` (value: `'MF'`)
388
+
389
+ * `Pm` (value: `'PM'`)
390
+
391
+ * `Vc` (value: `'VC'`)
392
+
393
+ * `Ws` (value: `'WS'`)
394
+
395
+ * `Sm` (value: `'SM'`)
396
+
397
+ * `St` (value: `'ST'`)
398
+
399
+ * `Sa` (value: `'SA'`)
400
+
401
+ * `Sn` (value: `'SN'`)
402
+
403
+ * `Rs` (value: `'RS'`)
404
+
405
+ * `Sc` (value: `'SC'`)
406
+
407
+ * `Sl` (value: `'SL'`)
408
+
409
+ * `Sg` (value: `'SG'`)
410
+
411
+ * `Sx` (value: `'SX'`)
412
+
413
+ * `Sk` (value: `'SK'`)
414
+
415
+ * `Si` (value: `'SI'`)
416
+
417
+ * `Sb` (value: `'SB'`)
418
+
419
+ * `So` (value: `'SO'`)
420
+
421
+ * `Qs` (value: `'QS'`)
422
+
423
+ * `Za` (value: `'ZA'`)
424
+
425
+ * `Gs` (value: `'GS'`)
426
+
427
+ * `Ss` (value: `'SS'`)
428
+
429
+ * `Es` (value: `'ES'`)
430
+
431
+ * `Lk` (value: `'LK'`)
432
+
433
+ * `Sd` (value: `'SD'`)
434
+
435
+ * `Sr` (value: `'SR'`)
436
+
437
+ * `Sj` (value: `'SJ'`)
438
+
439
+ * `Sz` (value: `'SZ'`)
440
+
441
+ * `Se` (value: `'SE'`)
442
+
443
+ * `Ch` (value: `'CH'`)
444
+
445
+ * `Sy` (value: `'SY'`)
446
+
447
+ * `Tw` (value: `'TW'`)
448
+
449
+ * `Tj` (value: `'TJ'`)
450
+
451
+ * `Tz` (value: `'TZ'`)
452
+
453
+ * `Th` (value: `'TH'`)
454
+
455
+ * `Tl` (value: `'TL'`)
456
+
457
+ * `Tg` (value: `'TG'`)
458
+
459
+ * `Tk` (value: `'TK'`)
460
+
461
+ * `To` (value: `'TO'`)
462
+
463
+ * `Tt` (value: `'TT'`)
464
+
465
+ * `Ta` (value: `'TA'`)
466
+
467
+ * `Tn` (value: `'TN'`)
468
+
469
+ * `Tr` (value: `'TR'`)
470
+
471
+ * `Tm` (value: `'TM'`)
472
+
473
+ * `Tc` (value: `'TC'`)
474
+
475
+ * `Tv` (value: `'TV'`)
476
+
477
+ * `Ug` (value: `'UG'`)
478
+
479
+ * `Ua` (value: `'UA'`)
480
+
481
+ * `Ae` (value: `'AE'`)
482
+
483
+ * `Gb` (value: `'GB'`)
484
+
485
+ * `Us` (value: `'US'`)
486
+
487
+ * `Um` (value: `'UM'`)
488
+
489
+ * `Uy` (value: `'UY'`)
490
+
491
+ * `Uz` (value: `'UZ'`)
492
+
493
+ * `Vu` (value: `'VU'`)
494
+
495
+ * `Ve` (value: `'VE'`)
496
+
497
+ * `Vn` (value: `'VN'`)
498
+
499
+ * `Vg` (value: `'VG'`)
500
+
501
+ * `Vi` (value: `'VI'`)
502
+
503
+ * `Wf` (value: `'WF'`)
504
+
505
+ * `Eh` (value: `'EH'`)
506
+
507
+ * `Ye` (value: `'YE'`)
508
+
509
+ * `Zm` (value: `'ZM'`)
510
+
511
+ * `Zw` (value: `'ZW'`)
512
+
513
+ * `Ax` (value: `'AX'`)
514
+
515
+ [[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,53 @@
1
+ # DNSRecord
2
+
3
+ Read-only representation of a DNS record from the cPanel zone dump.
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **Line** | **number** | | [readonly] [default to undefined]
10
+ **name** | **string** | | [readonly] [default to undefined]
11
+ **ttl** | **number** | | [readonly] [default to undefined]
12
+ **type** | **string** | | [readonly] [default to undefined]
13
+ **address** | **string** | | [readonly] [default to undefined]
14
+ **cname** | **string** | | [readonly] [default to undefined]
15
+ **exchange** | **string** | | [readonly] [default to undefined]
16
+ **preference** | **number** | | [readonly] [default to undefined]
17
+ **txtdata** | **string** | | [readonly] [default to undefined]
18
+ **unencoded** | **string** | | [readonly] [default to undefined]
19
+ **target** | **string** | | [readonly] [default to undefined]
20
+ **priority** | **number** | | [readonly] [default to undefined]
21
+ **weight** | **number** | | [readonly] [default to undefined]
22
+ **port** | **number** | | [readonly] [default to undefined]
23
+ **flag** | **number** | | [readonly] [default to undefined]
24
+ **tag** | **string** | | [readonly] [default to undefined]
25
+ **value** | **string** | | [readonly] [default to undefined]
26
+
27
+ ## Example
28
+
29
+ ```typescript
30
+ import { DNSRecord } from '@pidginhost/sdk';
31
+
32
+ const instance: DNSRecord = {
33
+ Line,
34
+ name,
35
+ ttl,
36
+ type,
37
+ address,
38
+ cname,
39
+ exchange,
40
+ preference,
41
+ txtdata,
42
+ unencoded,
43
+ target,
44
+ priority,
45
+ weight,
46
+ port,
47
+ flag,
48
+ tag,
49
+ value,
50
+ };
51
+ ```
52
+
53
+ [[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,53 @@
1
+ # DNSRecordCreate
2
+
3
+ Validate input for creating or editing a DNS record.
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **name** | **string** | Record hostname (use \'@\' or leave empty for zone apex). | [default to undefined]
10
+ **ttl** | **number** | Time to live in seconds. | [default to undefined]
11
+ **type** | [**DNSRecordCreateTypeEnum**](DNSRecordCreateTypeEnum.md) | DNS record type. * `A` - A * `AAAA` - AAAA * `TYPE257` - TYPE257 * `CNAME` - CNAME * `MX` - MX * `SRV` - SRV * `TXT` - TXT | [default to undefined]
12
+ **address** | **string** | IPv4/IPv6 address (A/AAAA). | [optional] [default to undefined]
13
+ **cname** | **string** | Canonical name (CNAME). | [optional] [default to undefined]
14
+ **exchange** | **string** | Mail exchange host (MX). | [optional] [default to undefined]
15
+ **preference** | **number** | MX preference / priority. | [optional] [default to undefined]
16
+ **txtdata** | **string** | TXT record data. | [optional] [default to undefined]
17
+ **unencoded** | **string** | Unencoded TXT value. | [optional] [default to undefined]
18
+ **target** | **string** | SRV target host. | [optional] [default to undefined]
19
+ **priority** | **number** | SRV priority. | [optional] [default to undefined]
20
+ **weight** | **number** | SRV weight. | [optional] [default to undefined]
21
+ **port** | **number** | SRV port. | [optional] [default to undefined]
22
+ **flag** | **number** | CAA flag (TYPE257). | [optional] [default to undefined]
23
+ **tag** | **string** | CAA tag (TYPE257). | [optional] [default to undefined]
24
+ **value** | **string** | CAA value (TYPE257). | [optional] [default to undefined]
25
+ **line** | **number** | Line number of existing record to edit. Omit to add a new record. | [optional] [default to undefined]
26
+
27
+ ## Example
28
+
29
+ ```typescript
30
+ import { DNSRecordCreate } from '@pidginhost/sdk';
31
+
32
+ const instance: DNSRecordCreate = {
33
+ name,
34
+ ttl,
35
+ type,
36
+ address,
37
+ cname,
38
+ exchange,
39
+ preference,
40
+ txtdata,
41
+ unencoded,
42
+ target,
43
+ priority,
44
+ weight,
45
+ port,
46
+ flag,
47
+ tag,
48
+ value,
49
+ line,
50
+ };
51
+ ```
52
+
53
+ [[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,21 @@
1
+ # DNSRecordCreateTypeEnum
2
+
3
+ * `A` - A * `AAAA` - AAAA * `TYPE257` - TYPE257 * `CNAME` - CNAME * `MX` - MX * `SRV` - SRV * `TXT` - TXT
4
+
5
+ ## Enum
6
+
7
+ * `A` (value: `'A'`)
8
+
9
+ * `Aaaa` (value: `'AAAA'`)
10
+
11
+ * `Type257` (value: `'TYPE257'`)
12
+
13
+ * `Cname` (value: `'CNAME'`)
14
+
15
+ * `Mx` (value: `'MX'`)
16
+
17
+ * `Srv` (value: `'SRV'`)
18
+
19
+ * `Txt` (value: `'TXT'`)
20
+
21
+ [[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
+ # DNSRecordMutateResponse
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **message** | **string** | | [default to undefined]
9
+ **record** | [**DNSRecord**](DNSRecord.md) | | [optional] [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { DNSRecordMutateResponse } from '@pidginhost/sdk';
15
+
16
+ const instance: DNSRecordMutateResponse = {
17
+ message,
18
+ record,
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,22 @@
1
+ # DeactivateFreeDNS
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **domain** | **string** | Domain name or primary key of the domain to deactivate. | [default to undefined]
9
+ **source** | [**SourceEnum**](SourceEnum.md) | | [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { DeactivateFreeDNS } from '@pidginhost/sdk';
15
+
16
+ const instance: DeactivateFreeDNS = {
17
+ domain,
18
+ source,
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
+ # DeactivateFreeDNSResponse
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 { DeactivateFreeDNSResponse } from '@pidginhost/sdk';
14
+
15
+ const instance: DeactivateFreeDNSResponse = {
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)