@leaflow/sdk 0.0.0-dev.35.g30ba751 → 0.0.0-dev.352.g85966ed

package/dist/dns/v1/generated/schemas.zod.d.ts

@@ -0,0 +1,354 @@
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * Leaflow DNS API
+ * Manage DNS records across supported providers through a single API. Register a provider
+ * credential, and every domain that credential can reach becomes readable and writable here.
+ *
+ * Reads and writes always reflect the current state at the provider. Records changed through the
+ * provider's own console, an ACME client, or any other automation are visible here immediately,
+ * and changes made here take effect there.
+ *
+ * ## Authentication
+ *
+ * Every request carries a scoped token; see the `bearerAuth` security scheme.
+ *
+ * **Neither the path nor the headers carry a `project_id`**: the current project is determined by
+ * the token.
+ *
+ * ## Conventions
+ *
+ * - **Records are addressed as record sets, not as individual records.** All records sharing a
+ *   name and a type form one set — for example, three A records pointing at three addresses. This
+ *   API exposes no per-record identifier, because provider-assigned identifiers are neither
+ *   portable across providers nor guaranteed to be stable within one.
+ * - **`PUT` replaces an entire record set; `PATCH` names individual values.** See below; this is
+ *   the single most consequential distinction in this API.
+ * - **Confirm which credential owns a domain before writing to it.** The same domain can exist in
+ *   more than one provider account — most commonly while a domain is being migrated and the old
+ *   account still holds it — and only one of them is actually serving queries.
+ * - **Changes do not take effect everywhere at once.** A write reaches the provider immediately,
+ *   but resolvers elsewhere continue serving the previous value until its TTL expires. Allow at
+ *   least one TTL before verifying a change by resolving the name.
+ * - **Credential material is never returned.** No operation, including the one that registers it,
+ *   returns the values that were submitted. A credential that was entered incorrectly must be
+ *   deleted and registered again.
+ *
+ * ## PUT or PATCH
+ *
+ * `PUT` states what a record set should contain. `PATCH` names values to add or remove and leaves
+ * the rest alone. The distinction is concurrency.
+ *
+ * Changing part of a set with `PUT` means reading it and submitting a modified list. That is a
+ * read-modify-write: a value added in between — by a concurrent certificate issuance, by another
+ * automation, or from the provider's own console — is absent from the submitted list and is
+ * therefore removed. Every request in that sequence returns 2xx.
+ *
+ * `PATCH` reads nothing. It is the only operation on a record set safe to issue concurrently, and
+ * the one certificate issuance must use.
+ * OpenAPI spec version: 1.0.0
+ */
+import * as zod from "zod";
+/**
+ * @summary List provider credentials
+ */
+export declare const listCredentialsQueryLimitDefault = 50;
+export declare const listCredentialsQueryLimitMax = 200;
+export declare const listCredentialsQueryOffsetDefault = 0;
+export declare const listCredentialsQueryOffsetMin = 0;
+export declare const listCredentialsQueryOffsetMax = 10000;
+export declare const ListCredentialsQueryParams: zod.ZodObject<{
+    limit: zod.ZodDefault<zod.ZodInt>;
+    offset: zod.ZodDefault<zod.ZodInt>;
+    provider: zod.ZodOptional<zod.ZodEnum<{
+        cloudflare: "cloudflare";
+        tencentcloud: "tencentcloud";
+        alidns: "alidns";
+        route53: "route53";
+    }>>;
+}, zod.z.core.$strict>;
+/**
+ * The credential is validated against the provider before it is accepted. A credential that
+ * cannot list domains is rejected with `CREDENTIAL_REJECTED_UPSTREAM` and is not stored.
+ *
+ * `provider` selects which configuration block is required: `provider: cloudflare` requires
+ * the `cloudflare` block, and the remaining blocks are ignored. Omitting the matching block
+ * returns `CREDENTIAL_CONFIG_MISSING`.
+ *
+ * Registering a credential that is already held by this project returns
+ * `CREDENTIAL_DUPLICATE`. Provider rate limits apply per credential, so a second copy grants
+ * no additional capacity.
+ *
+ * The submitted credential material is not returned by this or any other operation.
+ * @summary Register a provider credential
+ */
+export declare const CreateCredentialBody: zod.ZodObject<{
+    alidns: zod.ZodOptional<zod.ZodObject<{
+        access_key_id: zod.ZodString;
+        access_key_secret: zod.ZodString;
+        region_id: zod.ZodOptional<zod.ZodString>;
+    }, zod.z.core.$strict>>;
+    cloudflare: zod.ZodOptional<zod.ZodObject<{
+        api_token: zod.ZodString;
+        zone_token: zod.ZodOptional<zod.ZodString>;
+    }, zod.z.core.$strict>>;
+    name: zod.ZodString;
+    provider: zod.ZodEnum<{
+        cloudflare: "cloudflare";
+        tencentcloud: "tencentcloud";
+        alidns: "alidns";
+        route53: "route53";
+    }>;
+    route53: zod.ZodOptional<zod.ZodObject<{
+        access_key_id: zod.ZodString;
+        region: zod.ZodOptional<zod.ZodString>;
+        secret_access_key: zod.ZodString;
+        session_token: zod.ZodOptional<zod.ZodString>;
+    }, zod.z.core.$strict>>;
+    tencentcloud: zod.ZodOptional<zod.ZodObject<{
+        secret_id: zod.ZodString;
+        secret_key: zod.ZodString;
+    }, zod.z.core.$strict>>;
+}, zod.z.core.$strict>;
+/**
+ * @summary Get a provider credential
+ */
+export declare const GetCredentialParams: zod.ZodObject<{
+    credentialId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+/**
+ * Only the display name can be changed. To use different credential material, delete this
+ * credential and register a new one: a credential's identity does not change over its
+ * lifetime.
+ * @summary Rename a provider credential
+ */
+export declare const RenameCredentialParams: zod.ZodObject<{
+    credentialId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+export declare const RenameCredentialBody: zod.ZodObject<{
+    name: zod.ZodString;
+}, zod.z.core.$strict>;
+/**
+ * Domains reachable only through this credential stop appearing in `GET /zones` and can no
+ * longer be read or written through this API.
+ *
+ * **No DNS record is modified.** Deleting a credential withdraws this project's access to the
+ * provider account; it does not remove anything that was published there.
+ * @summary Delete a provider credential
+ */
+export declare const DeleteCredentialParams: zod.ZodObject<{
+    credentialId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+/**
+ * Checks the credential against the provider and records the outcome in `last_verified_at`
+ * and `last_verify_error`.
+ *
+ * A credential is validated when it is registered. This operation exists for credentials whose
+ * permissions or keys were subsequently changed at the provider, which is a change this API is
+ * not notified of.
+ *
+ * **A failed check returns 200, not an error.** The outcome is reported in
+ * `last_verify_error`: the request itself succeeded, and the answer it obtained is that the
+ * credential is no longer usable.
+ * @summary Re-validate a provider credential
+ */
+export declare const VerifyCredentialParams: zod.ZodObject<{
+    credentialId: zod.ZodUUID;
+}, zod.z.core.$strict>;
+/**
+ * Lists every domain reachable through the credentials registered by this project.
+ *
+ * Listings may briefly lag behind domains added or removed at the provider. Set `refresh` for
+ * an up-to-date answer.
+ *
+ * ## A domain that appears more than once
+ *
+ * While a domain is being migrated it commonly exists in both provider accounts at once. Such
+ * a domain is returned once per credential, with the same `zone` and different
+ * `credential_id`.
+ *
+ * `authoritative` reports which entry is the one currently serving queries, determined from
+ * the domain's delegation. `null` means no determination was made: either the domain appears
+ * only once, or its delegation does not identify any of the registered providers — for
+ * example when custom nameservers are in use, or the domain is not delegated at all.
+ *
+ * **Write operations are refused while the determination is `null` and the domain appears more
+ * than once**, with `ZONE_AMBIGUOUS`. Supply `credential_id` on the write request to select a
+ * credential explicitly.
+ * @summary List domains
+ */
+export declare const listZonesQueryRefreshDefault = false;
+export declare const ListZonesQueryParams: zod.ZodObject<{
+    credential_id: zod.ZodOptional<zod.ZodUUID>;
+    refresh: zod.ZodDefault<zod.ZodBoolean>;
+}, zod.z.core.$strict>;
+/**
+ * Returns the domain's records grouped into record sets: all records sharing a name and a type
+ * are reported as one entry, with their values in `values`.
+ *
+ * `limit` and `offset` reduce the size of the response but not the time taken to produce it.
+ * For domains with many records, filter by `name` or `type`.
+ * @summary List record sets
+ */
+export declare const listRecordsPathZoneMax = 253;
+export declare const ListRecordsParams: zod.ZodObject<{
+    zone: zod.ZodString;
+}, zod.z.core.$strict>;
+export declare const listRecordsQueryNameMax = 253;
+export declare const listRecordsQueryLimitDefault = 50;
+export declare const listRecordsQueryLimitMax = 200;
+export declare const listRecordsQueryOffsetDefault = 0;
+export declare const listRecordsQueryOffsetMin = 0;
+export declare const listRecordsQueryOffsetMax = 10000;
+export declare const ListRecordsQueryParams: zod.ZodObject<{
+    credential_id: zod.ZodOptional<zod.ZodUUID>;
+    name: zod.ZodOptional<zod.ZodString>;
+    type: zod.ZodOptional<zod.ZodEnum<{
+        A: "A";
+        AAAA: "AAAA";
+        CNAME: "CNAME";
+        TXT: "TXT";
+        MX: "MX";
+        NS: "NS";
+        SRV: "SRV";
+        CAA: "CAA";
+    }>>;
+    limit: zod.ZodDefault<zod.ZodInt>;
+    offset: zod.ZodDefault<zod.ZodInt>;
+}, zod.z.core.$strict>;
+/**
+ * Returns `RECORD_SET_NOT_FOUND` when no record of this type exists under this name.
+ * @summary Get a record set
+ */
+export declare const getRecordSetPathZoneMax = 253;
+export declare const getRecordSetPathNameMax = 253;
+export declare const GetRecordSetParams: zod.ZodObject<{
+    zone: zod.ZodString;
+    name: zod.ZodString;
+    type: zod.ZodEnum<{
+        A: "A";
+        AAAA: "AAAA";
+        CNAME: "CNAME";
+        TXT: "TXT";
+        MX: "MX";
+        NS: "NS";
+        SRV: "SRV";
+        CAA: "CAA";
+    }>;
+}, zod.z.core.$strict>;
+/**
+ * **This replaces the entire record set.** After this request, the only records under this
+ * name and type are the ones listed in `values`; any value present beforehand and absent here
+ * is removed.
+ *
+ * The record set is created if it does not exist, so this operation both creates and replaces,
+ * and is idempotent.
+ *
+ * Two concurrent requests against the same domain conflict; the second receives `ZONE_BUSY`
+ * and may be retried.
+ *
+ * **Use `PATCH` to add or remove individual values.** Reading the set and submitting a
+ * modified list is a read-modify-write: values added by anything else between those two steps
+ * are stated to be absent, and are therefore removed, with both requests returning 200.
+ * @summary Replace a record set
+ */
+export declare const setRecordSetPathZoneMax = 253;
+export declare const setRecordSetPathNameMax = 253;
+export declare const SetRecordSetParams: zod.ZodObject<{
+    zone: zod.ZodString;
+    name: zod.ZodString;
+    type: zod.ZodEnum<{
+        A: "A";
+        AAAA: "AAAA";
+        CNAME: "CNAME";
+        TXT: "TXT";
+        MX: "MX";
+        NS: "NS";
+        SRV: "SRV";
+        CAA: "CAA";
+    }>;
+}, zod.z.core.$strict>;
+export declare const SetRecordSetQueryParams: zod.ZodObject<{
+    credential_id: zod.ZodOptional<zod.ZodUUID>;
+}, zod.z.core.$strict>;
+export declare const SetRecordSetBody: zod.ZodObject<{
+    ttl: zod.ZodDefault<zod.ZodInt>;
+    values: zod.ZodArray<zod.ZodString>;
+}, zod.z.core.$strict>;
+/**
+ * **Names values to add and remove; anything not named is left in place.** Nothing is read
+ * first, so this is the only operation on a record set safe to issue concurrently. The set is
+ * created if it does not exist.
+ *
+ * Certificate issuance must use this operation for both the challenge record and its cleanup.
+ * `PUT` and `DELETE` state or remove the whole set, so a concurrent issuance's challenge
+ * record is discarded — with every request returning 2xx, and the failure surfacing as the
+ * second certificate failing validation.
+ *
+ * `add` is applied before `remove`, so a request carrying both changes a value without the
+ * name ever resolving without it: the set briefly holds one value too many rather than one too
+ * few. The reverse order, as two requests, leaves a window in which the value is absent — for
+ * a single-valued set, the name does not resolve at all — and an addition that then fails
+ * leaves it gone.
+ *
+ * A value appearing in both `add` and `remove` is rejected rather than resolved in one
+ * direction.
+ *
+ * Values in `remove` that are absent are skipped, so a retried cleanup reaches the same
+ * result. Values in `add` that are already present are rejected by the provider: a record set
+ * cannot hold the same value twice.
+ *
+ * Removing every value leaves an empty set, reported as `values: []`, not `RECORD_SET_NOT_FOUND`.
+ * @summary Add or remove values in a record set
+ */
+export declare const modifyRecordSetPathZoneMax = 253;
+export declare const modifyRecordSetPathNameMax = 253;
+export declare const ModifyRecordSetParams: zod.ZodObject<{
+    zone: zod.ZodString;
+    name: zod.ZodString;
+    type: zod.ZodEnum<{
+        A: "A";
+        AAAA: "AAAA";
+        CNAME: "CNAME";
+        TXT: "TXT";
+        MX: "MX";
+        NS: "NS";
+        SRV: "SRV";
+        CAA: "CAA";
+    }>;
+}, zod.z.core.$strict>;
+export declare const ModifyRecordSetQueryParams: zod.ZodObject<{
+    credential_id: zod.ZodOptional<zod.ZodUUID>;
+}, zod.z.core.$strict>;
+export declare const ModifyRecordSetBody: zod.ZodObject<{
+    add: zod.ZodOptional<zod.ZodArray<zod.ZodString>>;
+    remove: zod.ZodOptional<zod.ZodArray<zod.ZodString>>;
+    ttl: zod.ZodDefault<zod.ZodInt>;
+}, zod.z.core.$strict>;
+/**
+ * Removes every record under this name and type. **To remove part of a set, use `PATCH`**,
+ * which is safe to issue concurrently; this operation and `PUT` are not.
+ *
+ * Providers reject removal of the last NS record set at the apex of a domain, which would
+ * withdraw the domain from DNS entirely.
+ * @summary Delete a record set
+ */
+export declare const deleteRecordSetPathZoneMax = 253;
+export declare const deleteRecordSetPathNameMax = 253;
+export declare const DeleteRecordSetParams: zod.ZodObject<{
+    zone: zod.ZodString;
+    name: zod.ZodString;
+    type: zod.ZodEnum<{
+        A: "A";
+        AAAA: "AAAA";
+        CNAME: "CNAME";
+        TXT: "TXT";
+        MX: "MX";
+        NS: "NS";
+        SRV: "SRV";
+        CAA: "CAA";
+    }>;
+}, zod.z.core.$strict>;
+export declare const DeleteRecordSetQueryParams: zod.ZodObject<{
+    credential_id: zod.ZodOptional<zod.ZodUUID>;
+}, zod.z.core.$strict>;