@opusdns/api 0.30.0 → 0.32.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 +159 -33
- package/src/helpers/responses.d.ts +19 -1
- package/src/helpers/schemas-arrays.d.ts +6 -6
- package/src/helpers/schemas.d.ts +22 -6
- package/src/openapi.yaml +37 -4
- package/src/schema.d.ts +28 -3
package/package.json
CHANGED
package/src/helpers/keys.ts
CHANGED
|
@@ -71,7 +71,8 @@ import { DomainRenew } from './schemas';
|
|
|
71
71
|
import { Domain } from './schemas';
|
|
72
72
|
import { DomainSearchMeta } from './schemas';
|
|
73
73
|
import { DomainSearch } from './schemas';
|
|
74
|
-
import {
|
|
74
|
+
import { DomainSearchSuggestionPriceData } from './schemas';
|
|
75
|
+
import { DomainSearchSuggestionWithPrice } from './schemas';
|
|
75
76
|
import { DomainStatusesBase } from './schemas';
|
|
76
77
|
import { DomainSummaryData } from './schemas';
|
|
77
78
|
import { DomainSummary } from './schemas';
|
|
@@ -6894,6 +6895,106 @@ export const KEYS_DOMAIN_SEARCH = [
|
|
|
6894
6895
|
KEY_DOMAIN_SEARCH_RESULTS,
|
|
6895
6896
|
] as const satisfies (keyof DomainSearch)[];
|
|
6896
6897
|
|
|
6898
|
+
/**
|
|
6899
|
+
* Amount
|
|
6900
|
+
*
|
|
6901
|
+
*
|
|
6902
|
+
*
|
|
6903
|
+
*
|
|
6904
|
+
* @remarks
|
|
6905
|
+
* This key constant provides type-safe access to the `amount` property of DomainSearchSuggestionPriceData objects.
|
|
6906
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
6907
|
+
*
|
|
6908
|
+
* @example
|
|
6909
|
+
* ```typescript
|
|
6910
|
+
* // Direct property access
|
|
6911
|
+
* const value = domainsearchsuggestionpricedata[KEY_DOMAIN_SEARCH_SUGGESTION_PRICE_DATA_AMOUNT];
|
|
6912
|
+
*
|
|
6913
|
+
* // Dynamic property access
|
|
6914
|
+
* const propertyName = KEY_DOMAIN_SEARCH_SUGGESTION_PRICE_DATA_AMOUNT;
|
|
6915
|
+
* const value = domainsearchsuggestionpricedata[propertyName];
|
|
6916
|
+
* ```
|
|
6917
|
+
*
|
|
6918
|
+
* @see {@link DomainSearchSuggestionPriceData} - The TypeScript type definition
|
|
6919
|
+
* @see {@link KEYS_DOMAIN_SEARCH_SUGGESTION_PRICE_DATA} - Array of all keys for this type
|
|
6920
|
+
*/
|
|
6921
|
+
export const KEY_DOMAIN_SEARCH_SUGGESTION_PRICE_DATA_AMOUNT = 'amount' as keyof DomainSearchSuggestionPriceData;
|
|
6922
|
+
/**
|
|
6923
|
+
* Currency
|
|
6924
|
+
*
|
|
6925
|
+
*
|
|
6926
|
+
* @type {string}
|
|
6927
|
+
*
|
|
6928
|
+
*
|
|
6929
|
+
* @remarks
|
|
6930
|
+
* This key constant provides type-safe access to the `currency` property of DomainSearchSuggestionPriceData objects.
|
|
6931
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
6932
|
+
*
|
|
6933
|
+
* @example
|
|
6934
|
+
* ```typescript
|
|
6935
|
+
* // Direct property access
|
|
6936
|
+
* const value = domainsearchsuggestionpricedata[KEY_DOMAIN_SEARCH_SUGGESTION_PRICE_DATA_CURRENCY];
|
|
6937
|
+
*
|
|
6938
|
+
* // Dynamic property access
|
|
6939
|
+
* const propertyName = KEY_DOMAIN_SEARCH_SUGGESTION_PRICE_DATA_CURRENCY;
|
|
6940
|
+
* const value = domainsearchsuggestionpricedata[propertyName];
|
|
6941
|
+
* ```
|
|
6942
|
+
*
|
|
6943
|
+
* @see {@link DomainSearchSuggestionPriceData} - The TypeScript type definition
|
|
6944
|
+
* @see {@link KEYS_DOMAIN_SEARCH_SUGGESTION_PRICE_DATA} - Array of all keys for this type
|
|
6945
|
+
*/
|
|
6946
|
+
export const KEY_DOMAIN_SEARCH_SUGGESTION_PRICE_DATA_CURRENCY = 'currency' as keyof DomainSearchSuggestionPriceData;
|
|
6947
|
+
/**
|
|
6948
|
+
* period property
|
|
6949
|
+
*
|
|
6950
|
+
*
|
|
6951
|
+
*
|
|
6952
|
+
*
|
|
6953
|
+
* @remarks
|
|
6954
|
+
* This key constant provides type-safe access to the `period` property of DomainSearchSuggestionPriceData objects.
|
|
6955
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
6956
|
+
*
|
|
6957
|
+
* @example
|
|
6958
|
+
* ```typescript
|
|
6959
|
+
* // Direct property access
|
|
6960
|
+
* const value = domainsearchsuggestionpricedata[KEY_DOMAIN_SEARCH_SUGGESTION_PRICE_DATA_PERIOD];
|
|
6961
|
+
*
|
|
6962
|
+
* // Dynamic property access
|
|
6963
|
+
* const propertyName = KEY_DOMAIN_SEARCH_SUGGESTION_PRICE_DATA_PERIOD;
|
|
6964
|
+
* const value = domainsearchsuggestionpricedata[propertyName];
|
|
6965
|
+
* ```
|
|
6966
|
+
*
|
|
6967
|
+
* @see {@link DomainSearchSuggestionPriceData} - The TypeScript type definition
|
|
6968
|
+
* @see {@link KEYS_DOMAIN_SEARCH_SUGGESTION_PRICE_DATA} - Array of all keys for this type
|
|
6969
|
+
*/
|
|
6970
|
+
export const KEY_DOMAIN_SEARCH_SUGGESTION_PRICE_DATA_PERIOD = 'period' as keyof DomainSearchSuggestionPriceData;
|
|
6971
|
+
|
|
6972
|
+
/**
|
|
6973
|
+
* Array of all DomainSearchSuggestionPriceData property keys
|
|
6974
|
+
*
|
|
6975
|
+
* @remarks
|
|
6976
|
+
* This constant provides a readonly array containing all valid property keys for DomainSearchSuggestionPriceData objects.
|
|
6977
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
6978
|
+
*
|
|
6979
|
+
* @example
|
|
6980
|
+
* ```typescript
|
|
6981
|
+
* // Iterating through all keys
|
|
6982
|
+
* for (const key of KEYS_DOMAIN_SEARCH_SUGGESTION_PRICE_DATA) {
|
|
6983
|
+
* console.log(`Property: ${key}, Value: ${domainsearchsuggestionpricedata[key]}`);
|
|
6984
|
+
* }
|
|
6985
|
+
*
|
|
6986
|
+
* // Validation
|
|
6987
|
+
* const isValidKey = KEYS_DOMAIN_SEARCH_SUGGESTION_PRICE_DATA.includes(someKey);
|
|
6988
|
+
* ```
|
|
6989
|
+
*
|
|
6990
|
+
* @see {@link DomainSearchSuggestionPriceData} - The TypeScript type definition
|
|
6991
|
+
*/
|
|
6992
|
+
export const KEYS_DOMAIN_SEARCH_SUGGESTION_PRICE_DATA = [
|
|
6993
|
+
KEY_DOMAIN_SEARCH_SUGGESTION_PRICE_DATA_AMOUNT,
|
|
6994
|
+
KEY_DOMAIN_SEARCH_SUGGESTION_PRICE_DATA_CURRENCY,
|
|
6995
|
+
KEY_DOMAIN_SEARCH_SUGGESTION_PRICE_DATA_PERIOD,
|
|
6996
|
+
] as const satisfies (keyof DomainSearchSuggestionPriceData)[];
|
|
6997
|
+
|
|
6897
6998
|
/**
|
|
6898
6999
|
* Available
|
|
6899
7000
|
*
|
|
@@ -6902,23 +7003,23 @@ export const KEYS_DOMAIN_SEARCH = [
|
|
|
6902
7003
|
*
|
|
6903
7004
|
*
|
|
6904
7005
|
* @remarks
|
|
6905
|
-
* This key constant provides type-safe access to the `available` property of
|
|
7006
|
+
* This key constant provides type-safe access to the `available` property of DomainSearchSuggestionWithPrice objects.
|
|
6906
7007
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
6907
7008
|
*
|
|
6908
7009
|
* @example
|
|
6909
7010
|
* ```typescript
|
|
6910
7011
|
* // Direct property access
|
|
6911
|
-
* const value =
|
|
7012
|
+
* const value = domainsearchsuggestionwithprice[KEY_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE_AVAILABLE];
|
|
6912
7013
|
*
|
|
6913
7014
|
* // Dynamic property access
|
|
6914
|
-
* const propertyName =
|
|
6915
|
-
* const value =
|
|
7015
|
+
* const propertyName = KEY_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE_AVAILABLE;
|
|
7016
|
+
* const value = domainsearchsuggestionwithprice[propertyName];
|
|
6916
7017
|
* ```
|
|
6917
7018
|
*
|
|
6918
|
-
* @see {@link
|
|
6919
|
-
* @see {@link
|
|
7019
|
+
* @see {@link DomainSearchSuggestionWithPrice} - The TypeScript type definition
|
|
7020
|
+
* @see {@link KEYS_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE} - Array of all keys for this type
|
|
6920
7021
|
*/
|
|
6921
|
-
export const
|
|
7022
|
+
export const KEY_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE_AVAILABLE = 'available' as keyof DomainSearchSuggestionWithPrice;
|
|
6922
7023
|
/**
|
|
6923
7024
|
* Domain
|
|
6924
7025
|
*
|
|
@@ -6927,23 +7028,23 @@ export const KEY_DOMAIN_SEARCH_SUGGESTION_AVAILABLE = 'available' as keyof Domai
|
|
|
6927
7028
|
*
|
|
6928
7029
|
*
|
|
6929
7030
|
* @remarks
|
|
6930
|
-
* This key constant provides type-safe access to the `domain` property of
|
|
7031
|
+
* This key constant provides type-safe access to the `domain` property of DomainSearchSuggestionWithPrice objects.
|
|
6931
7032
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
6932
7033
|
*
|
|
6933
7034
|
* @example
|
|
6934
7035
|
* ```typescript
|
|
6935
7036
|
* // Direct property access
|
|
6936
|
-
* const value =
|
|
7037
|
+
* const value = domainsearchsuggestionwithprice[KEY_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE_DOMAIN];
|
|
6937
7038
|
*
|
|
6938
7039
|
* // Dynamic property access
|
|
6939
|
-
* const propertyName =
|
|
6940
|
-
* const value =
|
|
7040
|
+
* const propertyName = KEY_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE_DOMAIN;
|
|
7041
|
+
* const value = domainsearchsuggestionwithprice[propertyName];
|
|
6941
7042
|
* ```
|
|
6942
7043
|
*
|
|
6943
|
-
* @see {@link
|
|
6944
|
-
* @see {@link
|
|
7044
|
+
* @see {@link DomainSearchSuggestionWithPrice} - The TypeScript type definition
|
|
7045
|
+
* @see {@link KEYS_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE} - Array of all keys for this type
|
|
6945
7046
|
*/
|
|
6946
|
-
export const
|
|
7047
|
+
export const KEY_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE_DOMAIN = 'domain' as keyof DomainSearchSuggestionWithPrice;
|
|
6947
7048
|
/**
|
|
6948
7049
|
* Premium
|
|
6949
7050
|
*
|
|
@@ -6952,49 +7053,74 @@ export const KEY_DOMAIN_SEARCH_SUGGESTION_DOMAIN = 'domain' as keyof DomainSearc
|
|
|
6952
7053
|
*
|
|
6953
7054
|
*
|
|
6954
7055
|
* @remarks
|
|
6955
|
-
* This key constant provides type-safe access to the `premium` property of
|
|
7056
|
+
* This key constant provides type-safe access to the `premium` property of DomainSearchSuggestionWithPrice objects.
|
|
7057
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
7058
|
+
*
|
|
7059
|
+
* @example
|
|
7060
|
+
* ```typescript
|
|
7061
|
+
* // Direct property access
|
|
7062
|
+
* const value = domainsearchsuggestionwithprice[KEY_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE_PREMIUM];
|
|
7063
|
+
*
|
|
7064
|
+
* // Dynamic property access
|
|
7065
|
+
* const propertyName = KEY_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE_PREMIUM;
|
|
7066
|
+
* const value = domainsearchsuggestionwithprice[propertyName];
|
|
7067
|
+
* ```
|
|
7068
|
+
*
|
|
7069
|
+
* @see {@link DomainSearchSuggestionWithPrice} - The TypeScript type definition
|
|
7070
|
+
* @see {@link KEYS_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE} - Array of all keys for this type
|
|
7071
|
+
*/
|
|
7072
|
+
export const KEY_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE_PREMIUM = 'premium' as keyof DomainSearchSuggestionWithPrice;
|
|
7073
|
+
/**
|
|
7074
|
+
* price property
|
|
7075
|
+
*
|
|
7076
|
+
*
|
|
7077
|
+
*
|
|
7078
|
+
*
|
|
7079
|
+
* @remarks
|
|
7080
|
+
* This key constant provides type-safe access to the `price` property of DomainSearchSuggestionWithPrice objects.
|
|
6956
7081
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
6957
7082
|
*
|
|
6958
7083
|
* @example
|
|
6959
7084
|
* ```typescript
|
|
6960
7085
|
* // Direct property access
|
|
6961
|
-
* const value =
|
|
7086
|
+
* const value = domainsearchsuggestionwithprice[KEY_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE_PRICE];
|
|
6962
7087
|
*
|
|
6963
7088
|
* // Dynamic property access
|
|
6964
|
-
* const propertyName =
|
|
6965
|
-
* const value =
|
|
7089
|
+
* const propertyName = KEY_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE_PRICE;
|
|
7090
|
+
* const value = domainsearchsuggestionwithprice[propertyName];
|
|
6966
7091
|
* ```
|
|
6967
7092
|
*
|
|
6968
|
-
* @see {@link
|
|
6969
|
-
* @see {@link
|
|
7093
|
+
* @see {@link DomainSearchSuggestionWithPrice} - The TypeScript type definition
|
|
7094
|
+
* @see {@link KEYS_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE} - Array of all keys for this type
|
|
6970
7095
|
*/
|
|
6971
|
-
export const
|
|
7096
|
+
export const KEY_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE_PRICE = 'price' as keyof DomainSearchSuggestionWithPrice;
|
|
6972
7097
|
|
|
6973
7098
|
/**
|
|
6974
|
-
* Array of all
|
|
7099
|
+
* Array of all DomainSearchSuggestionWithPrice property keys
|
|
6975
7100
|
*
|
|
6976
7101
|
* @remarks
|
|
6977
|
-
* This constant provides a readonly array containing all valid property keys for
|
|
7102
|
+
* This constant provides a readonly array containing all valid property keys for DomainSearchSuggestionWithPrice objects.
|
|
6978
7103
|
* Useful for iteration, validation, and generating dynamic UI components.
|
|
6979
7104
|
*
|
|
6980
7105
|
* @example
|
|
6981
7106
|
* ```typescript
|
|
6982
7107
|
* // Iterating through all keys
|
|
6983
|
-
* for (const key of
|
|
6984
|
-
* console.log(`Property: ${key}, Value: ${
|
|
7108
|
+
* for (const key of KEYS_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE) {
|
|
7109
|
+
* console.log(`Property: ${key}, Value: ${domainsearchsuggestionwithprice[key]}`);
|
|
6985
7110
|
* }
|
|
6986
7111
|
*
|
|
6987
7112
|
* // Validation
|
|
6988
|
-
* const isValidKey =
|
|
7113
|
+
* const isValidKey = KEYS_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE.includes(someKey);
|
|
6989
7114
|
* ```
|
|
6990
7115
|
*
|
|
6991
|
-
* @see {@link
|
|
7116
|
+
* @see {@link DomainSearchSuggestionWithPrice} - The TypeScript type definition
|
|
6992
7117
|
*/
|
|
6993
|
-
export const
|
|
6994
|
-
|
|
6995
|
-
|
|
6996
|
-
|
|
6997
|
-
|
|
7118
|
+
export const KEYS_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE = [
|
|
7119
|
+
KEY_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE_AVAILABLE,
|
|
7120
|
+
KEY_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE_DOMAIN,
|
|
7121
|
+
KEY_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE_PREMIUM,
|
|
7122
|
+
KEY_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE_PRICE,
|
|
7123
|
+
] as const satisfies (keyof DomainSearchSuggestionWithPrice)[];
|
|
6998
7124
|
|
|
6999
7125
|
/**
|
|
7000
7126
|
* Default
|
|
@@ -5178,11 +5178,29 @@ export type POST_Users_Response_422 = HTTPValidationError
|
|
|
5178
5178
|
*
|
|
5179
5179
|
* @path /v1/users/{user_id}
|
|
5180
5180
|
*
|
|
5181
|
+
* @see {@link DELETE_UsersByUserId_Response_409} - 409 response type
|
|
5181
5182
|
* @see {@link DELETE_UsersByUserId_Response_422} - 422 response type
|
|
5182
5183
|
*
|
|
5183
5184
|
|
|
5184
5185
|
*/
|
|
5185
|
-
export type DELETE_UsersByUserId_Response = DELETE_UsersByUserId_Response_422;
|
|
5186
|
+
export type DELETE_UsersByUserId_Response = DELETE_UsersByUserId_Response_409 | DELETE_UsersByUserId_Response_422;
|
|
5187
|
+
|
|
5188
|
+
/**
|
|
5189
|
+
* 409 response for DELETE UsersByUserId endpoint
|
|
5190
|
+
*
|
|
5191
|
+
* @remarks
|
|
5192
|
+
* This type defines the response structure for the 409 status code
|
|
5193
|
+
* of the DELETE UsersByUserId endpoint.
|
|
5194
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
5195
|
+
*
|
|
5196
|
+
|
|
5197
|
+
*
|
|
5198
|
+
* @path /v1/users/{user_id}
|
|
5199
|
+
*
|
|
5200
|
+
* @see {@link DELETE_UsersByUserId_Response} - The main response type definition
|
|
5201
|
+
* @see {@link Problem} - The actual schema type definition
|
|
5202
|
+
*/
|
|
5203
|
+
export type DELETE_UsersByUserId_Response_409 = Problem
|
|
5186
5204
|
|
|
5187
5205
|
/**
|
|
5188
5206
|
* 422 response for DELETE UsersByUserId endpoint
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
* This file is auto-generated from the OpenAPI specification.
|
|
22
22
|
* Do not edit manually.
|
|
23
23
|
*/
|
|
24
|
-
import { DomainDnssecData, DomainDnssecDataCreate, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, TldResponseShort, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, Nameserver, DeletePolicyType, SyncOperationType, DomainContact,
|
|
24
|
+
import { DomainDnssecData, DomainDnssecDataCreate, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, TldResponseShort, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, Nameserver, DeletePolicyType, SyncOperationType, DomainContact, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, PlanInfo, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, ContactRoleType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, ContactSchema, DnsZone, Domain, EmailForwardAlias, EventResponse, OrganizationCredential, Organization, UserNotificationSummary, Period, Permission, PremiumAffectsType, Relation, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
|
|
25
25
|
|
|
26
26
|
/**
|
|
27
27
|
* DomainDnssecDataResponse
|
|
@@ -304,19 +304,19 @@ export type SyncOperationTypeArray = SyncOperationType[];
|
|
|
304
304
|
*/
|
|
305
305
|
export type DomainContactArray = DomainContact[];
|
|
306
306
|
/**
|
|
307
|
-
*
|
|
307
|
+
* DomainSearchSuggestionWithPrice
|
|
308
308
|
*
|
|
309
309
|
* @remarks
|
|
310
|
-
* Array type for
|
|
310
|
+
* Array type for DomainSearchSuggestionWithPrice objects. Used when the API returns a collection of DomainSearchSuggestionWithPrice instances.
|
|
311
311
|
*
|
|
312
312
|
* @example
|
|
313
313
|
* ```typescript
|
|
314
|
-
* const items:
|
|
314
|
+
* const items: DomainSearchSuggestionWithPriceArray = await api.getDomainSearchSuggestionWithPrices();
|
|
315
315
|
* ```
|
|
316
316
|
*
|
|
317
|
-
* @see {@link
|
|
317
|
+
* @see {@link DomainSearchSuggestionWithPrice} - The individual DomainSearchSuggestionWithPrice type definition
|
|
318
318
|
*/
|
|
319
|
-
export type
|
|
319
|
+
export type DomainSearchSuggestionWithPriceArray = DomainSearchSuggestionWithPrice[];
|
|
320
320
|
/**
|
|
321
321
|
* DomainStatus
|
|
322
322
|
*
|
package/src/helpers/schemas.d.ts
CHANGED
|
@@ -987,21 +987,37 @@ export type DomainSearchMeta = components['schemas']['DomainSearchMeta'];
|
|
|
987
987
|
*/
|
|
988
988
|
export type DomainSearch = components['schemas']['DomainSearchResponse'];
|
|
989
989
|
/**
|
|
990
|
-
*
|
|
990
|
+
* DomainSearchSuggestionPriceData
|
|
991
991
|
*
|
|
992
992
|
* @remarks
|
|
993
|
-
* Type alias for the `
|
|
994
|
-
* This type represents
|
|
993
|
+
* Type alias for the `DomainSearchSuggestionPriceData` OpenAPI schema.
|
|
994
|
+
* This type represents domainsearchsuggestionpricedata data structures used in API requests and responses.
|
|
995
995
|
*
|
|
996
996
|
* @example
|
|
997
997
|
* ```typescript
|
|
998
|
-
* const response = await api.
|
|
999
|
-
* const item:
|
|
998
|
+
* const response = await api.getDomainSearchSuggestionPriceData();
|
|
999
|
+
* const item: DomainSearchSuggestionPriceData = response.results;
|
|
1000
1000
|
* ```
|
|
1001
1001
|
*
|
|
1002
1002
|
* @see {@link components} - The OpenAPI components schema definition
|
|
1003
1003
|
*/
|
|
1004
|
-
export type
|
|
1004
|
+
export type DomainSearchSuggestionPriceData = components['schemas']['DomainSearchSuggestionPriceData'];
|
|
1005
|
+
/**
|
|
1006
|
+
* DomainSearchSuggestionWithPrice
|
|
1007
|
+
*
|
|
1008
|
+
* @remarks
|
|
1009
|
+
* Type alias for the `DomainSearchSuggestionWithPrice` OpenAPI schema.
|
|
1010
|
+
* This type represents domainsearchsuggestionwithprice data structures used in API requests and responses.
|
|
1011
|
+
*
|
|
1012
|
+
* @example
|
|
1013
|
+
* ```typescript
|
|
1014
|
+
* const response = await api.getDomainSearchSuggestionWithPrice();
|
|
1015
|
+
* const item: DomainSearchSuggestionWithPrice = response.results;
|
|
1016
|
+
* ```
|
|
1017
|
+
*
|
|
1018
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1019
|
+
*/
|
|
1020
|
+
export type DomainSearchSuggestionWithPrice = components['schemas']['DomainSearchSuggestionWithPrice'];
|
|
1005
1021
|
/**
|
|
1006
1022
|
* DomainSortField
|
|
1007
1023
|
*
|
package/src/openapi.yaml
CHANGED
|
@@ -1654,7 +1654,7 @@ components:
|
|
|
1654
1654
|
$ref: '#/components/schemas/DomainSearchMeta'
|
|
1655
1655
|
results:
|
|
1656
1656
|
items:
|
|
1657
|
-
$ref: '#/components/schemas/
|
|
1657
|
+
$ref: '#/components/schemas/DomainSearchSuggestionWithPrice'
|
|
1658
1658
|
title: Results
|
|
1659
1659
|
type: array
|
|
1660
1660
|
required:
|
|
@@ -1662,7 +1662,25 @@ components:
|
|
|
1662
1662
|
- results
|
|
1663
1663
|
title: DomainSearchResponse
|
|
1664
1664
|
type: object
|
|
1665
|
-
|
|
1665
|
+
DomainSearchSuggestionPriceData:
|
|
1666
|
+
properties:
|
|
1667
|
+
amount:
|
|
1668
|
+
anyOf:
|
|
1669
|
+
- type: string
|
|
1670
|
+
- type: 'null'
|
|
1671
|
+
title: Amount
|
|
1672
|
+
currency:
|
|
1673
|
+
title: Currency
|
|
1674
|
+
type: string
|
|
1675
|
+
period:
|
|
1676
|
+
$ref: '#/components/schemas/DomainPeriod'
|
|
1677
|
+
required:
|
|
1678
|
+
- amount
|
|
1679
|
+
- currency
|
|
1680
|
+
- period
|
|
1681
|
+
title: DomainSearchSuggestionPriceData
|
|
1682
|
+
type: object
|
|
1683
|
+
DomainSearchSuggestionWithPrice:
|
|
1666
1684
|
properties:
|
|
1667
1685
|
available:
|
|
1668
1686
|
title: Available
|
|
@@ -1673,11 +1691,14 @@ components:
|
|
|
1673
1691
|
premium:
|
|
1674
1692
|
title: Premium
|
|
1675
1693
|
type: boolean
|
|
1694
|
+
price:
|
|
1695
|
+
$ref: '#/components/schemas/DomainSearchSuggestionPriceData'
|
|
1676
1696
|
required:
|
|
1677
1697
|
- domain
|
|
1678
1698
|
- available
|
|
1679
1699
|
- premium
|
|
1680
|
-
|
|
1700
|
+
- price
|
|
1701
|
+
title: DomainSearchSuggestionWithPrice
|
|
1681
1702
|
type: object
|
|
1682
1703
|
DomainSortField:
|
|
1683
1704
|
enum:
|
|
@@ -4910,7 +4931,7 @@ info:
|
|
|
4910
4931
|
'
|
|
4911
4932
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
4912
4933
|
title: OpusDNS API
|
|
4913
|
-
version: 2025-09-
|
|
4934
|
+
version: 2025-09-05-210401
|
|
4914
4935
|
x-logo:
|
|
4915
4936
|
altText: OpusDNS API Reference
|
|
4916
4937
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -8905,6 +8926,18 @@ paths:
|
|
|
8905
8926
|
responses:
|
|
8906
8927
|
'204':
|
|
8907
8928
|
description: Successful Response
|
|
8929
|
+
'409':
|
|
8930
|
+
content:
|
|
8931
|
+
application/problem+json:
|
|
8932
|
+
example:
|
|
8933
|
+
code: ERROR_USER_IS_LAST_ADMIN
|
|
8934
|
+
detail: User is the last admin for the organization
|
|
8935
|
+
status: 409
|
|
8936
|
+
title: User Management Error
|
|
8937
|
+
type: user-is-last-admin
|
|
8938
|
+
schema:
|
|
8939
|
+
$ref: '#/components/schemas/Problem'
|
|
8940
|
+
description: Conflict
|
|
8908
8941
|
'422':
|
|
8909
8942
|
content:
|
|
8910
8943
|
application/problem+json:
|
package/src/schema.d.ts
CHANGED
|
@@ -2212,16 +2212,25 @@ export interface components {
|
|
|
2212
2212
|
DomainSearchResponse: {
|
|
2213
2213
|
meta: components["schemas"]["DomainSearchMeta"];
|
|
2214
2214
|
/** Results */
|
|
2215
|
-
results: components["schemas"]["
|
|
2215
|
+
results: components["schemas"]["DomainSearchSuggestionWithPrice"][];
|
|
2216
2216
|
};
|
|
2217
|
-
/**
|
|
2218
|
-
|
|
2217
|
+
/** DomainSearchSuggestionPriceData */
|
|
2218
|
+
DomainSearchSuggestionPriceData: {
|
|
2219
|
+
/** Amount */
|
|
2220
|
+
amount: string | null;
|
|
2221
|
+
/** Currency */
|
|
2222
|
+
currency: string;
|
|
2223
|
+
period: components["schemas"]["DomainPeriod"];
|
|
2224
|
+
};
|
|
2225
|
+
/** DomainSearchSuggestionWithPrice */
|
|
2226
|
+
DomainSearchSuggestionWithPrice: {
|
|
2219
2227
|
/** Available */
|
|
2220
2228
|
available: boolean;
|
|
2221
2229
|
/** Domain */
|
|
2222
2230
|
domain: string;
|
|
2223
2231
|
/** Premium */
|
|
2224
2232
|
premium: boolean;
|
|
2233
|
+
price: components["schemas"]["DomainSearchSuggestionPriceData"];
|
|
2225
2234
|
};
|
|
2226
2235
|
/**
|
|
2227
2236
|
* DomainSortField
|
|
@@ -8031,6 +8040,22 @@ export interface operations {
|
|
|
8031
8040
|
};
|
|
8032
8041
|
content?: never;
|
|
8033
8042
|
};
|
|
8043
|
+
/** @description Conflict */
|
|
8044
|
+
409: {
|
|
8045
|
+
headers: {
|
|
8046
|
+
[name: string]: unknown;
|
|
8047
|
+
};
|
|
8048
|
+
content: {
|
|
8049
|
+
/** @example {
|
|
8050
|
+
* "code": "ERROR_USER_IS_LAST_ADMIN",
|
|
8051
|
+
* "detail": "User is the last admin for the organization",
|
|
8052
|
+
* "status": 409,
|
|
8053
|
+
* "title": "User Management Error",
|
|
8054
|
+
* "type": "user-is-last-admin"
|
|
8055
|
+
* } */
|
|
8056
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
8057
|
+
};
|
|
8058
|
+
};
|
|
8034
8059
|
/** @description Validation Error */
|
|
8035
8060
|
422: {
|
|
8036
8061
|
headers: {
|