@opusdns/api 0.28.0 → 0.29.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -8,7 +8,7 @@
8
8
  "typescript": "^5.8.2"
9
9
  },
10
10
  "name": "@opusdns/api",
11
- "version": "0.28.0",
11
+ "version": "0.29.0",
12
12
  "description": "TypeScript types for the OpusDNS OpenAPI specification",
13
13
  "main": "./src/index.ts",
14
14
  "module": "./src/index.ts",
@@ -1663,6 +1663,82 @@ export type PUT_DomainsDomainReferenceDnssec_Request_Path = PUT_DomainsDomainRef
1663
1663
  */
1664
1664
  export type PUT_DomainsDomainReferenceDnssec_Request_Body = PUT_DomainsDomainReferenceDnssec_Request['requestBody'];
1665
1665
 
1666
+ /**
1667
+ * Request type for POST DomainsDomainReferenceDnssecDisable endpoint
1668
+ *
1669
+ * Disable DNSSEC for domains using our nameservers
1670
+ *
1671
+ * @remarks
1672
+ * This type defines the complete request structure for the POST DomainsDomainReferenceDnssecDisable endpoint.
1673
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
1674
+ * Use this type to ensure type safety when making API requests to this endpoint.
1675
+ *
1676
+ * @example
1677
+ * Use this type to ensure type safety when making API requests to this endpoint.
1678
+ *
1679
+ * @path /v1/domains/{domain_reference}/dnssec/disable
1680
+ *
1681
+ * @see {@link POST_DomainsDomainReferenceDnssecDisable_Request_Query} - Query parameters type
1682
+ * @see {@link POST_DomainsDomainReferenceDnssecDisable_Request_Path} - Path parameters type
1683
+ * @see {@link POST_DomainsDomainReferenceDnssecDisable_Request_Body} - Request body type
1684
+ */
1685
+ export type POST_DomainsDomainReferenceDnssecDisable_Request = {
1686
+ parameters: {
1687
+ path: operations['disable_and_unpublish_dnssec_records_v1_domains__domain_reference__dnssec_disable_post']['parameters']['path'];
1688
+ };
1689
+ }
1690
+ /**
1691
+ * Path parameters for POST /v1/domains/{domain_reference}/dnssec/disable
1692
+ *
1693
+ * @remarks
1694
+ * This type defines the path parameters for the POST /v1/domains/{domain_reference}/dnssec/disable endpoint.
1695
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
1696
+ *
1697
+ * @example
1698
+ * Use this type to ensure type safety for path parameters.
1699
+ *
1700
+ * @path /v1/domains/{domain_reference}/dnssec/disable
1701
+ */
1702
+ export type POST_DomainsDomainReferenceDnssecDisable_Request_Path = POST_DomainsDomainReferenceDnssecDisable_Request['parameters']['path'];
1703
+
1704
+ /**
1705
+ * Request type for POST DomainsDomainReferenceDnssecEnable endpoint
1706
+ *
1707
+ * Enable DNSSEC for domains using our nameservers
1708
+ *
1709
+ * @remarks
1710
+ * This type defines the complete request structure for the POST DomainsDomainReferenceDnssecEnable endpoint.
1711
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
1712
+ * Use this type to ensure type safety when making API requests to this endpoint.
1713
+ *
1714
+ * @example
1715
+ * Use this type to ensure type safety when making API requests to this endpoint.
1716
+ *
1717
+ * @path /v1/domains/{domain_reference}/dnssec/enable
1718
+ *
1719
+ * @see {@link POST_DomainsDomainReferenceDnssecEnable_Request_Query} - Query parameters type
1720
+ * @see {@link POST_DomainsDomainReferenceDnssecEnable_Request_Path} - Path parameters type
1721
+ * @see {@link POST_DomainsDomainReferenceDnssecEnable_Request_Body} - Request body type
1722
+ */
1723
+ export type POST_DomainsDomainReferenceDnssecEnable_Request = {
1724
+ parameters: {
1725
+ path: operations['enable_and_publish_dnssec_records_v1_domains__domain_reference__dnssec_enable_post']['parameters']['path'];
1726
+ };
1727
+ }
1728
+ /**
1729
+ * Path parameters for POST /v1/domains/{domain_reference}/dnssec/enable
1730
+ *
1731
+ * @remarks
1732
+ * This type defines the path parameters for the POST /v1/domains/{domain_reference}/dnssec/enable endpoint.
1733
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
1734
+ *
1735
+ * @example
1736
+ * Use this type to ensure type safety for path parameters.
1737
+ *
1738
+ * @path /v1/domains/{domain_reference}/dnssec/enable
1739
+ */
1740
+ export type POST_DomainsDomainReferenceDnssecEnable_Request_Path = POST_DomainsDomainReferenceDnssecEnable_Request['parameters']['path'];
1741
+
1666
1742
  /**
1667
1743
  * Request type for POST DomainsDomainReferenceRenew endpoint
1668
1744
  *
@@ -2678,6 +2678,134 @@ export type PUT_DomainsByDomainReferenceDnssec_Response_404 = Problem
2678
2678
  */
2679
2679
  export type PUT_DomainsByDomainReferenceDnssec_Response_422 = HTTPValidationError
2680
2680
 
2681
+ /**
2682
+ * Response types for POST DomainsByDomainReferenceDnssecDisable endpoint
2683
+ *
2684
+ * Disable DNSSEC for domains using our nameservers
2685
+ *
2686
+ * @remarks
2687
+ * This type defines all possible response structures for the POST DomainsByDomainReferenceDnssecDisable endpoint.
2688
+ * Each response code maps to a specific response type as defined in the OpenAPI specification.
2689
+ * Use this type to ensure type safety when handling API responses from this endpoint.
2690
+ *
2691
+
2692
+ *
2693
+ * @path /v1/domains/{domain_reference}/dnssec/disable
2694
+ *
2695
+ * @see {@link POST_DomainsByDomainReferenceDnssecDisable_Response_404} - 404 response type
2696
+ * @see {@link POST_DomainsByDomainReferenceDnssecDisable_Response_422} - 422 response type
2697
+ *
2698
+
2699
+ */
2700
+ export type POST_DomainsByDomainReferenceDnssecDisable_Response = POST_DomainsByDomainReferenceDnssecDisable_Response_404 | POST_DomainsByDomainReferenceDnssecDisable_Response_422;
2701
+
2702
+ /**
2703
+ * 404 response for POST DomainsByDomainReferenceDnssecDisable endpoint
2704
+ *
2705
+ * @remarks
2706
+ * This type defines the response structure for the 404 status code
2707
+ * of the POST DomainsByDomainReferenceDnssecDisable endpoint.
2708
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
2709
+ *
2710
+
2711
+ *
2712
+ * @path /v1/domains/{domain_reference}/dnssec/disable
2713
+ *
2714
+ * @see {@link POST_DomainsByDomainReferenceDnssecDisable_Response} - The main response type definition
2715
+ * @see {@link Problem} - The actual schema type definition
2716
+ */
2717
+ export type POST_DomainsByDomainReferenceDnssecDisable_Response_404 = Problem
2718
+
2719
+ /**
2720
+ * 422 response for POST DomainsByDomainReferenceDnssecDisable endpoint
2721
+ *
2722
+ * @remarks
2723
+ * This type defines the response structure for the 422 status code
2724
+ * of the POST DomainsByDomainReferenceDnssecDisable endpoint.
2725
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
2726
+ *
2727
+
2728
+ *
2729
+ * @path /v1/domains/{domain_reference}/dnssec/disable
2730
+ *
2731
+ * @see {@link POST_DomainsByDomainReferenceDnssecDisable_Response} - The main response type definition
2732
+ * @see {@link HTTPValidationError} - The actual schema type definition
2733
+ */
2734
+ export type POST_DomainsByDomainReferenceDnssecDisable_Response_422 = HTTPValidationError
2735
+
2736
+ /**
2737
+ * Response types for POST DomainsByDomainReferenceDnssecEnable endpoint
2738
+ *
2739
+ * Enable DNSSEC for domains using our nameservers
2740
+ *
2741
+ * @remarks
2742
+ * This type defines all possible response structures for the POST DomainsByDomainReferenceDnssecEnable endpoint.
2743
+ * Each response code maps to a specific response type as defined in the OpenAPI specification.
2744
+ * Use this type to ensure type safety when handling API responses from this endpoint.
2745
+ *
2746
+
2747
+ *
2748
+ * @path /v1/domains/{domain_reference}/dnssec/enable
2749
+ *
2750
+ * @see {@link POST_DomainsByDomainReferenceDnssecEnable_Response_200} - 200 response type
2751
+ * @see {@link POST_DomainsByDomainReferenceDnssecEnable_Response_404} - 404 response type
2752
+ * @see {@link POST_DomainsByDomainReferenceDnssecEnable_Response_422} - 422 response type
2753
+ *
2754
+
2755
+ */
2756
+ export type POST_DomainsByDomainReferenceDnssecEnable_Response = POST_DomainsByDomainReferenceDnssecEnable_Response_200 | POST_DomainsByDomainReferenceDnssecEnable_Response_404 | POST_DomainsByDomainReferenceDnssecEnable_Response_422;
2757
+
2758
+ /**
2759
+ * 200 response for POST DomainsByDomainReferenceDnssecEnable endpoint
2760
+ *
2761
+ * @remarks
2762
+ * This type defines the response structure for the 200 status code
2763
+ * of the POST DomainsByDomainReferenceDnssecEnable endpoint.
2764
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
2765
+ *
2766
+
2767
+ *
2768
+ * @path /v1/domains/{domain_reference}/dnssec/enable
2769
+ *
2770
+ * @see {@link POST_DomainsByDomainReferenceDnssecEnable_Response} - The main response type definition
2771
+ * @see {@link DomainDnssecData} - The actual schema type definition
2772
+ */
2773
+ export type POST_DomainsByDomainReferenceDnssecEnable_Response_200 = DomainDnssecDataArray
2774
+
2775
+ /**
2776
+ * 404 response for POST DomainsByDomainReferenceDnssecEnable endpoint
2777
+ *
2778
+ * @remarks
2779
+ * This type defines the response structure for the 404 status code
2780
+ * of the POST DomainsByDomainReferenceDnssecEnable endpoint.
2781
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
2782
+ *
2783
+
2784
+ *
2785
+ * @path /v1/domains/{domain_reference}/dnssec/enable
2786
+ *
2787
+ * @see {@link POST_DomainsByDomainReferenceDnssecEnable_Response} - The main response type definition
2788
+ * @see {@link Problem} - The actual schema type definition
2789
+ */
2790
+ export type POST_DomainsByDomainReferenceDnssecEnable_Response_404 = Problem
2791
+
2792
+ /**
2793
+ * 422 response for POST DomainsByDomainReferenceDnssecEnable endpoint
2794
+ *
2795
+ * @remarks
2796
+ * This type defines the response structure for the 422 status code
2797
+ * of the POST DomainsByDomainReferenceDnssecEnable endpoint.
2798
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
2799
+ *
2800
+
2801
+ *
2802
+ * @path /v1/domains/{domain_reference}/dnssec/enable
2803
+ *
2804
+ * @see {@link POST_DomainsByDomainReferenceDnssecEnable_Response} - The main response type definition
2805
+ * @see {@link HTTPValidationError} - The actual schema type definition
2806
+ */
2807
+ export type POST_DomainsByDomainReferenceDnssecEnable_Response_422 = HTTPValidationError
2808
+
2681
2809
  /**
2682
2810
  * Response types for POST DomainsByDomainReferenceRenew endpoint
2683
2811
  *
package/src/openapi.yaml CHANGED
@@ -4798,7 +4798,7 @@ info:
4798
4798
  '
4799
4799
  summary: OpusDNS - your gateway to a seamless domain management experience.
4800
4800
  title: OpusDNS API
4801
- version: 2025-08-29-171808
4801
+ version: 2025-08-30-003827
4802
4802
  x-logo:
4803
4803
  altText: OpusDNS API Reference
4804
4804
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -7144,6 +7144,102 @@ paths:
7144
7144
  summary: Update DNSSEC data
7145
7145
  tags:
7146
7146
  - domain
7147
+ /v1/domains/{domain_reference}/dnssec/disable:
7148
+ post:
7149
+ operationId: disable_and_unpublish_dnssec_records_v1_domains__domain_reference__dnssec_disable_post
7150
+ parameters:
7151
+ - in: path
7152
+ name: domain_reference
7153
+ required: true
7154
+ schema:
7155
+ anyOf:
7156
+ - examples:
7157
+ - domain_01h45ytscbebyvny4gc8cr8ma2
7158
+ format: typeid
7159
+ pattern: ^domain_[0-7][0-9a-hjkmnpq-tv-z]{25}$
7160
+ type: string
7161
+ x-typeid-prefix: domain
7162
+ - type: string
7163
+ title: Domain Reference
7164
+ responses:
7165
+ '204':
7166
+ description: Successful Response
7167
+ '404':
7168
+ content:
7169
+ application/problem+json:
7170
+ example:
7171
+ code: ERROR_DOMAIN_NOT_FOUND
7172
+ detail: Domain not found
7173
+ domain_name: Additional error context.
7174
+ status: 404
7175
+ title: Domain Management Error
7176
+ type: domain-not-found
7177
+ schema:
7178
+ $ref: '#/components/schemas/Problem'
7179
+ description: Not Found
7180
+ '422':
7181
+ content:
7182
+ application/problem+json:
7183
+ schema:
7184
+ $ref: '#/components/schemas/HTTPValidationError'
7185
+ description: Validation Error
7186
+ security:
7187
+ - OAuth2PasswordBearer: []
7188
+ summary: Disable DNSSEC for domains using our nameservers
7189
+ tags:
7190
+ - domain
7191
+ /v1/domains/{domain_reference}/dnssec/enable:
7192
+ post:
7193
+ operationId: enable_and_publish_dnssec_records_v1_domains__domain_reference__dnssec_enable_post
7194
+ parameters:
7195
+ - in: path
7196
+ name: domain_reference
7197
+ required: true
7198
+ schema:
7199
+ anyOf:
7200
+ - examples:
7201
+ - domain_01h45ytscbebyvny4gc8cr8ma2
7202
+ format: typeid
7203
+ pattern: ^domain_[0-7][0-9a-hjkmnpq-tv-z]{25}$
7204
+ type: string
7205
+ x-typeid-prefix: domain
7206
+ - type: string
7207
+ title: Domain Reference
7208
+ responses:
7209
+ '200':
7210
+ content:
7211
+ application/json:
7212
+ schema:
7213
+ items:
7214
+ $ref: '#/components/schemas/DomainDnssecDataResponse'
7215
+ title: Response Enable And Publish Dnssec Records V1 Domains Domain
7216
+ Reference Dnssec Enable Post
7217
+ type: array
7218
+ description: Successful Response
7219
+ '404':
7220
+ content:
7221
+ application/problem+json:
7222
+ example:
7223
+ code: ERROR_DOMAIN_NOT_FOUND
7224
+ detail: Domain not found
7225
+ domain_name: Additional error context.
7226
+ status: 404
7227
+ title: Domain Management Error
7228
+ type: domain-not-found
7229
+ schema:
7230
+ $ref: '#/components/schemas/Problem'
7231
+ description: Not Found
7232
+ '422':
7233
+ content:
7234
+ application/problem+json:
7235
+ schema:
7236
+ $ref: '#/components/schemas/HTTPValidationError'
7237
+ description: Validation Error
7238
+ security:
7239
+ - OAuth2PasswordBearer: []
7240
+ summary: Enable DNSSEC for domains using our nameservers
7241
+ tags:
7242
+ - domain
7147
7243
  /v1/domains/{domain_reference}/renew:
7148
7244
  post:
7149
7245
  description: 'Extends the registration period of an existing domain. The renewal
package/src/schema.d.ts CHANGED
@@ -545,6 +545,40 @@ export interface paths {
545
545
  patch?: never;
546
546
  trace?: never;
547
547
  };
548
+ "/v1/domains/{domain_reference}/dnssec/disable": {
549
+ parameters: {
550
+ query?: never;
551
+ header?: never;
552
+ path?: never;
553
+ cookie?: never;
554
+ };
555
+ get?: never;
556
+ put?: never;
557
+ /** Disable DNSSEC for domains using our nameservers */
558
+ post: operations["disable_and_unpublish_dnssec_records_v1_domains__domain_reference__dnssec_disable_post"];
559
+ delete?: never;
560
+ options?: never;
561
+ head?: never;
562
+ patch?: never;
563
+ trace?: never;
564
+ };
565
+ "/v1/domains/{domain_reference}/dnssec/enable": {
566
+ parameters: {
567
+ query?: never;
568
+ header?: never;
569
+ path?: never;
570
+ cookie?: never;
571
+ };
572
+ get?: never;
573
+ put?: never;
574
+ /** Enable DNSSEC for domains using our nameservers */
575
+ post: operations["enable_and_publish_dnssec_records_v1_domains__domain_reference__dnssec_enable_post"];
576
+ delete?: never;
577
+ options?: never;
578
+ head?: never;
579
+ patch?: never;
580
+ trace?: never;
581
+ };
548
582
  "/v1/domains/{domain_reference}/renew": {
549
583
  parameters: {
550
584
  query?: never;
@@ -6288,6 +6322,100 @@ export interface operations {
6288
6322
  };
6289
6323
  };
6290
6324
  };
6325
+ disable_and_unpublish_dnssec_records_v1_domains__domain_reference__dnssec_disable_post: {
6326
+ parameters: {
6327
+ query?: never;
6328
+ header?: never;
6329
+ path: {
6330
+ domain_reference: TypeID<"domain"> | string;
6331
+ };
6332
+ cookie?: never;
6333
+ };
6334
+ requestBody?: never;
6335
+ responses: {
6336
+ /** @description Successful Response */
6337
+ 204: {
6338
+ headers: {
6339
+ [name: string]: unknown;
6340
+ };
6341
+ content?: never;
6342
+ };
6343
+ /** @description Not Found */
6344
+ 404: {
6345
+ headers: {
6346
+ [name: string]: unknown;
6347
+ };
6348
+ content: {
6349
+ /** @example {
6350
+ * "code": "ERROR_DOMAIN_NOT_FOUND",
6351
+ * "detail": "Domain not found",
6352
+ * "domain_name": "Additional error context.",
6353
+ * "status": 404,
6354
+ * "title": "Domain Management Error",
6355
+ * "type": "domain-not-found"
6356
+ * } */
6357
+ "application/problem+json": components["schemas"]["Problem"];
6358
+ };
6359
+ };
6360
+ /** @description Validation Error */
6361
+ 422: {
6362
+ headers: {
6363
+ [name: string]: unknown;
6364
+ };
6365
+ content: {
6366
+ "application/problem+json": components["schemas"]["HTTPValidationError"];
6367
+ };
6368
+ };
6369
+ };
6370
+ };
6371
+ enable_and_publish_dnssec_records_v1_domains__domain_reference__dnssec_enable_post: {
6372
+ parameters: {
6373
+ query?: never;
6374
+ header?: never;
6375
+ path: {
6376
+ domain_reference: TypeID<"domain"> | string;
6377
+ };
6378
+ cookie?: never;
6379
+ };
6380
+ requestBody?: never;
6381
+ responses: {
6382
+ /** @description Successful Response */
6383
+ 200: {
6384
+ headers: {
6385
+ [name: string]: unknown;
6386
+ };
6387
+ content: {
6388
+ "application/json": components["schemas"]["DomainDnssecDataResponse"][];
6389
+ };
6390
+ };
6391
+ /** @description Not Found */
6392
+ 404: {
6393
+ headers: {
6394
+ [name: string]: unknown;
6395
+ };
6396
+ content: {
6397
+ /** @example {
6398
+ * "code": "ERROR_DOMAIN_NOT_FOUND",
6399
+ * "detail": "Domain not found",
6400
+ * "domain_name": "Additional error context.",
6401
+ * "status": 404,
6402
+ * "title": "Domain Management Error",
6403
+ * "type": "domain-not-found"
6404
+ * } */
6405
+ "application/problem+json": components["schemas"]["Problem"];
6406
+ };
6407
+ };
6408
+ /** @description Validation Error */
6409
+ 422: {
6410
+ headers: {
6411
+ [name: string]: unknown;
6412
+ };
6413
+ content: {
6414
+ "application/problem+json": components["schemas"]["HTTPValidationError"];
6415
+ };
6416
+ };
6417
+ };
6418
+ };
6291
6419
  renew_domain_v1_domains__domain_reference__renew_post: {
6292
6420
  parameters: {
6293
6421
  query?: never;