@opusdns/api 0.101.0 → 0.103.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 +10 -0
- package/src/helpers/requests.d.ts +5 -5
- package/src/helpers/responses.d.ts +5 -5
- package/src/openapi.yaml +26 -22
- package/src/schema.d.ts +7 -7
package/package.json
CHANGED
package/src/helpers/constants.ts
CHANGED
|
@@ -2345,6 +2345,7 @@ export const PERMISSION = {
|
|
|
2345
2345
|
CORPORATE_PLAN: "corporate_plan",
|
|
2346
2346
|
CREATE: "create",
|
|
2347
2347
|
DELETE: "delete",
|
|
2348
|
+
DELETE_DOMAIN_FORWARDS: "delete_domain_forwards",
|
|
2348
2349
|
ENTERPRISE_PLAN: "enterprise_plan",
|
|
2349
2350
|
HAS_ACCEPTED_TOS: "has_accepted_tos",
|
|
2350
2351
|
MANAGE_API_KEYS: "manage_api_keys",
|
|
@@ -2353,6 +2354,7 @@ export const PERMISSION = {
|
|
|
2353
2354
|
MANAGE_CONTACTS: "manage_contacts",
|
|
2354
2355
|
MANAGE_DNS_ZONES: "manage_dns_zones",
|
|
2355
2356
|
MANAGE_DOMAINS: "manage_domains",
|
|
2357
|
+
MANAGE_DOMAIN_FORWARDS: "manage_domain_forwards",
|
|
2356
2358
|
MANAGE_EMAIL_FORWARDS: "manage_email_forwards",
|
|
2357
2359
|
MANAGE_EVENTS: "manage_events",
|
|
2358
2360
|
MANAGE_HOSTS: "manage_hosts",
|
|
@@ -2367,9 +2369,11 @@ export const PERMISSION = {
|
|
|
2367
2369
|
STARTER_PLAN: "starter_plan",
|
|
2368
2370
|
TRANSFER_TRADE: "transfer_trade",
|
|
2369
2371
|
UPDATE: "update",
|
|
2372
|
+
UPDATE_DOMAIN_FORWARDS: "update_domain_forwards",
|
|
2370
2373
|
VERIFY: "verify",
|
|
2371
2374
|
VIEW: "view",
|
|
2372
2375
|
VIEW_AUDIT_LOGS: "view_audit_logs",
|
|
2376
|
+
VIEW_DOMAIN_FORWARDS: "view_domain_forwards",
|
|
2373
2377
|
VIEW_EVENTS: "view_events",
|
|
2374
2378
|
} as const satisfies Record<string, Permission>;
|
|
2375
2379
|
|
|
@@ -2403,6 +2407,7 @@ export const PERMISSION_VALUES = [
|
|
|
2403
2407
|
'corporate_plan',
|
|
2404
2408
|
'create',
|
|
2405
2409
|
'delete',
|
|
2410
|
+
'delete_domain_forwards',
|
|
2406
2411
|
'enterprise_plan',
|
|
2407
2412
|
'has_accepted_tos',
|
|
2408
2413
|
'manage_api_keys',
|
|
@@ -2411,6 +2416,7 @@ export const PERMISSION_VALUES = [
|
|
|
2411
2416
|
'manage_contacts',
|
|
2412
2417
|
'manage_dns_zones',
|
|
2413
2418
|
'manage_domains',
|
|
2419
|
+
'manage_domain_forwards',
|
|
2414
2420
|
'manage_email_forwards',
|
|
2415
2421
|
'manage_events',
|
|
2416
2422
|
'manage_hosts',
|
|
@@ -2425,9 +2431,11 @@ export const PERMISSION_VALUES = [
|
|
|
2425
2431
|
'starter_plan',
|
|
2426
2432
|
'transfer_trade',
|
|
2427
2433
|
'update',
|
|
2434
|
+
'update_domain_forwards',
|
|
2428
2435
|
'verify',
|
|
2429
2436
|
'view',
|
|
2430
2437
|
'view_audit_logs',
|
|
2438
|
+
'view_domain_forwards',
|
|
2431
2439
|
'view_events'
|
|
2432
2440
|
] as const satisfies [string, ...string[]] | Permission[];
|
|
2433
2441
|
|
|
@@ -2785,6 +2793,7 @@ export const RELATION = {
|
|
|
2785
2793
|
CLIENT_API_KEY: "client_api_key",
|
|
2786
2794
|
CMS_CONTENT_EDITOR: "cms_content_editor",
|
|
2787
2795
|
CONTACT_MANAGER: "contact_manager",
|
|
2796
|
+
DOMAIN_FORWARD_MANAGER: "domain_forward_manager",
|
|
2788
2797
|
DOMAIN_MANAGER: "domain_manager",
|
|
2789
2798
|
EMAIL_FORWARD_MANAGER: "email_forward_manager",
|
|
2790
2799
|
EVENTS_MANAGER: "events_manager",
|
|
@@ -2829,6 +2838,7 @@ export const RELATION_VALUES = [
|
|
|
2829
2838
|
'client_api_key',
|
|
2830
2839
|
'cms_content_editor',
|
|
2831
2840
|
'contact_manager',
|
|
2841
|
+
'domain_forward_manager',
|
|
2832
2842
|
'domain_manager',
|
|
2833
2843
|
'email_forward_manager',
|
|
2834
2844
|
'events_manager',
|
|
@@ -39,8 +39,8 @@ import { ContactCreate, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatc
|
|
|
39
39
|
/**
|
|
40
40
|
* Request type for GET ArchiveObjectLogs endpoint
|
|
41
41
|
*
|
|
42
|
-
*
|
|
43
|
-
* Retrieve paginated audit logs
|
|
42
|
+
* Retrieve all object history
|
|
43
|
+
* Retrieve all paginated audit logs with optional filtering and sorting
|
|
44
44
|
*
|
|
45
45
|
* @remarks
|
|
46
46
|
* This type defines the complete request structure for the GET ArchiveObjectLogs endpoint.
|
|
@@ -78,8 +78,8 @@ export type GET_ArchiveObjectLogs_Request_Query = GET_ArchiveObjectLogs_Request[
|
|
|
78
78
|
/**
|
|
79
79
|
* Request type for GET ArchiveObjectLogsObjectId endpoint
|
|
80
80
|
*
|
|
81
|
-
*
|
|
82
|
-
* Retrieve paginated audit logs for a specific
|
|
81
|
+
* Retrieve object history
|
|
82
|
+
* Retrieve paginated audit logs for a specific object with optional filtering and sorting
|
|
83
83
|
*
|
|
84
84
|
* @remarks
|
|
85
85
|
* This type defines the complete request structure for the GET ArchiveObjectLogsObjectId endpoint.
|
|
@@ -131,7 +131,7 @@ export type GET_ArchiveObjectLogsObjectId_Request_Path = GET_ArchiveObjectLogsOb
|
|
|
131
131
|
/**
|
|
132
132
|
* Request type for GET ArchiveRequestHistory endpoint
|
|
133
133
|
*
|
|
134
|
-
*
|
|
134
|
+
* Retrieve request history logs
|
|
135
135
|
* Retrieves a paginated list of request history logs
|
|
136
136
|
*
|
|
137
137
|
* @remarks
|
|
@@ -39,8 +39,8 @@ import { Pagination_ObjectLog, HTTPValidationError, Pagination_RequestHistory, P
|
|
|
39
39
|
/**
|
|
40
40
|
* Response types for GET ArchiveObjectLogs endpoint
|
|
41
41
|
*
|
|
42
|
-
*
|
|
43
|
-
* Retrieve paginated audit logs
|
|
42
|
+
* Retrieve all object history
|
|
43
|
+
* Retrieve all paginated audit logs with optional filtering and sorting
|
|
44
44
|
*
|
|
45
45
|
* @remarks
|
|
46
46
|
* This type defines all possible response structures for the GET ArchiveObjectLogs endpoint.
|
|
@@ -95,8 +95,8 @@ export type GET_ArchiveObjectLogs_Response_422 = HTTPValidationError
|
|
|
95
95
|
/**
|
|
96
96
|
* Response types for GET ArchiveObjectLogsByObjectId endpoint
|
|
97
97
|
*
|
|
98
|
-
*
|
|
99
|
-
* Retrieve paginated audit logs for a specific
|
|
98
|
+
* Retrieve object history
|
|
99
|
+
* Retrieve paginated audit logs for a specific object with optional filtering and sorting
|
|
100
100
|
*
|
|
101
101
|
* @remarks
|
|
102
102
|
* This type defines all possible response structures for the GET ArchiveObjectLogsByObjectId endpoint.
|
|
@@ -151,7 +151,7 @@ export type GET_ArchiveObjectLogsByObjectId_Response_422 = HTTPValidationError
|
|
|
151
151
|
/**
|
|
152
152
|
* Response types for GET ArchiveRequestHistory endpoint
|
|
153
153
|
*
|
|
154
|
-
*
|
|
154
|
+
* Retrieve request history logs
|
|
155
155
|
* Retrieves a paginated list of request history logs
|
|
156
156
|
*
|
|
157
157
|
* @remarks
|
package/src/openapi.yaml
CHANGED
|
@@ -4152,6 +4152,7 @@ components:
|
|
|
4152
4152
|
- corporate_plan
|
|
4153
4153
|
- create
|
|
4154
4154
|
- delete
|
|
4155
|
+
- delete_domain_forwards
|
|
4155
4156
|
- enterprise_plan
|
|
4156
4157
|
- has_accepted_tos
|
|
4157
4158
|
- manage_api_keys
|
|
@@ -4160,6 +4161,7 @@ components:
|
|
|
4160
4161
|
- manage_contacts
|
|
4161
4162
|
- manage_dns_zones
|
|
4162
4163
|
- manage_domains
|
|
4164
|
+
- manage_domain_forwards
|
|
4163
4165
|
- manage_email_forwards
|
|
4164
4166
|
- manage_events
|
|
4165
4167
|
- manage_hosts
|
|
@@ -4174,9 +4176,11 @@ components:
|
|
|
4174
4176
|
- starter_plan
|
|
4175
4177
|
- transfer_trade
|
|
4176
4178
|
- update
|
|
4179
|
+
- update_domain_forwards
|
|
4177
4180
|
- verify
|
|
4178
4181
|
- view
|
|
4179
4182
|
- view_audit_logs
|
|
4183
|
+
- view_domain_forwards
|
|
4180
4184
|
- view_events
|
|
4181
4185
|
title: Permission
|
|
4182
4186
|
type: string
|
|
@@ -4407,6 +4411,7 @@ components:
|
|
|
4407
4411
|
- client_api_key
|
|
4408
4412
|
- cms_content_editor
|
|
4409
4413
|
- contact_manager
|
|
4414
|
+
- domain_forward_manager
|
|
4410
4415
|
- domain_manager
|
|
4411
4416
|
- email_forward_manager
|
|
4412
4417
|
- events_manager
|
|
@@ -5529,7 +5534,7 @@ info:
|
|
|
5529
5534
|
'
|
|
5530
5535
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
5531
5536
|
title: OpusDNS API
|
|
5532
|
-
version: 2025-
|
|
5537
|
+
version: 2025-12-01-143608
|
|
5533
5538
|
x-logo:
|
|
5534
5539
|
altText: OpusDNS API Reference
|
|
5535
5540
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -5537,8 +5542,7 @@ openapi: 3.1.0
|
|
|
5537
5542
|
paths:
|
|
5538
5543
|
/v1/archive/object-logs:
|
|
5539
5544
|
get:
|
|
5540
|
-
description: Retrieve paginated audit logs
|
|
5541
|
-
optional filtering and sorting
|
|
5545
|
+
description: Retrieve all paginated audit logs with optional filtering and sorting
|
|
5542
5546
|
operationId: get_object_logs_v1_archive_object_logs_get
|
|
5543
5547
|
parameters:
|
|
5544
5548
|
- in: query
|
|
@@ -5558,7 +5562,7 @@ paths:
|
|
|
5558
5562
|
required: false
|
|
5559
5563
|
schema:
|
|
5560
5564
|
default: 10
|
|
5561
|
-
maximum:
|
|
5565
|
+
maximum: 1000
|
|
5562
5566
|
minimum: 1
|
|
5563
5567
|
title: Page Size
|
|
5564
5568
|
type: integer
|
|
@@ -5659,13 +5663,13 @@ paths:
|
|
|
5659
5663
|
description: Validation Error
|
|
5660
5664
|
security:
|
|
5661
5665
|
- OAuth2PasswordBearer: []
|
|
5662
|
-
summary:
|
|
5666
|
+
summary: Retrieve all object history
|
|
5663
5667
|
tags:
|
|
5664
5668
|
- archive
|
|
5665
5669
|
/v1/archive/object-logs/{object_id}:
|
|
5666
5670
|
get:
|
|
5667
|
-
description: Retrieve paginated audit logs for a specific
|
|
5668
|
-
|
|
5671
|
+
description: Retrieve paginated audit logs for a specific object with optional
|
|
5672
|
+
filtering and sorting
|
|
5669
5673
|
operationId: get_object_logs_by_object_id_v1_archive_object_logs__object_id__get
|
|
5670
5674
|
parameters:
|
|
5671
5675
|
- in: path
|
|
@@ -5691,7 +5695,7 @@ paths:
|
|
|
5691
5695
|
required: false
|
|
5692
5696
|
schema:
|
|
5693
5697
|
default: 10
|
|
5694
|
-
maximum:
|
|
5698
|
+
maximum: 1000
|
|
5695
5699
|
minimum: 1
|
|
5696
5700
|
title: Page Size
|
|
5697
5701
|
type: integer
|
|
@@ -5784,7 +5788,7 @@ paths:
|
|
|
5784
5788
|
description: Validation Error
|
|
5785
5789
|
security:
|
|
5786
5790
|
- OAuth2PasswordBearer: []
|
|
5787
|
-
summary:
|
|
5791
|
+
summary: Retrieve object history
|
|
5788
5792
|
tags:
|
|
5789
5793
|
- archive
|
|
5790
5794
|
/v1/archive/request-history:
|
|
@@ -5809,7 +5813,7 @@ paths:
|
|
|
5809
5813
|
required: false
|
|
5810
5814
|
schema:
|
|
5811
5815
|
default: 10
|
|
5812
|
-
maximum:
|
|
5816
|
+
maximum: 1000
|
|
5813
5817
|
minimum: 1
|
|
5814
5818
|
title: Page Size
|
|
5815
5819
|
type: integer
|
|
@@ -5942,7 +5946,7 @@ paths:
|
|
|
5942
5946
|
description: Validation Error
|
|
5943
5947
|
security:
|
|
5944
5948
|
- OAuth2PasswordBearer: []
|
|
5945
|
-
summary:
|
|
5949
|
+
summary: Retrieve request history logs
|
|
5946
5950
|
tags:
|
|
5947
5951
|
- archive
|
|
5948
5952
|
/v1/auth/token:
|
|
@@ -6227,7 +6231,7 @@ paths:
|
|
|
6227
6231
|
required: false
|
|
6228
6232
|
schema:
|
|
6229
6233
|
default: 10
|
|
6230
|
-
maximum:
|
|
6234
|
+
maximum: 1000
|
|
6231
6235
|
minimum: 1
|
|
6232
6236
|
title: Page Size
|
|
6233
6237
|
type: integer
|
|
@@ -6914,7 +6918,7 @@ paths:
|
|
|
6914
6918
|
required: false
|
|
6915
6919
|
schema:
|
|
6916
6920
|
default: 10
|
|
6917
|
-
maximum:
|
|
6921
|
+
maximum: 1000
|
|
6918
6922
|
minimum: 1
|
|
6919
6923
|
title: Page Size
|
|
6920
6924
|
type: integer
|
|
@@ -7194,7 +7198,7 @@ paths:
|
|
|
7194
7198
|
required: false
|
|
7195
7199
|
schema:
|
|
7196
7200
|
default: 10
|
|
7197
|
-
maximum:
|
|
7201
|
+
maximum: 1000
|
|
7198
7202
|
minimum: 1
|
|
7199
7203
|
title: Page Size
|
|
7200
7204
|
type: integer
|
|
@@ -7596,7 +7600,7 @@ paths:
|
|
|
7596
7600
|
required: false
|
|
7597
7601
|
schema:
|
|
7598
7602
|
default: 10
|
|
7599
|
-
maximum:
|
|
7603
|
+
maximum: 1000
|
|
7600
7604
|
minimum: 1
|
|
7601
7605
|
title: Page Size
|
|
7602
7606
|
type: integer
|
|
@@ -8722,7 +8726,7 @@ paths:
|
|
|
8722
8726
|
required: false
|
|
8723
8727
|
schema:
|
|
8724
8728
|
default: 10
|
|
8725
|
-
maximum:
|
|
8729
|
+
maximum: 1000
|
|
8726
8730
|
minimum: 1
|
|
8727
8731
|
title: Page Size
|
|
8728
8732
|
type: integer
|
|
@@ -9595,7 +9599,7 @@ paths:
|
|
|
9595
9599
|
required: false
|
|
9596
9600
|
schema:
|
|
9597
9601
|
default: 10
|
|
9598
|
-
maximum:
|
|
9602
|
+
maximum: 1000
|
|
9599
9603
|
minimum: 1
|
|
9600
9604
|
title: Page Size
|
|
9601
9605
|
type: integer
|
|
@@ -9882,7 +9886,7 @@ paths:
|
|
|
9882
9886
|
required: false
|
|
9883
9887
|
schema:
|
|
9884
9888
|
default: 10
|
|
9885
|
-
maximum:
|
|
9889
|
+
maximum: 1000
|
|
9886
9890
|
minimum: 1
|
|
9887
9891
|
title: Page Size
|
|
9888
9892
|
type: integer
|
|
@@ -10047,7 +10051,7 @@ paths:
|
|
|
10047
10051
|
required: false
|
|
10048
10052
|
schema:
|
|
10049
10053
|
default: 10
|
|
10050
|
-
maximum:
|
|
10054
|
+
maximum: 1000
|
|
10051
10055
|
minimum: 1
|
|
10052
10056
|
title: Page Size
|
|
10053
10057
|
type: integer
|
|
@@ -10777,7 +10781,7 @@ paths:
|
|
|
10777
10781
|
required: false
|
|
10778
10782
|
schema:
|
|
10779
10783
|
default: 10
|
|
10780
|
-
maximum:
|
|
10784
|
+
maximum: 1000
|
|
10781
10785
|
minimum: 1
|
|
10782
10786
|
title: Page Size
|
|
10783
10787
|
type: integer
|
|
@@ -11026,7 +11030,7 @@ paths:
|
|
|
11026
11030
|
required: false
|
|
11027
11031
|
schema:
|
|
11028
11032
|
default: 10
|
|
11029
|
-
maximum:
|
|
11033
|
+
maximum: 1000
|
|
11030
11034
|
minimum: 1
|
|
11031
11035
|
title: Page Size
|
|
11032
11036
|
type: integer
|
|
@@ -11238,7 +11242,7 @@ paths:
|
|
|
11238
11242
|
required: false
|
|
11239
11243
|
schema:
|
|
11240
11244
|
default: 10
|
|
11241
|
-
maximum:
|
|
11245
|
+
maximum: 1000
|
|
11242
11246
|
minimum: 1
|
|
11243
11247
|
title: Page Size
|
|
11244
11248
|
type: integer
|
package/src/schema.d.ts
CHANGED
|
@@ -8,8 +8,8 @@ export interface paths {
|
|
|
8
8
|
cookie?: never;
|
|
9
9
|
};
|
|
10
10
|
/**
|
|
11
|
-
*
|
|
12
|
-
* @description Retrieve paginated audit logs
|
|
11
|
+
* Retrieve all object history
|
|
12
|
+
* @description Retrieve all paginated audit logs with optional filtering and sorting
|
|
13
13
|
*/
|
|
14
14
|
get: operations["get_object_logs_v1_archive_object_logs_get"];
|
|
15
15
|
put?: never;
|
|
@@ -28,8 +28,8 @@ export interface paths {
|
|
|
28
28
|
cookie?: never;
|
|
29
29
|
};
|
|
30
30
|
/**
|
|
31
|
-
*
|
|
32
|
-
* @description Retrieve paginated audit logs for a specific
|
|
31
|
+
* Retrieve object history
|
|
32
|
+
* @description Retrieve paginated audit logs for a specific object with optional filtering and sorting
|
|
33
33
|
*/
|
|
34
34
|
get: operations["get_object_logs_by_object_id_v1_archive_object_logs__object_id__get"];
|
|
35
35
|
put?: never;
|
|
@@ -48,7 +48,7 @@ export interface paths {
|
|
|
48
48
|
cookie?: never;
|
|
49
49
|
};
|
|
50
50
|
/**
|
|
51
|
-
*
|
|
51
|
+
* Retrieve request history logs
|
|
52
52
|
* @description Retrieves a paginated list of request history logs
|
|
53
53
|
*/
|
|
54
54
|
get: operations["get_request_history_v1_archive_request_history_get"];
|
|
@@ -4112,7 +4112,7 @@ export interface components {
|
|
|
4112
4112
|
* Permission
|
|
4113
4113
|
* @enum {string}
|
|
4114
4114
|
*/
|
|
4115
|
-
Permission: "bulk_create" | "bulk_delete" | "bulk_renew_expire" | "bulk_transfer_trade" | "bulk_update" | "corporate_plan" | "create" | "delete" | "enterprise_plan" | "has_accepted_tos" | "manage_api_keys" | "manage_billing" | "manage_cms_content" | "manage_contacts" | "manage_dns_zones" | "manage_domains" | "manage_email_forwards" | "manage_events" | "manage_hosts" | "manage_opusdns_api_keys" | "manage_products" | "manage_reseller" | "manage_users" | "manage_user_relations" | "plan_manager" | "premium_plan" | "renew_expire" | "starter_plan" | "transfer_trade" | "update" | "verify" | "view" | "view_audit_logs" | "view_events";
|
|
4115
|
+
Permission: "bulk_create" | "bulk_delete" | "bulk_renew_expire" | "bulk_transfer_trade" | "bulk_update" | "corporate_plan" | "create" | "delete" | "delete_domain_forwards" | "enterprise_plan" | "has_accepted_tos" | "manage_api_keys" | "manage_billing" | "manage_cms_content" | "manage_contacts" | "manage_dns_zones" | "manage_domains" | "manage_domain_forwards" | "manage_email_forwards" | "manage_events" | "manage_hosts" | "manage_opusdns_api_keys" | "manage_products" | "manage_reseller" | "manage_users" | "manage_user_relations" | "plan_manager" | "premium_plan" | "renew_expire" | "starter_plan" | "transfer_trade" | "update" | "update_domain_forwards" | "verify" | "view" | "view_audit_logs" | "view_domain_forwards" | "view_events";
|
|
4116
4116
|
/** PermissionSet */
|
|
4117
4117
|
PermissionSet: {
|
|
4118
4118
|
/** Permissions */
|
|
@@ -4260,7 +4260,7 @@ export interface components {
|
|
|
4260
4260
|
* Relation
|
|
4261
4261
|
* @enum {string}
|
|
4262
4262
|
*/
|
|
4263
|
-
Relation: "accepted_tos" | "admin" | "api_admin" | "billing_manager" | "client_api_key" | "cms_content_editor" | "contact_manager" | "domain_manager" | "email_forward_manager" | "events_manager" | "host_manager" | "member" | "opusdns_internal_api_key" | "organization_manager" | "owner" | "parent" | "product_manager" | "reseller_manager" | "root_admin" | "self";
|
|
4263
|
+
Relation: "accepted_tos" | "admin" | "api_admin" | "billing_manager" | "client_api_key" | "cms_content_editor" | "contact_manager" | "domain_forward_manager" | "domain_manager" | "email_forward_manager" | "events_manager" | "host_manager" | "member" | "opusdns_internal_api_key" | "organization_manager" | "owner" | "parent" | "product_manager" | "reseller_manager" | "root_admin" | "self";
|
|
4264
4264
|
/** RelationSet */
|
|
4265
4265
|
RelationSet: {
|
|
4266
4266
|
/** Relations */
|