Skip to content

Commit beb8ea2

Browse files
author
williamd5
committed
docs: zone validation response class & interface
1 parent 3e0dcee commit beb8ea2

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

docs.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,9 @@
9191
- [Class: `BulkUpdateRecordsPretty`](#class-bulkupdaterecordspretty)
9292
- [`bulkUpdateRecordsPretty.failedRecords`](#bulkupdaterecordsprettyfailedrecords)
9393
- [`bulkUpdateRecordsPretty.records`](#bulkupdaterecordsprettyrecords)
94+
- [Class: `ZoneValidationPretty`](#class-zonevalidationpretty)
95+
- [`zoneValidationPretty.parsedRecords`](#zonevalidationprettyparsedrecords)
96+
- [`zoneValidationPretty.validRecords`](#zonevalidationprettyvalidrecords)
9497
- [Class: `ApiError`](#class-apierror)
9598
- [Class property: `ApiError.messages`](#class-property-apierrormessages)
9699
- [Class property: `ApiError.specialMessages`](#class-property-apierrorspecialmessages)
@@ -109,6 +112,7 @@
109112
- [Interface: `PrimaryServerModel`](#interface-primaryservermodel)
110113
- [Interface: `PaginatedZones`](#interface-paginatedzones)
111114
- [Interface: `PaginatedData`](#interface-paginateddata)
115+
- [Interface: `ZoneValidation`](#interface-zonevalidation)
112116
</details>
113117

114118
<a name="class-hetznerdnsclient"></a>
@@ -893,6 +897,29 @@ Records that were updated
893897
- Type: <code>[**DnsRecord**](#class-dnsrecord)[]</code>
894898
- Read only
895899

900+
<a name="class-zonevalidationpretty"></a>
901+
902+
## Class: `ZoneValidationPretty`
903+
Hetzner DNS Zone Validation
904+
905+
- Extends: <code>[**ClientObject**](#class-clientobjectt)&lt;[**ZoneValidation**](#interface-zonevalidation)></code>
906+
907+
<a name="zonevalidationprettyparsedrecords"></a>
908+
909+
### `zoneValidationPretty.parsedRecords`
910+
Number of parsed records
911+
912+
- Type: <code>[**number**](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)</code>
913+
- Read only
914+
915+
<a name="zonevalidationprettyvalidrecords"></a>
916+
917+
### `zoneValidationPretty.validRecords`
918+
Valid records
919+
920+
- Type: <code>[**DnsRecord**](#class-dnsrecord)[]</code>
921+
- Read only
922+
896923
<a name="class-apierror"></a>
897924

898925
## Class: `ApiError`
@@ -1073,3 +1100,12 @@ Paginated API response
10731100
- `per_page` <code>[**number**](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)</code> The number of items shown per page
10741101
- `last_page` <code>[**number**](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)</code> The number of the last page
10751102
- `total_entries` <code>[**number**](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)</code> The total number of items
1103+
1104+
<a name="interface-zonevalidation"></a>
1105+
1106+
## Interface: `ZoneValidation`
1107+
Zone file validation response
1108+
1109+
- Extends: <code>[**ErrorModel**](#interface-errormodel)</code>
1110+
- `parsed_records` <code>[**number**](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)</code> Number of parsed records
1111+
- `valid_records` <code>[**RecordModel**](#interface-recordmodel)[]</code> Valid records

0 commit comments

Comments
 (0)