@opusdns/api 0.208.0 → 0.210.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
@@ -596,132 +596,6 @@ components:
596
596
  - disclose
597
597
  title: ContactCreate
598
598
  type: object
599
- ContactDetailResponse:
600
- properties:
601
- attribute_sets:
602
- description: Linked attribute sets for this contact
603
- items:
604
- $ref: '#/components/schemas/ContactAttributeLinkDetail'
605
- title: Attribute Sets
606
- type: array
607
- city:
608
- description: The city of the contact
609
- minLength: 1
610
- title: City
611
- type: string
612
- contact_id:
613
- examples:
614
- - contact_01h45ytscbebyvny4gc8cr8ma2
615
- format: typeid
616
- pattern: ^contact_[0-7][0-9a-hjkmnpq-tv-z]{25}$
617
- title: Contact Id
618
- type: string
619
- x-typeid-prefix: contact
620
- country:
621
- description: The country of the contact
622
- pattern: ^\w{2}$
623
- title: Country
624
- type: string
625
- created_on:
626
- description: The date/time the entry was created on
627
- format: date-time
628
- title: Created On
629
- type: string
630
- deleted_on:
631
- anyOf:
632
- - format: date-time
633
- type: string
634
- - type: 'null'
635
- description: The date/time the entry was deleted on
636
- title: Deleted On
637
- disclose:
638
- description: Whether the contact details should be disclosed. The Disclose
639
- function may not work with all TLDs. Some registries still display the
640
- data in Whois if, for example, the organization field is filled in.
641
- title: Disclose
642
- type: boolean
643
- email:
644
- description: The email of the contact
645
- format: email
646
- title: Email
647
- type: string
648
- fax:
649
- anyOf:
650
- - format: phone
651
- type: string
652
- - type: 'null'
653
- description: The contacts's fax number
654
- title: Fax
655
- first_name:
656
- description: The first name of the contact
657
- minLength: 1
658
- title: First Name
659
- type: string
660
- last_name:
661
- description: The last name of the contact
662
- minLength: 1
663
- title: Last Name
664
- type: string
665
- org:
666
- anyOf:
667
- - minLength: 1
668
- type: string
669
- - type: 'null'
670
- description: The organization of the contact
671
- title: Org
672
- organization_id:
673
- default: None
674
- description: The organization that owns the domain
675
- examples:
676
- - organization_01h45ytscbebyvny4gc8cr8ma2
677
- format: typeid
678
- pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
679
- title: Organization Id
680
- type: string
681
- x-typeid-prefix: organization
682
- phone:
683
- description: The contact's phone number
684
- examples:
685
- - '+1.2125552368'
686
- format: phone
687
- title: Phone
688
- type: string
689
- postal_code:
690
- description: The postal code of the contact
691
- minLength: 1
692
- title: Postal Code
693
- type: string
694
- state:
695
- anyOf:
696
- - minLength: 1
697
- type: string
698
- - type: 'null'
699
- description: The state of the contact
700
- title: State
701
- street:
702
- description: The address of the contact
703
- minLength: 1
704
- title: Street
705
- type: string
706
- title:
707
- anyOf:
708
- - minLength: 1
709
- type: string
710
- - type: 'null'
711
- description: The title of the contact
712
- title: Title
713
- required:
714
- - first_name
715
- - last_name
716
- - email
717
- - phone
718
- - street
719
- - city
720
- - postal_code
721
- - country
722
- - disclose
723
- title: ContactDetailResponse
724
- type: object
725
599
  ContactHandle:
726
600
  properties:
727
601
  attributes:
@@ -761,16 +635,35 @@ components:
761
635
  type: object
762
636
  ContactResponse:
763
637
  properties:
638
+ attribute_sets:
639
+ description: Linked attribute sets for this contact
640
+ items:
641
+ $ref: '#/components/schemas/ContactAttributeLinkDetail'
642
+ title: Attribute Sets
643
+ type: array
764
644
  city:
765
645
  description: The city of the contact
766
646
  minLength: 1
767
647
  title: City
768
648
  type: string
649
+ contact_id:
650
+ examples:
651
+ - contact_01h45ytscbebyvny4gc8cr8ma2
652
+ format: typeid
653
+ pattern: ^contact_[0-7][0-9a-hjkmnpq-tv-z]{25}$
654
+ title: Contact Id
655
+ type: string
656
+ x-typeid-prefix: contact
769
657
  country:
770
658
  description: The country of the contact
771
659
  pattern: ^\w{2}$
772
660
  title: Country
773
661
  type: string
662
+ created_on:
663
+ description: The date/time the entry was created on
664
+ format: date-time
665
+ title: Created On
666
+ type: string
774
667
  disclose:
775
668
  description: Whether the contact details should be disclosed. The Disclose
776
669
  function may not work with all TLDs. Some registries still display the
@@ -806,6 +699,16 @@ components:
806
699
  - type: 'null'
807
700
  description: The organization of the contact
808
701
  title: Org
702
+ organization_id:
703
+ default: None
704
+ description: The organization that owns the domain
705
+ examples:
706
+ - organization_01h45ytscbebyvny4gc8cr8ma2
707
+ format: typeid
708
+ pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
709
+ title: Organization Id
710
+ type: string
711
+ x-typeid-prefix: organization
809
712
  phone:
810
713
  description: The contact's phone number
811
714
  examples:
@@ -874,13 +777,6 @@ components:
874
777
  format: date-time
875
778
  title: Created On
876
779
  type: string
877
- deleted_on:
878
- anyOf:
879
- - format: date-time
880
- type: string
881
- - type: 'null'
882
- description: The date/time the entry was deleted on
883
- title: Deleted On
884
780
  disclose:
885
781
  description: Whether the contact details should be disclosed. The Disclose
886
782
  function may not work with all TLDs. Some registries still display the
@@ -2107,9 +2003,7 @@ components:
2107
2003
  properties:
2108
2004
  redirects:
2109
2005
  items:
2110
- anyOf:
2111
- - $ref: '#/components/schemas/HttpRedirectRequest'
2112
- - $ref: '#/components/schemas/WildcardHttpRedirectRequest'
2006
+ $ref: '#/components/schemas/HttpRedirectRequest'
2113
2007
  title: Redirects
2114
2008
  type: array
2115
2009
  required:
@@ -2154,9 +2048,7 @@ components:
2154
2048
  $ref: '#/components/schemas/HttpProtocol'
2155
2049
  redirects:
2156
2050
  items:
2157
- anyOf:
2158
- - $ref: '#/components/schemas/HttpRedirectRequest'
2159
- - $ref: '#/components/schemas/WildcardHttpRedirectRequest'
2051
+ $ref: '#/components/schemas/HttpRedirectRequest'
2160
2052
  title: Redirects
2161
2053
  type: array
2162
2054
  required:
@@ -2168,9 +2060,7 @@ components:
2168
2060
  properties:
2169
2061
  redirects:
2170
2062
  items:
2171
- anyOf:
2172
- - $ref: '#/components/schemas/HttpRedirectRequest'
2173
- - $ref: '#/components/schemas/WildcardHttpRedirectRequest'
2063
+ $ref: '#/components/schemas/HttpRedirectRequest'
2174
2064
  title: Redirects
2175
2065
  type: array
2176
2066
  required:
@@ -5107,19 +4997,19 @@ components:
5107
4997
  - pagination
5108
4998
  title: Pagination[ContactAttributeSetResponse]
5109
4999
  type: object
5110
- Pagination_ContactDetailResponse_:
5000
+ Pagination_ContactResponse_:
5111
5001
  properties:
5112
5002
  pagination:
5113
5003
  $ref: '#/components/schemas/PaginationMetadata'
5114
5004
  results:
5115
5005
  items:
5116
- $ref: '#/components/schemas/ContactDetailResponse'
5006
+ $ref: '#/components/schemas/ContactResponse'
5117
5007
  title: Results
5118
5008
  type: array
5119
5009
  required:
5120
5010
  - results
5121
5011
  - pagination
5122
- title: Pagination[ContactDetailResponse]
5012
+ title: Pagination[ContactResponse]
5123
5013
  type: object
5124
5014
  Pagination_DnsZoneResponse_:
5125
5015
  properties:
@@ -7142,33 +7032,6 @@ components:
7142
7032
  title: Whois Server
7143
7033
  title: WhoisBase
7144
7034
  type: object
7145
- WildcardHttpRedirectRequest:
7146
- properties:
7147
- redirect_code:
7148
- $ref: '#/components/schemas/RedirectCode'
7149
- request_path:
7150
- title: Request Path
7151
- type: string
7152
- request_subdomain:
7153
- title: Request Subdomain
7154
- type: string
7155
- target_hostname:
7156
- title: Target Hostname
7157
- type: string
7158
- target_path:
7159
- title: Target Path
7160
- type: string
7161
- target_protocol:
7162
- $ref: '#/components/schemas/HttpProtocol'
7163
- required:
7164
- - request_path
7165
- - target_protocol
7166
- - target_hostname
7167
- - target_path
7168
- - redirect_code
7169
- - request_subdomain
7170
- title: WildcardHttpRedirectRequest
7171
- type: object
7172
7035
  ZoneSortField:
7173
7036
  enum:
7174
7037
  - name
@@ -7350,7 +7213,7 @@ info:
7350
7213
  '
7351
7214
  summary: OpusDNS - your gateway to a seamless domain management experience.
7352
7215
  title: OpusDNS API
7353
- version: 2026-02-26-130807
7216
+ version: 2026-03-02-094357
7354
7217
  x-logo:
7355
7218
  altText: OpusDNS API Reference
7356
7219
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -8256,7 +8119,7 @@ paths:
8256
8119
  content:
8257
8120
  application/json:
8258
8121
  schema:
8259
- $ref: '#/components/schemas/Pagination_ContactDetailResponse_'
8122
+ $ref: '#/components/schemas/Pagination_ContactResponse_'
8260
8123
  description: Successful Response
8261
8124
  '422':
8262
8125
  content:
@@ -8757,7 +8620,7 @@ paths:
8757
8620
  content:
8758
8621
  application/json:
8759
8622
  schema:
8760
- $ref: '#/components/schemas/ContactDetailResponse'
8623
+ $ref: '#/components/schemas/ContactResponse'
8761
8624
  description: Successful Response
8762
8625
  '404':
8763
8626
  content:
@@ -12670,116 +12533,6 @@ paths:
12670
12533
  summary: Get domain forward set
12671
12534
  tags:
12672
12535
  - domain_forward
12673
- post:
12674
- deprecated: true
12675
- description: 'Deprecated: Use POST /{hostname} with protocol in body instead.
12676
- Creates a new domain forward set for a specific protocol (HTTP or HTTPS).'
12677
- operationId: create_domain_forward_set_deprecated_v1_domain_forwards__hostname___protocol__post
12678
- parameters:
12679
- - in: path
12680
- name: protocol
12681
- required: true
12682
- schema:
12683
- $ref: '#/components/schemas/HttpProtocol'
12684
- - description: Hostname
12685
- in: path
12686
- name: hostname
12687
- required: true
12688
- schema:
12689
- description: Hostname
12690
- title: Hostname
12691
- type: string
12692
- requestBody:
12693
- content:
12694
- application/json:
12695
- schema:
12696
- $ref: '#/components/schemas/DomainForwardSetRequest'
12697
- required: true
12698
- responses:
12699
- '201':
12700
- content:
12701
- application/json:
12702
- examples:
12703
- created_protocol_set:
12704
- description: New domain forward protocol set with HTTP redirects
12705
- summary: Protocol set created
12706
- value:
12707
- created_on: '2025-02-20T10:30:45'
12708
- hostname: example.com.
12709
- protocol: http
12710
- redirects:
12711
- - protected: false
12712
- redirect_code: 301
12713
- request_hostname: example.com.
12714
- request_path: /
12715
- request_protocol: http
12716
- target_hostname: example.com
12717
- target_path: /
12718
- target_protocol: https
12719
- updated_on: '2025-02-20T10:30:45'
12720
- schema:
12721
- $ref: '#/components/schemas/DomainForwardSetResponse'
12722
- description: Domain forward protocol set created successfully
12723
- '401':
12724
- content:
12725
- application/problem+json:
12726
- example:
12727
- code: ERROR_AUTHENTICATION
12728
- detail: Additional error context.
12729
- status: 401
12730
- title: Authentication Error
12731
- type: authentication
12732
- schema:
12733
- $ref: '#/components/schemas/Problem'
12734
- description: Unauthorized
12735
- '403':
12736
- content:
12737
- application/problem+json:
12738
- example:
12739
- code: ERROR_PERMISSION_DENIED
12740
- detail: Insufficient permissions to perform this action
12741
- status: 403
12742
- title: Permission Denied
12743
- type: permission-denied
12744
- schema:
12745
- $ref: '#/components/schemas/Problem'
12746
- description: Forbidden
12747
- '404':
12748
- content:
12749
- application/problem+json:
12750
- example:
12751
- code: ERROR_DOMAIN_FORWARD_NOT_EXISTS
12752
- detail: Domain forward not found for Additional error context.
12753
- status: 404
12754
- title: Domain Forward Error
12755
- type: domain-forward-not-found
12756
- schema:
12757
- $ref: '#/components/schemas/Problem'
12758
- description: Not Found
12759
- '409':
12760
- content:
12761
- application/problem+json:
12762
- example:
12763
- code: ERROR_DOMAIN_FORWARD_ALREADY_EXISTS
12764
- detail: Domain forward already exists for Additional error context.
12765
- status: 409
12766
- title: Domain Forward Error
12767
- type: domain-forward-already-exists
12768
- schema:
12769
- $ref: '#/components/schemas/Problem'
12770
- description: Conflict
12771
- '422':
12772
- content:
12773
- application/problem+json:
12774
- schema:
12775
- $ref: '#/components/schemas/HTTPValidationError'
12776
- description: Validation Error
12777
- security:
12778
- - OAuth2PasswordBearer: []
12779
- - APIKeyHeader: []
12780
- summary: Create domain forward set (deprecated)
12781
- tags:
12782
- - domain_forward
12783
12536
  put:
12784
12537
  description: Updates an existing domain forward set for a specific protocol
12785
12538
  (HTTP or HTTPS). All existing redirects for this protocol are replaced with