@opusdns/api 0.175.0 → 0.177.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 +26 -0
- package/src/helpers/schemas.d.ts +16 -0
- package/src/openapi.yaml +19 -1
- package/src/schema.d.ts +3 -0
package/package.json
CHANGED
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,
|
package/src/helpers/schemas.d.ts
CHANGED
|
@@ -3343,6 +3343,22 @@ export type Period = components['schemas']['Period'];
|
|
|
3343
3343
|
* @see {@link components} - The OpenAPI components schema definition
|
|
3344
3344
|
*/
|
|
3345
3345
|
export type PeriodList = components['schemas']['PeriodList'];
|
|
3346
|
+
/**
|
|
3347
|
+
* PeriodStr
|
|
3348
|
+
*
|
|
3349
|
+
* @remarks
|
|
3350
|
+
* Type alias for the `PeriodStr` OpenAPI schema.
|
|
3351
|
+
* This type represents periodstr data structures used in API requests and responses.
|
|
3352
|
+
*
|
|
3353
|
+
* @example
|
|
3354
|
+
* ```typescript
|
|
3355
|
+
* const response = await api.getPeriodStr();
|
|
3356
|
+
* const item: PeriodStr = response.results;
|
|
3357
|
+
* ```
|
|
3358
|
+
*
|
|
3359
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
3360
|
+
*/
|
|
3361
|
+
export type PeriodStr = components['schemas']['PeriodStr'];
|
|
3346
3362
|
/**
|
|
3347
3363
|
* PeriodUnit
|
|
3348
3364
|
*
|
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:
|
|
@@ -5169,6 +5175,10 @@ components:
|
|
|
5169
5175
|
$ref: '#/components/schemas/Period'
|
|
5170
5176
|
type: array
|
|
5171
5177
|
- type: 'null'
|
|
5178
|
+
PeriodStr:
|
|
5179
|
+
anyOf:
|
|
5180
|
+
- $ref: '#/components/schemas/Period'
|
|
5181
|
+
- type: 'null'
|
|
5172
5182
|
PeriodUnit:
|
|
5173
5183
|
enum:
|
|
5174
5184
|
- y
|
|
@@ -6917,11 +6927,19 @@ info:
|
|
|
6917
6927
|
at support@opusdns.com. We are happy to help!
|
|
6918
6928
|
|
|
6919
6929
|
|
|
6930
|
+
# Open-source SDKs and libraries
|
|
6931
|
+
|
|
6932
|
+
|
|
6933
|
+
We''re constantly building new features and services from SDKs and plugins to
|
|
6934
|
+
other exciting tools. Check out [our GitHub](https://github.com/OpusDNS/) to see
|
|
6935
|
+
the latest developments and try them out yourself!
|
|
6936
|
+
|
|
6937
|
+
|
|
6920
6938
|
|
|
6921
6939
|
'
|
|
6922
6940
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
6923
6941
|
title: OpusDNS API
|
|
6924
|
-
version: 2026-01-28-
|
|
6942
|
+
version: 2026-01-28-123004
|
|
6925
6943
|
x-logo:
|
|
6926
6944
|
altText: OpusDNS API Reference
|
|
6927
6945
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
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)
|
|
@@ -5299,6 +5301,7 @@ export interface components {
|
|
|
5299
5301
|
value: number;
|
|
5300
5302
|
};
|
|
5301
5303
|
PeriodList: components["schemas"]["Period"][] | null;
|
|
5304
|
+
PeriodStr: components["schemas"]["Period"] | null;
|
|
5302
5305
|
/**
|
|
5303
5306
|
* PeriodUnit
|
|
5304
5307
|
* @enum {string}
|