@opusdns/api 1.42.0 → 1.44.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/constants.ts +11 -0
- package/src/helpers/keys.ts +4 -0
- package/src/helpers/schemas.d.ts +1 -0
- package/src/openapi.yaml +63 -1
- package/src/schema.d.ts +15 -0
package/package.json
CHANGED
package/src/helpers/constants.ts
CHANGED
|
@@ -4,6 +4,7 @@ import type {
|
|
|
4
4
|
AttributeType,
|
|
5
5
|
BatchSortField,
|
|
6
6
|
BatchStatus,
|
|
7
|
+
BillingMode,
|
|
7
8
|
BillingTransactionAction,
|
|
8
9
|
BillingTransactionProductType,
|
|
9
10
|
BillingTransactionSortField,
|
|
@@ -183,6 +184,16 @@ export const BATCH_STATUS_VALUES = [
|
|
|
183
184
|
'complete',
|
|
184
185
|
] as const satisfies ReadonlyArray<BatchStatus>;
|
|
185
186
|
|
|
187
|
+
export const BILLING_MODE = {
|
|
188
|
+
CONSOLIDATED: "consolidated",
|
|
189
|
+
INDEPENDENT: "independent",
|
|
190
|
+
} as const satisfies Record<string, BillingMode>;
|
|
191
|
+
|
|
192
|
+
export const BILLING_MODE_VALUES = [
|
|
193
|
+
'consolidated',
|
|
194
|
+
'independent',
|
|
195
|
+
] as const satisfies ReadonlyArray<BillingMode>;
|
|
196
|
+
|
|
186
197
|
export const BILLING_TRANSACTION_ACTION = {
|
|
187
198
|
CREATE: "create",
|
|
188
199
|
TRANSFER: "transfer",
|
package/src/helpers/keys.ts
CHANGED
|
@@ -3797,6 +3797,7 @@ export const KEYS_OBJECT_TAG_CHANGES2 = [
|
|
|
3797
3797
|
export const KEY_ORGANIZATION_ADDRESS_1 = 'address_1' satisfies keyof Organization;
|
|
3798
3798
|
export const KEY_ORGANIZATION_ADDRESS_2 = 'address_2' satisfies keyof Organization;
|
|
3799
3799
|
export const KEY_ORGANIZATION_ATTRIBUTES = 'attributes' satisfies keyof Organization;
|
|
3800
|
+
export const KEY_ORGANIZATION_BILLING_MODE = 'billing_mode' satisfies keyof Organization;
|
|
3800
3801
|
export const KEY_ORGANIZATION_BUSINESS_NUMBER = 'business_number' satisfies keyof Organization;
|
|
3801
3802
|
export const KEY_ORGANIZATION_CITY = 'city' satisfies keyof Organization;
|
|
3802
3803
|
export const KEY_ORGANIZATION_COUNTRY_CODE = 'country_code' satisfies keyof Organization;
|
|
@@ -3820,6 +3821,7 @@ export const KEYS_ORGANIZATION = [
|
|
|
3820
3821
|
KEY_ORGANIZATION_ADDRESS_1,
|
|
3821
3822
|
KEY_ORGANIZATION_ADDRESS_2,
|
|
3822
3823
|
KEY_ORGANIZATION_ATTRIBUTES,
|
|
3824
|
+
KEY_ORGANIZATION_BILLING_MODE,
|
|
3823
3825
|
KEY_ORGANIZATION_BUSINESS_NUMBER,
|
|
3824
3826
|
KEY_ORGANIZATION_CITY,
|
|
3825
3827
|
KEY_ORGANIZATION_COUNTRY_CODE,
|
|
@@ -4002,6 +4004,7 @@ export const KEY_ORGANIZATION_WITH_BILLING_DATA_ADDRESS_1 = 'address_1' satisfie
|
|
|
4002
4004
|
export const KEY_ORGANIZATION_WITH_BILLING_DATA_ADDRESS_2 = 'address_2' satisfies keyof OrganizationWithBillingData;
|
|
4003
4005
|
export const KEY_ORGANIZATION_WITH_BILLING_DATA_ATTRIBUTES = 'attributes' satisfies keyof OrganizationWithBillingData;
|
|
4004
4006
|
export const KEY_ORGANIZATION_WITH_BILLING_DATA_BILLING_METADATA = 'billing_metadata' satisfies keyof OrganizationWithBillingData;
|
|
4007
|
+
export const KEY_ORGANIZATION_WITH_BILLING_DATA_BILLING_MODE = 'billing_mode' satisfies keyof OrganizationWithBillingData;
|
|
4005
4008
|
export const KEY_ORGANIZATION_WITH_BILLING_DATA_BUSINESS_NUMBER = 'business_number' satisfies keyof OrganizationWithBillingData;
|
|
4006
4009
|
export const KEY_ORGANIZATION_WITH_BILLING_DATA_CITY = 'city' satisfies keyof OrganizationWithBillingData;
|
|
4007
4010
|
export const KEY_ORGANIZATION_WITH_BILLING_DATA_COUNTRY_CODE = 'country_code' satisfies keyof OrganizationWithBillingData;
|
|
@@ -4028,6 +4031,7 @@ export const KEYS_ORGANIZATION_WITH_BILLING_DATA = [
|
|
|
4028
4031
|
KEY_ORGANIZATION_WITH_BILLING_DATA_ADDRESS_2,
|
|
4029
4032
|
KEY_ORGANIZATION_WITH_BILLING_DATA_ATTRIBUTES,
|
|
4030
4033
|
KEY_ORGANIZATION_WITH_BILLING_DATA_BILLING_METADATA,
|
|
4034
|
+
KEY_ORGANIZATION_WITH_BILLING_DATA_BILLING_MODE,
|
|
4031
4035
|
KEY_ORGANIZATION_WITH_BILLING_DATA_BUSINESS_NUMBER,
|
|
4032
4036
|
KEY_ORGANIZATION_WITH_BILLING_DATA_CITY,
|
|
4033
4037
|
KEY_ORGANIZATION_WITH_BILLING_DATA_COUNTRY_CODE,
|
package/src/helpers/schemas.d.ts
CHANGED
|
@@ -8,6 +8,7 @@ export type AttributeType = components['schemas']['AttributeType'];
|
|
|
8
8
|
export type BatchSortField = components['schemas']['BatchSortField'];
|
|
9
9
|
export type BatchStatus = components['schemas']['BatchStatus'];
|
|
10
10
|
export type BillingMetadata = components['schemas']['BillingMetadata'];
|
|
11
|
+
export type BillingMode = components['schemas']['BillingMode'];
|
|
11
12
|
export type BillingPlan = components['schemas']['BillingPlan'];
|
|
12
13
|
export type BillingTransactionAction = components['schemas']['BillingTransactionAction'];
|
|
13
14
|
export type BillingTransactionProductType = components['schemas']['BillingTransactionProductType'];
|
package/src/openapi.yaml
CHANGED
|
@@ -100,6 +100,12 @@ components:
|
|
|
100
100
|
title: Customer Number
|
|
101
101
|
title: BillingMetadata
|
|
102
102
|
type: object
|
|
103
|
+
BillingMode:
|
|
104
|
+
enum:
|
|
105
|
+
- consolidated
|
|
106
|
+
- independent
|
|
107
|
+
title: BillingMode
|
|
108
|
+
type: string
|
|
103
109
|
BillingPlan:
|
|
104
110
|
properties:
|
|
105
111
|
amount:
|
|
@@ -8972,6 +8978,11 @@ components:
|
|
|
8972
8978
|
$ref: '#/components/schemas/OrganizationAttribute'
|
|
8973
8979
|
title: Attributes
|
|
8974
8980
|
type: array
|
|
8981
|
+
billing_mode:
|
|
8982
|
+
$ref: '#/components/schemas/BillingMode'
|
|
8983
|
+
default: consolidated
|
|
8984
|
+
description: Whether the organization is billed on its own account (INDEPENDENT)
|
|
8985
|
+
or rolled up to its parent (CONSOLIDATED).
|
|
8975
8986
|
business_number:
|
|
8976
8987
|
anyOf:
|
|
8977
8988
|
- maxLength: 100
|
|
@@ -9618,6 +9629,11 @@ components:
|
|
|
9618
9629
|
type: array
|
|
9619
9630
|
billing_metadata:
|
|
9620
9631
|
$ref: '#/components/schemas/BillingMetadata'
|
|
9632
|
+
billing_mode:
|
|
9633
|
+
$ref: '#/components/schemas/BillingMode'
|
|
9634
|
+
default: consolidated
|
|
9635
|
+
description: Whether the organization is billed on its own account (INDEPENDENT)
|
|
9636
|
+
or rolled up to its parent (CONSOLIDATED).
|
|
9621
9637
|
business_number:
|
|
9622
9638
|
anyOf:
|
|
9623
9639
|
- maxLength: 100
|
|
@@ -13806,7 +13822,7 @@ info:
|
|
|
13806
13822
|
\n\n"
|
|
13807
13823
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
13808
13824
|
title: OpusDNS API
|
|
13809
|
-
version: 2026-06-30-
|
|
13825
|
+
version: 2026-06-30-170126
|
|
13810
13826
|
x-logo:
|
|
13811
13827
|
altText: OpusDNS API Reference
|
|
13812
13828
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -15387,6 +15403,8 @@ paths:
|
|
|
15387
15403
|
summary: Retrieve all object history
|
|
15388
15404
|
tags:
|
|
15389
15405
|
- archive
|
|
15406
|
+
x-required-permissions:
|
|
15407
|
+
- organization:read
|
|
15390
15408
|
/v1/archive/object-logs/{object_id}:
|
|
15391
15409
|
get:
|
|
15392
15410
|
description: Retrieve paginated audit logs for a specific object with optional
|
|
@@ -15513,6 +15531,8 @@ paths:
|
|
|
15513
15531
|
summary: Retrieve object history
|
|
15514
15532
|
tags:
|
|
15515
15533
|
- archive
|
|
15534
|
+
x-required-permissions:
|
|
15535
|
+
- organization:read
|
|
15516
15536
|
/v1/archive/request-history:
|
|
15517
15537
|
get:
|
|
15518
15538
|
description: Retrieves a paginated list of request history logs
|
|
@@ -15673,6 +15693,8 @@ paths:
|
|
|
15673
15693
|
summary: Retrieve request history logs
|
|
15674
15694
|
tags:
|
|
15675
15695
|
- archive
|
|
15696
|
+
x-required-permissions:
|
|
15697
|
+
- organization:read
|
|
15676
15698
|
/v1/auth/client_credentials/introspect:
|
|
15677
15699
|
get:
|
|
15678
15700
|
description: Returns the stored record for the API key (or organization token)
|
|
@@ -25797,6 +25819,8 @@ paths:
|
|
|
25797
25819
|
summary: List all organizations
|
|
25798
25820
|
tags:
|
|
25799
25821
|
- organization
|
|
25822
|
+
x-required-permissions:
|
|
25823
|
+
- organization:read
|
|
25800
25824
|
post:
|
|
25801
25825
|
description: Create a new organization under the current organization
|
|
25802
25826
|
operationId: create_organization_v1_organizations_post
|
|
@@ -25913,6 +25937,8 @@ paths:
|
|
|
25913
25937
|
summary: List organization attributes
|
|
25914
25938
|
tags:
|
|
25915
25939
|
- organization
|
|
25940
|
+
x-required-permissions:
|
|
25941
|
+
- organization:read
|
|
25916
25942
|
patch:
|
|
25917
25943
|
description: Updates one or more organization attributes for the current organization
|
|
25918
25944
|
operationId: update_current_organization_attributes_v1_organizations_attributes_patch
|
|
@@ -26029,6 +26055,8 @@ paths:
|
|
|
26029
26055
|
summary: List IP restrictions
|
|
26030
26056
|
tags:
|
|
26031
26057
|
- organization
|
|
26058
|
+
x-required-permissions:
|
|
26059
|
+
- organization:read
|
|
26032
26060
|
post:
|
|
26033
26061
|
description: 'Create a new IP restriction for the organization.
|
|
26034
26062
|
|
|
@@ -26200,6 +26228,8 @@ paths:
|
|
|
26200
26228
|
summary: Get an IP restriction
|
|
26201
26229
|
tags:
|
|
26202
26230
|
- organization
|
|
26231
|
+
x-required-permissions:
|
|
26232
|
+
- organization:read
|
|
26203
26233
|
patch:
|
|
26204
26234
|
description: 'Update an existing IP restriction.
|
|
26205
26235
|
|
|
@@ -26313,6 +26343,8 @@ paths:
|
|
|
26313
26343
|
summary: List grantable role permissions
|
|
26314
26344
|
tags:
|
|
26315
26345
|
- organization
|
|
26346
|
+
x-required-permissions:
|
|
26347
|
+
- organization:read
|
|
26316
26348
|
/v1/organizations/roles:
|
|
26317
26349
|
get:
|
|
26318
26350
|
description: 'Retrieves all roles assignable in the current organization: the
|
|
@@ -26364,6 +26396,8 @@ paths:
|
|
|
26364
26396
|
summary: List roles
|
|
26365
26397
|
tags:
|
|
26366
26398
|
- organization
|
|
26399
|
+
x-required-permissions:
|
|
26400
|
+
- organization:read
|
|
26367
26401
|
post:
|
|
26368
26402
|
description: Creates an organization-owned custom role granting the requested
|
|
26369
26403
|
permissions. The escalation-bearing admin/owner permissions cannot be granted.
|
|
@@ -26574,6 +26608,8 @@ paths:
|
|
|
26574
26608
|
summary: Get a role
|
|
26575
26609
|
tags:
|
|
26576
26610
|
- organization
|
|
26611
|
+
x-required-permissions:
|
|
26612
|
+
- organization:read
|
|
26577
26613
|
patch:
|
|
26578
26614
|
description: Updates a custom role's name, description and/or permission set.
|
|
26579
26615
|
Permission changes apply to every subject holding the role instantly. Built-in
|
|
@@ -26747,6 +26783,8 @@ paths:
|
|
|
26747
26783
|
summary: List all users
|
|
26748
26784
|
tags:
|
|
26749
26785
|
- organization
|
|
26786
|
+
x-required-permissions:
|
|
26787
|
+
- organization:read
|
|
26750
26788
|
/v1/organizations/{organization_id}:
|
|
26751
26789
|
delete:
|
|
26752
26790
|
description: Permanently deletes an organization
|
|
@@ -26860,6 +26898,8 @@ paths:
|
|
|
26860
26898
|
summary: Get organization details
|
|
26861
26899
|
tags:
|
|
26862
26900
|
- organization
|
|
26901
|
+
x-required-permissions:
|
|
26902
|
+
- organization:read
|
|
26863
26903
|
patch:
|
|
26864
26904
|
description: Updates details for a specific organization
|
|
26865
26905
|
operationId: update_organization_v1_organizations__organization_id__patch
|
|
@@ -26999,6 +27039,8 @@ paths:
|
|
|
26999
27039
|
summary: List organization attributes
|
|
27000
27040
|
tags:
|
|
27001
27041
|
- organization
|
|
27042
|
+
x-required-permissions:
|
|
27043
|
+
- organization:read
|
|
27002
27044
|
patch:
|
|
27003
27045
|
description: Updates one or more organization attributes for the specified organization
|
|
27004
27046
|
operationId: update_organization_attributes_v1_organizations__organization_id__attributes_patch
|
|
@@ -27205,6 +27247,8 @@ paths:
|
|
|
27205
27247
|
summary: List product prices
|
|
27206
27248
|
tags:
|
|
27207
27249
|
- organization
|
|
27250
|
+
x-required-permissions:
|
|
27251
|
+
- organization:read
|
|
27208
27252
|
/v1/organizations/{organization_id}/transactions:
|
|
27209
27253
|
get:
|
|
27210
27254
|
description: Retrieves a paginated list of transactions for an organization
|
|
@@ -27363,6 +27407,8 @@ paths:
|
|
|
27363
27407
|
summary: List all transactions
|
|
27364
27408
|
tags:
|
|
27365
27409
|
- organization
|
|
27410
|
+
x-required-permissions:
|
|
27411
|
+
- organization:read
|
|
27366
27412
|
/v1/organizations/{organization_id}/transactions/{transaction_id}:
|
|
27367
27413
|
get:
|
|
27368
27414
|
description: Retrieves details for a specific transaction for an organization
|
|
@@ -27433,6 +27479,8 @@ paths:
|
|
|
27433
27479
|
summary: Get a specific transaction
|
|
27434
27480
|
tags:
|
|
27435
27481
|
- organization
|
|
27482
|
+
x-required-permissions:
|
|
27483
|
+
- organization:read
|
|
27436
27484
|
/v1/parking:
|
|
27437
27485
|
get:
|
|
27438
27486
|
description: Retrieves a paginated list of parking entries for the organization
|
|
@@ -27888,6 +27936,8 @@ paths:
|
|
|
27888
27936
|
summary: List Reports
|
|
27889
27937
|
tags:
|
|
27890
27938
|
- report
|
|
27939
|
+
x-required-permissions:
|
|
27940
|
+
- organization:read
|
|
27891
27941
|
post:
|
|
27892
27942
|
operationId: create_report_v1_reports_post
|
|
27893
27943
|
requestBody:
|
|
@@ -27916,6 +27966,8 @@ paths:
|
|
|
27916
27966
|
summary: Create Report
|
|
27917
27967
|
tags:
|
|
27918
27968
|
- report
|
|
27969
|
+
x-required-permissions:
|
|
27970
|
+
- organization:read
|
|
27919
27971
|
/v1/reports/{report_id}:
|
|
27920
27972
|
get:
|
|
27921
27973
|
operationId: get_report_v1_reports__report_id__get
|
|
@@ -27945,6 +27997,8 @@ paths:
|
|
|
27945
27997
|
summary: Get Report
|
|
27946
27998
|
tags:
|
|
27947
27999
|
- report
|
|
28000
|
+
x-required-permissions:
|
|
28001
|
+
- organization:read
|
|
27948
28002
|
/v1/reports/{report_id}/download:
|
|
27949
28003
|
get:
|
|
27950
28004
|
operationId: download_report_v1_reports__report_id__download_get
|
|
@@ -27973,6 +28027,8 @@ paths:
|
|
|
27973
28027
|
summary: Download Report
|
|
27974
28028
|
tags:
|
|
27975
28029
|
- report
|
|
28030
|
+
x-required-permissions:
|
|
28031
|
+
- organization:read
|
|
27976
28032
|
/v1/tags:
|
|
27977
28033
|
get:
|
|
27978
28034
|
description: Retrieves a paginated list of tags
|
|
@@ -28499,6 +28555,8 @@ paths:
|
|
|
28499
28555
|
summary: Get list of Specifications for all TLDs we support
|
|
28500
28556
|
tags:
|
|
28501
28557
|
- tld
|
|
28558
|
+
x-required-permissions:
|
|
28559
|
+
- organization:read
|
|
28502
28560
|
/v1/tlds/portfolio:
|
|
28503
28561
|
get:
|
|
28504
28562
|
description: Retrieves a list of TLDs we have support for
|
|
@@ -28525,6 +28583,8 @@ paths:
|
|
|
28525
28583
|
summary: Get the list of TLDs we support
|
|
28526
28584
|
tags:
|
|
28527
28585
|
- tld
|
|
28586
|
+
x-required-permissions:
|
|
28587
|
+
- organization:read
|
|
28528
28588
|
/v1/tlds/{tld}:
|
|
28529
28589
|
get:
|
|
28530
28590
|
description: Retrieves the TLD specification for a given TLD
|
|
@@ -28567,6 +28627,8 @@ paths:
|
|
|
28567
28627
|
summary: Get the TLD specification
|
|
28568
28628
|
tags:
|
|
28569
28629
|
- tld
|
|
28630
|
+
x-required-permissions:
|
|
28631
|
+
- organization:read
|
|
28570
28632
|
/v1/users:
|
|
28571
28633
|
post:
|
|
28572
28634
|
description: Create a new user
|
package/src/schema.d.ts
CHANGED
|
@@ -2790,6 +2790,11 @@ export interface components {
|
|
|
2790
2790
|
*/
|
|
2791
2791
|
customer_number?: number | null;
|
|
2792
2792
|
};
|
|
2793
|
+
/**
|
|
2794
|
+
* BillingMode
|
|
2795
|
+
* @enum {string}
|
|
2796
|
+
*/
|
|
2797
|
+
BillingMode: "consolidated" | "independent";
|
|
2793
2798
|
/** BillingPlan */
|
|
2794
2799
|
BillingPlan: {
|
|
2795
2800
|
/**
|
|
@@ -8655,6 +8660,11 @@ export interface components {
|
|
|
8655
8660
|
address_2?: string | null;
|
|
8656
8661
|
/** Attributes */
|
|
8657
8662
|
attributes?: components["schemas"]["OrganizationAttribute"][];
|
|
8663
|
+
/**
|
|
8664
|
+
* @description Whether the organization is billed on its own account (INDEPENDENT) or rolled up to its parent (CONSOLIDATED).
|
|
8665
|
+
* @default consolidated
|
|
8666
|
+
*/
|
|
8667
|
+
billing_mode: components["schemas"]["BillingMode"];
|
|
8658
8668
|
/**
|
|
8659
8669
|
* Business Number
|
|
8660
8670
|
* @description Government issued business identifier for the organization issued.
|
|
@@ -9097,6 +9107,11 @@ export interface components {
|
|
|
9097
9107
|
/** Attributes */
|
|
9098
9108
|
attributes?: components["schemas"]["OrganizationAttribute"][];
|
|
9099
9109
|
billing_metadata?: components["schemas"]["BillingMetadata"];
|
|
9110
|
+
/**
|
|
9111
|
+
* @description Whether the organization is billed on its own account (INDEPENDENT) or rolled up to its parent (CONSOLIDATED).
|
|
9112
|
+
* @default consolidated
|
|
9113
|
+
*/
|
|
9114
|
+
billing_mode: components["schemas"]["BillingMode"];
|
|
9100
9115
|
/**
|
|
9101
9116
|
* Business Number
|
|
9102
9117
|
* @description Government issued business identifier for the organization issued.
|