@opusdns/api 0.282.0 → 0.284.0

package/README.md

@@ -59,6 +59,39 @@ import {
 - `User` - User type
 - `Contact` - Contact type
 
+## Documentation
+
+There are two documentation setups in this repository:
+
+### Legacy: GitHub Pages API Reference (production)
+
+The `docs/` folder is a static site that embeds
+[`@scalar/api-reference`](https://github.com/scalar/scalar) and is published
+via GitHub Pages on [developers.opusdns.com](https://developers.opusdns.com/).
+Source of truth: [`docs/index.html`](./docs/index.html). Do **not** put
+guides/Markdown content here.
+
+### Scalar Docs 2.0 (local preview)
+
+A more sophisticated documentation setup using
+[Scalar Docs 2.0](https://scalar.com/products/docs/getting-started) is
+contained in [`scalar/`](./scalar/). The Scalar project config lives at
+[`scalar/scalar.config.json`](./scalar/scalar.config.json), guide content lives
+under [`scalar/content/`](./scalar/content/), and the API reference is
+fetched from the raw GitHub copy of [`src/openapi.yaml`](./src/openapi.yaml).
+
+To preview locally:
+
+```bash
+npm install
+npm --prefix scalar install
+npm run docs:preview
+# → http://localhost:7970
+```
+
+> Deployment of the Scalar Docs 2.0 site is intentionally not wired up yet —
+> the legacy GitHub Pages site continues to serve production.
+
 ### Links
 
 - [Main website](https://www.opusdns.com/)

package/package.json

@@ -3,7 +3,7 @@
     "@opusdns/api-spec-ts-generator": "^0.19.0"
   },
   "name": "@opusdns/api",
-  "version": "0.282.0",
+  "version": "0.284.0",
   "description": "TypeScript types for the OpusDNS OpenAPI specification",
   "main": "./src/index.ts",
   "module": "./src/index.ts",
@@ -31,7 +31,8 @@
   },
   "scripts": {
     "generate:schema": "tsx scripts/generate-schema.ts",
-    "generate:helpers": "tsx scripts/generate-all-helpers.ts"
+    "generate:helpers": "tsx scripts/generate-all-helpers.ts",
+    "docs:preview": "npm --prefix scalar run preview --"
   },
   "homepage": "https://github.com/OpusDNS/api-spec#readme",
   "files": [

package/src/helpers/constants.ts

@@ -21,7 +21,7 @@
  * ```
  */
 
-import { AllocationMethodType, AttributeType, BatchSortField, BatchStatus, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ComplianceStatus, ConditionOperator, ContactAttributeSetSortField, ContactIncludeField, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsProtectedReason, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAttributeKey, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainForwardSortField, DomainForwardZoneSortField, DomainIncludeField, DomainSortField, DomainStatus, EmailForwardLogSortField, EmailForwardLogStatus, EmailForwardSortField, EmailForwardZoneSortField, EmailVerificationStatus, EventObjectType, EventSortField, EventSubtype, EventType, ExecutingEntity, HTTPMethod, HostStatus, HttpProtocol, InvoiceResponsePaymentStatus, InvoiceResponseStatus, InvoiceResponseType, JobStatus, LaunchPhaseType, LegalRequirementOperationType, LegalRequirementType, LocalPresenceRequirementType, MetricsGrouping, ObjectEventType, ObjectLogSortField, OrganizationSortField, OrganizationStatus, ParkingSortField, PatchOp, PeriodUnit, Permission, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, Protocol, RedirectCode, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, ReportStatus, ReportTriggerType, ReportType, RequestHistorySortField, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TagColor, TagFilterMode, TagSortField, TagType, TimeRange, TransferAckType, UserSortField, UserStatus, VerificationType, ZoneIncludeField, ZoneSortField } from './schemas';
+import { AllocationMethodType, AttributeType, BatchSortField, BatchStatus, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ComplianceStatus, ConditionOperator, ContactAttributeSetSortField, ContactIncludeField, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsProtectedReason, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAttributeKey, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainForwardSortField, DomainForwardZoneSortField, DomainIncludeField, DomainSortField, DomainStatus, EmailForwardLogSortField, EmailForwardLogStatus, EmailForwardSortField, EmailForwardZoneSortField, EmailVerificationStatus, EventObjectType, EventSortField, EventSubtype, EventType, ExecutingEntity, HTTPMethod, HostStatus, HttpProtocol, InvoiceResponsePaymentStatus, InvoiceResponseStatus, InvoiceResponseType, JobStatus, LaunchPhaseType, LegalRequirementOperationType, LegalRequirementType, LocalPresenceRequirementType, MemoryFactKind, MessageContextKind, MessageRole, MetricsGrouping, ObjectEventType, ObjectLogSortField, OrganizationSortField, OrganizationStatus, ParkingSortField, PatchOp, PeriodUnit, Permission, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, Protocol, RedirectCode, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, ReportStatus, ReportTriggerType, ReportType, RequestHistorySortField, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TagColor, TagFilterMode, TagSortField, TagType, TimeRange, TransferAckType, UserSortField, UserStatus, VerificationType, ZoneIncludeField, ZoneSortField } from './schemas';
 
 /**
  * AllocationMethodType. Auto-generated enum for AllocationMethodType
@@ -2934,6 +2934,168 @@ export const LOCAL_PRESENCE_REQUIREMENT_TYPE_VALUES = [
   'business_entity'
 ] as const satisfies [string, ...string[]] | LocalPresenceRequirementType[];
 
+/**
+ * MemoryFactKind. Auto-generated enum for MemoryFactKind
+ *
+ * @remarks
+ * This constant provides both object and array forms for the MemoryFactKind enum.
+ * The object form allows key-value access, while the array form enables iteration and validation.
+ *
+ * @example
+ * ```typescript
+ * // Using the object form for key-value access
+ * const status = MEMORY_FACT_KIND.SUCCESS;
+ * 
+ * // Using the array form for iteration
+ * const allStatuses = MEMORY_FACT_KIND_VALUES;
+ * console.log(`Available statuses: ${allStatuses.join(', ')}`);
+ * ```
+ *
+ * @see {@link MemoryFactKind} - The TypeScript type definition
+ */
+export const MEMORY_FACT_KIND = {
+  PREFERENCE: "preference",
+  NOTE: "note",
+  OTHER: "other",
+} as const satisfies Record<string, MemoryFactKind>;
+
+/**
+ * Array of all MemoryFactKind enum values
+ *
+ * @remarks
+ * This constant provides a array containing all valid MemoryFactKind enum values.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all values
+ * for (const value of MEMORY_FACT_KIND_VALUES) {
+ *   console.log(`Processing: ${value}`);
+ * }
+ * 
+ * // Validation
+ * const isValid = MEMORY_FACT_KIND_VALUES.includes(someValue);
+ * ```
+ *
+ * @see {@link MemoryFactKind} - The TypeScript type definition
+ * @see {@link MEMORY_FACT_KIND} - The object form of this enum
+ */
+export const MEMORY_FACT_KIND_VALUES = [
+  'preference',
+  'note',
+  'other'
+] as const satisfies [string, ...string[]] | MemoryFactKind[];
+
+/**
+ * MessageContextKind. Auto-generated enum for MessageContextKind
+ *
+ * @remarks
+ * This constant provides both object and array forms for the MessageContextKind enum.
+ * The object form allows key-value access, while the array form enables iteration and validation.
+ *
+ * @example
+ * ```typescript
+ * // Using the object form for key-value access
+ * const status = MESSAGE_CONTEXT_KIND.SUCCESS;
+ * 
+ * // Using the array form for iteration
+ * const allStatuses = MESSAGE_CONTEXT_KIND_VALUES;
+ * console.log(`Available statuses: ${allStatuses.join(', ')}`);
+ * ```
+ *
+ * @see {@link MessageContextKind} - The TypeScript type definition
+ */
+export const MESSAGE_CONTEXT_KIND = {
+  ZONES: "zones",
+  CONTACTS: "contacts",
+  DOMAINS: "domains",
+  BATCH_IDS: "batch_ids",
+  OTHER: "other",
+} as const satisfies Record<string, MessageContextKind>;
+
+/**
+ * Array of all MessageContextKind enum values
+ *
+ * @remarks
+ * This constant provides a array containing all valid MessageContextKind enum values.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all values
+ * for (const value of MESSAGE_CONTEXT_KIND_VALUES) {
+ *   console.log(`Processing: ${value}`);
+ * }
+ * 
+ * // Validation
+ * const isValid = MESSAGE_CONTEXT_KIND_VALUES.includes(someValue);
+ * ```
+ *
+ * @see {@link MessageContextKind} - The TypeScript type definition
+ * @see {@link MESSAGE_CONTEXT_KIND} - The object form of this enum
+ */
+export const MESSAGE_CONTEXT_KIND_VALUES = [
+  'zones',
+  'contacts',
+  'domains',
+  'batch_ids',
+  'other'
+] as const satisfies [string, ...string[]] | MessageContextKind[];
+
+/**
+ * MessageRole. Auto-generated enum for MessageRole
+ *
+ * @remarks
+ * This constant provides both object and array forms for the MessageRole enum.
+ * The object form allows key-value access, while the array form enables iteration and validation.
+ *
+ * @example
+ * ```typescript
+ * // Using the object form for key-value access
+ * const status = MESSAGE_ROLE.SUCCESS;
+ * 
+ * // Using the array form for iteration
+ * const allStatuses = MESSAGE_ROLE_VALUES;
+ * console.log(`Available statuses: ${allStatuses.join(', ')}`);
+ * ```
+ *
+ * @see {@link MessageRole} - The TypeScript type definition
+ */
+export const MESSAGE_ROLE = {
+  USER: "user",
+  ASSISTANT: "assistant",
+  SYSTEM: "system",
+  TOOL: "tool",
+} as const satisfies Record<string, MessageRole>;
+
+/**
+ * Array of all MessageRole enum values
+ *
+ * @remarks
+ * This constant provides a array containing all valid MessageRole enum values.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all values
+ * for (const value of MESSAGE_ROLE_VALUES) {
+ *   console.log(`Processing: ${value}`);
+ * }
+ * 
+ * // Validation
+ * const isValid = MESSAGE_ROLE_VALUES.includes(someValue);
+ * ```
+ *
+ * @see {@link MessageRole} - The TypeScript type definition
+ * @see {@link MESSAGE_ROLE} - The object form of this enum
+ */
+export const MESSAGE_ROLE_VALUES = [
+  'user',
+  'assistant',
+  'system',
+  'tool'
+] as const satisfies [string, ...string[]] | MessageRole[];
+
 /**
  * MetricsGrouping. Auto-generated enum for MetricsGrouping
  *