@opusdns/api 0.44.0 → 0.45.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 +238 -0
- package/src/helpers/requests.d.ts +53 -1
- package/src/helpers/responses.d.ts +56 -1
- package/src/helpers/schemas.d.ts +32 -0
- package/src/openapi.yaml +95 -1
- package/src/schema.d.ts +97 -0
package/package.json
CHANGED
package/src/helpers/keys.ts
CHANGED
|
@@ -72,6 +72,8 @@ import { DomainPeriod } from './schemas';
|
|
|
72
72
|
import { DomainRenewRequest } from './schemas';
|
|
73
73
|
import { DomainRenew } from './schemas';
|
|
74
74
|
import { Domain } from './schemas';
|
|
75
|
+
import { DomainRestoreRequest } from './schemas';
|
|
76
|
+
import { DomainRestore } from './schemas';
|
|
75
77
|
import { DomainSearchMeta } from './schemas';
|
|
76
78
|
import { DomainSearch } from './schemas';
|
|
77
79
|
import { DomainSearchSuggestionPriceData } from './schemas';
|
|
@@ -7115,6 +7117,242 @@ export const KEYS_DOMAIN = [
|
|
|
7115
7117
|
KEY_DOMAIN_UPDATED_ON,
|
|
7116
7118
|
] as const satisfies (keyof Domain)[];
|
|
7117
7119
|
|
|
7120
|
+
/**
|
|
7121
|
+
* Additional Info
|
|
7122
|
+
*
|
|
7123
|
+
* Additional information to include in the restore operation
|
|
7124
|
+
*
|
|
7125
|
+
*
|
|
7126
|
+
*
|
|
7127
|
+
* @remarks
|
|
7128
|
+
* This key constant provides type-safe access to the `additional_info` property of DomainRestoreRequest objects.
|
|
7129
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
7130
|
+
*
|
|
7131
|
+
* @example
|
|
7132
|
+
* ```typescript
|
|
7133
|
+
* // Direct property access
|
|
7134
|
+
* const value = domainrestorerequest[KEY_DOMAIN_RESTORE_REQUEST_ADDITIONAL_INFO];
|
|
7135
|
+
*
|
|
7136
|
+
* // Dynamic property access
|
|
7137
|
+
* const propertyName = KEY_DOMAIN_RESTORE_REQUEST_ADDITIONAL_INFO;
|
|
7138
|
+
* const value = domainrestorerequest[propertyName];
|
|
7139
|
+
* ```
|
|
7140
|
+
*
|
|
7141
|
+
* @see {@link DomainRestoreRequest} - The TypeScript type definition
|
|
7142
|
+
* @see {@link KEYS_DOMAIN_RESTORE_REQUEST} - Array of all keys for this type
|
|
7143
|
+
*/
|
|
7144
|
+
export const KEY_DOMAIN_RESTORE_REQUEST_ADDITIONAL_INFO = 'additional_info' as keyof DomainRestoreRequest;
|
|
7145
|
+
/**
|
|
7146
|
+
* Auto Renew
|
|
7147
|
+
*
|
|
7148
|
+
* Whether to automatically renew the domain after restore
|
|
7149
|
+
*
|
|
7150
|
+
* @type {boolean}
|
|
7151
|
+
*
|
|
7152
|
+
*
|
|
7153
|
+
* @remarks
|
|
7154
|
+
* This key constant provides type-safe access to the `auto_renew` property of DomainRestoreRequest objects.
|
|
7155
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
7156
|
+
*
|
|
7157
|
+
* @example
|
|
7158
|
+
* ```typescript
|
|
7159
|
+
* // Direct property access
|
|
7160
|
+
* const value = domainrestorerequest[KEY_DOMAIN_RESTORE_REQUEST_AUTO_RENEW];
|
|
7161
|
+
*
|
|
7162
|
+
* // Dynamic property access
|
|
7163
|
+
* const propertyName = KEY_DOMAIN_RESTORE_REQUEST_AUTO_RENEW;
|
|
7164
|
+
* const value = domainrestorerequest[propertyName];
|
|
7165
|
+
* ```
|
|
7166
|
+
*
|
|
7167
|
+
* @see {@link DomainRestoreRequest} - The TypeScript type definition
|
|
7168
|
+
* @see {@link KEYS_DOMAIN_RESTORE_REQUEST} - Array of all keys for this type
|
|
7169
|
+
*/
|
|
7170
|
+
export const KEY_DOMAIN_RESTORE_REQUEST_AUTO_RENEW = 'auto_renew' as keyof DomainRestoreRequest;
|
|
7171
|
+
/**
|
|
7172
|
+
* Reason
|
|
7173
|
+
*
|
|
7174
|
+
* Reason for restoring the domain
|
|
7175
|
+
*
|
|
7176
|
+
* @type {string}
|
|
7177
|
+
*
|
|
7178
|
+
*
|
|
7179
|
+
* @remarks
|
|
7180
|
+
* This key constant provides type-safe access to the `reason` property of DomainRestoreRequest objects.
|
|
7181
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
7182
|
+
*
|
|
7183
|
+
* @example
|
|
7184
|
+
* ```typescript
|
|
7185
|
+
* // Direct property access
|
|
7186
|
+
* const value = domainrestorerequest[KEY_DOMAIN_RESTORE_REQUEST_REASON];
|
|
7187
|
+
*
|
|
7188
|
+
* // Dynamic property access
|
|
7189
|
+
* const propertyName = KEY_DOMAIN_RESTORE_REQUEST_REASON;
|
|
7190
|
+
* const value = domainrestorerequest[propertyName];
|
|
7191
|
+
* ```
|
|
7192
|
+
*
|
|
7193
|
+
* @see {@link DomainRestoreRequest} - The TypeScript type definition
|
|
7194
|
+
* @see {@link KEYS_DOMAIN_RESTORE_REQUEST} - Array of all keys for this type
|
|
7195
|
+
*/
|
|
7196
|
+
export const KEY_DOMAIN_RESTORE_REQUEST_REASON = 'reason' as keyof DomainRestoreRequest;
|
|
7197
|
+
|
|
7198
|
+
/**
|
|
7199
|
+
* Array of all DomainRestoreRequest property keys
|
|
7200
|
+
*
|
|
7201
|
+
* @remarks
|
|
7202
|
+
* This constant provides a readonly array containing all valid property keys for DomainRestoreRequest objects.
|
|
7203
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
7204
|
+
*
|
|
7205
|
+
* @example
|
|
7206
|
+
* ```typescript
|
|
7207
|
+
* // Iterating through all keys
|
|
7208
|
+
* for (const key of KEYS_DOMAIN_RESTORE_REQUEST) {
|
|
7209
|
+
* console.log(`Property: ${key}, Value: ${domainrestorerequest[key]}`);
|
|
7210
|
+
* }
|
|
7211
|
+
*
|
|
7212
|
+
* // Validation
|
|
7213
|
+
* const isValidKey = KEYS_DOMAIN_RESTORE_REQUEST.includes(someKey);
|
|
7214
|
+
* ```
|
|
7215
|
+
*
|
|
7216
|
+
* @see {@link DomainRestoreRequest} - The TypeScript type definition
|
|
7217
|
+
*/
|
|
7218
|
+
export const KEYS_DOMAIN_RESTORE_REQUEST = [
|
|
7219
|
+
KEY_DOMAIN_RESTORE_REQUEST_ADDITIONAL_INFO,
|
|
7220
|
+
KEY_DOMAIN_RESTORE_REQUEST_AUTO_RENEW,
|
|
7221
|
+
KEY_DOMAIN_RESTORE_REQUEST_REASON,
|
|
7222
|
+
] as const satisfies (keyof DomainRestoreRequest)[];
|
|
7223
|
+
|
|
7224
|
+
/**
|
|
7225
|
+
* Domain Id
|
|
7226
|
+
*
|
|
7227
|
+
* The ID of the restored domain
|
|
7228
|
+
*
|
|
7229
|
+
* @type {string}
|
|
7230
|
+
*
|
|
7231
|
+
*
|
|
7232
|
+
* @remarks
|
|
7233
|
+
* This key constant provides type-safe access to the `domain_id` property of DomainRestore objects.
|
|
7234
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
7235
|
+
*
|
|
7236
|
+
* @example
|
|
7237
|
+
* ```typescript
|
|
7238
|
+
* // Direct property access
|
|
7239
|
+
* const value = domainrestore[KEY_DOMAIN_RESTORE_DOMAIN_ID];
|
|
7240
|
+
*
|
|
7241
|
+
* // Dynamic property access
|
|
7242
|
+
* const propertyName = KEY_DOMAIN_RESTORE_DOMAIN_ID;
|
|
7243
|
+
* const value = domainrestore[propertyName];
|
|
7244
|
+
* ```
|
|
7245
|
+
*
|
|
7246
|
+
* @see {@link DomainRestore} - The TypeScript type definition
|
|
7247
|
+
* @see {@link KEYS_DOMAIN_RESTORE} - Array of all keys for this type
|
|
7248
|
+
*/
|
|
7249
|
+
export const KEY_DOMAIN_RESTORE_DOMAIN_ID = 'domain_id' as keyof DomainRestore;
|
|
7250
|
+
/**
|
|
7251
|
+
* Expiration Date
|
|
7252
|
+
*
|
|
7253
|
+
* The new expiration date after restore
|
|
7254
|
+
*
|
|
7255
|
+
* @type {string}
|
|
7256
|
+
*
|
|
7257
|
+
*
|
|
7258
|
+
* @remarks
|
|
7259
|
+
* This key constant provides type-safe access to the `expiration_date` property of DomainRestore objects.
|
|
7260
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
7261
|
+
*
|
|
7262
|
+
* @example
|
|
7263
|
+
* ```typescript
|
|
7264
|
+
* // Direct property access
|
|
7265
|
+
* const value = domainrestore[KEY_DOMAIN_RESTORE_EXPIRATION_DATE];
|
|
7266
|
+
*
|
|
7267
|
+
* // Dynamic property access
|
|
7268
|
+
* const propertyName = KEY_DOMAIN_RESTORE_EXPIRATION_DATE;
|
|
7269
|
+
* const value = domainrestore[propertyName];
|
|
7270
|
+
* ```
|
|
7271
|
+
*
|
|
7272
|
+
* @see {@link DomainRestore} - The TypeScript type definition
|
|
7273
|
+
* @see {@link KEYS_DOMAIN_RESTORE} - Array of all keys for this type
|
|
7274
|
+
*/
|
|
7275
|
+
export const KEY_DOMAIN_RESTORE_EXPIRATION_DATE = 'expiration_date' as keyof DomainRestore;
|
|
7276
|
+
/**
|
|
7277
|
+
* Name
|
|
7278
|
+
*
|
|
7279
|
+
* The name of the restored domain
|
|
7280
|
+
*
|
|
7281
|
+
* @type {string}
|
|
7282
|
+
*
|
|
7283
|
+
*
|
|
7284
|
+
* @remarks
|
|
7285
|
+
* This key constant provides type-safe access to the `name` property of DomainRestore objects.
|
|
7286
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
7287
|
+
*
|
|
7288
|
+
* @example
|
|
7289
|
+
* ```typescript
|
|
7290
|
+
* // Direct property access
|
|
7291
|
+
* const value = domainrestore[KEY_DOMAIN_RESTORE_NAME];
|
|
7292
|
+
*
|
|
7293
|
+
* // Dynamic property access
|
|
7294
|
+
* const propertyName = KEY_DOMAIN_RESTORE_NAME;
|
|
7295
|
+
* const value = domainrestore[propertyName];
|
|
7296
|
+
* ```
|
|
7297
|
+
*
|
|
7298
|
+
* @see {@link DomainRestore} - The TypeScript type definition
|
|
7299
|
+
* @see {@link KEYS_DOMAIN_RESTORE} - Array of all keys for this type
|
|
7300
|
+
*/
|
|
7301
|
+
export const KEY_DOMAIN_RESTORE_NAME = 'name' as keyof DomainRestore;
|
|
7302
|
+
/**
|
|
7303
|
+
* Restored At
|
|
7304
|
+
*
|
|
7305
|
+
* When the domain restore operation was completed
|
|
7306
|
+
*
|
|
7307
|
+
* @type {string}
|
|
7308
|
+
*
|
|
7309
|
+
*
|
|
7310
|
+
* @remarks
|
|
7311
|
+
* This key constant provides type-safe access to the `restored_at` property of DomainRestore objects.
|
|
7312
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
7313
|
+
*
|
|
7314
|
+
* @example
|
|
7315
|
+
* ```typescript
|
|
7316
|
+
* // Direct property access
|
|
7317
|
+
* const value = domainrestore[KEY_DOMAIN_RESTORE_RESTORED_AT];
|
|
7318
|
+
*
|
|
7319
|
+
* // Dynamic property access
|
|
7320
|
+
* const propertyName = KEY_DOMAIN_RESTORE_RESTORED_AT;
|
|
7321
|
+
* const value = domainrestore[propertyName];
|
|
7322
|
+
* ```
|
|
7323
|
+
*
|
|
7324
|
+
* @see {@link DomainRestore} - The TypeScript type definition
|
|
7325
|
+
* @see {@link KEYS_DOMAIN_RESTORE} - Array of all keys for this type
|
|
7326
|
+
*/
|
|
7327
|
+
export const KEY_DOMAIN_RESTORE_RESTORED_AT = 'restored_at' as keyof DomainRestore;
|
|
7328
|
+
|
|
7329
|
+
/**
|
|
7330
|
+
* Array of all DomainRestore property keys
|
|
7331
|
+
*
|
|
7332
|
+
* @remarks
|
|
7333
|
+
* This constant provides a readonly array containing all valid property keys for DomainRestore objects.
|
|
7334
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
7335
|
+
*
|
|
7336
|
+
* @example
|
|
7337
|
+
* ```typescript
|
|
7338
|
+
* // Iterating through all keys
|
|
7339
|
+
* for (const key of KEYS_DOMAIN_RESTORE) {
|
|
7340
|
+
* console.log(`Property: ${key}, Value: ${domainrestore[key]}`);
|
|
7341
|
+
* }
|
|
7342
|
+
*
|
|
7343
|
+
* // Validation
|
|
7344
|
+
* const isValidKey = KEYS_DOMAIN_RESTORE.includes(someKey);
|
|
7345
|
+
* ```
|
|
7346
|
+
*
|
|
7347
|
+
* @see {@link DomainRestore} - The TypeScript type definition
|
|
7348
|
+
*/
|
|
7349
|
+
export const KEYS_DOMAIN_RESTORE = [
|
|
7350
|
+
KEY_DOMAIN_RESTORE_DOMAIN_ID,
|
|
7351
|
+
KEY_DOMAIN_RESTORE_EXPIRATION_DATE,
|
|
7352
|
+
KEY_DOMAIN_RESTORE_NAME,
|
|
7353
|
+
KEY_DOMAIN_RESTORE_RESTORED_AT,
|
|
7354
|
+
] as const satisfies (keyof DomainRestore)[];
|
|
7355
|
+
|
|
7118
7356
|
/**
|
|
7119
7357
|
* Processing Time Ms
|
|
7120
7358
|
*
|
|
@@ -34,7 +34,7 @@ import { operations } from '../schema';
|
|
|
34
34
|
|
|
35
35
|
import { DomainDnssecDataCreateArray, OrganizationAttributeUpdateArray } from './schemas-arrays.d';
|
|
36
36
|
|
|
37
|
-
import { OrganizationCredentialExtra, SignupCreate, ContactCreate, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatchOps, DnsZoneRrsetsCreate, DomainCreate, DomainUpdate, DomainRenewRequest, DomainTransferIn, EmailForwardAlias, EmailForwardAliasUpdate, NotificationCreate, NotificationUpdate, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate, UserCreate, StartPasswordReset, PasswordUpdate, UserUpdate, SpiceDbRelationshipUpdate } from './schemas.d';
|
|
37
|
+
import { OrganizationCredentialExtra, SignupCreate, ContactCreate, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatchOps, DnsZoneRrsetsCreate, DomainCreate, DomainUpdate, DomainRenewRequest, DomainRestoreRequest, DomainTransferIn, EmailForwardAlias, EmailForwardAliasUpdate, NotificationCreate, NotificationUpdate, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate, UserCreate, StartPasswordReset, PasswordUpdate, UserUpdate, SpiceDbRelationshipUpdate } from './schemas.d';
|
|
38
38
|
|
|
39
39
|
/**
|
|
40
40
|
* Request type for GET AuthClientCredentials endpoint
|
|
@@ -1793,6 +1793,58 @@ export type POST_DomainsDomainReferenceRenew_Request_Path = POST_DomainsDomainRe
|
|
|
1793
1793
|
*/
|
|
1794
1794
|
export type POST_DomainsDomainReferenceRenew_Request_Body = POST_DomainsDomainReferenceRenew_Request['requestBody'];
|
|
1795
1795
|
|
|
1796
|
+
/**
|
|
1797
|
+
* Request type for POST DomainsDomainReferenceRestore endpoint
|
|
1798
|
+
*
|
|
1799
|
+
* Restore Domain
|
|
1800
|
+
*
|
|
1801
|
+
* @remarks
|
|
1802
|
+
* This type defines the complete request structure for the POST DomainsDomainReferenceRestore endpoint.
|
|
1803
|
+
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
1804
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
1805
|
+
*
|
|
1806
|
+
* @example
|
|
1807
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
1808
|
+
*
|
|
1809
|
+
* @path /v1/domains/{domain_reference}/restore
|
|
1810
|
+
*
|
|
1811
|
+
* @see {@link POST_DomainsDomainReferenceRestore_Request_Query} - Query parameters type
|
|
1812
|
+
* @see {@link POST_DomainsDomainReferenceRestore_Request_Path} - Path parameters type
|
|
1813
|
+
* @see {@link POST_DomainsDomainReferenceRestore_Request_Body} - Request body type
|
|
1814
|
+
*/
|
|
1815
|
+
export type POST_DomainsDomainReferenceRestore_Request = {
|
|
1816
|
+
parameters: {
|
|
1817
|
+
path: operations['restore_domain_v1_domains__domain_reference__restore_post']['parameters']['path'];
|
|
1818
|
+
};
|
|
1819
|
+
requestBody: DomainRestoreRequest;
|
|
1820
|
+
}
|
|
1821
|
+
/**
|
|
1822
|
+
* Path parameters for POST /v1/domains/{domain_reference}/restore
|
|
1823
|
+
*
|
|
1824
|
+
* @remarks
|
|
1825
|
+
* This type defines the path parameters for the POST /v1/domains/{domain_reference}/restore endpoint.
|
|
1826
|
+
* It provides type safety for all path parameters as defined in the OpenAPI specification.
|
|
1827
|
+
*
|
|
1828
|
+
* @example
|
|
1829
|
+
* Use this type to ensure type safety for path parameters.
|
|
1830
|
+
*
|
|
1831
|
+
* @path /v1/domains/{domain_reference}/restore
|
|
1832
|
+
*/
|
|
1833
|
+
export type POST_DomainsDomainReferenceRestore_Request_Path = POST_DomainsDomainReferenceRestore_Request['parameters']['path'];
|
|
1834
|
+
/**
|
|
1835
|
+
* Request body for POST /v1/domains/{domain_reference}/restore
|
|
1836
|
+
*
|
|
1837
|
+
* @remarks
|
|
1838
|
+
* This type defines the request body structure for the POST /v1/domains/{domain_reference}/restore endpoint.
|
|
1839
|
+
* It provides type safety for the request body as defined in the OpenAPI specification.
|
|
1840
|
+
*
|
|
1841
|
+
* @example
|
|
1842
|
+
* Use this type to ensure type safety for request body structure.
|
|
1843
|
+
*
|
|
1844
|
+
* @path /v1/domains/{domain_reference}/restore
|
|
1845
|
+
*/
|
|
1846
|
+
export type POST_DomainsDomainReferenceRestore_Request_Body = POST_DomainsDomainReferenceRestore_Request['requestBody'];
|
|
1847
|
+
|
|
1796
1848
|
/**
|
|
1797
1849
|
* Request type for DELETE DomainsDomainReferenceTransfer endpoint
|
|
1798
1850
|
*
|
|
@@ -34,7 +34,7 @@
|
|
|
34
34
|
|
|
35
35
|
import { DomainDnssecDataArray, OrganizationAttribute2Array, IpRestrictionArray, TldResponseShortArray } from './schemas-arrays.d';
|
|
36
36
|
|
|
37
|
-
import { Pagination_OrganizationCredential, Problem, HTTPValidationError, OrganizationCredentialCreated, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DnsZoneSummary, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainCheck, DomainSummary, Pagination_EmailForwardAlias, EmailForwardAlias, Pagination_Event, EventSchema, Pagination_UserNotificationSummary, Notification, UserNotification, Pagination_Organization, Organization, OrganizationWithBillingData, GetCurrentAvailablePlans, GetPrices, IpRestriction, Pagination_User, TldSpecification, User, UserWithAttributes, PermissionSet, RelationSet, UserVerification, UserPasswordResetEmail, UserWithRelationPermissions } from './schemas.d';
|
|
37
|
+
import { Pagination_OrganizationCredential, Problem, HTTPValidationError, OrganizationCredentialCreated, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DnsZoneSummary, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, Pagination_EmailForwardAlias, EmailForwardAlias, Pagination_Event, EventSchema, Pagination_UserNotificationSummary, Notification, UserNotification, Pagination_Organization, Organization, OrganizationWithBillingData, GetCurrentAvailablePlans, GetPrices, IpRestriction, Pagination_User, TldSpecification, User, UserWithAttributes, PermissionSet, RelationSet, UserVerification, UserPasswordResetEmail, UserWithRelationPermissions } from './schemas.d';
|
|
38
38
|
|
|
39
39
|
/**
|
|
40
40
|
* Response types for GET AuthClientCredentials endpoint
|
|
@@ -2863,6 +2863,61 @@ export type POST_DomainsByDomainReferenceRenew_Response_200 = DomainRenew
|
|
|
2863
2863
|
*/
|
|
2864
2864
|
export type POST_DomainsByDomainReferenceRenew_Response_422 = HTTPValidationError
|
|
2865
2865
|
|
|
2866
|
+
/**
|
|
2867
|
+
* Response types for POST DomainsByDomainReferenceRestore endpoint
|
|
2868
|
+
*
|
|
2869
|
+
* Restore Domain
|
|
2870
|
+
*
|
|
2871
|
+
* @remarks
|
|
2872
|
+
* This type defines all possible response structures for the POST DomainsByDomainReferenceRestore endpoint.
|
|
2873
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
2874
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
2875
|
+
*
|
|
2876
|
+
|
|
2877
|
+
*
|
|
2878
|
+
* @path /v1/domains/{domain_reference}/restore
|
|
2879
|
+
*
|
|
2880
|
+
* @see {@link POST_DomainsByDomainReferenceRestore_Response_200} - 200 response type
|
|
2881
|
+
* @see {@link POST_DomainsByDomainReferenceRestore_Response_422} - 422 response type
|
|
2882
|
+
*
|
|
2883
|
+
|
|
2884
|
+
*/
|
|
2885
|
+
export type POST_DomainsByDomainReferenceRestore_Response = POST_DomainsByDomainReferenceRestore_Response_200 | POST_DomainsByDomainReferenceRestore_Response_422;
|
|
2886
|
+
|
|
2887
|
+
/**
|
|
2888
|
+
* 200 response for POST DomainsByDomainReferenceRestore endpoint
|
|
2889
|
+
*
|
|
2890
|
+
* @remarks
|
|
2891
|
+
* This type defines the response structure for the 200 status code
|
|
2892
|
+
* of the POST DomainsByDomainReferenceRestore endpoint.
|
|
2893
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
2894
|
+
*
|
|
2895
|
+
|
|
2896
|
+
*
|
|
2897
|
+
* @path /v1/domains/{domain_reference}/restore
|
|
2898
|
+
*
|
|
2899
|
+
* @see {@link POST_DomainsByDomainReferenceRestore_Response} - The main response type definition
|
|
2900
|
+
* @see {@link DomainRestore} - The actual schema type definition
|
|
2901
|
+
*/
|
|
2902
|
+
export type POST_DomainsByDomainReferenceRestore_Response_200 = DomainRestore
|
|
2903
|
+
|
|
2904
|
+
/**
|
|
2905
|
+
* 422 response for POST DomainsByDomainReferenceRestore endpoint
|
|
2906
|
+
*
|
|
2907
|
+
* @remarks
|
|
2908
|
+
* This type defines the response structure for the 422 status code
|
|
2909
|
+
* of the POST DomainsByDomainReferenceRestore endpoint.
|
|
2910
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
2911
|
+
*
|
|
2912
|
+
|
|
2913
|
+
*
|
|
2914
|
+
* @path /v1/domains/{domain_reference}/restore
|
|
2915
|
+
*
|
|
2916
|
+
* @see {@link POST_DomainsByDomainReferenceRestore_Response} - The main response type definition
|
|
2917
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
2918
|
+
*/
|
|
2919
|
+
export type POST_DomainsByDomainReferenceRestore_Response_422 = HTTPValidationError
|
|
2920
|
+
|
|
2866
2921
|
/**
|
|
2867
2922
|
* Response types for DELETE DomainsByDomainReferenceTransfer endpoint
|
|
2868
2923
|
*
|
package/src/helpers/schemas.d.ts
CHANGED
|
@@ -1034,6 +1034,38 @@ export type DomainRenew = components['schemas']['DomainRenewResponse'];
|
|
|
1034
1034
|
* @see {@link components} - The OpenAPI components schema definition
|
|
1035
1035
|
*/
|
|
1036
1036
|
export type Domain = components['schemas']['DomainResponse'];
|
|
1037
|
+
/**
|
|
1038
|
+
* DomainRestoreRequest
|
|
1039
|
+
*
|
|
1040
|
+
* @remarks
|
|
1041
|
+
* Type alias for the `DomainRestoreRequest` OpenAPI schema.
|
|
1042
|
+
* This type represents domainrestorerequest data structures used in API requests and responses.
|
|
1043
|
+
*
|
|
1044
|
+
* @example
|
|
1045
|
+
* ```typescript
|
|
1046
|
+
* const response = await api.getDomainRestoreRequest();
|
|
1047
|
+
* const item: DomainRestoreRequest = response.results;
|
|
1048
|
+
* ```
|
|
1049
|
+
*
|
|
1050
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1051
|
+
*/
|
|
1052
|
+
export type DomainRestoreRequest = components['schemas']['DomainRestoreRequest'];
|
|
1053
|
+
/**
|
|
1054
|
+
* DomainRestoreResponse
|
|
1055
|
+
*
|
|
1056
|
+
* @remarks
|
|
1057
|
+
* Type alias for the `DomainRestoreResponse` OpenAPI schema.
|
|
1058
|
+
* This type represents domainrestoreresponse data structures used in API requests and responses.
|
|
1059
|
+
*
|
|
1060
|
+
* @example
|
|
1061
|
+
* ```typescript
|
|
1062
|
+
* const response = await api.getDomainRestore();
|
|
1063
|
+
* const item: DomainRestore = response.results;
|
|
1064
|
+
* ```
|
|
1065
|
+
*
|
|
1066
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1067
|
+
*/
|
|
1068
|
+
export type DomainRestore = components['schemas']['DomainRestoreResponse'];
|
|
1037
1069
|
/**
|
|
1038
1070
|
* DomainSearchMeta
|
|
1039
1071
|
*
|
package/src/openapi.yaml
CHANGED
|
@@ -1738,6 +1738,59 @@ components:
|
|
|
1738
1738
|
- roid
|
|
1739
1739
|
title: DomainResponse
|
|
1740
1740
|
type: object
|
|
1741
|
+
DomainRestoreRequest:
|
|
1742
|
+
properties:
|
|
1743
|
+
additional_info:
|
|
1744
|
+
anyOf:
|
|
1745
|
+
- type: string
|
|
1746
|
+
- type: 'null'
|
|
1747
|
+
description: Additional information to include in the restore operation
|
|
1748
|
+
title: Additional Info
|
|
1749
|
+
auto_renew:
|
|
1750
|
+
default: true
|
|
1751
|
+
description: Whether to automatically renew the domain after restore
|
|
1752
|
+
title: Auto Renew
|
|
1753
|
+
type: boolean
|
|
1754
|
+
reason:
|
|
1755
|
+
description: Reason for restoring the domain
|
|
1756
|
+
title: Reason
|
|
1757
|
+
type: string
|
|
1758
|
+
required:
|
|
1759
|
+
- reason
|
|
1760
|
+
title: DomainRestoreRequest
|
|
1761
|
+
type: object
|
|
1762
|
+
DomainRestoreResponse:
|
|
1763
|
+
properties:
|
|
1764
|
+
domain_id:
|
|
1765
|
+
description: The ID of the restored domain
|
|
1766
|
+
examples:
|
|
1767
|
+
- domain_01h45ytscbebyvny4gc8cr8ma2
|
|
1768
|
+
format: typeid
|
|
1769
|
+
pattern: ^domain_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
1770
|
+
title: Domain Id
|
|
1771
|
+
type: string
|
|
1772
|
+
x-typeid-prefix: domain
|
|
1773
|
+
expiration_date:
|
|
1774
|
+
description: The new expiration date after restore
|
|
1775
|
+
format: date-time
|
|
1776
|
+
title: Expiration Date
|
|
1777
|
+
type: string
|
|
1778
|
+
name:
|
|
1779
|
+
description: The name of the restored domain
|
|
1780
|
+
title: Name
|
|
1781
|
+
type: string
|
|
1782
|
+
restored_at:
|
|
1783
|
+
description: When the domain restore operation was completed
|
|
1784
|
+
format: date-time
|
|
1785
|
+
title: Restored At
|
|
1786
|
+
type: string
|
|
1787
|
+
required:
|
|
1788
|
+
- domain_id
|
|
1789
|
+
- name
|
|
1790
|
+
- expiration_date
|
|
1791
|
+
- restored_at
|
|
1792
|
+
title: DomainRestoreResponse
|
|
1793
|
+
type: object
|
|
1741
1794
|
DomainSearchMeta:
|
|
1742
1795
|
properties:
|
|
1743
1796
|
processing_time_ms:
|
|
@@ -5271,7 +5324,7 @@ info:
|
|
|
5271
5324
|
'
|
|
5272
5325
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
5273
5326
|
title: OpusDNS API
|
|
5274
|
-
version: 2025-09-
|
|
5327
|
+
version: 2025-09-16-171129
|
|
5275
5328
|
x-logo:
|
|
5276
5329
|
altText: OpusDNS API Reference
|
|
5277
5330
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -7758,6 +7811,47 @@ paths:
|
|
|
7758
7811
|
summary: Renew a domain
|
|
7759
7812
|
tags:
|
|
7760
7813
|
- domain
|
|
7814
|
+
/v1/domains/{domain_reference}/restore:
|
|
7815
|
+
post:
|
|
7816
|
+
operationId: restore_domain_v1_domains__domain_reference__restore_post
|
|
7817
|
+
parameters:
|
|
7818
|
+
- in: path
|
|
7819
|
+
name: domain_reference
|
|
7820
|
+
required: true
|
|
7821
|
+
schema:
|
|
7822
|
+
anyOf:
|
|
7823
|
+
- examples:
|
|
7824
|
+
- domain_01h45ytscbebyvny4gc8cr8ma2
|
|
7825
|
+
format: typeid
|
|
7826
|
+
pattern: ^domain_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
7827
|
+
type: string
|
|
7828
|
+
x-typeid-prefix: domain
|
|
7829
|
+
- type: string
|
|
7830
|
+
title: Domain Reference
|
|
7831
|
+
requestBody:
|
|
7832
|
+
content:
|
|
7833
|
+
application/json:
|
|
7834
|
+
schema:
|
|
7835
|
+
$ref: '#/components/schemas/DomainRestoreRequest'
|
|
7836
|
+
required: true
|
|
7837
|
+
responses:
|
|
7838
|
+
'200':
|
|
7839
|
+
content:
|
|
7840
|
+
application/json:
|
|
7841
|
+
schema:
|
|
7842
|
+
$ref: '#/components/schemas/DomainRestoreResponse'
|
|
7843
|
+
description: Successful Response
|
|
7844
|
+
'422':
|
|
7845
|
+
content:
|
|
7846
|
+
application/problem+json:
|
|
7847
|
+
schema:
|
|
7848
|
+
$ref: '#/components/schemas/HTTPValidationError'
|
|
7849
|
+
description: Validation Error
|
|
7850
|
+
security:
|
|
7851
|
+
- OAuth2PasswordBearer: []
|
|
7852
|
+
summary: Restore Domain
|
|
7853
|
+
tags:
|
|
7854
|
+
- domain
|
|
7761
7855
|
/v1/domains/{domain_reference}/transfer:
|
|
7762
7856
|
delete:
|
|
7763
7857
|
description: This will cancel the in-progress domain transfer and delete the
|
package/src/schema.d.ts
CHANGED
|
@@ -600,6 +600,23 @@ export interface paths {
|
|
|
600
600
|
patch?: never;
|
|
601
601
|
trace?: never;
|
|
602
602
|
};
|
|
603
|
+
"/v1/domains/{domain_reference}/restore": {
|
|
604
|
+
parameters: {
|
|
605
|
+
query?: never;
|
|
606
|
+
header?: never;
|
|
607
|
+
path?: never;
|
|
608
|
+
cookie?: never;
|
|
609
|
+
};
|
|
610
|
+
get?: never;
|
|
611
|
+
put?: never;
|
|
612
|
+
/** Restore Domain */
|
|
613
|
+
post: operations["restore_domain_v1_domains__domain_reference__restore_post"];
|
|
614
|
+
delete?: never;
|
|
615
|
+
options?: never;
|
|
616
|
+
head?: never;
|
|
617
|
+
patch?: never;
|
|
618
|
+
trace?: never;
|
|
619
|
+
};
|
|
603
620
|
"/v1/domains/{domain_reference}/transfer": {
|
|
604
621
|
parameters: {
|
|
605
622
|
query?: never;
|
|
@@ -2352,6 +2369,51 @@ export interface components {
|
|
|
2352
2369
|
*/
|
|
2353
2370
|
updated_on?: Date;
|
|
2354
2371
|
};
|
|
2372
|
+
/** DomainRestoreRequest */
|
|
2373
|
+
DomainRestoreRequest: {
|
|
2374
|
+
/**
|
|
2375
|
+
* Additional Info
|
|
2376
|
+
* @description Additional information to include in the restore operation
|
|
2377
|
+
*/
|
|
2378
|
+
additional_info?: string | null;
|
|
2379
|
+
/**
|
|
2380
|
+
* Auto Renew
|
|
2381
|
+
* @description Whether to automatically renew the domain after restore
|
|
2382
|
+
* @default true
|
|
2383
|
+
*/
|
|
2384
|
+
auto_renew: boolean;
|
|
2385
|
+
/**
|
|
2386
|
+
* Reason
|
|
2387
|
+
* @description Reason for restoring the domain
|
|
2388
|
+
*/
|
|
2389
|
+
reason: string;
|
|
2390
|
+
};
|
|
2391
|
+
/** DomainRestoreResponse */
|
|
2392
|
+
DomainRestoreResponse: {
|
|
2393
|
+
/**
|
|
2394
|
+
* Domain Id
|
|
2395
|
+
* Format: typeid
|
|
2396
|
+
* @description The ID of the restored domain
|
|
2397
|
+
*/
|
|
2398
|
+
domain_id: TypeId<"domain">;
|
|
2399
|
+
/**
|
|
2400
|
+
* Expiration Date
|
|
2401
|
+
* Format: date-time
|
|
2402
|
+
* @description The new expiration date after restore
|
|
2403
|
+
*/
|
|
2404
|
+
expiration_date: Date;
|
|
2405
|
+
/**
|
|
2406
|
+
* Name
|
|
2407
|
+
* @description The name of the restored domain
|
|
2408
|
+
*/
|
|
2409
|
+
name: string;
|
|
2410
|
+
/**
|
|
2411
|
+
* Restored At
|
|
2412
|
+
* Format: date-time
|
|
2413
|
+
* @description When the domain restore operation was completed
|
|
2414
|
+
*/
|
|
2415
|
+
restored_at: Date;
|
|
2416
|
+
};
|
|
2355
2417
|
/** DomainSearchMeta */
|
|
2356
2418
|
DomainSearchMeta: {
|
|
2357
2419
|
/** Processing Time Ms */
|
|
@@ -6902,6 +6964,41 @@ export interface operations {
|
|
|
6902
6964
|
};
|
|
6903
6965
|
};
|
|
6904
6966
|
};
|
|
6967
|
+
restore_domain_v1_domains__domain_reference__restore_post: {
|
|
6968
|
+
parameters: {
|
|
6969
|
+
query?: never;
|
|
6970
|
+
header?: never;
|
|
6971
|
+
path: {
|
|
6972
|
+
domain_reference: TypeId<"domain"> | string;
|
|
6973
|
+
};
|
|
6974
|
+
cookie?: never;
|
|
6975
|
+
};
|
|
6976
|
+
requestBody: {
|
|
6977
|
+
content: {
|
|
6978
|
+
"application/json": components["schemas"]["DomainRestoreRequest"];
|
|
6979
|
+
};
|
|
6980
|
+
};
|
|
6981
|
+
responses: {
|
|
6982
|
+
/** @description Successful Response */
|
|
6983
|
+
200: {
|
|
6984
|
+
headers: {
|
|
6985
|
+
[name: string]: unknown;
|
|
6986
|
+
};
|
|
6987
|
+
content: {
|
|
6988
|
+
"application/json": components["schemas"]["DomainRestoreResponse"];
|
|
6989
|
+
};
|
|
6990
|
+
};
|
|
6991
|
+
/** @description Validation Error */
|
|
6992
|
+
422: {
|
|
6993
|
+
headers: {
|
|
6994
|
+
[name: string]: unknown;
|
|
6995
|
+
};
|
|
6996
|
+
content: {
|
|
6997
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
6998
|
+
};
|
|
6999
|
+
};
|
|
7000
|
+
};
|
|
7001
|
+
};
|
|
6905
7002
|
cancel_domain_transfer_v1_domains__domain_reference__transfer_delete: {
|
|
6906
7003
|
parameters: {
|
|
6907
7004
|
query?: never;
|