@hostafrica/ha-sdk-typescript 1.1.4 → 1.1.5
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/dist/apis/BillingApi.d.ts +45 -0
- package/dist/apis/BillingApi.js +122 -0
- package/dist/apis/DNSApi.d.ts +8 -8
- package/dist/apis/DNSApi.js +8 -8
- package/dist/apis/index.d.ts +1 -0
- package/dist/apis/index.js +1 -0
- package/dist/esm/apis/BillingApi.d.ts +45 -0
- package/dist/esm/apis/BillingApi.js +118 -0
- package/dist/esm/apis/DNSApi.d.ts +8 -8
- package/dist/esm/apis/DNSApi.js +8 -8
- package/dist/esm/apis/index.d.ts +1 -0
- package/dist/esm/apis/index.js +1 -0
- package/dist/esm/models/AddDnsRecordRequestContent.d.ts +22 -3
- package/dist/esm/models/AddDnsRecordRequestContent.js +8 -3
- package/dist/esm/models/DeleteDnsRecordRequestContent.d.ts +22 -3
- package/dist/esm/models/DeleteDnsRecordRequestContent.js +8 -3
- package/dist/esm/models/DnsBackend.d.ts +28 -0
- package/dist/esm/models/DnsBackend.js +46 -0
- package/dist/esm/models/DnsRecordMutationRecord.d.ts +3 -2
- package/dist/esm/models/DnsZoneInfo.d.ts +7 -0
- package/dist/esm/models/DnsZoneInfo.js +3 -0
- package/dist/esm/models/EditDnsRecordRequestContent.d.ts +22 -3
- package/dist/esm/models/EditDnsRecordRequestContent.js +8 -3
- package/dist/esm/models/GetDnsZoneDetailsRequestContent.d.ts +7 -0
- package/dist/esm/models/GetDnsZoneDetailsRequestContent.js +3 -0
- package/dist/esm/models/GetInvoiceDetailsRequestContent.d.ts +32 -0
- package/dist/esm/models/GetInvoiceDetailsRequestContent.js +43 -0
- package/dist/esm/models/GetInvoiceDetailsResponseContent.d.ts +40 -0
- package/dist/esm/models/GetInvoiceDetailsResponseContent.js +49 -0
- package/dist/esm/models/GetInvoiceDetailsResponseData.d.ts +40 -0
- package/dist/esm/models/GetInvoiceDetailsResponseData.js +47 -0
- package/dist/esm/models/InvoiceDetails.d.ts +143 -0
- package/dist/esm/models/InvoiceDetails.js +112 -0
- package/dist/esm/models/InvoiceIssuedTo.d.ts +69 -0
- package/dist/esm/models/InvoiceIssuedTo.js +66 -0
- package/dist/esm/models/InvoiceIssuedToTax.d.ts +44 -0
- package/dist/esm/models/InvoiceIssuedToTax.js +51 -0
- package/dist/esm/models/InvoiceItem.d.ts +56 -0
- package/dist/esm/models/InvoiceItem.js +59 -0
- package/dist/esm/models/InvoiceSummary.d.ts +98 -0
- package/dist/esm/models/InvoiceSummary.js +83 -0
- package/dist/esm/models/InvoiceTransaction.d.ts +74 -0
- package/dist/esm/models/InvoiceTransaction.js +57 -0
- package/dist/esm/models/ListInvoicesResponseContent.d.ts +40 -0
- package/dist/esm/models/ListInvoicesResponseContent.js +49 -0
- package/dist/esm/models/ListInvoicesResponseData.d.ts +39 -0
- package/dist/esm/models/ListInvoicesResponseData.js +48 -0
- package/dist/esm/models/SelcomMetadata.d.ts +56 -0
- package/dist/esm/models/SelcomMetadata.js +59 -0
- package/dist/esm/models/index.d.ts +13 -0
- package/dist/esm/models/index.js +13 -0
- package/dist/esm/retryablePaths.js +2 -0
- package/dist/models/AddDnsRecordRequestContent.d.ts +22 -3
- package/dist/models/AddDnsRecordRequestContent.js +8 -3
- package/dist/models/DeleteDnsRecordRequestContent.d.ts +22 -3
- package/dist/models/DeleteDnsRecordRequestContent.js +8 -3
- package/dist/models/DnsBackend.d.ts +28 -0
- package/dist/models/DnsBackend.js +54 -0
- package/dist/models/DnsRecordMutationRecord.d.ts +3 -2
- package/dist/models/DnsZoneInfo.d.ts +7 -0
- package/dist/models/DnsZoneInfo.js +3 -0
- package/dist/models/EditDnsRecordRequestContent.d.ts +22 -3
- package/dist/models/EditDnsRecordRequestContent.js +8 -3
- package/dist/models/GetDnsZoneDetailsRequestContent.d.ts +7 -0
- package/dist/models/GetDnsZoneDetailsRequestContent.js +3 -0
- package/dist/models/GetInvoiceDetailsRequestContent.d.ts +32 -0
- package/dist/models/GetInvoiceDetailsRequestContent.js +50 -0
- package/dist/models/GetInvoiceDetailsResponseContent.d.ts +40 -0
- package/dist/models/GetInvoiceDetailsResponseContent.js +56 -0
- package/dist/models/GetInvoiceDetailsResponseData.d.ts +40 -0
- package/dist/models/GetInvoiceDetailsResponseData.js +54 -0
- package/dist/models/InvoiceDetails.d.ts +143 -0
- package/dist/models/InvoiceDetails.js +119 -0
- package/dist/models/InvoiceIssuedTo.d.ts +69 -0
- package/dist/models/InvoiceIssuedTo.js +73 -0
- package/dist/models/InvoiceIssuedToTax.d.ts +44 -0
- package/dist/models/InvoiceIssuedToTax.js +58 -0
- package/dist/models/InvoiceItem.d.ts +56 -0
- package/dist/models/InvoiceItem.js +66 -0
- package/dist/models/InvoiceSummary.d.ts +98 -0
- package/dist/models/InvoiceSummary.js +90 -0
- package/dist/models/InvoiceTransaction.d.ts +74 -0
- package/dist/models/InvoiceTransaction.js +64 -0
- package/dist/models/ListInvoicesResponseContent.d.ts +40 -0
- package/dist/models/ListInvoicesResponseContent.js +56 -0
- package/dist/models/ListInvoicesResponseData.d.ts +39 -0
- package/dist/models/ListInvoicesResponseData.js +55 -0
- package/dist/models/SelcomMetadata.d.ts +56 -0
- package/dist/models/SelcomMetadata.js +66 -0
- package/dist/models/index.d.ts +13 -0
- package/dist/models/index.js +13 -0
- package/dist/retryablePaths.js +2 -0
- package/dist.zip +0 -0
- package/docs/AddDnsRecordRequestContent.md +6 -0
- package/docs/BillingApi.md +159 -0
- package/docs/DNSApi.md +4 -4
- package/docs/DeleteDnsRecordRequestContent.md +6 -0
- package/docs/DnsBackend.md +33 -0
- package/docs/DnsRecordMutationRecord.md +1 -1
- package/docs/DnsZoneInfo.md +2 -0
- package/docs/EditDnsRecordRequestContent.md +6 -0
- package/docs/GetDnsZoneDetailsRequestContent.md +2 -0
- package/docs/GetInvoiceDetailsRequestContent.md +34 -0
- package/docs/GetInvoiceDetailsResponseContent.md +36 -0
- package/docs/GetInvoiceDetailsResponseData.md +37 -0
- package/docs/InvoiceDetails.md +71 -0
- package/docs/InvoiceIssuedTo.md +47 -0
- package/docs/InvoiceIssuedToTax.md +39 -0
- package/docs/InvoiceItem.md +43 -0
- package/docs/InvoiceSummary.md +57 -0
- package/docs/InvoiceTransaction.md +49 -0
- package/docs/ListInvoicesResponseContent.md +36 -0
- package/docs/ListInvoicesResponseData.md +37 -0
- package/docs/SelcomMetadata.md +43 -0
- package/package.json +1 -1
- package/src/apis/BillingApi.ts +164 -0
- package/src/apis/DNSApi.ts +8 -8
- package/src/apis/index.ts +1 -0
- package/src/models/AddDnsRecordRequestContent.ts +37 -5
- package/src/models/DeleteDnsRecordRequestContent.ts +37 -5
- package/src/models/DnsBackend.ts +56 -0
- package/src/models/DnsRecordMutationRecord.ts +3 -2
- package/src/models/DnsZoneInfo.ts +17 -0
- package/src/models/EditDnsRecordRequestContent.ts +37 -5
- package/src/models/GetDnsZoneDetailsRequestContent.ts +18 -0
- package/src/models/GetInvoiceDetailsRequestContent.ts +66 -0
- package/src/models/GetInvoiceDetailsResponseContent.ts +92 -0
- package/src/models/GetInvoiceDetailsResponseData.ts +89 -0
- package/src/models/InvoiceDetails.ts +247 -0
- package/src/models/InvoiceIssuedTo.ts +127 -0
- package/src/models/InvoiceIssuedToTax.ts +84 -0
- package/src/models/InvoiceItem.ts +102 -0
- package/src/models/InvoiceSummary.ts +163 -0
- package/src/models/InvoiceTransaction.ts +122 -0
- package/src/models/ListInvoicesResponseContent.ts +92 -0
- package/src/models/ListInvoicesResponseData.ts +83 -0
- package/src/models/SelcomMetadata.ts +102 -0
- package/src/models/index.ts +13 -0
- package/src/retryablePaths.ts +2 -0
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* HostAfricaApi
|
|
3
|
+
* HostAfrica API
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.1.0 - 2026-07-16
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* Selcom alt-gateway payment details included on an invoice when configured
|
|
14
|
+
* @export
|
|
15
|
+
* @interface SelcomMetadata
|
|
16
|
+
*/
|
|
17
|
+
export interface SelcomMetadata {
|
|
18
|
+
/**
|
|
19
|
+
* Due amount formatted for display (e.g. "TZS 29,000.00"). Non-TZS amounts are converted using the WHMCS currency rate.
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof SelcomMetadata
|
|
22
|
+
*/
|
|
23
|
+
amount: string;
|
|
24
|
+
/**
|
|
25
|
+
* Selcom Pesa account: 5-digit padded client id plus 6-digit padded invoice id
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof SelcomMetadata
|
|
28
|
+
*/
|
|
29
|
+
pesaAccount: string;
|
|
30
|
+
/**
|
|
31
|
+
* Mobile payment reference: 61107370 plus the same padded client and invoice ids
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof SelcomMetadata
|
|
34
|
+
*/
|
|
35
|
+
mobileReference: string;
|
|
36
|
+
/**
|
|
37
|
+
* USSD shortcode for Selcom (always *150*50*1#)
|
|
38
|
+
* @type {string}
|
|
39
|
+
* @memberof SelcomMetadata
|
|
40
|
+
*/
|
|
41
|
+
ussdCode: string;
|
|
42
|
+
/**
|
|
43
|
+
* WHMCS Selcom alt-gateway instructions HTML with placeholders filled
|
|
44
|
+
* @type {string}
|
|
45
|
+
* @memberof SelcomMetadata
|
|
46
|
+
*/
|
|
47
|
+
instructions: string;
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* Check if a given object implements the SelcomMetadata interface.
|
|
51
|
+
*/
|
|
52
|
+
export declare function instanceOfSelcomMetadata(value: object): value is SelcomMetadata;
|
|
53
|
+
export declare function SelcomMetadataFromJSON(json: any): SelcomMetadata;
|
|
54
|
+
export declare function SelcomMetadataFromJSONTyped(json: any, ignoreDiscriminator: boolean): SelcomMetadata;
|
|
55
|
+
export declare function SelcomMetadataToJSON(json: any): SelcomMetadata;
|
|
56
|
+
export declare function SelcomMetadataToJSONTyped(value?: SelcomMetadata | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* HostAfricaApi
|
|
6
|
+
* HostAfrica API
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.1.0 - 2026-07-16
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.instanceOfSelcomMetadata = instanceOfSelcomMetadata;
|
|
17
|
+
exports.SelcomMetadataFromJSON = SelcomMetadataFromJSON;
|
|
18
|
+
exports.SelcomMetadataFromJSONTyped = SelcomMetadataFromJSONTyped;
|
|
19
|
+
exports.SelcomMetadataToJSON = SelcomMetadataToJSON;
|
|
20
|
+
exports.SelcomMetadataToJSONTyped = SelcomMetadataToJSONTyped;
|
|
21
|
+
/**
|
|
22
|
+
* Check if a given object implements the SelcomMetadata interface.
|
|
23
|
+
*/
|
|
24
|
+
function instanceOfSelcomMetadata(value) {
|
|
25
|
+
if (!('amount' in value) || value['amount'] === undefined)
|
|
26
|
+
return false;
|
|
27
|
+
if (!('pesaAccount' in value) || value['pesaAccount'] === undefined)
|
|
28
|
+
return false;
|
|
29
|
+
if (!('mobileReference' in value) || value['mobileReference'] === undefined)
|
|
30
|
+
return false;
|
|
31
|
+
if (!('ussdCode' in value) || value['ussdCode'] === undefined)
|
|
32
|
+
return false;
|
|
33
|
+
if (!('instructions' in value) || value['instructions'] === undefined)
|
|
34
|
+
return false;
|
|
35
|
+
return true;
|
|
36
|
+
}
|
|
37
|
+
function SelcomMetadataFromJSON(json) {
|
|
38
|
+
return SelcomMetadataFromJSONTyped(json, false);
|
|
39
|
+
}
|
|
40
|
+
function SelcomMetadataFromJSONTyped(json, ignoreDiscriminator) {
|
|
41
|
+
if (json == null) {
|
|
42
|
+
return json;
|
|
43
|
+
}
|
|
44
|
+
return {
|
|
45
|
+
'amount': json['amount'],
|
|
46
|
+
'pesaAccount': json['pesa_account'],
|
|
47
|
+
'mobileReference': json['mobile_reference'],
|
|
48
|
+
'ussdCode': json['ussd_code'],
|
|
49
|
+
'instructions': json['instructions'],
|
|
50
|
+
};
|
|
51
|
+
}
|
|
52
|
+
function SelcomMetadataToJSON(json) {
|
|
53
|
+
return SelcomMetadataToJSONTyped(json, false);
|
|
54
|
+
}
|
|
55
|
+
function SelcomMetadataToJSONTyped(value, ignoreDiscriminator = false) {
|
|
56
|
+
if (value == null) {
|
|
57
|
+
return value;
|
|
58
|
+
}
|
|
59
|
+
return {
|
|
60
|
+
'amount': value['amount'],
|
|
61
|
+
'pesa_account': value['pesaAccount'],
|
|
62
|
+
'mobile_reference': value['mobileReference'],
|
|
63
|
+
'ussd_code': value['ussdCode'],
|
|
64
|
+
'instructions': value['instructions'],
|
|
65
|
+
};
|
|
66
|
+
}
|
package/dist/models/index.d.ts
CHANGED
|
@@ -66,6 +66,7 @@ export * from './DeleteSnapshotJobRequestContent.js';
|
|
|
66
66
|
export * from './DeleteSnapshotJobResponseContent.js';
|
|
67
67
|
export * from './DeleteSnapshotRequestContent.js';
|
|
68
68
|
export * from './DeleteSnapshotResponseContent.js';
|
|
69
|
+
export * from './DnsBackend.js';
|
|
69
70
|
export * from './DnsCreateCandidateInfo.js';
|
|
70
71
|
export * from './DnsRecordInfo.js';
|
|
71
72
|
export * from './DnsRecordMutationData.js';
|
|
@@ -117,6 +118,9 @@ export * from './GetDomainRequestContent.js';
|
|
|
117
118
|
export * from './GetDomainResponseContent.js';
|
|
118
119
|
export * from './GetEncryptedPasswordRequestContent.js';
|
|
119
120
|
export * from './GetEncryptedPasswordResponseContent.js';
|
|
121
|
+
export * from './GetInvoiceDetailsRequestContent.js';
|
|
122
|
+
export * from './GetInvoiceDetailsResponseContent.js';
|
|
123
|
+
export * from './GetInvoiceDetailsResponseData.js';
|
|
120
124
|
export * from './GetNoVncConsoleRequestContent.js';
|
|
121
125
|
export * from './GetNoVncConsoleResponseContent.js';
|
|
122
126
|
export * from './GetVpsConfigRequestContent.js';
|
|
@@ -125,6 +129,12 @@ export * from './GetVpsDetailsRequestContent.js';
|
|
|
125
129
|
export * from './GetVpsDetailsResponseContent.js';
|
|
126
130
|
export * from './InternalServiceErrorResponseContent.js';
|
|
127
131
|
export * from './InvalidStateErrorResponseContent.js';
|
|
132
|
+
export * from './InvoiceDetails.js';
|
|
133
|
+
export * from './InvoiceIssuedTo.js';
|
|
134
|
+
export * from './InvoiceIssuedToTax.js';
|
|
135
|
+
export * from './InvoiceItem.js';
|
|
136
|
+
export * from './InvoiceSummary.js';
|
|
137
|
+
export * from './InvoiceTransaction.js';
|
|
128
138
|
export * from './ListBackupSchedulesRequestContent.js';
|
|
129
139
|
export * from './ListBackupSchedulesResponseContent.js';
|
|
130
140
|
export * from './ListBackupsRequestContent.js';
|
|
@@ -142,6 +152,8 @@ export * from './ListDomainsRequiringDataResponseContent.js';
|
|
|
142
152
|
export * from './ListDomainsResponseContent.js';
|
|
143
153
|
export * from './ListFirewallRulesRequestContent.js';
|
|
144
154
|
export * from './ListFirewallRulesResponseContent.js';
|
|
155
|
+
export * from './ListInvoicesResponseContent.js';
|
|
156
|
+
export * from './ListInvoicesResponseData.js';
|
|
145
157
|
export * from './ListIsosRequestContent.js';
|
|
146
158
|
export * from './ListIsosResponseContent.js';
|
|
147
159
|
export * from './ListIsosResponseData.js';
|
|
@@ -203,6 +215,7 @@ export * from './RollbackSnapshotResponseContent.js';
|
|
|
203
215
|
export * from './SaveDomainRequiredDataData.js';
|
|
204
216
|
export * from './SaveDomainRequiredDataRequestContent.js';
|
|
205
217
|
export * from './SaveDomainRequiredDataResponseContent.js';
|
|
218
|
+
export * from './SelcomMetadata.js';
|
|
206
219
|
export * from './ServiceBackupsResponseData.js';
|
|
207
220
|
export * from './ServiceSnapshotsResponseData.js';
|
|
208
221
|
export * from './ServiceUnavailableErrorResponseContent.js';
|
package/dist/models/index.js
CHANGED
|
@@ -84,6 +84,7 @@ __exportStar(require("./DeleteSnapshotJobRequestContent.js"), exports);
|
|
|
84
84
|
__exportStar(require("./DeleteSnapshotJobResponseContent.js"), exports);
|
|
85
85
|
__exportStar(require("./DeleteSnapshotRequestContent.js"), exports);
|
|
86
86
|
__exportStar(require("./DeleteSnapshotResponseContent.js"), exports);
|
|
87
|
+
__exportStar(require("./DnsBackend.js"), exports);
|
|
87
88
|
__exportStar(require("./DnsCreateCandidateInfo.js"), exports);
|
|
88
89
|
__exportStar(require("./DnsRecordInfo.js"), exports);
|
|
89
90
|
__exportStar(require("./DnsRecordMutationData.js"), exports);
|
|
@@ -135,6 +136,9 @@ __exportStar(require("./GetDomainRequestContent.js"), exports);
|
|
|
135
136
|
__exportStar(require("./GetDomainResponseContent.js"), exports);
|
|
136
137
|
__exportStar(require("./GetEncryptedPasswordRequestContent.js"), exports);
|
|
137
138
|
__exportStar(require("./GetEncryptedPasswordResponseContent.js"), exports);
|
|
139
|
+
__exportStar(require("./GetInvoiceDetailsRequestContent.js"), exports);
|
|
140
|
+
__exportStar(require("./GetInvoiceDetailsResponseContent.js"), exports);
|
|
141
|
+
__exportStar(require("./GetInvoiceDetailsResponseData.js"), exports);
|
|
138
142
|
__exportStar(require("./GetNoVncConsoleRequestContent.js"), exports);
|
|
139
143
|
__exportStar(require("./GetNoVncConsoleResponseContent.js"), exports);
|
|
140
144
|
__exportStar(require("./GetVpsConfigRequestContent.js"), exports);
|
|
@@ -143,6 +147,12 @@ __exportStar(require("./GetVpsDetailsRequestContent.js"), exports);
|
|
|
143
147
|
__exportStar(require("./GetVpsDetailsResponseContent.js"), exports);
|
|
144
148
|
__exportStar(require("./InternalServiceErrorResponseContent.js"), exports);
|
|
145
149
|
__exportStar(require("./InvalidStateErrorResponseContent.js"), exports);
|
|
150
|
+
__exportStar(require("./InvoiceDetails.js"), exports);
|
|
151
|
+
__exportStar(require("./InvoiceIssuedTo.js"), exports);
|
|
152
|
+
__exportStar(require("./InvoiceIssuedToTax.js"), exports);
|
|
153
|
+
__exportStar(require("./InvoiceItem.js"), exports);
|
|
154
|
+
__exportStar(require("./InvoiceSummary.js"), exports);
|
|
155
|
+
__exportStar(require("./InvoiceTransaction.js"), exports);
|
|
146
156
|
__exportStar(require("./ListBackupSchedulesRequestContent.js"), exports);
|
|
147
157
|
__exportStar(require("./ListBackupSchedulesResponseContent.js"), exports);
|
|
148
158
|
__exportStar(require("./ListBackupsRequestContent.js"), exports);
|
|
@@ -160,6 +170,8 @@ __exportStar(require("./ListDomainsRequiringDataResponseContent.js"), exports);
|
|
|
160
170
|
__exportStar(require("./ListDomainsResponseContent.js"), exports);
|
|
161
171
|
__exportStar(require("./ListFirewallRulesRequestContent.js"), exports);
|
|
162
172
|
__exportStar(require("./ListFirewallRulesResponseContent.js"), exports);
|
|
173
|
+
__exportStar(require("./ListInvoicesResponseContent.js"), exports);
|
|
174
|
+
__exportStar(require("./ListInvoicesResponseData.js"), exports);
|
|
163
175
|
__exportStar(require("./ListIsosRequestContent.js"), exports);
|
|
164
176
|
__exportStar(require("./ListIsosResponseContent.js"), exports);
|
|
165
177
|
__exportStar(require("./ListIsosResponseData.js"), exports);
|
|
@@ -221,6 +233,7 @@ __exportStar(require("./RollbackSnapshotResponseContent.js"), exports);
|
|
|
221
233
|
__exportStar(require("./SaveDomainRequiredDataData.js"), exports);
|
|
222
234
|
__exportStar(require("./SaveDomainRequiredDataRequestContent.js"), exports);
|
|
223
235
|
__exportStar(require("./SaveDomainRequiredDataResponseContent.js"), exports);
|
|
236
|
+
__exportStar(require("./SelcomMetadata.js"), exports);
|
|
224
237
|
__exportStar(require("./ServiceBackupsResponseData.js"), exports);
|
|
225
238
|
__exportStar(require("./ServiceSnapshotsResponseData.js"), exports);
|
|
226
239
|
__exportStar(require("./ServiceUnavailableErrorResponseContent.js"), exports);
|
package/dist/retryablePaths.js
CHANGED
package/dist.zip
CHANGED
|
Binary file
|
|
@@ -8,6 +8,9 @@ Name | Type
|
|
|
8
8
|
------------ | -------------
|
|
9
9
|
`domainName` | string
|
|
10
10
|
`zoneId` | string
|
|
11
|
+
`domainId` | string
|
|
12
|
+
`serviceId` | number
|
|
13
|
+
`backend` | [DnsBackend](DnsBackend.md)
|
|
11
14
|
`record` | [DnsRecordMutationRecord](DnsRecordMutationRecord.md)
|
|
12
15
|
|
|
13
16
|
## Example
|
|
@@ -19,6 +22,9 @@ import type { AddDnsRecordRequestContent } from '@hostafrica/ha-sdk-typescript'
|
|
|
19
22
|
const example = {
|
|
20
23
|
"domainName": null,
|
|
21
24
|
"zoneId": null,
|
|
25
|
+
"domainId": null,
|
|
26
|
+
"serviceId": null,
|
|
27
|
+
"backend": null,
|
|
22
28
|
"record": null,
|
|
23
29
|
} satisfies AddDnsRecordRequestContent
|
|
24
30
|
|
|
@@ -0,0 +1,159 @@
|
|
|
1
|
+
# BillingApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.hostafrica.com*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
| [**getInvoiceDetails**](BillingApi.md#getinvoicedetails) | **POST** /billing/get-invoice-details | |
|
|
8
|
+
| [**listInvoices**](BillingApi.md#listinvoices) | **POST** /billing/list-invoices | |
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
## getInvoiceDetails
|
|
13
|
+
|
|
14
|
+
> GetInvoiceDetailsResponseContent getInvoiceDetails(getInvoiceDetailsRequestContent)
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
Gets details for a single invoice, including line items, payee information, and transactions
|
|
19
|
+
|
|
20
|
+
### Example
|
|
21
|
+
|
|
22
|
+
```ts
|
|
23
|
+
import {
|
|
24
|
+
Configuration,
|
|
25
|
+
BillingApi,
|
|
26
|
+
} from '@hostafrica/ha-sdk-typescript';
|
|
27
|
+
import type { GetInvoiceDetailsRequest } from '@hostafrica/ha-sdk-typescript';
|
|
28
|
+
|
|
29
|
+
async function example() {
|
|
30
|
+
console.log("🚀 Testing @hostafrica/ha-sdk-typescript SDK...");
|
|
31
|
+
const config = new Configuration({
|
|
32
|
+
// Configure HTTP bearer authorization: BearerAuth
|
|
33
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
34
|
+
});
|
|
35
|
+
const api = new BillingApi(config);
|
|
36
|
+
|
|
37
|
+
const body = {
|
|
38
|
+
// GetInvoiceDetailsRequestContent
|
|
39
|
+
getInvoiceDetailsRequestContent: ...,
|
|
40
|
+
} satisfies GetInvoiceDetailsRequest;
|
|
41
|
+
|
|
42
|
+
try {
|
|
43
|
+
const data = await api.getInvoiceDetails(body);
|
|
44
|
+
console.log(data);
|
|
45
|
+
} catch (error) {
|
|
46
|
+
console.error(error);
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
// Run the test
|
|
51
|
+
example().catch(console.error);
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
### Parameters
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
| Name | Type | Description | Notes |
|
|
58
|
+
|------------- | ------------- | ------------- | -------------|
|
|
59
|
+
| **getInvoiceDetailsRequestContent** | [GetInvoiceDetailsRequestContent](GetInvoiceDetailsRequestContent.md) | | |
|
|
60
|
+
|
|
61
|
+
### Return type
|
|
62
|
+
|
|
63
|
+
[**GetInvoiceDetailsResponseContent**](GetInvoiceDetailsResponseContent.md)
|
|
64
|
+
|
|
65
|
+
### Authorization
|
|
66
|
+
|
|
67
|
+
[BearerAuth](../README.md#BearerAuth)
|
|
68
|
+
|
|
69
|
+
### HTTP request headers
|
|
70
|
+
|
|
71
|
+
- **Content-Type**: `application/json`
|
|
72
|
+
- **Accept**: `application/json`
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
### HTTP response details
|
|
76
|
+
| Status code | Description | Response headers |
|
|
77
|
+
|-------------|-------------|------------------|
|
|
78
|
+
| **200** | GetInvoiceDetails 200 response | - |
|
|
79
|
+
| **400** | BadRequestError 400 response | - |
|
|
80
|
+
| **401** | UnauthorizedError 401 response | - |
|
|
81
|
+
| **403** | ForbiddenError 403 response | - |
|
|
82
|
+
| **404** | ResourceNotFoundError 404 response | - |
|
|
83
|
+
| **422** | ValidationError 422 response | - |
|
|
84
|
+
| **429** | TooManyRequestsError 429 response | * Retry-After - Number of seconds to wait before retrying <br> |
|
|
85
|
+
| **500** | InternalServiceError 500 response | - |
|
|
86
|
+
| **503** | ServiceUnavailableError 503 response | * Retry-After - Number of seconds to wait before retrying <br> |
|
|
87
|
+
|
|
88
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
## listInvoices
|
|
92
|
+
|
|
93
|
+
> ListInvoicesResponseContent listInvoices()
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
Lists invoices for the authenticated user
|
|
98
|
+
|
|
99
|
+
### Example
|
|
100
|
+
|
|
101
|
+
```ts
|
|
102
|
+
import {
|
|
103
|
+
Configuration,
|
|
104
|
+
BillingApi,
|
|
105
|
+
} from '@hostafrica/ha-sdk-typescript';
|
|
106
|
+
import type { ListInvoicesRequest } from '@hostafrica/ha-sdk-typescript';
|
|
107
|
+
|
|
108
|
+
async function example() {
|
|
109
|
+
console.log("🚀 Testing @hostafrica/ha-sdk-typescript SDK...");
|
|
110
|
+
const config = new Configuration({
|
|
111
|
+
// Configure HTTP bearer authorization: BearerAuth
|
|
112
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
113
|
+
});
|
|
114
|
+
const api = new BillingApi(config);
|
|
115
|
+
|
|
116
|
+
try {
|
|
117
|
+
const data = await api.listInvoices();
|
|
118
|
+
console.log(data);
|
|
119
|
+
} catch (error) {
|
|
120
|
+
console.error(error);
|
|
121
|
+
}
|
|
122
|
+
}
|
|
123
|
+
|
|
124
|
+
// Run the test
|
|
125
|
+
example().catch(console.error);
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
### Parameters
|
|
129
|
+
|
|
130
|
+
This endpoint does not need any parameter.
|
|
131
|
+
|
|
132
|
+
### Return type
|
|
133
|
+
|
|
134
|
+
[**ListInvoicesResponseContent**](ListInvoicesResponseContent.md)
|
|
135
|
+
|
|
136
|
+
### Authorization
|
|
137
|
+
|
|
138
|
+
[BearerAuth](../README.md#BearerAuth)
|
|
139
|
+
|
|
140
|
+
### HTTP request headers
|
|
141
|
+
|
|
142
|
+
- **Content-Type**: Not defined
|
|
143
|
+
- **Accept**: `application/json`
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
### HTTP response details
|
|
147
|
+
| Status code | Description | Response headers |
|
|
148
|
+
|-------------|-------------|------------------|
|
|
149
|
+
| **200** | ListInvoices 200 response | - |
|
|
150
|
+
| **400** | BadRequestError 400 response | - |
|
|
151
|
+
| **401** | UnauthorizedError 401 response | - |
|
|
152
|
+
| **403** | ForbiddenError 403 response | - |
|
|
153
|
+
| **422** | ValidationError 422 response | - |
|
|
154
|
+
| **429** | TooManyRequestsError 429 response | * Retry-After - Number of seconds to wait before retrying <br> |
|
|
155
|
+
| **500** | InternalServiceError 500 response | - |
|
|
156
|
+
| **503** | ServiceUnavailableError 503 response | * Retry-After - Number of seconds to wait before retrying <br> |
|
|
157
|
+
|
|
158
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
159
|
+
|
package/docs/DNSApi.md
CHANGED
|
@@ -22,7 +22,7 @@ All URIs are relative to *https://api.hostafrica.com*
|
|
|
22
22
|
|
|
23
23
|
|
|
24
24
|
|
|
25
|
-
Adds a DNS record to a zone
|
|
25
|
+
Adds a DNS record to a zone. Legacy callers pass zone_id only (DNS Manager v1). For DirectAdmin, pass backend=directadmin with domain_id; upstream v2 receives domain_id and record only.
|
|
26
26
|
|
|
27
27
|
### Example
|
|
28
28
|
|
|
@@ -180,7 +180,7 @@ example().catch(console.error);
|
|
|
180
180
|
|
|
181
181
|
|
|
182
182
|
|
|
183
|
-
Deletes a DNS record from a zone
|
|
183
|
+
Deletes a DNS record from a zone. Legacy callers pass zone_id only (DNS Manager v1). For DirectAdmin, pass backend=directadmin with domain_id; upstream v2 receives domain_id and record only.
|
|
184
184
|
|
|
185
185
|
### Example
|
|
186
186
|
|
|
@@ -338,7 +338,7 @@ example().catch(console.error);
|
|
|
338
338
|
|
|
339
339
|
|
|
340
340
|
|
|
341
|
-
Edits a DNS record in a zone
|
|
341
|
+
Edits a DNS record in a zone. Legacy callers pass zone_id only (DNS Manager v1). For DirectAdmin, pass backend=directadmin with domain_id; upstream v2 receives domain_id and record only.
|
|
342
342
|
|
|
343
343
|
### Example
|
|
344
344
|
|
|
@@ -417,7 +417,7 @@ example().catch(console.error);
|
|
|
417
417
|
|
|
418
418
|
|
|
419
419
|
|
|
420
|
-
Retrieves DNS zone details and records for an owned domain.
|
|
420
|
+
Retrieves DNS zone details and records for an owned domain. Omit backend for the legacy DNS Manager (v1) path; set backend from list-dns-zones to route DirectAdmin zones to v2.
|
|
421
421
|
|
|
422
422
|
### Example
|
|
423
423
|
|
|
@@ -8,6 +8,9 @@ Name | Type
|
|
|
8
8
|
------------ | -------------
|
|
9
9
|
`domainName` | string
|
|
10
10
|
`zoneId` | string
|
|
11
|
+
`domainId` | string
|
|
12
|
+
`serviceId` | number
|
|
13
|
+
`backend` | [DnsBackend](DnsBackend.md)
|
|
11
14
|
`record` | [DnsRecordMutationRecord](DnsRecordMutationRecord.md)
|
|
12
15
|
|
|
13
16
|
## Example
|
|
@@ -19,6 +22,9 @@ import type { DeleteDnsRecordRequestContent } from '@hostafrica/ha-sdk-typescrip
|
|
|
19
22
|
const example = {
|
|
20
23
|
"domainName": null,
|
|
21
24
|
"zoneId": null,
|
|
25
|
+
"domainId": null,
|
|
26
|
+
"serviceId": null,
|
|
27
|
+
"backend": null,
|
|
22
28
|
"record": null,
|
|
23
29
|
} satisfies DeleteDnsRecordRequestContent
|
|
24
30
|
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
|
|
2
|
+
# DnsBackend
|
|
3
|
+
|
|
4
|
+
Upstream DNS management backend for a zone. - `dns_manager` — WHMCS DNS Manager - `directadmin` — DirectAdmin DNS
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { DnsBackend } from '@hostafrica/ha-sdk-typescript'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
} satisfies DnsBackend
|
|
19
|
+
|
|
20
|
+
console.log(example)
|
|
21
|
+
|
|
22
|
+
// Convert the instance to a JSON string
|
|
23
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
24
|
+
console.log(exampleJSON)
|
|
25
|
+
|
|
26
|
+
// Parse the JSON string back to an object
|
|
27
|
+
const exampleParsed = JSON.parse(exampleJSON) as DnsBackend
|
|
28
|
+
console.log(exampleParsed)
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
32
|
+
|
|
33
|
+
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
|
|
2
2
|
# DnsRecordMutationRecord
|
|
3
3
|
|
|
4
|
-
DNS record fields for add, edit, or delete via DNSManager. See `DnsRecordInfo` for how `content` and structured fields map to upstream record data. Delete requires only `id`, `name`, and `type`.
|
|
4
|
+
DNS record fields for add, edit, or delete via DNSManager. See `DnsRecordInfo` for how `content` and structured fields map to upstream record data. Delete requires only `id`, `name`, and `type`. For edit and delete, `id` must be the numeric zone line from get-dns-zone-details (a positive integer string).
|
|
5
5
|
|
|
6
6
|
## Properties
|
|
7
7
|
|
package/docs/DnsZoneInfo.md
CHANGED
|
@@ -16,6 +16,7 @@ Name | Type
|
|
|
16
16
|
`packageName` | string
|
|
17
17
|
`hasHosting` | [DomainHostingLink](DomainHostingLink.md)
|
|
18
18
|
`hasDnsManagerZone` | boolean
|
|
19
|
+
`backend` | [DnsBackend](DnsBackend.md)
|
|
19
20
|
|
|
20
21
|
## Example
|
|
21
22
|
|
|
@@ -33,6 +34,7 @@ const example = {
|
|
|
33
34
|
"packageName": null,
|
|
34
35
|
"hasHosting": null,
|
|
35
36
|
"hasDnsManagerZone": null,
|
|
37
|
+
"backend": null,
|
|
36
38
|
} satisfies DnsZoneInfo
|
|
37
39
|
|
|
38
40
|
console.log(example)
|
|
@@ -8,6 +8,9 @@ Name | Type
|
|
|
8
8
|
------------ | -------------
|
|
9
9
|
`domainName` | string
|
|
10
10
|
`zoneId` | string
|
|
11
|
+
`domainId` | string
|
|
12
|
+
`serviceId` | number
|
|
13
|
+
`backend` | [DnsBackend](DnsBackend.md)
|
|
11
14
|
`record` | [DnsRecordMutationRecord](DnsRecordMutationRecord.md)
|
|
12
15
|
|
|
13
16
|
## Example
|
|
@@ -19,6 +22,9 @@ import type { EditDnsRecordRequestContent } from '@hostafrica/ha-sdk-typescript'
|
|
|
19
22
|
const example = {
|
|
20
23
|
"domainName": null,
|
|
21
24
|
"zoneId": null,
|
|
25
|
+
"domainId": null,
|
|
26
|
+
"serviceId": null,
|
|
27
|
+
"backend": null,
|
|
22
28
|
"record": null,
|
|
23
29
|
} satisfies EditDnsRecordRequestContent
|
|
24
30
|
|
|
@@ -7,6 +7,7 @@
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
9
|
`domainId` | string
|
|
10
|
+
`backend` | [DnsBackend](DnsBackend.md)
|
|
10
11
|
|
|
11
12
|
## Example
|
|
12
13
|
|
|
@@ -16,6 +17,7 @@ import type { GetDnsZoneDetailsRequestContent } from '@hostafrica/ha-sdk-typescr
|
|
|
16
17
|
// TODO: Update the object below with actual values
|
|
17
18
|
const example = {
|
|
18
19
|
"domainId": null,
|
|
20
|
+
"backend": null,
|
|
19
21
|
} satisfies GetDnsZoneDetailsRequestContent
|
|
20
22
|
|
|
21
23
|
console.log(example)
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
|
|
2
|
+
# GetInvoiceDetailsRequestContent
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`invoiceId` | string
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { GetInvoiceDetailsRequestContent } from '@hostafrica/ha-sdk-typescript'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"invoiceId": null,
|
|
19
|
+
} satisfies GetInvoiceDetailsRequestContent
|
|
20
|
+
|
|
21
|
+
console.log(example)
|
|
22
|
+
|
|
23
|
+
// Convert the instance to a JSON string
|
|
24
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
25
|
+
console.log(exampleJSON)
|
|
26
|
+
|
|
27
|
+
// Parse the JSON string back to an object
|
|
28
|
+
const exampleParsed = JSON.parse(exampleJSON) as GetInvoiceDetailsRequestContent
|
|
29
|
+
console.log(exampleParsed)
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
33
|
+
|
|
34
|
+
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
|
|
2
|
+
# GetInvoiceDetailsResponseContent
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`status` | [OperationStatus](OperationStatus.md)
|
|
10
|
+
`data` | [GetInvoiceDetailsResponseData](GetInvoiceDetailsResponseData.md)
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import type { GetInvoiceDetailsResponseContent } from '@hostafrica/ha-sdk-typescript'
|
|
16
|
+
|
|
17
|
+
// TODO: Update the object below with actual values
|
|
18
|
+
const example = {
|
|
19
|
+
"status": null,
|
|
20
|
+
"data": null,
|
|
21
|
+
} satisfies GetInvoiceDetailsResponseContent
|
|
22
|
+
|
|
23
|
+
console.log(example)
|
|
24
|
+
|
|
25
|
+
// Convert the instance to a JSON string
|
|
26
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
27
|
+
console.log(exampleJSON)
|
|
28
|
+
|
|
29
|
+
// Parse the JSON string back to an object
|
|
30
|
+
const exampleParsed = JSON.parse(exampleJSON) as GetInvoiceDetailsResponseContent
|
|
31
|
+
console.log(exampleParsed)
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
35
|
+
|
|
36
|
+
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
|
|
2
|
+
# GetInvoiceDetailsResponseData
|
|
3
|
+
|
|
4
|
+
Top-level data payload for the GetInvoiceDetails response
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`invoice` | [InvoiceDetails](InvoiceDetails.md)
|
|
11
|
+
`selcomMetadata` | [SelcomMetadata](SelcomMetadata.md)
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import type { GetInvoiceDetailsResponseData } from '@hostafrica/ha-sdk-typescript'
|
|
17
|
+
|
|
18
|
+
// TODO: Update the object below with actual values
|
|
19
|
+
const example = {
|
|
20
|
+
"invoice": null,
|
|
21
|
+
"selcomMetadata": null,
|
|
22
|
+
} satisfies GetInvoiceDetailsResponseData
|
|
23
|
+
|
|
24
|
+
console.log(example)
|
|
25
|
+
|
|
26
|
+
// Convert the instance to a JSON string
|
|
27
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
28
|
+
console.log(exampleJSON)
|
|
29
|
+
|
|
30
|
+
// Parse the JSON string back to an object
|
|
31
|
+
const exampleParsed = JSON.parse(exampleJSON) as GetInvoiceDetailsResponseData
|
|
32
|
+
console.log(exampleParsed)
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
36
|
+
|
|
37
|
+
|