import * as API from "@distilled.cloud/core/api"; import { type HetznerOpError, type HetznerOpContext } from "../protocol.ts"; export type { HetznerOpError, HetznerOpContext }; /** Type of the [RRSet](#tag/zone-rrsets). */ export type AddZoneRrsetRecordsRequestRrType = "A" | "AAAA" | "CAA" | "CNAME" | "DS" | "HINFO" | "HTTPS" | "MX" | "NS" | "PTR" | "RP" | "SOA" | "SRV" | "SVCB" | "TLSA" | "TXT"; /** Record of a [RRSet](#tag/zone-rrsets). The `value` is used to identify the record in an [RRSet](#tag/zone-rrsets). */ export interface AddZoneRrsetRecordsRequestRecordsItem { /** Value of the record. For details about accepted values, see the [DNS record types documentation](https://docs.hetzner.com/networking/dns/record-types/overview/). */ value: string; /** Comment of the record. */ comment?: string; } /** Records to add to the [RRSet](#tag/zone-rrsets). Must not be empty and must only contain distinct record values. */ export type AddZoneRrsetRecordsRequestRecordsList = Array; export interface AddZoneRrsetRecordsRequest { /** ID or Name of the Zone. */ id_or_name: string; rr_name: string; rr_type: AddZoneRrsetRecordsRequestRrType | (string & {}); /** Time To Live (TTL) of the [RRSet](#tag/zone-rrsets). If not set, the [Zone's](#tag/zones) Default TTL is used. If set, and the RRSet being updated already has a TTL, the values must be the same. */ ttl?: number | null; /** Records to add to the [RRSet](#tag/zone-rrsets). Must not be empty and must only contain distinct record values. */ records: AddZoneRrsetRecordsRequestRecordsList; } /** Status of the Action. */ export type AddZoneRrsetRecordsResponseActionStatus = "running" | "success" | "error"; export interface AddZoneRrsetRecordsResponseActionResourcesItem { /** ID of the Resource. */ id: number; /** Type of the Resource. */ type: string; } /** Resources the Action relates to. */ export type AddZoneRrsetRecordsResponseActionResourcesList = Array; /** Error message for the Action if an error occurred, otherwise null. */ export interface AddZoneRrsetRecordsResponseActionError { /** Fixed error code for machines. */ code: string; /** Error message for humans. */ message: string; } export interface AddZoneRrsetRecordsResponseAction { /** ID of the [Action](#description/actions). */ id: number; /** Command executed in the Action. */ command: string; /** Status of the Action. */ status: AddZoneRrsetRecordsResponseActionStatus; /** Point in time when the Action was started (in [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) format). */ started: string; /** Point in time when the Action was finished (in [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) format). Only set if the Action is finished otherwise null. */ finished: string | null; /** Progress of the Action in percent. */ progress: number; /** Resources the Action relates to. */ resources: AddZoneRrsetRecordsResponseActionResourcesList; /** Error message for the Action if an error occurred, otherwise null. */ error: AddZoneRrsetRecordsResponseActionError | null; } export interface AddZoneRrsetRecordsResponse { action: AddZoneRrsetRecordsResponseAction; } /** Type of the [RRSet](#tag/zone-rrsets). */ export type ChangeZoneRrsetProtectionRequestRrType = "A" | "AAAA" | "CAA" | "CNAME" | "DS" | "HINFO" | "HTTPS" | "MX" | "NS" | "PTR" | "RP" | "SOA" | "SRV" | "SVCB" | "TLSA" | "TXT"; export interface ChangeZoneRrsetProtectionRequest { /** ID or Name of the Zone. */ id_or_name: string; rr_name: string; rr_type: ChangeZoneRrsetProtectionRequestRrType | (string & {}); /** Prevent the Resource from being changed. */ change: boolean; } /** Status of the Action. */ export type ChangeZoneRrsetProtectionResponseActionStatus = "running" | "success" | "error"; export type ChangeZoneRrsetProtectionResponseActionResourcesItem = AddZoneRrsetRecordsResponseActionResourcesItem; /** Resources the Action relates to. */ export type ChangeZoneRrsetProtectionResponseActionResourcesList = Array; /** Error message for the Action if an error occurred, otherwise null. */ export type ChangeZoneRrsetProtectionResponseActionError = AddZoneRrsetRecordsResponseActionError; export interface ChangeZoneRrsetProtectionResponseAction { /** ID of the [Action](#description/actions). */ id: number; /** Command executed in the Action. */ command: string; /** Status of the Action. */ status: ChangeZoneRrsetProtectionResponseActionStatus; /** Point in time when the Action was started (in [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) format). */ started: string; /** Point in time when the Action was finished (in [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) format). Only set if the Action is finished otherwise null. */ finished: string | null; /** Progress of the Action in percent. */ progress: number; /** Resources the Action relates to. */ resources: ChangeZoneRrsetProtectionResponseActionResourcesList; /** Error message for the Action if an error occurred, otherwise null. */ error: AddZoneRrsetRecordsResponseActionError | null; } export interface ChangeZoneRrsetProtectionResponse { action: ChangeZoneRrsetProtectionResponseAction; } /** Type of the [RRSet](#tag/zone-rrsets). */ export type ChangeZoneRrsetTtlRequestRrType = "A" | "AAAA" | "CAA" | "CNAME" | "DS" | "HINFO" | "HTTPS" | "MX" | "NS" | "PTR" | "RP" | "SOA" | "SRV" | "SVCB" | "TLSA" | "TXT"; export interface ChangeZoneRrsetTtlRequest { /** ID or Name of the Zone. */ id_or_name: string; rr_name: string; rr_type: ChangeZoneRrsetTtlRequestRrType | (string & {}); /** Time To Live (TTL) of the [RRSet](#tag/zone-rrsets). Must be in between 60s and 2147483647s. If not set, the [Zone's](#tag/zones) Default TTL is used. */ ttl: number | null; } /** Status of the Action. */ export type ChangeZoneRrsetTtlResponseActionStatus = "running" | "success" | "error"; export type ChangeZoneRrsetTtlResponseActionResourcesItem = AddZoneRrsetRecordsResponseActionResourcesItem; /** Resources the Action relates to. */ export type ChangeZoneRrsetTtlResponseActionResourcesList = Array; /** Error message for the Action if an error occurred, otherwise null. */ export type ChangeZoneRrsetTtlResponseActionError = AddZoneRrsetRecordsResponseActionError; export interface ChangeZoneRrsetTtlResponseAction { /** ID of the [Action](#description/actions). */ id: number; /** Command executed in the Action. */ command: string; /** Status of the Action. */ status: ChangeZoneRrsetTtlResponseActionStatus; /** Point in time when the Action was started (in [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) format). */ started: string; /** Point in time when the Action was finished (in [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) format). Only set if the Action is finished otherwise null. */ finished: string | null; /** Progress of the Action in percent. */ progress: number; /** Resources the Action relates to. */ resources: ChangeZoneRrsetTtlResponseActionResourcesList; /** Error message for the Action if an error occurred, otherwise null. */ error: AddZoneRrsetRecordsResponseActionError | null; } export interface ChangeZoneRrsetTtlResponse { action: ChangeZoneRrsetTtlResponseAction; } /** Type of the [RRSet](#tag/zone-rrsets). */ export type RemoveZoneRrsetRecordsRequestRrType = "A" | "AAAA" | "CAA" | "CNAME" | "DS" | "HINFO" | "HTTPS" | "MX" | "NS" | "PTR" | "RP" | "SOA" | "SRV" | "SVCB" | "TLSA" | "TXT"; /** Record of a [RRSet](#tag/zone-rrsets). The `value` is used to identify the record in an [RRSet](#tag/zone-rrsets). */ export type RemoveZoneRrsetRecordsRequestRecordsItem = AddZoneRrsetRecordsRequestRecordsItem; /** Records to remove from the [RRSet](#tag/zone-rrsets). Must not be empty and must only contain distinct record values. */ export type RemoveZoneRrsetRecordsRequestRecordsList = Array; export interface RemoveZoneRrsetRecordsRequest { /** ID or Name of the Zone. */ id_or_name: string; rr_name: string; rr_type: RemoveZoneRrsetRecordsRequestRrType | (string & {}); /** Records to remove from the [RRSet](#tag/zone-rrsets). Must not be empty and must only contain distinct record values. */ records: RemoveZoneRrsetRecordsRequestRecordsList; } /** Status of the Action. */ export type RemoveZoneRrsetRecordsResponseActionStatus = "running" | "success" | "error"; export type RemoveZoneRrsetRecordsResponseActionResourcesItem = AddZoneRrsetRecordsResponseActionResourcesItem; /** Resources the Action relates to. */ export type RemoveZoneRrsetRecordsResponseActionResourcesList = Array; /** Error message for the Action if an error occurred, otherwise null. */ export type RemoveZoneRrsetRecordsResponseActionError = AddZoneRrsetRecordsResponseActionError; export interface RemoveZoneRrsetRecordsResponseAction { /** ID of the [Action](#description/actions). */ id: number; /** Command executed in the Action. */ command: string; /** Status of the Action. */ status: RemoveZoneRrsetRecordsResponseActionStatus; /** Point in time when the Action was started (in [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) format). */ started: string; /** Point in time when the Action was finished (in [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) format). Only set if the Action is finished otherwise null. */ finished: string | null; /** Progress of the Action in percent. */ progress: number; /** Resources the Action relates to. */ resources: RemoveZoneRrsetRecordsResponseActionResourcesList; /** Error message for the Action if an error occurred, otherwise null. */ error: AddZoneRrsetRecordsResponseActionError | null; } export interface RemoveZoneRrsetRecordsResponse { action: RemoveZoneRrsetRecordsResponseAction; } /** Type of the [RRSet](#tag/zone-rrsets). */ export type SetZoneRrsetRecordsRequestRrType = "A" | "AAAA" | "CAA" | "CNAME" | "DS" | "HINFO" | "HTTPS" | "MX" | "NS" | "PTR" | "RP" | "SOA" | "SRV" | "SVCB" | "TLSA" | "TXT"; /** Record of a [RRSet](#tag/zone-rrsets). The `value` is used to identify the record in an [RRSet](#tag/zone-rrsets). */ export type SetZoneRrsetRecordsRequestRecordsItem = AddZoneRrsetRecordsRequestRecordsItem; /** Records to set in the [RRSet](#tag/zone-rrsets). Must not be empty and must only contain distinct record values. */ export type SetZoneRrsetRecordsRequestRecordsList = Array; export interface SetZoneRrsetRecordsRequest { /** ID or Name of the Zone. */ id_or_name: string; rr_name: string; rr_type: SetZoneRrsetRecordsRequestRrType | (string & {}); /** Records to set in the [RRSet](#tag/zone-rrsets). Must not be empty and must only contain distinct record values. */ records: SetZoneRrsetRecordsRequestRecordsList; } /** Status of the Action. */ export type SetZoneRrsetRecordsResponseActionStatus = "running" | "success" | "error"; export type SetZoneRrsetRecordsResponseActionResourcesItem = AddZoneRrsetRecordsResponseActionResourcesItem; /** Resources the Action relates to. */ export type SetZoneRrsetRecordsResponseActionResourcesList = Array; /** Error message for the Action if an error occurred, otherwise null. */ export type SetZoneRrsetRecordsResponseActionError = AddZoneRrsetRecordsResponseActionError; export interface SetZoneRrsetRecordsResponseAction { /** ID of the [Action](#description/actions). */ id: number; /** Command executed in the Action. */ command: string; /** Status of the Action. */ status: SetZoneRrsetRecordsResponseActionStatus; /** Point in time when the Action was started (in [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) format). */ started: string; /** Point in time when the Action was finished (in [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) format). Only set if the Action is finished otherwise null. */ finished: string | null; /** Progress of the Action in percent. */ progress: number; /** Resources the Action relates to. */ resources: SetZoneRrsetRecordsResponseActionResourcesList; /** Error message for the Action if an error occurred, otherwise null. */ error: AddZoneRrsetRecordsResponseActionError | null; } export interface SetZoneRrsetRecordsResponse { action: SetZoneRrsetRecordsResponseAction; } /** Type of the [RRSet](#tag/zone-rrsets). */ export type UpdateZoneRrsetRecordsRequestRrType = "A" | "AAAA" | "CAA" | "CNAME" | "DS" | "HINFO" | "HTTPS" | "MX" | "NS" | "PTR" | "RP" | "SOA" | "SRV" | "SVCB" | "TLSA" | "TXT"; /** Record of a [RRSet](#tag/zone-rrsets). The `value` is used to identify the record in an [RRSet](#tag/zone-rrsets). */ export interface UpdateZoneRrsetRecordsRequestRecordsItem { /** Value of the record to update. */ value: string; /** New comment for the record. */ comment: string; } /** Records to update in the [RRSet](#tag/zone-rrsets). Must not be empty and must only contain distinct record values. */ export type UpdateZoneRrsetRecordsRequestRecordsList = Array; export interface UpdateZoneRrsetRecordsRequest { /** ID or Name of the Zone. */ id_or_name: string; rr_name: string; rr_type: UpdateZoneRrsetRecordsRequestRrType | (string & {}); /** Records to update in the [RRSet](#tag/zone-rrsets). Must not be empty and must only contain distinct record values. */ records: UpdateZoneRrsetRecordsRequestRecordsList; } /** Status of the Action. */ export type UpdateZoneRrsetRecordsResponseActionStatus = "running" | "success" | "error"; export type UpdateZoneRrsetRecordsResponseActionResourcesItem = AddZoneRrsetRecordsResponseActionResourcesItem; /** Resources the Action relates to. */ export type UpdateZoneRrsetRecordsResponseActionResourcesList = Array; /** Error message for the Action if an error occurred, otherwise null. */ export type UpdateZoneRrsetRecordsResponseActionError = AddZoneRrsetRecordsResponseActionError; export interface UpdateZoneRrsetRecordsResponseAction { /** ID of the [Action](#description/actions). */ id: number; /** Command executed in the Action. */ command: string; /** Status of the Action. */ status: UpdateZoneRrsetRecordsResponseActionStatus; /** Point in time when the Action was started (in [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) format). */ started: string; /** Point in time when the Action was finished (in [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) format). Only set if the Action is finished otherwise null. */ finished: string | null; /** Progress of the Action in percent. */ progress: number; /** Resources the Action relates to. */ resources: UpdateZoneRrsetRecordsResponseActionResourcesList; /** Error message for the Action if an error occurred, otherwise null. */ error: AddZoneRrsetRecordsResponseActionError | null; } export interface UpdateZoneRrsetRecordsResponse { action: UpdateZoneRrsetRecordsResponseAction; } export type AddZoneRrsetRecordsError = HetznerOpError; /** Add Records to an RRSet Adds resource records (RRs) to an [RRSet](#tag/zone-rrsets) in the [Zone](#tag/zones). For convenience, the [RRSet](#tag/zone-rrsets) will be automatically created if it doesn't exist. Otherwise, the new records are appended to the existing [RRSet](#tag/zone-rrsets). Only applicable for [Zones](#tag/zones) in primary mode. #### Operation specific errors */ export declare const addZoneRrsetRecords: API.OperationMethod; export type ChangeZoneRrsetProtectionError = HetznerOpError; /** Change an RRSet's Protection Changes the protection of an [RRSet](#tag/zone-rrsets) in the [Zone](#tag/zones). Only applicable for [Zones](#tag/zones) in primary mode. #### Operation specific errors */ export declare const changeZoneRrsetProtection: API.OperationMethod; export type ChangeZoneRrsetTtlError = HetznerOpError; /** Change an RRSet's TTL Changes the Time To Live (TTL) of an [RRSet](#tag/zone-rrsets) in the [Zone](#tag/zones). Only applicable for [Zones](#tag/zones) in primary mode. #### Operation specific errors */ export declare const changeZoneRrsetTtl: API.OperationMethod; export type RemoveZoneRrsetRecordsError = HetznerOpError; /** Remove Records from an RRSet Removes resource records (RRs) from an existing [RRSet](#tag/zone-rrsets) in the [Zone](#tag/zones). For convenience, the [RRSet](#tag/zone-rrsets) will be automatically deleted if it doesn't contain any RRs afterwards. Only applicable for [Zones](#tag/zones) in primary mode. #### Operation specific errors */ export declare const removeZoneRrsetRecords: API.OperationMethod; export type SetZoneRrsetRecordsError = HetznerOpError; /** Set Records of an RRSet Overwrites the resource records (RRs) of an existing [RRSet](#tag/zone-rrsets) in the [Zone](#tag/zones). Only applicable for [Zones](#tag/zones) in primary mode. #### Operation specific errors */ export declare const setZoneRrsetRecords: API.OperationMethod; export type UpdateZoneRrsetRecordsError = HetznerOpError; /** Update Records of an RRSet Updates resource records' (RRs) comments of an existing [RRSet](#tag/zone-rrsets) in the [Zone](#tag/zones). Only applicable for [Zones](#tag/zones) in primary mode. #### Operation specific errors */ export declare const updateZoneRrsetRecords: API.OperationMethod; //# sourceMappingURL=zone_rrset_actions.d.ts.map