@opusdns/api 0.176.0 → 0.178.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 +122 -1
- package/src/helpers/keys.ts +29 -4
- package/src/helpers/schemas.d.ts +53 -0
- package/src/openapi.yaml +54 -22
- package/src/schema.d.ts +34 -23
package/package.json
CHANGED
package/src/helpers/constants.ts
CHANGED
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
* ```
|
|
22
22
|
*/
|
|
23
23
|
|
|
24
|
-
import { AllocationMethodType, AttributeType, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ComplianceStatus, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAttributeKey, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainForwardSortField, DomainForwardZoneSortField, DomainSortField, DomainStatus, EmailForwardLogSortField, EmailForwardLogStatus, EmailForwardSortField, EmailForwardZoneSortField, EmailVerificationStatus, EventObjectType, EventSortField, EventSubtype, EventType, GrantType, HostStatus, HttpProtocol, InvoiceResponsePaymentStatus, InvoiceResponseStatus, InvoiceResponseType, LaunchPhaseType, LocalPresenceRequirementType, MetricsGrouping, ObjectEventType, ObjectLogSortField, OrganizationStatus, ParkingSortField, PatchOp, PeriodUnit, Permission, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, Protocol, RedirectCode, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, RequestHistorySortField, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TimeRange, TransferAckType, UserStatus, VerificationType, ZoneSortField } from './schemas';
|
|
24
|
+
import { AllocationMethodType, AttributeType, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ComplianceStatus, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAttributeKey, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainForwardSortField, DomainForwardZoneSortField, DomainSortField, DomainStatus, EmailForwardLogSortField, EmailForwardLogStatus, EmailForwardSortField, EmailForwardZoneSortField, EmailVerificationStatus, EventObjectType, EventSortField, EventSubtype, EventType, ExecutingEntity, GrantType, HTTPMethod, HostStatus, HttpProtocol, InvoiceResponsePaymentStatus, InvoiceResponseStatus, InvoiceResponseType, LaunchPhaseType, LocalPresenceRequirementType, MetricsGrouping, ObjectEventType, ObjectLogSortField, OrganizationStatus, ParkingSortField, PatchOp, PeriodUnit, Permission, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, Protocol, RedirectCode, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, RequestHistorySortField, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TimeRange, TransferAckType, UserStatus, VerificationType, ZoneSortField } from './schemas';
|
|
25
25
|
|
|
26
26
|
/**
|
|
27
27
|
* AllocationMethodType. Auto-generated enum for AllocationMethodType
|
|
@@ -1887,6 +1887,58 @@ export const EVENT_TYPE_VALUES = [
|
|
|
1887
1887
|
'VERIFICATION'
|
|
1888
1888
|
] as const satisfies [string, ...string[]] | EventType[];
|
|
1889
1889
|
|
|
1890
|
+
/**
|
|
1891
|
+
* ExecutingEntity. Auto-generated enum for ExecutingEntity
|
|
1892
|
+
*
|
|
1893
|
+
* @remarks
|
|
1894
|
+
* This constant provides both object and array forms for the ExecutingEntity enum.
|
|
1895
|
+
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
1896
|
+
*
|
|
1897
|
+
* @example
|
|
1898
|
+
* ```typescript
|
|
1899
|
+
* // Using the object form for key-value access
|
|
1900
|
+
* const status = EXECUTING_ENTITY.SUCCESS;
|
|
1901
|
+
*
|
|
1902
|
+
* // Using the array form for iteration
|
|
1903
|
+
* const allStatuses = EXECUTING_ENTITY_VALUES;
|
|
1904
|
+
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
1905
|
+
* ```
|
|
1906
|
+
*
|
|
1907
|
+
* @see {@link ExecutingEntity} - The TypeScript type definition
|
|
1908
|
+
*/
|
|
1909
|
+
export const EXECUTING_ENTITY = {
|
|
1910
|
+
USER: "user",
|
|
1911
|
+
ORGANIZATION: "organization",
|
|
1912
|
+
SYSTEM: "system",
|
|
1913
|
+
} as const satisfies Record<string, ExecutingEntity>;
|
|
1914
|
+
|
|
1915
|
+
/**
|
|
1916
|
+
* Array of all ExecutingEntity enum values
|
|
1917
|
+
*
|
|
1918
|
+
* @remarks
|
|
1919
|
+
* This constant provides a array containing all valid ExecutingEntity enum values.
|
|
1920
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
1921
|
+
*
|
|
1922
|
+
* @example
|
|
1923
|
+
* ```typescript
|
|
1924
|
+
* // Iterating through all values
|
|
1925
|
+
* for (const value of EXECUTING_ENTITY_VALUES) {
|
|
1926
|
+
* console.log(`Processing: ${value}`);
|
|
1927
|
+
* }
|
|
1928
|
+
*
|
|
1929
|
+
* // Validation
|
|
1930
|
+
* const isValid = EXECUTING_ENTITY_VALUES.includes(someValue);
|
|
1931
|
+
* ```
|
|
1932
|
+
*
|
|
1933
|
+
* @see {@link ExecutingEntity} - The TypeScript type definition
|
|
1934
|
+
* @see {@link EXECUTING_ENTITY} - The object form of this enum
|
|
1935
|
+
*/
|
|
1936
|
+
export const EXECUTING_ENTITY_VALUES = [
|
|
1937
|
+
'user',
|
|
1938
|
+
'organization',
|
|
1939
|
+
'system'
|
|
1940
|
+
] as const satisfies [string, ...string[]] | ExecutingEntity[];
|
|
1941
|
+
|
|
1890
1942
|
/**
|
|
1891
1943
|
* GrantType. Auto-generated enum for GrantType
|
|
1892
1944
|
*
|
|
@@ -1939,6 +1991,75 @@ export const GRANT_TYPE_VALUES = [
|
|
|
1939
1991
|
'refresh_token'
|
|
1940
1992
|
] as const satisfies [string, ...string[]] | GrantType[];
|
|
1941
1993
|
|
|
1994
|
+
/**
|
|
1995
|
+
* HTTPMethod. HTTP methods and descriptions
|
|
1996
|
+
|
|
1997
|
+
Methods from the following RFCs are all observed:
|
|
1998
|
+
|
|
1999
|
+
* RFC 9110: HTTP Semantics, obsoletes 7231, which obsoleted 2616
|
|
2000
|
+
* RFC 5789: PATCH Method for HTTP
|
|
2001
|
+
*
|
|
2002
|
+
* @remarks
|
|
2003
|
+
* This constant provides both object and array forms for the HTTPMethod enum.
|
|
2004
|
+
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
2005
|
+
*
|
|
2006
|
+
* @example
|
|
2007
|
+
* ```typescript
|
|
2008
|
+
* // Using the object form for key-value access
|
|
2009
|
+
* const status = HTTP_METHOD.SUCCESS;
|
|
2010
|
+
*
|
|
2011
|
+
* // Using the array form for iteration
|
|
2012
|
+
* const allStatuses = HTTP_METHOD_VALUES;
|
|
2013
|
+
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
2014
|
+
* ```
|
|
2015
|
+
*
|
|
2016
|
+
* @see {@link HTTPMethod} - The TypeScript type definition
|
|
2017
|
+
*/
|
|
2018
|
+
export const HTTP_METHOD = {
|
|
2019
|
+
CONNECT: "CONNECT",
|
|
2020
|
+
DELETE: "DELETE",
|
|
2021
|
+
GET: "GET",
|
|
2022
|
+
HEAD: "HEAD",
|
|
2023
|
+
OPTIONS: "OPTIONS",
|
|
2024
|
+
PATCH: "PATCH",
|
|
2025
|
+
POST: "POST",
|
|
2026
|
+
PUT: "PUT",
|
|
2027
|
+
TRACE: "TRACE",
|
|
2028
|
+
} as const satisfies Record<string, HTTPMethod>;
|
|
2029
|
+
|
|
2030
|
+
/**
|
|
2031
|
+
* Array of all HTTPMethod enum values
|
|
2032
|
+
*
|
|
2033
|
+
* @remarks
|
|
2034
|
+
* This constant provides a array containing all valid HTTPMethod enum values.
|
|
2035
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
2036
|
+
*
|
|
2037
|
+
* @example
|
|
2038
|
+
* ```typescript
|
|
2039
|
+
* // Iterating through all values
|
|
2040
|
+
* for (const value of HTTP_METHOD_VALUES) {
|
|
2041
|
+
* console.log(`Processing: ${value}`);
|
|
2042
|
+
* }
|
|
2043
|
+
*
|
|
2044
|
+
* // Validation
|
|
2045
|
+
* const isValid = HTTP_METHOD_VALUES.includes(someValue);
|
|
2046
|
+
* ```
|
|
2047
|
+
*
|
|
2048
|
+
* @see {@link HTTPMethod} - The TypeScript type definition
|
|
2049
|
+
* @see {@link HTTP_METHOD} - The object form of this enum
|
|
2050
|
+
*/
|
|
2051
|
+
export const HTTP_METHOD_VALUES = [
|
|
2052
|
+
'CONNECT',
|
|
2053
|
+
'DELETE',
|
|
2054
|
+
'GET',
|
|
2055
|
+
'HEAD',
|
|
2056
|
+
'OPTIONS',
|
|
2057
|
+
'PATCH',
|
|
2058
|
+
'POST',
|
|
2059
|
+
'PUT',
|
|
2060
|
+
'TRACE'
|
|
2061
|
+
] as const satisfies [string, ...string[]] | HTTPMethod[];
|
|
2062
|
+
|
|
1942
2063
|
/**
|
|
1943
2064
|
* HostStatus. Auto-generated enum for HostStatus
|
|
1944
2065
|
*
|
package/src/helpers/keys.ts
CHANGED
|
@@ -8266,6 +8266,31 @@ export const KEY_DOMAIN_LIFECYCLE_BASE_ADD_GRACE_PERIOD: keyof DomainLifecycleBa
|
|
|
8266
8266
|
* @see {@link KEYS_DOMAIN_LIFECYCLE_BASE} - Array of all keys for this type
|
|
8267
8267
|
*/
|
|
8268
8268
|
export const KEY_DOMAIN_LIFECYCLE_BASE_AUTO_RENEW_BEFORE_EXPIRATION: keyof DomainLifecycleBase = 'auto_renew_before_expiration';
|
|
8269
|
+
/**
|
|
8270
|
+
* default_transfer_renewal_period property
|
|
8271
|
+
*
|
|
8272
|
+
* Default period for transfer if no transfer_renewal_period is specified
|
|
8273
|
+
*
|
|
8274
|
+
*
|
|
8275
|
+
*
|
|
8276
|
+
* @remarks
|
|
8277
|
+
* This key constant provides type-safe access to the `default_transfer_renewal_period` property of DomainLifecycleBase objects.
|
|
8278
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
8279
|
+
*
|
|
8280
|
+
* @example
|
|
8281
|
+
* ```typescript
|
|
8282
|
+
* // Direct property access
|
|
8283
|
+
* const value = domainlifecyclebase[KEY_DOMAIN_LIFECYCLE_BASE_DEFAULT_TRANSFER_RENEWAL_PERIOD];
|
|
8284
|
+
*
|
|
8285
|
+
* // Dynamic property access
|
|
8286
|
+
* const propertyName = KEY_DOMAIN_LIFECYCLE_BASE_DEFAULT_TRANSFER_RENEWAL_PERIOD;
|
|
8287
|
+
* const value = domainlifecyclebase[propertyName];
|
|
8288
|
+
* ```
|
|
8289
|
+
*
|
|
8290
|
+
* @see {@link DomainLifecycleBase} - The TypeScript type definition
|
|
8291
|
+
* @see {@link KEYS_DOMAIN_LIFECYCLE_BASE} - Array of all keys for this type
|
|
8292
|
+
*/
|
|
8293
|
+
export const KEY_DOMAIN_LIFECYCLE_BASE_DEFAULT_TRANSFER_RENEWAL_PERIOD: keyof DomainLifecycleBase = 'default_transfer_renewal_period';
|
|
8269
8294
|
/**
|
|
8270
8295
|
* Delete Before Expiration
|
|
8271
8296
|
*
|
|
@@ -8590,6 +8615,7 @@ export const KEY_DOMAIN_LIFECYCLE_BASE_TRANSFER_RENEWAL_PERIODS: keyof DomainLif
|
|
|
8590
8615
|
export const KEYS_DOMAIN_LIFECYCLE_BASE = [
|
|
8591
8616
|
KEY_DOMAIN_LIFECYCLE_BASE_ADD_GRACE_PERIOD,
|
|
8592
8617
|
KEY_DOMAIN_LIFECYCLE_BASE_AUTO_RENEW_BEFORE_EXPIRATION,
|
|
8618
|
+
KEY_DOMAIN_LIFECYCLE_BASE_DEFAULT_TRANSFER_RENEWAL_PERIOD,
|
|
8593
8619
|
KEY_DOMAIN_LIFECYCLE_BASE_DELETE_BEFORE_EXPIRATION,
|
|
8594
8620
|
KEY_DOMAIN_LIFECYCLE_BASE_DELETE_POLICY,
|
|
8595
8621
|
KEY_DOMAIN_LIFECYCLE_BASE_EXPLICIT_RENEW,
|
|
@@ -16285,7 +16311,7 @@ export const KEY_OBJECT_LOG_OBJECT_TYPE: keyof ObjectLog = 'object_type';
|
|
|
16285
16311
|
*/
|
|
16286
16312
|
export const KEY_OBJECT_LOG_PERFORMED_BY_ID: keyof ObjectLog = 'performed_by_id';
|
|
16287
16313
|
/**
|
|
16288
|
-
*
|
|
16314
|
+
* performed_by_type property
|
|
16289
16315
|
*
|
|
16290
16316
|
* Type of the actor who performed the action
|
|
16291
16317
|
*
|
|
@@ -21496,11 +21522,10 @@ export const KEY_REQUEST_HISTORY_CLIENT_IP: keyof RequestHistory = 'client_ip';
|
|
|
21496
21522
|
*/
|
|
21497
21523
|
export const KEY_REQUEST_HISTORY_DURATION: keyof RequestHistory = 'duration';
|
|
21498
21524
|
/**
|
|
21499
|
-
*
|
|
21525
|
+
* method property
|
|
21500
21526
|
*
|
|
21501
21527
|
* HTTP method
|
|
21502
21528
|
*
|
|
21503
|
-
* @type {string}
|
|
21504
21529
|
*
|
|
21505
21530
|
*
|
|
21506
21531
|
* @remarks
|
|
@@ -21573,7 +21598,7 @@ export const KEY_REQUEST_HISTORY_PATH: keyof RequestHistory = 'path';
|
|
|
21573
21598
|
*/
|
|
21574
21599
|
export const KEY_REQUEST_HISTORY_PERFORMED_BY_ID: keyof RequestHistory = 'performed_by_id';
|
|
21575
21600
|
/**
|
|
21576
|
-
*
|
|
21601
|
+
* performed_by_type property
|
|
21577
21602
|
*
|
|
21578
21603
|
* Type of the actor who performed the request
|
|
21579
21604
|
*
|
package/src/helpers/schemas.d.ts
CHANGED
|
@@ -2202,6 +2202,22 @@ export type EventSubtype = components['schemas']['EventSubtype'];
|
|
|
2202
2202
|
* @see {@link components} - The OpenAPI components schema definition
|
|
2203
2203
|
*/
|
|
2204
2204
|
export type EventType = components['schemas']['EventType'];
|
|
2205
|
+
/**
|
|
2206
|
+
* ExecutingEntity
|
|
2207
|
+
*
|
|
2208
|
+
* @remarks
|
|
2209
|
+
* Type alias for the `ExecutingEntity` OpenAPI schema.
|
|
2210
|
+
* This type represents executingentity data structures used in API requests and responses.
|
|
2211
|
+
*
|
|
2212
|
+
* @example
|
|
2213
|
+
* ```typescript
|
|
2214
|
+
* const response = await api.getExecutingEntity();
|
|
2215
|
+
* const item: ExecutingEntity = response.results;
|
|
2216
|
+
* ```
|
|
2217
|
+
*
|
|
2218
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2219
|
+
*/
|
|
2220
|
+
export type ExecutingEntity = components['schemas']['ExecutingEntity'];
|
|
2205
2221
|
/**
|
|
2206
2222
|
* GeneralAvailabilityBase
|
|
2207
2223
|
*
|
|
@@ -2266,6 +2282,27 @@ export type GetPrices = components['schemas']['GetPricesResponse'];
|
|
|
2266
2282
|
* @see {@link components} - The OpenAPI components schema definition
|
|
2267
2283
|
*/
|
|
2268
2284
|
export type GrantType = components['schemas']['GrantType'];
|
|
2285
|
+
/**
|
|
2286
|
+
* HTTPMethod. HTTP methods and descriptions
|
|
2287
|
+
|
|
2288
|
+
Methods from the following RFCs are all observed:
|
|
2289
|
+
|
|
2290
|
+
* RFC 9110: HTTP Semantics, obsoletes 7231, which obsoleted 2616
|
|
2291
|
+
* RFC 5789: PATCH Method for HTTP
|
|
2292
|
+
*
|
|
2293
|
+
* @remarks
|
|
2294
|
+
* Type alias for the `HTTPMethod` OpenAPI schema.
|
|
2295
|
+
* This type represents httpmethod data structures used in API requests and responses.
|
|
2296
|
+
*
|
|
2297
|
+
* @example
|
|
2298
|
+
* ```typescript
|
|
2299
|
+
* const response = await api.getHTTPMethod();
|
|
2300
|
+
* const item: HTTPMethod = response.results;
|
|
2301
|
+
* ```
|
|
2302
|
+
*
|
|
2303
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2304
|
+
*/
|
|
2305
|
+
export type HTTPMethod = components['schemas']['HTTPMethod'];
|
|
2269
2306
|
/**
|
|
2270
2307
|
* RequestValidationError
|
|
2271
2308
|
*
|
|
@@ -3343,6 +3380,22 @@ export type Period = components['schemas']['Period'];
|
|
|
3343
3380
|
* @see {@link components} - The OpenAPI components schema definition
|
|
3344
3381
|
*/
|
|
3345
3382
|
export type PeriodList = components['schemas']['PeriodList'];
|
|
3383
|
+
/**
|
|
3384
|
+
* PeriodStr
|
|
3385
|
+
*
|
|
3386
|
+
* @remarks
|
|
3387
|
+
* Type alias for the `PeriodStr` OpenAPI schema.
|
|
3388
|
+
* This type represents periodstr data structures used in API requests and responses.
|
|
3389
|
+
*
|
|
3390
|
+
* @example
|
|
3391
|
+
* ```typescript
|
|
3392
|
+
* const response = await api.getPeriodStr();
|
|
3393
|
+
* const item: PeriodStr = response.results;
|
|
3394
|
+
* ```
|
|
3395
|
+
*
|
|
3396
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
3397
|
+
*/
|
|
3398
|
+
export type PeriodStr = components['schemas']['PeriodStr'];
|
|
3346
3399
|
/**
|
|
3347
3400
|
* PeriodUnit
|
|
3348
3401
|
*
|
package/src/openapi.yaml
CHANGED
|
@@ -1967,6 +1967,10 @@ components:
|
|
|
1967
1967
|
description: Time before expiration to auto-renew a domain in ISO 8601 format
|
|
1968
1968
|
(e.g., 5D, -7D)
|
|
1969
1969
|
title: Auto Renew Before Expiration
|
|
1970
|
+
default_transfer_renewal_period:
|
|
1971
|
+
$ref: '#/components/schemas/PeriodStr'
|
|
1972
|
+
description: Default period for transfer if no transfer_renewal_period is
|
|
1973
|
+
specified
|
|
1970
1974
|
delete_before_expiration:
|
|
1971
1975
|
anyOf:
|
|
1972
1976
|
- examples:
|
|
@@ -2058,6 +2062,8 @@ components:
|
|
|
2058
2062
|
transfer_renewal_periods:
|
|
2059
2063
|
$ref: '#/components/schemas/PeriodList'
|
|
2060
2064
|
description: List of allowed transfer renewal periods (eg. '1y')
|
|
2065
|
+
required:
|
|
2066
|
+
- default_transfer_renewal_period
|
|
2061
2067
|
title: DomainLifecycleBase
|
|
2062
2068
|
type: object
|
|
2063
2069
|
DomainNameParts:
|
|
@@ -3307,6 +3313,13 @@ components:
|
|
|
3307
3313
|
- VERIFICATION
|
|
3308
3314
|
title: EventType
|
|
3309
3315
|
type: string
|
|
3316
|
+
ExecutingEntity:
|
|
3317
|
+
enum:
|
|
3318
|
+
- user
|
|
3319
|
+
- organization
|
|
3320
|
+
- system
|
|
3321
|
+
title: ExecutingEntity
|
|
3322
|
+
type: string
|
|
3310
3323
|
GeneralAvailabilityBase:
|
|
3311
3324
|
properties:
|
|
3312
3325
|
start_date:
|
|
@@ -3350,6 +3363,22 @@ components:
|
|
|
3350
3363
|
- refresh_token
|
|
3351
3364
|
title: GrantType
|
|
3352
3365
|
type: string
|
|
3366
|
+
HTTPMethod:
|
|
3367
|
+
description: "HTTP methods and descriptions\n\nMethods from the following RFCs\
|
|
3368
|
+
\ are all observed:\n\n * RFC 9110: HTTP Semantics, obsoletes 7231, which\
|
|
3369
|
+
\ obsoleted 2616\n * RFC 5789: PATCH Method for HTTP"
|
|
3370
|
+
enum:
|
|
3371
|
+
- CONNECT
|
|
3372
|
+
- DELETE
|
|
3373
|
+
- GET
|
|
3374
|
+
- HEAD
|
|
3375
|
+
- OPTIONS
|
|
3376
|
+
- PATCH
|
|
3377
|
+
- POST
|
|
3378
|
+
- PUT
|
|
3379
|
+
- TRACE
|
|
3380
|
+
title: HTTPMethod
|
|
3381
|
+
type: string
|
|
3353
3382
|
HTTPValidationError:
|
|
3354
3383
|
properties:
|
|
3355
3384
|
errors:
|
|
@@ -3965,10 +3994,9 @@ components:
|
|
|
3965
3994
|
title: Performed By Id
|
|
3966
3995
|
performed_by_type:
|
|
3967
3996
|
anyOf:
|
|
3968
|
-
-
|
|
3997
|
+
- $ref: '#/components/schemas/ExecutingEntity'
|
|
3969
3998
|
- type: 'null'
|
|
3970
3999
|
description: Type of the actor who performed the action
|
|
3971
|
-
title: Performed By Type
|
|
3972
4000
|
server_request_id:
|
|
3973
4001
|
anyOf:
|
|
3974
4002
|
- type: string
|
|
@@ -5169,6 +5197,10 @@ components:
|
|
|
5169
5197
|
$ref: '#/components/schemas/Period'
|
|
5170
5198
|
type: array
|
|
5171
5199
|
- type: 'null'
|
|
5200
|
+
PeriodStr:
|
|
5201
|
+
anyOf:
|
|
5202
|
+
- $ref: '#/components/schemas/Period'
|
|
5203
|
+
- type: 'null'
|
|
5172
5204
|
PeriodUnit:
|
|
5173
5205
|
enum:
|
|
5174
5206
|
- y
|
|
@@ -5558,6 +5590,7 @@ components:
|
|
|
5558
5590
|
properties:
|
|
5559
5591
|
client_ip:
|
|
5560
5592
|
description: Client IP address
|
|
5593
|
+
format: ipvanyaddress
|
|
5561
5594
|
title: Client Ip
|
|
5562
5595
|
type: string
|
|
5563
5596
|
duration:
|
|
@@ -5565,9 +5598,8 @@ components:
|
|
|
5565
5598
|
title: Duration
|
|
5566
5599
|
type: number
|
|
5567
5600
|
method:
|
|
5601
|
+
$ref: '#/components/schemas/HTTPMethod'
|
|
5568
5602
|
description: HTTP method
|
|
5569
|
-
title: Method
|
|
5570
|
-
type: string
|
|
5571
5603
|
path:
|
|
5572
5604
|
description: Request path
|
|
5573
5605
|
title: Path
|
|
@@ -5580,10 +5612,9 @@ components:
|
|
|
5580
5612
|
title: Performed By Id
|
|
5581
5613
|
performed_by_type:
|
|
5582
5614
|
anyOf:
|
|
5583
|
-
-
|
|
5615
|
+
- $ref: '#/components/schemas/ExecutingEntity'
|
|
5584
5616
|
- type: 'null'
|
|
5585
5617
|
description: Type of the actor who performed the request
|
|
5586
|
-
title: Performed By Type
|
|
5587
5618
|
request_body:
|
|
5588
5619
|
anyOf:
|
|
5589
5620
|
- additionalProperties: true
|
|
@@ -6929,7 +6960,7 @@ info:
|
|
|
6929
6960
|
'
|
|
6930
6961
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
6931
6962
|
title: OpusDNS API
|
|
6932
|
-
version: 2026-01-
|
|
6963
|
+
version: 2026-01-29-080310
|
|
6933
6964
|
x-logo:
|
|
6934
6965
|
altText: OpusDNS API Reference
|
|
6935
6966
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -7212,23 +7243,23 @@ paths:
|
|
|
7212
7243
|
- type: 'null'
|
|
7213
7244
|
title: Performed By Id
|
|
7214
7245
|
- in: query
|
|
7215
|
-
name:
|
|
7246
|
+
name: created_before
|
|
7216
7247
|
required: false
|
|
7217
7248
|
schema:
|
|
7218
7249
|
anyOf:
|
|
7219
7250
|
- format: date-time
|
|
7220
7251
|
type: string
|
|
7221
7252
|
- type: 'null'
|
|
7222
|
-
title:
|
|
7253
|
+
title: Created Before
|
|
7223
7254
|
- in: query
|
|
7224
|
-
name:
|
|
7255
|
+
name: created_after
|
|
7225
7256
|
required: false
|
|
7226
7257
|
schema:
|
|
7227
7258
|
anyOf:
|
|
7228
7259
|
- format: date-time
|
|
7229
7260
|
type: string
|
|
7230
7261
|
- type: 'null'
|
|
7231
|
-
title:
|
|
7262
|
+
title: Created After
|
|
7232
7263
|
- in: query
|
|
7233
7264
|
name: object_id
|
|
7234
7265
|
required: false
|
|
@@ -7346,23 +7377,23 @@ paths:
|
|
|
7346
7377
|
- type: 'null'
|
|
7347
7378
|
title: Performed By Id
|
|
7348
7379
|
- in: query
|
|
7349
|
-
name:
|
|
7380
|
+
name: created_before
|
|
7350
7381
|
required: false
|
|
7351
7382
|
schema:
|
|
7352
7383
|
anyOf:
|
|
7353
7384
|
- format: date-time
|
|
7354
7385
|
type: string
|
|
7355
7386
|
- type: 'null'
|
|
7356
|
-
title:
|
|
7387
|
+
title: Created Before
|
|
7357
7388
|
- in: query
|
|
7358
|
-
name:
|
|
7389
|
+
name: created_after
|
|
7359
7390
|
required: false
|
|
7360
7391
|
schema:
|
|
7361
7392
|
anyOf:
|
|
7362
7393
|
- format: date-time
|
|
7363
7394
|
type: string
|
|
7364
7395
|
- type: 'null'
|
|
7365
|
-
title:
|
|
7396
|
+
title: Created After
|
|
7366
7397
|
responses:
|
|
7367
7398
|
'200':
|
|
7368
7399
|
content:
|
|
@@ -7421,7 +7452,7 @@ paths:
|
|
|
7421
7452
|
required: false
|
|
7422
7453
|
schema:
|
|
7423
7454
|
anyOf:
|
|
7424
|
-
-
|
|
7455
|
+
- $ref: '#/components/schemas/HTTPMethod'
|
|
7425
7456
|
- type: 'null'
|
|
7426
7457
|
title: Method
|
|
7427
7458
|
- in: query
|
|
@@ -7477,7 +7508,8 @@ paths:
|
|
|
7477
7508
|
required: false
|
|
7478
7509
|
schema:
|
|
7479
7510
|
anyOf:
|
|
7480
|
-
-
|
|
7511
|
+
- format: ipvanyaddress
|
|
7512
|
+
type: string
|
|
7481
7513
|
- type: 'null'
|
|
7482
7514
|
title: Client Ip
|
|
7483
7515
|
- in: query
|
|
@@ -7493,7 +7525,7 @@ paths:
|
|
|
7493
7525
|
required: false
|
|
7494
7526
|
schema:
|
|
7495
7527
|
anyOf:
|
|
7496
|
-
-
|
|
7528
|
+
- $ref: '#/components/schemas/ExecutingEntity'
|
|
7497
7529
|
- type: 'null'
|
|
7498
7530
|
title: Performed By Type
|
|
7499
7531
|
- in: query
|
|
@@ -7505,23 +7537,23 @@ paths:
|
|
|
7505
7537
|
- type: 'null'
|
|
7506
7538
|
title: Performed By Id
|
|
7507
7539
|
- in: query
|
|
7508
|
-
name:
|
|
7540
|
+
name: request_started_before
|
|
7509
7541
|
required: false
|
|
7510
7542
|
schema:
|
|
7511
7543
|
anyOf:
|
|
7512
7544
|
- format: date-time
|
|
7513
7545
|
type: string
|
|
7514
7546
|
- type: 'null'
|
|
7515
|
-
title:
|
|
7547
|
+
title: Request Started Before
|
|
7516
7548
|
- in: query
|
|
7517
|
-
name:
|
|
7549
|
+
name: request_started_after
|
|
7518
7550
|
required: false
|
|
7519
7551
|
schema:
|
|
7520
7552
|
anyOf:
|
|
7521
7553
|
- format: date-time
|
|
7522
7554
|
type: string
|
|
7523
7555
|
- type: 'null'
|
|
7524
|
-
title:
|
|
7556
|
+
title: Request Started After
|
|
7525
7557
|
responses:
|
|
7526
7558
|
'200':
|
|
7527
7559
|
content:
|
package/src/schema.d.ts
CHANGED
|
@@ -3132,6 +3132,8 @@ export interface components {
|
|
|
3132
3132
|
* @description Time before expiration to auto-renew a domain in ISO 8601 format (e.g., 5D, -7D)
|
|
3133
3133
|
*/
|
|
3134
3134
|
auto_renew_before_expiration?: string | null;
|
|
3135
|
+
/** @description Default period for transfer if no transfer_renewal_period is specified */
|
|
3136
|
+
default_transfer_renewal_period: components["schemas"]["PeriodStr"];
|
|
3135
3137
|
/**
|
|
3136
3138
|
* Delete Before Expiration
|
|
3137
3139
|
* @description Time before expiration to delete a domain in ISO 8601 format (e.g., 5D, -7D)
|
|
@@ -4062,6 +4064,11 @@ export interface components {
|
|
|
4062
4064
|
* @enum {string}
|
|
4063
4065
|
*/
|
|
4064
4066
|
EventType: "REGISTRATION" | "RENEWAL" | "MODIFICATION" | "DELETION" | "INBOUND_TRANSFER" | "OUTBOUND_TRANSFER" | "VERIFICATION";
|
|
4067
|
+
/**
|
|
4068
|
+
* ExecutingEntity
|
|
4069
|
+
* @enum {string}
|
|
4070
|
+
*/
|
|
4071
|
+
ExecutingEntity: "user" | "organization" | "system";
|
|
4065
4072
|
/** GeneralAvailabilityBase */
|
|
4066
4073
|
GeneralAvailabilityBase: {
|
|
4067
4074
|
/**
|
|
@@ -4091,6 +4098,17 @@ export interface components {
|
|
|
4091
4098
|
* @enum {string}
|
|
4092
4099
|
*/
|
|
4093
4100
|
GrantType: "client_credentials" | "password" | "refresh_token";
|
|
4101
|
+
/**
|
|
4102
|
+
* HTTPMethod
|
|
4103
|
+
* @description HTTP methods and descriptions
|
|
4104
|
+
*
|
|
4105
|
+
* Methods from the following RFCs are all observed:
|
|
4106
|
+
*
|
|
4107
|
+
* * RFC 9110: HTTP Semantics, obsoletes 7231, which obsoleted 2616
|
|
4108
|
+
* * RFC 5789: PATCH Method for HTTP
|
|
4109
|
+
* @enum {string}
|
|
4110
|
+
*/
|
|
4111
|
+
HTTPMethod: "CONNECT" | "DELETE" | "GET" | "HEAD" | "OPTIONS" | "PATCH" | "POST" | "PUT" | "TRACE";
|
|
4094
4112
|
/** RequestValidationError */
|
|
4095
4113
|
HTTPValidationError: {
|
|
4096
4114
|
errors: components["schemas"]["ValidationError"][];
|
|
@@ -4509,11 +4527,8 @@ export interface components {
|
|
|
4509
4527
|
* @description ID of the actor who performed the action
|
|
4510
4528
|
*/
|
|
4511
4529
|
performed_by_id?: string | null;
|
|
4512
|
-
/**
|
|
4513
|
-
|
|
4514
|
-
* @description Type of the actor who performed the action
|
|
4515
|
-
*/
|
|
4516
|
-
performed_by_type?: string | null;
|
|
4530
|
+
/** @description Type of the actor who performed the action */
|
|
4531
|
+
performed_by_type?: components["schemas"]["ExecutingEntity"] | null;
|
|
4517
4532
|
/**
|
|
4518
4533
|
* Server Request Id
|
|
4519
4534
|
* @description Server request ID
|
|
@@ -5299,6 +5314,7 @@ export interface components {
|
|
|
5299
5314
|
value: number;
|
|
5300
5315
|
};
|
|
5301
5316
|
PeriodList: components["schemas"]["Period"][] | null;
|
|
5317
|
+
PeriodStr: components["schemas"]["Period"] | null;
|
|
5302
5318
|
/**
|
|
5303
5319
|
* PeriodUnit
|
|
5304
5320
|
* @enum {string}
|
|
@@ -5503,6 +5519,7 @@ export interface components {
|
|
|
5503
5519
|
RequestHistory: {
|
|
5504
5520
|
/**
|
|
5505
5521
|
* Client Ip
|
|
5522
|
+
* Format: ipvanyaddress
|
|
5506
5523
|
* @description Client IP address
|
|
5507
5524
|
*/
|
|
5508
5525
|
client_ip: string;
|
|
@@ -5511,11 +5528,8 @@ export interface components {
|
|
|
5511
5528
|
* @description Request duration in milliseconds
|
|
5512
5529
|
*/
|
|
5513
5530
|
duration: number;
|
|
5514
|
-
/**
|
|
5515
|
-
|
|
5516
|
-
* @description HTTP method
|
|
5517
|
-
*/
|
|
5518
|
-
method: string;
|
|
5531
|
+
/** @description HTTP method */
|
|
5532
|
+
method: components["schemas"]["HTTPMethod"];
|
|
5519
5533
|
/**
|
|
5520
5534
|
* Path
|
|
5521
5535
|
* @description Request path
|
|
@@ -5526,11 +5540,8 @@ export interface components {
|
|
|
5526
5540
|
* @description ID of the actor who performed the request
|
|
5527
5541
|
*/
|
|
5528
5542
|
performed_by_id?: string | null;
|
|
5529
|
-
/**
|
|
5530
|
-
|
|
5531
|
-
* @description Type of the actor who performed the request
|
|
5532
|
-
*/
|
|
5533
|
-
performed_by_type?: string | null;
|
|
5543
|
+
/** @description Type of the actor who performed the request */
|
|
5544
|
+
performed_by_type?: components["schemas"]["ExecutingEntity"] | null;
|
|
5534
5545
|
/**
|
|
5535
5546
|
* Request Body
|
|
5536
5547
|
* @description Request body
|
|
@@ -6519,8 +6530,8 @@ export interface operations {
|
|
|
6519
6530
|
server_request_id?: string | null;
|
|
6520
6531
|
performed_by_type?: string | null;
|
|
6521
6532
|
performed_by_id?: string | null;
|
|
6522
|
-
|
|
6523
|
-
|
|
6533
|
+
created_before?: Date | null;
|
|
6534
|
+
created_after?: Date | null;
|
|
6524
6535
|
object_id?: string | null;
|
|
6525
6536
|
};
|
|
6526
6537
|
header?: never;
|
|
@@ -6562,8 +6573,8 @@ export interface operations {
|
|
|
6562
6573
|
server_request_id?: string | null;
|
|
6563
6574
|
performed_by_type?: string | null;
|
|
6564
6575
|
performed_by_id?: string | null;
|
|
6565
|
-
|
|
6566
|
-
|
|
6576
|
+
created_before?: Date | null;
|
|
6577
|
+
created_after?: Date | null;
|
|
6567
6578
|
};
|
|
6568
6579
|
header?: never;
|
|
6569
6580
|
path: {
|
|
@@ -6600,7 +6611,7 @@ export interface operations {
|
|
|
6600
6611
|
sort_order?: components["schemas"]["SortOrder"];
|
|
6601
6612
|
page_size?: number;
|
|
6602
6613
|
page?: number;
|
|
6603
|
-
method?:
|
|
6614
|
+
method?: components["schemas"]["HTTPMethod"] | null;
|
|
6604
6615
|
path?: string | null;
|
|
6605
6616
|
status_code?: number | null;
|
|
6606
6617
|
min_status_code?: number | null;
|
|
@@ -6609,10 +6620,10 @@ export interface operations {
|
|
|
6609
6620
|
max_duration?: number | null;
|
|
6610
6621
|
client_ip?: string | null;
|
|
6611
6622
|
server_request_id?: string | null;
|
|
6612
|
-
performed_by_type?:
|
|
6623
|
+
performed_by_type?: components["schemas"]["ExecutingEntity"] | null;
|
|
6613
6624
|
performed_by_id?: string | null;
|
|
6614
|
-
|
|
6615
|
-
|
|
6625
|
+
request_started_before?: Date | null;
|
|
6626
|
+
request_started_after?: Date | null;
|
|
6616
6627
|
};
|
|
6617
6628
|
header?: never;
|
|
6618
6629
|
path?: never;
|