@opusdns/api 0.271.0 → 0.273.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 +1 -1
- package/src/helpers/keys.ts +52 -0
- package/src/helpers/requests.d.ts +108 -108
- package/src/helpers/responses.d.ts +160 -160
- package/src/openapi.yaml +167 -151
- package/src/schema.d.ts +110 -100
package/src/openapi.yaml
CHANGED
|
@@ -2629,6 +2629,14 @@ components:
|
|
|
2629
2629
|
- type: 'null'
|
|
2630
2630
|
description: The auth code used for the domain
|
|
2631
2631
|
title: Auth Code
|
|
2632
|
+
claims_notice_acceptance_hash:
|
|
2633
|
+
anyOf:
|
|
2634
|
+
- type: string
|
|
2635
|
+
- type: 'null'
|
|
2636
|
+
description: During the claims phase domain names that match a trademark
|
|
2637
|
+
registered in the Trademark Clearinghouse require an acceptance by the
|
|
2638
|
+
registrant.
|
|
2639
|
+
title: The accept_hash of the related claims notice
|
|
2632
2640
|
contacts:
|
|
2633
2641
|
anyOf:
|
|
2634
2642
|
- $ref: '#/components/schemas/DomainContactHandles'
|
|
@@ -2849,6 +2857,14 @@ components:
|
|
|
2849
2857
|
- type: 'null'
|
|
2850
2858
|
description: The auth code used for the domain
|
|
2851
2859
|
title: Auth Code
|
|
2860
|
+
claims_notice_acceptance_hash:
|
|
2861
|
+
anyOf:
|
|
2862
|
+
- type: string
|
|
2863
|
+
- type: 'null'
|
|
2864
|
+
description: During the claims phase domain names that match a trademark
|
|
2865
|
+
registered in the Trademark Clearinghouse require an acceptance by the
|
|
2866
|
+
registrant.
|
|
2867
|
+
title: The accept_hash of the related claims notice
|
|
2852
2868
|
contacts:
|
|
2853
2869
|
anyOf:
|
|
2854
2870
|
- $ref: '#/components/schemas/DomainContactHandles'
|
|
@@ -10153,7 +10169,7 @@ info:
|
|
|
10153
10169
|
\n\n"
|
|
10154
10170
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
10155
10171
|
title: OpusDNS API
|
|
10156
|
-
version: 2026-04-27-
|
|
10172
|
+
version: 2026-04-27-175347
|
|
10157
10173
|
x-logo:
|
|
10158
10174
|
altText: OpusDNS API Reference
|
|
10159
10175
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -19811,156 +19827,6 @@ paths:
|
|
|
19811
19827
|
summary: Update organization attributes
|
|
19812
19828
|
tags:
|
|
19813
19829
|
- organization
|
|
19814
|
-
/v1/organizations/attributes/{organization_id}:
|
|
19815
|
-
get:
|
|
19816
|
-
description: Retrieves a list of organization attributes for the specified organization
|
|
19817
|
-
operationId: get_attributes_v1_organizations_attributes__organization_id__get
|
|
19818
|
-
parameters:
|
|
19819
|
-
- in: path
|
|
19820
|
-
name: organization_id
|
|
19821
|
-
required: true
|
|
19822
|
-
schema:
|
|
19823
|
-
anyOf:
|
|
19824
|
-
- examples:
|
|
19825
|
-
- organization_01h45ytscbebyvny4gc8cr8ma2
|
|
19826
|
-
format: typeid
|
|
19827
|
-
pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
19828
|
-
type: string
|
|
19829
|
-
x-typeid-prefix: organization
|
|
19830
|
-
- type: 'null'
|
|
19831
|
-
title: Organization Id
|
|
19832
|
-
- description: Optional list of attribute keys to filter
|
|
19833
|
-
in: query
|
|
19834
|
-
name: keys
|
|
19835
|
-
required: false
|
|
19836
|
-
schema:
|
|
19837
|
-
anyOf:
|
|
19838
|
-
- items:
|
|
19839
|
-
type: string
|
|
19840
|
-
type: array
|
|
19841
|
-
- type: 'null'
|
|
19842
|
-
description: Optional list of attribute keys to filter
|
|
19843
|
-
title: Keys
|
|
19844
|
-
responses:
|
|
19845
|
-
'200':
|
|
19846
|
-
content:
|
|
19847
|
-
application/json:
|
|
19848
|
-
schema:
|
|
19849
|
-
items:
|
|
19850
|
-
$ref: '#/components/schemas/OrganizationAttributeResponse'
|
|
19851
|
-
title: Response Get Attributes V1 Organizations Attributes Organization
|
|
19852
|
-
Id Get
|
|
19853
|
-
type: array
|
|
19854
|
-
description: Successful Response
|
|
19855
|
-
'401':
|
|
19856
|
-
content:
|
|
19857
|
-
application/problem+json:
|
|
19858
|
-
example:
|
|
19859
|
-
code: ERROR_AUTHENTICATION
|
|
19860
|
-
detail: Additional error context.
|
|
19861
|
-
status: 401
|
|
19862
|
-
title: Authentication Error
|
|
19863
|
-
type: authentication
|
|
19864
|
-
schema:
|
|
19865
|
-
$ref: '#/components/schemas/Problem'
|
|
19866
|
-
description: Unauthorized
|
|
19867
|
-
'403':
|
|
19868
|
-
content:
|
|
19869
|
-
application/problem+json:
|
|
19870
|
-
example:
|
|
19871
|
-
code: ERROR_PERMISSION_DENIED
|
|
19872
|
-
detail: Insufficient permissions to perform this action
|
|
19873
|
-
status: 403
|
|
19874
|
-
title: Permission Denied
|
|
19875
|
-
type: permission-denied
|
|
19876
|
-
schema:
|
|
19877
|
-
$ref: '#/components/schemas/Problem'
|
|
19878
|
-
description: Forbidden
|
|
19879
|
-
'422':
|
|
19880
|
-
content:
|
|
19881
|
-
application/problem+json:
|
|
19882
|
-
schema:
|
|
19883
|
-
$ref: '#/components/schemas/HTTPValidationError'
|
|
19884
|
-
description: Validation Error
|
|
19885
|
-
security:
|
|
19886
|
-
- OAuth2PasswordBearer: []
|
|
19887
|
-
- APIKeyHeader: []
|
|
19888
|
-
summary: List organization attributes
|
|
19889
|
-
tags:
|
|
19890
|
-
- organization
|
|
19891
|
-
patch:
|
|
19892
|
-
description: Updates one or more organization attributes for the specified organization
|
|
19893
|
-
operationId: update_attributes_v1_organizations_attributes__organization_id__patch
|
|
19894
|
-
parameters:
|
|
19895
|
-
- in: path
|
|
19896
|
-
name: organization_id
|
|
19897
|
-
required: true
|
|
19898
|
-
schema:
|
|
19899
|
-
anyOf:
|
|
19900
|
-
- examples:
|
|
19901
|
-
- organization_01h45ytscbebyvny4gc8cr8ma2
|
|
19902
|
-
format: typeid
|
|
19903
|
-
pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
19904
|
-
type: string
|
|
19905
|
-
x-typeid-prefix: organization
|
|
19906
|
-
- type: 'null'
|
|
19907
|
-
title: Organization Id
|
|
19908
|
-
requestBody:
|
|
19909
|
-
content:
|
|
19910
|
-
application/json:
|
|
19911
|
-
schema:
|
|
19912
|
-
items:
|
|
19913
|
-
$ref: '#/components/schemas/OrganizationAttributeUpdate'
|
|
19914
|
-
title: Attributes
|
|
19915
|
-
type: array
|
|
19916
|
-
required: true
|
|
19917
|
-
responses:
|
|
19918
|
-
'200':
|
|
19919
|
-
content:
|
|
19920
|
-
application/json:
|
|
19921
|
-
schema:
|
|
19922
|
-
items:
|
|
19923
|
-
$ref: '#/components/schemas/OrganizationAttributeResponse'
|
|
19924
|
-
title: Response Update Attributes V1 Organizations Attributes Organization
|
|
19925
|
-
Id Patch
|
|
19926
|
-
type: array
|
|
19927
|
-
description: Successful Response
|
|
19928
|
-
'401':
|
|
19929
|
-
content:
|
|
19930
|
-
application/problem+json:
|
|
19931
|
-
example:
|
|
19932
|
-
code: ERROR_AUTHENTICATION
|
|
19933
|
-
detail: Additional error context.
|
|
19934
|
-
status: 401
|
|
19935
|
-
title: Authentication Error
|
|
19936
|
-
type: authentication
|
|
19937
|
-
schema:
|
|
19938
|
-
$ref: '#/components/schemas/Problem'
|
|
19939
|
-
description: Unauthorized
|
|
19940
|
-
'403':
|
|
19941
|
-
content:
|
|
19942
|
-
application/problem+json:
|
|
19943
|
-
example:
|
|
19944
|
-
code: ERROR_PERMISSION_DENIED
|
|
19945
|
-
detail: Insufficient permissions to perform this action
|
|
19946
|
-
status: 403
|
|
19947
|
-
title: Permission Denied
|
|
19948
|
-
type: permission-denied
|
|
19949
|
-
schema:
|
|
19950
|
-
$ref: '#/components/schemas/Problem'
|
|
19951
|
-
description: Forbidden
|
|
19952
|
-
'422':
|
|
19953
|
-
content:
|
|
19954
|
-
application/problem+json:
|
|
19955
|
-
schema:
|
|
19956
|
-
$ref: '#/components/schemas/HTTPValidationError'
|
|
19957
|
-
description: Validation Error
|
|
19958
|
-
security:
|
|
19959
|
-
- OAuth2PasswordBearer: []
|
|
19960
|
-
- APIKeyHeader: []
|
|
19961
|
-
summary: Update organization attributes
|
|
19962
|
-
tags:
|
|
19963
|
-
- organization
|
|
19964
19830
|
/v1/organizations/ip-restrictions:
|
|
19965
19831
|
get:
|
|
19966
19832
|
description: 'List all IP restrictions for the organization.
|
|
@@ -20563,6 +20429,156 @@ paths:
|
|
|
20563
20429
|
summary: Update an organization
|
|
20564
20430
|
tags:
|
|
20565
20431
|
- organization
|
|
20432
|
+
/v1/organizations/{organization_id}/attributes:
|
|
20433
|
+
get:
|
|
20434
|
+
description: Retrieves a list of organization attributes for the specified organization
|
|
20435
|
+
operationId: get_attributes_v1_organizations__organization_id__attributes_get
|
|
20436
|
+
parameters:
|
|
20437
|
+
- in: path
|
|
20438
|
+
name: organization_id
|
|
20439
|
+
required: true
|
|
20440
|
+
schema:
|
|
20441
|
+
anyOf:
|
|
20442
|
+
- examples:
|
|
20443
|
+
- organization_01h45ytscbebyvny4gc8cr8ma2
|
|
20444
|
+
format: typeid
|
|
20445
|
+
pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
20446
|
+
type: string
|
|
20447
|
+
x-typeid-prefix: organization
|
|
20448
|
+
- type: 'null'
|
|
20449
|
+
title: Organization Id
|
|
20450
|
+
- description: Optional list of attribute keys to filter
|
|
20451
|
+
in: query
|
|
20452
|
+
name: keys
|
|
20453
|
+
required: false
|
|
20454
|
+
schema:
|
|
20455
|
+
anyOf:
|
|
20456
|
+
- items:
|
|
20457
|
+
type: string
|
|
20458
|
+
type: array
|
|
20459
|
+
- type: 'null'
|
|
20460
|
+
description: Optional list of attribute keys to filter
|
|
20461
|
+
title: Keys
|
|
20462
|
+
responses:
|
|
20463
|
+
'200':
|
|
20464
|
+
content:
|
|
20465
|
+
application/json:
|
|
20466
|
+
schema:
|
|
20467
|
+
items:
|
|
20468
|
+
$ref: '#/components/schemas/OrganizationAttributeResponse'
|
|
20469
|
+
title: Response Get Attributes V1 Organizations Organization Id Attributes
|
|
20470
|
+
Get
|
|
20471
|
+
type: array
|
|
20472
|
+
description: Successful Response
|
|
20473
|
+
'401':
|
|
20474
|
+
content:
|
|
20475
|
+
application/problem+json:
|
|
20476
|
+
example:
|
|
20477
|
+
code: ERROR_AUTHENTICATION
|
|
20478
|
+
detail: Additional error context.
|
|
20479
|
+
status: 401
|
|
20480
|
+
title: Authentication Error
|
|
20481
|
+
type: authentication
|
|
20482
|
+
schema:
|
|
20483
|
+
$ref: '#/components/schemas/Problem'
|
|
20484
|
+
description: Unauthorized
|
|
20485
|
+
'403':
|
|
20486
|
+
content:
|
|
20487
|
+
application/problem+json:
|
|
20488
|
+
example:
|
|
20489
|
+
code: ERROR_PERMISSION_DENIED
|
|
20490
|
+
detail: Insufficient permissions to perform this action
|
|
20491
|
+
status: 403
|
|
20492
|
+
title: Permission Denied
|
|
20493
|
+
type: permission-denied
|
|
20494
|
+
schema:
|
|
20495
|
+
$ref: '#/components/schemas/Problem'
|
|
20496
|
+
description: Forbidden
|
|
20497
|
+
'422':
|
|
20498
|
+
content:
|
|
20499
|
+
application/problem+json:
|
|
20500
|
+
schema:
|
|
20501
|
+
$ref: '#/components/schemas/HTTPValidationError'
|
|
20502
|
+
description: Validation Error
|
|
20503
|
+
security:
|
|
20504
|
+
- OAuth2PasswordBearer: []
|
|
20505
|
+
- APIKeyHeader: []
|
|
20506
|
+
summary: List organization attributes
|
|
20507
|
+
tags:
|
|
20508
|
+
- organization
|
|
20509
|
+
patch:
|
|
20510
|
+
description: Updates one or more organization attributes for the specified organization
|
|
20511
|
+
operationId: update_attributes_v1_organizations__organization_id__attributes_patch
|
|
20512
|
+
parameters:
|
|
20513
|
+
- in: path
|
|
20514
|
+
name: organization_id
|
|
20515
|
+
required: true
|
|
20516
|
+
schema:
|
|
20517
|
+
anyOf:
|
|
20518
|
+
- examples:
|
|
20519
|
+
- organization_01h45ytscbebyvny4gc8cr8ma2
|
|
20520
|
+
format: typeid
|
|
20521
|
+
pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
20522
|
+
type: string
|
|
20523
|
+
x-typeid-prefix: organization
|
|
20524
|
+
- type: 'null'
|
|
20525
|
+
title: Organization Id
|
|
20526
|
+
requestBody:
|
|
20527
|
+
content:
|
|
20528
|
+
application/json:
|
|
20529
|
+
schema:
|
|
20530
|
+
items:
|
|
20531
|
+
$ref: '#/components/schemas/OrganizationAttributeUpdate'
|
|
20532
|
+
title: Attributes
|
|
20533
|
+
type: array
|
|
20534
|
+
required: true
|
|
20535
|
+
responses:
|
|
20536
|
+
'200':
|
|
20537
|
+
content:
|
|
20538
|
+
application/json:
|
|
20539
|
+
schema:
|
|
20540
|
+
items:
|
|
20541
|
+
$ref: '#/components/schemas/OrganizationAttributeResponse'
|
|
20542
|
+
title: Response Update Attributes V1 Organizations Organization Id Attributes
|
|
20543
|
+
Patch
|
|
20544
|
+
type: array
|
|
20545
|
+
description: Successful Response
|
|
20546
|
+
'401':
|
|
20547
|
+
content:
|
|
20548
|
+
application/problem+json:
|
|
20549
|
+
example:
|
|
20550
|
+
code: ERROR_AUTHENTICATION
|
|
20551
|
+
detail: Additional error context.
|
|
20552
|
+
status: 401
|
|
20553
|
+
title: Authentication Error
|
|
20554
|
+
type: authentication
|
|
20555
|
+
schema:
|
|
20556
|
+
$ref: '#/components/schemas/Problem'
|
|
20557
|
+
description: Unauthorized
|
|
20558
|
+
'403':
|
|
20559
|
+
content:
|
|
20560
|
+
application/problem+json:
|
|
20561
|
+
example:
|
|
20562
|
+
code: ERROR_PERMISSION_DENIED
|
|
20563
|
+
detail: Insufficient permissions to perform this action
|
|
20564
|
+
status: 403
|
|
20565
|
+
title: Permission Denied
|
|
20566
|
+
type: permission-denied
|
|
20567
|
+
schema:
|
|
20568
|
+
$ref: '#/components/schemas/Problem'
|
|
20569
|
+
description: Forbidden
|
|
20570
|
+
'422':
|
|
20571
|
+
content:
|
|
20572
|
+
application/problem+json:
|
|
20573
|
+
schema:
|
|
20574
|
+
$ref: '#/components/schemas/HTTPValidationError'
|
|
20575
|
+
description: Validation Error
|
|
20576
|
+
security:
|
|
20577
|
+
- OAuth2PasswordBearer: []
|
|
20578
|
+
- APIKeyHeader: []
|
|
20579
|
+
summary: Update organization attributes
|
|
20580
|
+
tags:
|
|
20581
|
+
- organization
|
|
20566
20582
|
/v1/organizations/{organization_id}/billing/invoices:
|
|
20567
20583
|
get:
|
|
20568
20584
|
description: Retrieves a paginated list of all invoices for the organization
|