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

package/dist/dns/v1/generated/models.d.ts

@@ -0,0 +1,442 @@
+/**
+ * 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
+ */
+/**
+ * What a given `code` carries alongside the message. The keys depend on the code,
+ * and a client that does not recognise one ignores it.
+ */
+export type ErrorMeta = {
+    [key: string]: unknown;
+};
+export interface Error {
+    code?: string;
+    message: string;
+    /**
+     * What a given `code` carries alongside the message. The keys depend on the code,
+     * and a client that does not recognise one ignores it.
+     */
+    meta?: ErrorMeta;
+    status: number;
+}
+/**
+ * A DNS record type.
+ *
+ * The listed types are those this API supports uniformly across every provider. HTTPS and
+ * SVCB are not yet available.
+ */
+export type RecordType = (typeof RecordType)[keyof typeof RecordType];
+export declare const RecordType: {
+    readonly A: "A";
+    readonly AAAA: "AAAA";
+    readonly CNAME: "CNAME";
+    readonly TXT: "TXT";
+    readonly MX: "MX";
+    readonly NS: "NS";
+    readonly SRV: "SRV";
+    readonly CAA: "CAA";
+};
+/**
+ * A supported DNS provider.
+ */
+export type Provider = (typeof Provider)[keyof typeof Provider];
+export declare const Provider: {
+    readonly cloudflare: "cloudflare";
+    readonly tencentcloud: "tencentcloud";
+    readonly alidns: "alidns";
+    readonly route53: "route53";
+};
+/**
+ * `active` is usable. `disabled` means the platform has disabled this credential and requires
+ * contact with support.
+ *
+ * A project that has been suspended is reported separately, in `suspended_at`.
+ */
+export type CredentialStatus = (typeof CredentialStatus)[keyof typeof CredentialStatus];
+export declare const CredentialStatus: {
+    readonly active: "active";
+    readonly disabled: "disabled";
+};
+/**
+ * A registered provider credential. The credential material itself is never included.
+ */
+export interface CredentialResource {
+    created_at: string;
+    /** Equal fingerprints denote the same credential material */
+    fingerprint: string;
+    id: string;
+    /**
+     * When the credential was last confirmed to work; null if it never has
+     * @nullable
+     */
+    last_verified_at: string | null;
+    /**
+     * Why the most recent check failed; null if the most recent check succeeded
+     * @nullable
+     */
+    last_verify_error: string | null;
+    name: string;
+    provider: Provider;
+    /** A partially masked fragment of the credential, for visual identification only */
+    redacted: string;
+    status: CredentialStatus;
+    /**
+     * When the credential was suspended because the project was suspended; null if it was not. Cleared when the project is restored
+     * @nullable
+     */
+    suspended_at: string | null;
+    updated_at: string;
+}
+/**
+ * Cloudflare credentials, created under My Profile then API Tokens
+ */
+export interface CloudflareConfig {
+    /**
+     * An API token with the Zone.DNS edit permission
+     * @minLength 1
+     * @maxLength 512
+     */
+    api_token: string;
+    /**
+     * Optional, and required only when api_token is scoped to a single zone, in which case it is used to enumerate zones
+     * @maxLength 512
+     */
+    zone_token?: string;
+}
+/**
+ * Tencent Cloud DNSPod credentials, created under Access Management then Access Keys
+ */
+export interface TencentCloudConfig {
+    /**
+     * @minLength 1
+     * @maxLength 256
+     */
+    secret_id: string;
+    /**
+     * @minLength 1
+     * @maxLength 256
+     */
+    secret_key: string;
+}
+/**
+ * Alibaba Cloud DNS credentials, created under RAM
+ */
+export interface AliDNSConfig {
+    /**
+     * @minLength 1
+     * @maxLength 256
+     */
+    access_key_id: string;
+    /**
+     * @minLength 1
+     * @maxLength 256
+     */
+    access_key_secret: string;
+    /**
+     * Defaults to cn-hangzhou
+     * @maxLength 64
+     */
+    region_id?: string;
+}
+/**
+ * AWS Route 53 credentials
+ */
+export interface Route53Config {
+    /**
+     * @minLength 1
+     * @maxLength 256
+     */
+    access_key_id: string;
+    /**
+     * Defaults to us-east-1. Route 53 is a global service, so this affects request signing only
+     * @maxLength 64
+     */
+    region?: string;
+    /**
+     * @minLength 1
+     * @maxLength 256
+     */
+    secret_access_key: string;
+    /**
+     * Optional, and required only for temporary STS credentials. Such credentials expire, after which every operation against this provider fails
+     * @maxLength 2048
+     */
+    session_token?: string;
+}
+/**
+ * `provider` selects which configuration block is read. The remaining blocks are ignored.
+ */
+export interface CreateCredentialRequestBody {
+    alidns?: AliDNSConfig;
+    cloudflare?: CloudflareConfig;
+    /**
+     * A display name for this credential
+     * @minLength 1
+     * @maxLength 128
+     */
+    name: string;
+    provider: Provider;
+    route53?: Route53Config;
+    tencentcloud?: TencentCloudConfig;
+}
+export interface RenameCredentialRequestBody {
+    /**
+     * @minLength 1
+     * @maxLength 128
+     */
+    name: string;
+}
+export interface LengthAwarePageCredentialResource {
+    /** The contents of this page */
+    items: CredentialResource[];
+    /** Maximum items per page, echoing the value in the request */
+    limit: number;
+    /** Items skipped, echoing the value in the request */
+    offset: number;
+    /** Total number of matching items, not only those in this page */
+    total: number;
+}
+export interface ZoneResource {
+    /**
+     * Whether this entry is the one currently serving queries for the domain.
+     *
+     * `null` means no determination was made: either the domain appears only once, or its
+     * delegation does not identify any registered provider. While this is `null` and the
+     * domain appears more than once, write operations require an explicit `credential_id`.
+     * @nullable
+     */
+    authoritative: boolean | null;
+    /** The credential through which this domain is reachable */
+    credential_id: string;
+    provider: Provider;
+    /** The domain in absolute form, with a trailing dot */
+    zone: string;
+}
+export interface ZoneListResponseBody {
+    items: ZoneResource[];
+    /**
+     * True when at least one provider could not be reached while producing this listing, so
+     * recent additions or removals may be missing.
+     *
+     * The listing remains usable and write operations are unaffected.
+     */
+    stale: boolean;
+}
+/**
+ * Every record sharing a name and a type.
+ */
+export interface RecordSetResource {
+    /** The name relative to the domain. `@` denotes the domain itself */
+    name: string;
+    /** Time to live, in seconds. 0 leaves the choice to the provider */
+    ttl: number;
+    type: RecordType;
+    /**
+     * Every value in this record set, in unescaped zone-file RDATA syntax:
+     *
+     * - `A`, `AAAA`: `192.0.2.1`, `2001:db8::1`
+     * - `CNAME`, `NS`: `target.example.com.`, absolute, with a trailing dot
+     * - `TXT`: the text itself, neither quoted nor escaped
+     * - `MX`: `10 mail.example.com.`
+     * - `SRV`: `10 20 443 target.example.com.`
+     * - `CAA`: `0 issue "letsencrypt.org"`
+     */
+    values: string[];
+    /** The domain in absolute form, with a trailing dot */
+    zone: string;
+}
+export interface LengthAwarePageRecordSetResource {
+    /** The contents of this page */
+    items: RecordSetResource[];
+    /** Maximum items per page, echoing the value in the request */
+    limit: number;
+    /** Items skipped, echoing the value in the request */
+    offset: number;
+    /** Total number of matching items, not only those in this page */
+    total: number;
+}
+/**
+ * `values` states the final contents of the record set. Values omitted here are removed.
+ */
+export interface SetRecordSetRequestBody {
+    /**
+     * Time to live, in seconds. 0 leaves the choice to the provider. Providers enforce their own minimum and raise lower values to it
+     * @minimum 0
+     * @maximum 604800
+     */
+    ttl?: number;
+    /**
+     * The final contents of the record set. Syntax as described on RecordSetResource.values
+     * @minItems 1
+     * @maxItems 100
+     * @items.minLength 1
+     * @items.maxLength 4096
+     */
+    values: string[];
+}
+/**
+ * Names the values to add and to remove. Anything not named is left in place. At least one of `add` and `remove` is required, and no value may appear in both.
+ */
+export interface ModifyRecordSetRequestBody {
+    /**
+     * The values to add. Values already present are rejected by the provider. Syntax as described on RecordSetResource.values
+     * @minItems 1
+     * @maxItems 100
+     * @items.minLength 1
+     * @items.maxLength 4096
+     */
+    add?: string[];
+    /**
+     * The values to remove. Values that are not present are skipped. Syntax as described on RecordSetResource.values
+     * @minItems 1
+     * @maxItems 100
+     * @items.minLength 1
+     * @items.maxLength 4096
+     */
+    remove?: string[];
+    /**
+     * Time to live, in seconds, applied to the values in `add`. 0 leaves the choice to the provider. The time to live of values already in the set is not changed; use `PUT` for that
+     * @minimum 0
+     * @maximum 604800
+     */
+    ttl?: number;
+}
+/**
+ * Pagination metadata for stable numbered pages. total_count is returned only when the operation can determine it without an unbounded scan.
+ */
+export interface OffsetPagination {
+    /** @minimum 1 */
+    page: number;
+    /** @minimum 1 */
+    page_size: number;
+    /** @minimum 0 */
+    total_count?: number;
+}
+/**
+ * Pagination metadata for keyset traversal. Pass next_cursor as cursor to read the following page; null means there is no following page.
+ */
+export interface CursorPagination {
+    /** @minimum 1 */
+    page_size: number;
+    /** @nullable */
+    next_cursor?: string | null;
+}
+export type ListCredentialsParams = {
+    /**
+     * Items returned in this page. Defaults to 50; at most 200.
+     * @minimum 1
+     * @maximum 200
+     */
+    limit?: number;
+    /**
+     * Items to skip. Defaults to 0; at most 10000.
+     * @minimum 0
+     * @maximum 10000
+     */
+    offset?: number;
+    /**
+     * Return only credentials for this provider; omit for all providers
+     */
+    provider?: Provider;
+};
+export type ListZonesParams = {
+    /**
+     * Return only domains reachable through this credential
+     */
+    credential_id?: string;
+    /**
+     * Return the current set of domains rather than a possibly slightly stale one. Slower, and consumes provider API quota
+     */
+    refresh?: boolean;
+};
+export type ListRecordsParams = {
+    /**
+     * Which credential to use. When omitted, the credential is determined from the domain; see ZONE_AMBIGUOUS
+     */
+    credential_id?: string;
+    /**
+     * Return only record sets with this name, given relative to the domain. `@` denotes the domain itself
+     * @maxLength 253
+     */
+    name?: string;
+    /**
+     * Return only record sets of this type
+     */
+    type?: RecordType;
+    /**
+     * Items returned in this page. Defaults to 50; at most 200.
+     * @minimum 1
+     * @maximum 200
+     */
+    limit?: number;
+    /**
+     * Items to skip. Defaults to 0; at most 10000.
+     * @minimum 0
+     * @maximum 10000
+     */
+    offset?: number;
+};
+export type SetRecordSetParams = {
+    /**
+     * Which credential to use. When omitted, the credential is determined from the domain; see ZONE_AMBIGUOUS
+     */
+    credential_id?: string;
+};
+export type ModifyRecordSetParams = {
+    /**
+     * Which credential to use. When omitted, the credential is determined from the domain; see ZONE_AMBIGUOUS
+     */
+    credential_id?: string;
+};
+export type DeleteRecordSetParams = {
+    /**
+     * Which credential to use. When omitted, the credential is determined from the domain; see ZONE_AMBIGUOUS
+     */
+    credential_id?: string;
+};

package/dist/dns/v1/generated/models.js

@@ -0,0 +1,20 @@
+export const RecordType = {
+    A: "A",
+    AAAA: "AAAA",
+    CNAME: "CNAME",
+    TXT: "TXT",
+    MX: "MX",
+    NS: "NS",
+    SRV: "SRV",
+    CAA: "CAA",
+};
+export const Provider = {
+    cloudflare: "cloudflare",
+    tencentcloud: "tencentcloud",
+    alidns: "alidns",
+    route53: "route53",
+};
+export const CredentialStatus = {
+    active: "active",
+    disabled: "disabled",
+};