@opusdns/api 0.89.0 → 0.91.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/src/openapi.yaml CHANGED
@@ -1563,6 +1563,50 @@ components:
1563
1563
  - created_on
1564
1564
  title: DomainForward
1565
1565
  type: object
1566
+ DomainForwardPatchOp:
1567
+ properties:
1568
+ op:
1569
+ $ref: '#/components/schemas/PatchOp'
1570
+ redirect:
1571
+ anyOf:
1572
+ - $ref: '#/components/schemas/HttpRedirect'
1573
+ - $ref: '#/components/schemas/HttpRedirectRemove'
1574
+ title: Redirect
1575
+ request_protocol:
1576
+ $ref: '#/components/schemas/HttpProtocol'
1577
+ zone_name:
1578
+ title: Zone Name
1579
+ type: string
1580
+ required:
1581
+ - op
1582
+ - zone_name
1583
+ - request_protocol
1584
+ - redirect
1585
+ title: DomainForwardPatchOp
1586
+ type: object
1587
+ DomainForwardPatchOps:
1588
+ properties:
1589
+ ops:
1590
+ items:
1591
+ $ref: '#/components/schemas/DomainForwardPatchOp'
1592
+ title: Ops
1593
+ type: array
1594
+ required:
1595
+ - ops
1596
+ title: DomainForwardPatchOps
1597
+ type: object
1598
+ DomainForwardProtocols:
1599
+ properties:
1600
+ http:
1601
+ anyOf:
1602
+ - $ref: '#/components/schemas/ProtocolRedirects'
1603
+ - type: 'null'
1604
+ https:
1605
+ anyOf:
1606
+ - $ref: '#/components/schemas/ProtocolRedirects'
1607
+ - type: 'null'
1608
+ title: DomainForwardProtocols
1609
+ type: object
1566
1610
  DomainForwardRequest:
1567
1611
  properties:
1568
1612
  redirects:
@@ -1578,6 +1622,26 @@ components:
1578
1622
  - redirects
1579
1623
  title: DomainForwardRequest
1580
1624
  type: object
1625
+ DomainForwardZone:
1626
+ properties:
1627
+ enabled:
1628
+ title: Enabled
1629
+ type: boolean
1630
+ protocols:
1631
+ $ref: '#/components/schemas/DomainForwardProtocols'
1632
+ wildcard:
1633
+ title: Wildcard
1634
+ type: boolean
1635
+ zone_name:
1636
+ title: Zone Name
1637
+ type: string
1638
+ required:
1639
+ - zone_name
1640
+ - wildcard
1641
+ - enabled
1642
+ - protocols
1643
+ title: DomainForwardZone
1644
+ type: object
1581
1645
  DomainLifecycleBase:
1582
1646
  properties:
1583
1647
  add_grace_period:
@@ -2545,6 +2609,20 @@ components:
2545
2609
  - redirect_code
2546
2610
  title: HttpRedirect
2547
2611
  type: object
2612
+ HttpRedirectRemove:
2613
+ properties:
2614
+ request_path:
2615
+ title: Request Path
2616
+ type: string
2617
+ request_subdomain:
2618
+ anyOf:
2619
+ - type: string
2620
+ - type: 'null'
2621
+ title: Request Subdomain
2622
+ required:
2623
+ - request_path
2624
+ title: HttpRedirectRemove
2625
+ type: object
2548
2626
  IdnBase:
2549
2627
  properties:
2550
2628
  idn_capable:
@@ -3628,6 +3706,20 @@ components:
3628
3706
  - pagination
3629
3707
  title: Pagination[DnsZoneResponse]
3630
3708
  type: object
3709
+ Pagination_DomainForwardZone_:
3710
+ properties:
3711
+ pagination:
3712
+ $ref: '#/components/schemas/PaginationMetadata'
3713
+ results:
3714
+ items:
3715
+ $ref: '#/components/schemas/DomainForwardZone'
3716
+ title: Results
3717
+ type: array
3718
+ required:
3719
+ - results
3720
+ - pagination
3721
+ title: Pagination[DomainForwardZone]
3722
+ type: object
3631
3723
  Pagination_DomainResponse_:
3632
3724
  properties:
3633
3725
  pagination:
@@ -3922,6 +4014,17 @@ components:
3922
4014
  - status
3923
4015
  title: Problem
3924
4016
  type: object
4017
+ ProtocolRedirects:
4018
+ properties:
4019
+ redirects:
4020
+ items:
4021
+ $ref: '#/components/schemas/HttpRedirect'
4022
+ title: Redirects
4023
+ type: array
4024
+ required:
4025
+ - redirects
4026
+ title: ProtocolRedirects
4027
+ type: object
3925
4028
  PublicAuthRequestForm:
3926
4029
  properties:
3927
4030
  client_id:
@@ -5005,7 +5108,7 @@ info:
5005
5108
  '
5006
5109
  summary: OpusDNS - your gateway to a seamless domain management experience.
5007
5110
  title: OpusDNS API
5008
- version: 2025-10-29-093948
5111
+ version: 2025-10-31-135349
5009
5112
  x-logo:
5010
5113
  altText: OpusDNS API Reference
5011
5114
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -6483,6 +6586,159 @@ paths:
6483
6586
  summary: Update Zone Rrsets
6484
6587
  tags:
6485
6588
  - dns
6589
+ /v1/domain-forwards:
6590
+ get:
6591
+ operationId: list_domain_forwards_v1_domain_forwards_get
6592
+ parameters:
6593
+ - in: query
6594
+ name: sort_by
6595
+ required: false
6596
+ schema:
6597
+ $ref: '#/components/schemas/ZoneSortField'
6598
+ default: created_on
6599
+ - in: query
6600
+ name: sort_order
6601
+ required: false
6602
+ schema:
6603
+ $ref: '#/components/schemas/SortOrder'
6604
+ default: desc
6605
+ - in: query
6606
+ name: dnssec_status
6607
+ required: false
6608
+ schema:
6609
+ anyOf:
6610
+ - $ref: '#/components/schemas/DnssecStatus'
6611
+ - type: 'null'
6612
+ title: Dnssec Status
6613
+ - in: query
6614
+ name: name
6615
+ required: false
6616
+ schema:
6617
+ anyOf:
6618
+ - type: string
6619
+ - type: 'null'
6620
+ title: Name
6621
+ - in: query
6622
+ name: search
6623
+ required: false
6624
+ schema:
6625
+ anyOf:
6626
+ - type: string
6627
+ - type: 'null'
6628
+ title: Search
6629
+ - in: query
6630
+ name: suffix
6631
+ required: false
6632
+ schema:
6633
+ anyOf:
6634
+ - type: string
6635
+ - type: 'null'
6636
+ title: Suffix
6637
+ - in: query
6638
+ name: created_after
6639
+ required: false
6640
+ schema:
6641
+ anyOf:
6642
+ - format: date-time
6643
+ type: string
6644
+ - type: 'null'
6645
+ title: Created After
6646
+ - in: query
6647
+ name: created_before
6648
+ required: false
6649
+ schema:
6650
+ anyOf:
6651
+ - format: date-time
6652
+ type: string
6653
+ - type: 'null'
6654
+ title: Created Before
6655
+ - in: query
6656
+ name: updated_after
6657
+ required: false
6658
+ schema:
6659
+ anyOf:
6660
+ - format: date-time
6661
+ type: string
6662
+ - type: 'null'
6663
+ title: Updated After
6664
+ - in: query
6665
+ name: updated_before
6666
+ required: false
6667
+ schema:
6668
+ anyOf:
6669
+ - format: date-time
6670
+ type: string
6671
+ - type: 'null'
6672
+ title: Updated Before
6673
+ - in: query
6674
+ name: page
6675
+ required: false
6676
+ schema:
6677
+ default: 1
6678
+ minimum: 1
6679
+ title: Page
6680
+ type: integer
6681
+ - in: query
6682
+ name: page_size
6683
+ required: false
6684
+ schema:
6685
+ default: 10
6686
+ maximum: 100
6687
+ minimum: 1
6688
+ title: Page Size
6689
+ type: integer
6690
+ responses:
6691
+ '200':
6692
+ content:
6693
+ application/json:
6694
+ schema:
6695
+ $ref: '#/components/schemas/Pagination_DomainForwardZone_'
6696
+ description: Successful Response
6697
+ '422':
6698
+ content:
6699
+ application/problem+json:
6700
+ schema:
6701
+ $ref: '#/components/schemas/HTTPValidationError'
6702
+ description: Validation Error
6703
+ security:
6704
+ - OAuth2PasswordBearer: []
6705
+ summary: List Domain Forwards
6706
+ tags:
6707
+ - domain_forward
6708
+ patch:
6709
+ operationId: patch_redirects_v1_domain_forwards_patch
6710
+ requestBody:
6711
+ content:
6712
+ application/json:
6713
+ schema:
6714
+ $ref: '#/components/schemas/DomainForwardPatchOps'
6715
+ required: true
6716
+ responses:
6717
+ '204':
6718
+ description: Successful Response
6719
+ '404':
6720
+ content:
6721
+ application/problem+json:
6722
+ example:
6723
+ code: ERROR_DOMAIN_FORWARD_NOT_EXISTS
6724
+ detail: Domain forward not found
6725
+ status: 404
6726
+ title: Domain Forward Error
6727
+ type: domain-forward-not-found
6728
+ schema:
6729
+ $ref: '#/components/schemas/Problem'
6730
+ description: Not Found
6731
+ '422':
6732
+ content:
6733
+ application/problem+json:
6734
+ schema:
6735
+ $ref: '#/components/schemas/HTTPValidationError'
6736
+ description: Validation Error
6737
+ security:
6738
+ - OAuth2PasswordBearer: []
6739
+ summary: Patch Redirects
6740
+ tags:
6741
+ - domain_forward
6486
6742
  /v1/domain-forwards/{zone_name}/disable:
6487
6743
  patch:
6488
6744
  operationId: disable_domain_forward_v1_domain_forwards__zone_name__disable_patch
@@ -6528,6 +6784,13 @@ paths:
6528
6784
  default: false
6529
6785
  title: Auto Create Zone
6530
6786
  type: boolean
6787
+ - in: query
6788
+ name: wildcard
6789
+ required: false
6790
+ schema:
6791
+ default: false
6792
+ title: Wildcard
6793
+ type: boolean
6531
6794
  responses:
6532
6795
  '204':
6533
6796
  description: Successful Response
@@ -6562,6 +6825,18 @@ paths:
6562
6825
  responses:
6563
6826
  '204':
6564
6827
  description: Successful Response
6828
+ '404':
6829
+ content:
6830
+ application/problem+json:
6831
+ example:
6832
+ code: ERROR_DOMAIN_FORWARD_NOT_EXISTS
6833
+ detail: Domain forward not found
6834
+ status: 404
6835
+ title: Domain Forward Error
6836
+ type: domain-forward-not-found
6837
+ schema:
6838
+ $ref: '#/components/schemas/Problem'
6839
+ description: Not Found
6565
6840
  '422':
6566
6841
  content:
6567
6842
  application/problem+json:
@@ -6640,12 +6915,11 @@ paths:
6640
6915
  content:
6641
6916
  application/problem+json:
6642
6917
  example:
6643
- code: ERROR_DOMAIN_FORWARD_REDIRECT_ALREADY_EXISTS
6644
- detail: Redirect already exists for A, d, d, i, t, i, o, n, a, l, ,
6645
- e, r, r, o, r, , c, o, n, t, e, x, t, .
6918
+ code: ERROR_DOMAIN_FORWARD_ALREADY_EXISTS
6919
+ detail: Domain forward already exists
6646
6920
  status: 409
6647
6921
  title: Domain Forward Error
6648
- type: domain-forward-redirect-already-exists
6922
+ type: domain-forward-already-exists
6649
6923
  schema:
6650
6924
  $ref: '#/components/schemas/Problem'
6651
6925
  description: Conflict
@@ -6689,19 +6963,18 @@ paths:
6689
6963
  schema:
6690
6964
  $ref: '#/components/schemas/DomainForward'
6691
6965
  description: Successful Response
6692
- '409':
6966
+ '404':
6693
6967
  content:
6694
6968
  application/problem+json:
6695
6969
  example:
6696
- code: ERROR_DOMAIN_FORWARD_REDIRECT_NOT_EXISTS
6697
- detail: Redirect does not exist for A, d, d, i, t, i, o, n, a, l, ,
6698
- e, r, r, o, r, , c, o, n, t, e, x, t, .
6699
- status: 409
6970
+ code: ERROR_DOMAIN_FORWARD_NOT_EXISTS
6971
+ detail: Domain forward not found
6972
+ status: 404
6700
6973
  title: Domain Forward Error
6701
- type: domain-forward-redirect-not-exists
6974
+ type: domain-forward-not-found
6702
6975
  schema:
6703
6976
  $ref: '#/components/schemas/Problem'
6704
- description: Conflict
6977
+ description: Not Found
6705
6978
  '422':
6706
6979
  content:
6707
6980
  application/problem+json:
package/src/schema.d.ts CHANGED
@@ -282,6 +282,24 @@ export interface paths {
282
282
  patch: operations["patch_zone_rrsets_v1_dns__zone_name__rrsets_patch"];
283
283
  trace?: never;
284
284
  };
285
+ "/v1/domain-forwards": {
286
+ parameters: {
287
+ query?: never;
288
+ header?: never;
289
+ path?: never;
290
+ cookie?: never;
291
+ };
292
+ /** List Domain Forwards */
293
+ get: operations["list_domain_forwards_v1_domain_forwards_get"];
294
+ put?: never;
295
+ post?: never;
296
+ delete?: never;
297
+ options?: never;
298
+ head?: never;
299
+ /** Patch Redirects */
300
+ patch: operations["patch_redirects_v1_domain_forwards_patch"];
301
+ trace?: never;
302
+ };
285
303
  "/v1/domain-forwards/{zone_name}/disable": {
286
304
  parameters: {
287
305
  query?: never;
@@ -2271,6 +2289,25 @@ export interface components {
2271
2289
  /** Zone Name */
2272
2290
  zone_name: string;
2273
2291
  };
2292
+ /** DomainForwardPatchOp */
2293
+ DomainForwardPatchOp: {
2294
+ op: components["schemas"]["PatchOp"];
2295
+ /** Redirect */
2296
+ redirect: components["schemas"]["HttpRedirect"] | components["schemas"]["HttpRedirectRemove"];
2297
+ request_protocol: components["schemas"]["HttpProtocol"];
2298
+ /** Zone Name */
2299
+ zone_name: string;
2300
+ };
2301
+ /** DomainForwardPatchOps */
2302
+ DomainForwardPatchOps: {
2303
+ /** Ops */
2304
+ ops: components["schemas"]["DomainForwardPatchOp"][];
2305
+ };
2306
+ /** DomainForwardProtocols */
2307
+ DomainForwardProtocols: {
2308
+ http?: components["schemas"]["ProtocolRedirects"] | null;
2309
+ https?: components["schemas"]["ProtocolRedirects"] | null;
2310
+ };
2274
2311
  /** DomainForwardRequest */
2275
2312
  DomainForwardRequest: {
2276
2313
  /** Redirects */
@@ -2278,6 +2315,16 @@ export interface components {
2278
2315
  /** Wildcard */
2279
2316
  wildcard: boolean;
2280
2317
  };
2318
+ /** DomainForwardZone */
2319
+ DomainForwardZone: {
2320
+ /** Enabled */
2321
+ enabled: boolean;
2322
+ protocols: components["schemas"]["DomainForwardProtocols"];
2323
+ /** Wildcard */
2324
+ wildcard: boolean;
2325
+ /** Zone Name */
2326
+ zone_name: string;
2327
+ };
2281
2328
  /** DomainLifecycleBase */
2282
2329
  DomainLifecycleBase: {
2283
2330
  /**
@@ -2914,6 +2961,13 @@ export interface components {
2914
2961
  /** Target Subdomain */
2915
2962
  target_subdomain?: string | null;
2916
2963
  };
2964
+ /** HttpRedirectRemove */
2965
+ HttpRedirectRemove: {
2966
+ /** Request Path */
2967
+ request_path: string;
2968
+ /** Request Subdomain */
2969
+ request_subdomain?: string | null;
2970
+ };
2917
2971
  /** IdnBase */
2918
2972
  IdnBase: {
2919
2973
  /**
@@ -3666,6 +3720,12 @@ export interface components {
3666
3720
  /** Results */
3667
3721
  results: components["schemas"]["DnsZoneResponse"][];
3668
3722
  };
3723
+ /** Pagination[DomainForwardZone] */
3724
+ Pagination_DomainForwardZone_: {
3725
+ pagination: components["schemas"]["PaginationMetadata"];
3726
+ /** Results */
3727
+ results: components["schemas"]["DomainForwardZone"][];
3728
+ };
3669
3729
  /** Pagination[DomainResponse] */
3670
3730
  Pagination_DomainResponse_: {
3671
3731
  pagination: components["schemas"]["PaginationMetadata"];
@@ -3812,6 +3872,11 @@ export interface components {
3812
3872
  /** Problem type */
3813
3873
  type: string;
3814
3874
  };
3875
+ /** ProtocolRedirects */
3876
+ ProtocolRedirects: {
3877
+ /** Redirects */
3878
+ redirects: components["schemas"]["HttpRedirect"][];
3879
+ };
3815
3880
  /** PublicAuthRequestForm */
3816
3881
  PublicAuthRequestForm: {
3817
3882
  /**
@@ -5782,6 +5847,95 @@ export interface operations {
5782
5847
  };
5783
5848
  };
5784
5849
  };
5850
+ list_domain_forwards_v1_domain_forwards_get: {
5851
+ parameters: {
5852
+ query?: {
5853
+ sort_by?: components["schemas"]["ZoneSortField"];
5854
+ sort_order?: components["schemas"]["SortOrder"];
5855
+ dnssec_status?: components["schemas"]["DnssecStatus"] | null;
5856
+ name?: string | null;
5857
+ search?: string | null;
5858
+ suffix?: string | null;
5859
+ created_after?: Date | null;
5860
+ created_before?: Date | null;
5861
+ updated_after?: Date | null;
5862
+ updated_before?: Date | null;
5863
+ page?: number;
5864
+ page_size?: number;
5865
+ };
5866
+ header?: never;
5867
+ path?: never;
5868
+ cookie?: never;
5869
+ };
5870
+ requestBody?: never;
5871
+ responses: {
5872
+ /** @description Successful Response */
5873
+ 200: {
5874
+ headers: {
5875
+ [name: string]: unknown;
5876
+ };
5877
+ content: {
5878
+ "application/json": components["schemas"]["Pagination_DomainForwardZone_"];
5879
+ };
5880
+ };
5881
+ /** @description Validation Error */
5882
+ 422: {
5883
+ headers: {
5884
+ [name: string]: unknown;
5885
+ };
5886
+ content: {
5887
+ "application/problem+json": components["schemas"]["HTTPValidationError"];
5888
+ };
5889
+ };
5890
+ };
5891
+ };
5892
+ patch_redirects_v1_domain_forwards_patch: {
5893
+ parameters: {
5894
+ query?: never;
5895
+ header?: never;
5896
+ path?: never;
5897
+ cookie?: never;
5898
+ };
5899
+ requestBody: {
5900
+ content: {
5901
+ "application/json": components["schemas"]["DomainForwardPatchOps"];
5902
+ };
5903
+ };
5904
+ responses: {
5905
+ /** @description Successful Response */
5906
+ 204: {
5907
+ headers: {
5908
+ [name: string]: unknown;
5909
+ };
5910
+ content?: never;
5911
+ };
5912
+ /** @description Not Found */
5913
+ 404: {
5914
+ headers: {
5915
+ [name: string]: unknown;
5916
+ };
5917
+ content: {
5918
+ /** @example {
5919
+ * "code": "ERROR_DOMAIN_FORWARD_NOT_EXISTS",
5920
+ * "detail": "Domain forward not found",
5921
+ * "status": 404,
5922
+ * "title": "Domain Forward Error",
5923
+ * "type": "domain-forward-not-found"
5924
+ * } */
5925
+ "application/problem+json": components["schemas"]["Problem"];
5926
+ };
5927
+ };
5928
+ /** @description Validation Error */
5929
+ 422: {
5930
+ headers: {
5931
+ [name: string]: unknown;
5932
+ };
5933
+ content: {
5934
+ "application/problem+json": components["schemas"]["HTTPValidationError"];
5935
+ };
5936
+ };
5937
+ };
5938
+ };
5785
5939
  disable_domain_forward_v1_domain_forwards__zone_name__disable_patch: {
5786
5940
  parameters: {
5787
5941
  query?: never;
@@ -5816,6 +5970,7 @@ export interface operations {
5816
5970
  parameters: {
5817
5971
  query?: {
5818
5972
  auto_create_zone?: boolean;
5973
+ wildcard?: boolean;
5819
5974
  };
5820
5975
  header?: never;
5821
5976
  path: {
@@ -5903,18 +6058,18 @@ export interface operations {
5903
6058
  "application/json": components["schemas"]["DomainForward"];
5904
6059
  };
5905
6060
  };
5906
- /** @description Conflict */
5907
- 409: {
6061
+ /** @description Not Found */
6062
+ 404: {
5908
6063
  headers: {
5909
6064
  [name: string]: unknown;
5910
6065
  };
5911
6066
  content: {
5912
6067
  /** @example {
5913
- * "code": "ERROR_DOMAIN_FORWARD_REDIRECT_NOT_EXISTS",
5914
- * "detail": "Redirect does not exist for A, d, d, i, t, i, o, n, a, l, , e, r, r, o, r, , c, o, n, t, e, x, t, .",
5915
- * "status": 409,
6068
+ * "code": "ERROR_DOMAIN_FORWARD_NOT_EXISTS",
6069
+ * "detail": "Domain forward not found",
6070
+ * "status": 404,
5916
6071
  * "title": "Domain Forward Error",
5917
- * "type": "domain-forward-redirect-not-exists"
6072
+ * "type": "domain-forward-not-found"
5918
6073
  * } */
5919
6074
  "application/problem+json": components["schemas"]["Problem"];
5920
6075
  };
@@ -5963,11 +6118,11 @@ export interface operations {
5963
6118
  };
5964
6119
  content: {
5965
6120
  /** @example {
5966
- * "code": "ERROR_DOMAIN_FORWARD_REDIRECT_ALREADY_EXISTS",
5967
- * "detail": "Redirect already exists for A, d, d, i, t, i, o, n, a, l, , e, r, r, o, r, , c, o, n, t, e, x, t, .",
6121
+ * "code": "ERROR_DOMAIN_FORWARD_ALREADY_EXISTS",
6122
+ * "detail": "Domain forward already exists",
5968
6123
  * "status": 409,
5969
6124
  * "title": "Domain Forward Error",
5970
- * "type": "domain-forward-redirect-already-exists"
6125
+ * "type": "domain-forward-already-exists"
5971
6126
  * } */
5972
6127
  "application/problem+json": components["schemas"]["Problem"];
5973
6128
  };
@@ -6003,6 +6158,22 @@ export interface operations {
6003
6158
  };
6004
6159
  content?: never;
6005
6160
  };
6161
+ /** @description Not Found */
6162
+ 404: {
6163
+ headers: {
6164
+ [name: string]: unknown;
6165
+ };
6166
+ content: {
6167
+ /** @example {
6168
+ * "code": "ERROR_DOMAIN_FORWARD_NOT_EXISTS",
6169
+ * "detail": "Domain forward not found",
6170
+ * "status": 404,
6171
+ * "title": "Domain Forward Error",
6172
+ * "type": "domain-forward-not-found"
6173
+ * } */
6174
+ "application/problem+json": components["schemas"]["Problem"];
6175
+ };
6176
+ };
6006
6177
  /** @description Validation Error */
6007
6178
  422: {
6008
6179
  headers: {