@opusdns/api 0.63.0 → 0.65.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 +1 -57
- package/src/helpers/keys.ts +106 -50
- package/src/helpers/requests.d.ts +2 -2
- package/src/helpers/schemas.d.ts +12 -28
- package/src/openapi.yaml +22 -18
- package/src/schema.d.ts +21 -11
package/package.json
CHANGED
package/src/helpers/constants.ts
CHANGED
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
* ```
|
|
22
22
|
*/
|
|
23
23
|
|
|
24
|
-
import { AgreementType, AllocationMethodType, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ContactRoleType, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainSortField, DomainStatus, EmailVerificationStatus, EventObjectType, EventSubtype, EventType, GrantType, LaunchPhaseType, LocalPresenceRequirementType, OrganizationCredentialStatus, OrganizationStatus, PatchOp, PeriodUnit, Permission,
|
|
24
|
+
import { AgreementType, AllocationMethodType, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ContactRoleType, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainSortField, DomainStatus, EmailVerificationStatus, EventObjectType, EventSubtype, EventType, GrantType, LaunchPhaseType, LocalPresenceRequirementType, OrganizationCredentialStatus, OrganizationStatus, PatchOp, PeriodUnit, Permission, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TransferAckType, UserStatus, VerificationType, WalletCreditResponseStatus, ZoneSortField } from './schemas';
|
|
25
25
|
|
|
26
26
|
/**
|
|
27
27
|
* AgreementType. Auto-generated enum for AgreementType
|
|
@@ -1919,62 +1919,6 @@ export const PERMISSION_VALUES = [
|
|
|
1919
1919
|
'view_events'
|
|
1920
1920
|
] as const satisfies [string, ...string[]] | Permission[];
|
|
1921
1921
|
|
|
1922
|
-
/**
|
|
1923
|
-
* PlanRelation. Auto-generated enum for PlanRelation
|
|
1924
|
-
*
|
|
1925
|
-
* @remarks
|
|
1926
|
-
* This constant provides both object and array forms for the PlanRelation enum.
|
|
1927
|
-
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
1928
|
-
*
|
|
1929
|
-
* @example
|
|
1930
|
-
* ```typescript
|
|
1931
|
-
* // Using the object form for key-value access
|
|
1932
|
-
* const status = PLAN_RELATION.SUCCESS;
|
|
1933
|
-
*
|
|
1934
|
-
* // Using the array form for iteration
|
|
1935
|
-
* const allStatuses = PLAN_RELATION_VALUES;
|
|
1936
|
-
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
1937
|
-
* ```
|
|
1938
|
-
*
|
|
1939
|
-
* @see {@link PlanRelation} - The TypeScript type definition
|
|
1940
|
-
*/
|
|
1941
|
-
export const PLAN_RELATION = {
|
|
1942
|
-
BASIC: "basic",
|
|
1943
|
-
ENTERPRISE: "enterprise",
|
|
1944
|
-
CORPORATE: "corporate",
|
|
1945
|
-
PREMIUM: "premium",
|
|
1946
|
-
STARTER: "starter",
|
|
1947
|
-
} as const satisfies Record<string, PlanRelation>;
|
|
1948
|
-
|
|
1949
|
-
/**
|
|
1950
|
-
* Array of all PlanRelation enum values
|
|
1951
|
-
*
|
|
1952
|
-
* @remarks
|
|
1953
|
-
* This constant provides a array containing all valid PlanRelation enum values.
|
|
1954
|
-
* Useful for iteration, validation, and generating dynamic UI components.
|
|
1955
|
-
*
|
|
1956
|
-
* @example
|
|
1957
|
-
* ```typescript
|
|
1958
|
-
* // Iterating through all values
|
|
1959
|
-
* for (const value of PLAN_RELATION_VALUES) {
|
|
1960
|
-
* console.log(`Processing: ${value}`);
|
|
1961
|
-
* }
|
|
1962
|
-
*
|
|
1963
|
-
* // Validation
|
|
1964
|
-
* const isValid = PLAN_RELATION_VALUES.includes(someValue);
|
|
1965
|
-
* ```
|
|
1966
|
-
*
|
|
1967
|
-
* @see {@link PlanRelation} - The TypeScript type definition
|
|
1968
|
-
* @see {@link PLAN_RELATION} - The object form of this enum
|
|
1969
|
-
*/
|
|
1970
|
-
export const PLAN_RELATION_VALUES = [
|
|
1971
|
-
'basic',
|
|
1972
|
-
'enterprise',
|
|
1973
|
-
'corporate',
|
|
1974
|
-
'premium',
|
|
1975
|
-
'starter'
|
|
1976
|
-
] as const satisfies [string, ...string[]] | PlanRelation[];
|
|
1977
|
-
|
|
1978
1922
|
/**
|
|
1979
1923
|
* PostTransferRequirements. Auto-generated enum for PostTransferRequirements
|
|
1980
1924
|
*
|
package/src/helpers/keys.ts
CHANGED
|
@@ -120,8 +120,8 @@ import { PaginationMetadata } from './schemas';
|
|
|
120
120
|
import { PasswordUpdate } from './schemas';
|
|
121
121
|
import { Period } from './schemas';
|
|
122
122
|
import { PermissionSet } from './schemas';
|
|
123
|
+
import { PlanIdRequest } from './schemas';
|
|
123
124
|
import { PlanInfo } from './schemas';
|
|
124
|
-
import { PlanUpdate } from './schemas';
|
|
125
125
|
import { PremiumDomainsBase } from './schemas';
|
|
126
126
|
import { PriceInfo } from './schemas';
|
|
127
127
|
import { PricingPeriod } from './schemas';
|
|
@@ -5712,6 +5712,32 @@ export const KEY_DOMAIN_CREATE_AUTH_CODE = 'auth_code' as keyof DomainCreate;
|
|
|
5712
5712
|
* @see {@link KEYS_DOMAIN_CREATE} - Array of all keys for this type
|
|
5713
5713
|
*/
|
|
5714
5714
|
export const KEY_DOMAIN_CREATE_CONTACTS = 'contacts' as keyof DomainCreate;
|
|
5715
|
+
/**
|
|
5716
|
+
* Create Zone
|
|
5717
|
+
*
|
|
5718
|
+
* Create a zone for the domain on OpusDNS nameserver infrastructure
|
|
5719
|
+
*
|
|
5720
|
+
* @type {boolean}
|
|
5721
|
+
*
|
|
5722
|
+
*
|
|
5723
|
+
* @remarks
|
|
5724
|
+
* This key constant provides type-safe access to the `create_zone` property of DomainCreate objects.
|
|
5725
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
5726
|
+
*
|
|
5727
|
+
* @example
|
|
5728
|
+
* ```typescript
|
|
5729
|
+
* // Direct property access
|
|
5730
|
+
* const value = domaincreate[KEY_DOMAIN_CREATE_CREATE_ZONE];
|
|
5731
|
+
*
|
|
5732
|
+
* // Dynamic property access
|
|
5733
|
+
* const propertyName = KEY_DOMAIN_CREATE_CREATE_ZONE;
|
|
5734
|
+
* const value = domaincreate[propertyName];
|
|
5735
|
+
* ```
|
|
5736
|
+
*
|
|
5737
|
+
* @see {@link DomainCreate} - The TypeScript type definition
|
|
5738
|
+
* @see {@link KEYS_DOMAIN_CREATE} - Array of all keys for this type
|
|
5739
|
+
*/
|
|
5740
|
+
export const KEY_DOMAIN_CREATE_CREATE_ZONE = 'create_zone' as keyof DomainCreate;
|
|
5715
5741
|
/**
|
|
5716
5742
|
* Name
|
|
5717
5743
|
*
|
|
@@ -5837,6 +5863,7 @@ export const KEY_DOMAIN_CREATE_RENEWAL_MODE = 'renewal_mode' as keyof DomainCrea
|
|
|
5837
5863
|
export const KEYS_DOMAIN_CREATE = [
|
|
5838
5864
|
KEY_DOMAIN_CREATE_AUTH_CODE,
|
|
5839
5865
|
KEY_DOMAIN_CREATE_CONTACTS,
|
|
5866
|
+
KEY_DOMAIN_CREATE_CREATE_ZONE,
|
|
5840
5867
|
KEY_DOMAIN_CREATE_NAME,
|
|
5841
5868
|
KEY_DOMAIN_CREATE_NAMESERVERS,
|
|
5842
5869
|
KEY_DOMAIN_CREATE_PERIOD,
|
|
@@ -8665,6 +8692,32 @@ export const KEY_DOMAIN_TRANSFER_IN_AUTH_CODE = 'auth_code' as keyof DomainTrans
|
|
|
8665
8692
|
* @see {@link KEYS_DOMAIN_TRANSFER_IN} - Array of all keys for this type
|
|
8666
8693
|
*/
|
|
8667
8694
|
export const KEY_DOMAIN_TRANSFER_IN_CONTACTS = 'contacts' as keyof DomainTransferIn;
|
|
8695
|
+
/**
|
|
8696
|
+
* Create Zone
|
|
8697
|
+
*
|
|
8698
|
+
* Create a zone for the domain on OpusDNS nameserver infrastructure
|
|
8699
|
+
*
|
|
8700
|
+
* @type {boolean}
|
|
8701
|
+
*
|
|
8702
|
+
*
|
|
8703
|
+
* @remarks
|
|
8704
|
+
* This key constant provides type-safe access to the `create_zone` property of DomainTransferIn objects.
|
|
8705
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
8706
|
+
*
|
|
8707
|
+
* @example
|
|
8708
|
+
* ```typescript
|
|
8709
|
+
* // Direct property access
|
|
8710
|
+
* const value = domaintransferin[KEY_DOMAIN_TRANSFER_IN_CREATE_ZONE];
|
|
8711
|
+
*
|
|
8712
|
+
* // Dynamic property access
|
|
8713
|
+
* const propertyName = KEY_DOMAIN_TRANSFER_IN_CREATE_ZONE;
|
|
8714
|
+
* const value = domaintransferin[propertyName];
|
|
8715
|
+
* ```
|
|
8716
|
+
*
|
|
8717
|
+
* @see {@link DomainTransferIn} - The TypeScript type definition
|
|
8718
|
+
* @see {@link KEYS_DOMAIN_TRANSFER_IN} - Array of all keys for this type
|
|
8719
|
+
*/
|
|
8720
|
+
export const KEY_DOMAIN_TRANSFER_IN_CREATE_ZONE = 'create_zone' as keyof DomainTransferIn;
|
|
8668
8721
|
/**
|
|
8669
8722
|
* Name
|
|
8670
8723
|
*
|
|
@@ -8765,6 +8818,7 @@ export const KEY_DOMAIN_TRANSFER_IN_RENEWAL_MODE = 'renewal_mode' as keyof Domai
|
|
|
8765
8818
|
export const KEYS_DOMAIN_TRANSFER_IN = [
|
|
8766
8819
|
KEY_DOMAIN_TRANSFER_IN_AUTH_CODE,
|
|
8767
8820
|
KEY_DOMAIN_TRANSFER_IN_CONTACTS,
|
|
8821
|
+
KEY_DOMAIN_TRANSFER_IN_CREATE_ZONE,
|
|
8768
8822
|
KEY_DOMAIN_TRANSFER_IN_NAME,
|
|
8769
8823
|
KEY_DOMAIN_TRANSFER_IN_NAMESERVERS,
|
|
8770
8824
|
KEY_DOMAIN_TRANSFER_IN_RENEWAL_MODE,
|
|
@@ -14511,6 +14565,57 @@ export const KEYS_PERMISSION_SET = [
|
|
|
14511
14565
|
KEY_PERMISSION_SET_PERMISSIONS,
|
|
14512
14566
|
] as const satisfies (keyof PermissionSet)[];
|
|
14513
14567
|
|
|
14568
|
+
/**
|
|
14569
|
+
* Plan Id
|
|
14570
|
+
*
|
|
14571
|
+
* Plan ID from available plans
|
|
14572
|
+
*
|
|
14573
|
+
* @type {string}
|
|
14574
|
+
*
|
|
14575
|
+
*
|
|
14576
|
+
* @remarks
|
|
14577
|
+
* This key constant provides type-safe access to the `plan_id` property of PlanIdRequest objects.
|
|
14578
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
14579
|
+
*
|
|
14580
|
+
* @example
|
|
14581
|
+
* ```typescript
|
|
14582
|
+
* // Direct property access
|
|
14583
|
+
* const value = planidrequest[KEY_PLAN_ID_REQUEST_PLAN_ID];
|
|
14584
|
+
*
|
|
14585
|
+
* // Dynamic property access
|
|
14586
|
+
* const propertyName = KEY_PLAN_ID_REQUEST_PLAN_ID;
|
|
14587
|
+
* const value = planidrequest[propertyName];
|
|
14588
|
+
* ```
|
|
14589
|
+
*
|
|
14590
|
+
* @see {@link PlanIdRequest} - The TypeScript type definition
|
|
14591
|
+
* @see {@link KEYS_PLAN_ID_REQUEST} - Array of all keys for this type
|
|
14592
|
+
*/
|
|
14593
|
+
export const KEY_PLAN_ID_REQUEST_PLAN_ID = 'plan_id' as keyof PlanIdRequest;
|
|
14594
|
+
|
|
14595
|
+
/**
|
|
14596
|
+
* Array of all PlanIdRequest property keys
|
|
14597
|
+
*
|
|
14598
|
+
* @remarks
|
|
14599
|
+
* This constant provides a readonly array containing all valid property keys for PlanIdRequest objects.
|
|
14600
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
14601
|
+
*
|
|
14602
|
+
* @example
|
|
14603
|
+
* ```typescript
|
|
14604
|
+
* // Iterating through all keys
|
|
14605
|
+
* for (const key of KEYS_PLAN_ID_REQUEST) {
|
|
14606
|
+
* console.log(`Property: ${key}, Value: ${planidrequest[key]}`);
|
|
14607
|
+
* }
|
|
14608
|
+
*
|
|
14609
|
+
* // Validation
|
|
14610
|
+
* const isValidKey = KEYS_PLAN_ID_REQUEST.includes(someKey);
|
|
14611
|
+
* ```
|
|
14612
|
+
*
|
|
14613
|
+
* @see {@link PlanIdRequest} - The TypeScript type definition
|
|
14614
|
+
*/
|
|
14615
|
+
export const KEYS_PLAN_ID_REQUEST = [
|
|
14616
|
+
KEY_PLAN_ID_REQUEST_PLAN_ID,
|
|
14617
|
+
] as const satisfies (keyof PlanIdRequest)[];
|
|
14618
|
+
|
|
14514
14619
|
/**
|
|
14515
14620
|
* Amount
|
|
14516
14621
|
*
|
|
@@ -14694,55 +14799,6 @@ export const KEYS_PLAN_INFO = [
|
|
|
14694
14799
|
KEY_PLAN_INFO_PLAN_TYPE,
|
|
14695
14800
|
] as const satisfies (keyof PlanInfo)[];
|
|
14696
14801
|
|
|
14697
|
-
/**
|
|
14698
|
-
* plan property
|
|
14699
|
-
*
|
|
14700
|
-
*
|
|
14701
|
-
*
|
|
14702
|
-
*
|
|
14703
|
-
* @remarks
|
|
14704
|
-
* This key constant provides type-safe access to the `plan` property of PlanUpdate objects.
|
|
14705
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
14706
|
-
*
|
|
14707
|
-
* @example
|
|
14708
|
-
* ```typescript
|
|
14709
|
-
* // Direct property access
|
|
14710
|
-
* const value = planupdate[KEY_PLAN_UPDATE_PLAN];
|
|
14711
|
-
*
|
|
14712
|
-
* // Dynamic property access
|
|
14713
|
-
* const propertyName = KEY_PLAN_UPDATE_PLAN;
|
|
14714
|
-
* const value = planupdate[propertyName];
|
|
14715
|
-
* ```
|
|
14716
|
-
*
|
|
14717
|
-
* @see {@link PlanUpdate} - The TypeScript type definition
|
|
14718
|
-
* @see {@link KEYS_PLAN_UPDATE} - Array of all keys for this type
|
|
14719
|
-
*/
|
|
14720
|
-
export const KEY_PLAN_UPDATE_PLAN = 'plan' as keyof PlanUpdate;
|
|
14721
|
-
|
|
14722
|
-
/**
|
|
14723
|
-
* Array of all PlanUpdate property keys
|
|
14724
|
-
*
|
|
14725
|
-
* @remarks
|
|
14726
|
-
* This constant provides a readonly array containing all valid property keys for PlanUpdate objects.
|
|
14727
|
-
* Useful for iteration, validation, and generating dynamic UI components.
|
|
14728
|
-
*
|
|
14729
|
-
* @example
|
|
14730
|
-
* ```typescript
|
|
14731
|
-
* // Iterating through all keys
|
|
14732
|
-
* for (const key of KEYS_PLAN_UPDATE) {
|
|
14733
|
-
* console.log(`Property: ${key}, Value: ${planupdate[key]}`);
|
|
14734
|
-
* }
|
|
14735
|
-
*
|
|
14736
|
-
* // Validation
|
|
14737
|
-
* const isValidKey = KEYS_PLAN_UPDATE.includes(someKey);
|
|
14738
|
-
* ```
|
|
14739
|
-
*
|
|
14740
|
-
* @see {@link PlanUpdate} - The TypeScript type definition
|
|
14741
|
-
*/
|
|
14742
|
-
export const KEYS_PLAN_UPDATE = [
|
|
14743
|
-
KEY_PLAN_UPDATE_PLAN,
|
|
14744
|
-
] as const satisfies (keyof PlanUpdate)[];
|
|
14745
|
-
|
|
14746
14802
|
/**
|
|
14747
14803
|
* Affects
|
|
14748
14804
|
*
|
|
@@ -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, DomainRestoreRequest, DomainTransferIn, EmailForwardAlias, EmailForwardAliasUpdate, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate, CheckoutSessionRequest, WalletCreditRequest,
|
|
37
|
+
import { OrganizationCredentialExtra, SignupCreate, ContactCreate, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatchOps, DnsZoneRrsetsCreate, DomainCreate, DomainUpdate, DomainRenewRequest, DomainRestoreRequest, DomainTransferIn, EmailForwardAlias, EmailForwardAliasUpdate, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate, CheckoutSessionRequest, WalletCreditRequest, PlanIdRequest, UserCreate, PasswordUpdate, UserUpdate, SpiceDbRelationshipUpdate } from './schemas.d';
|
|
38
38
|
|
|
39
39
|
/**
|
|
40
40
|
* Request type for GET AuthClientCredentials endpoint
|
|
@@ -3232,7 +3232,7 @@ export type PATCH_OrganizationsOrganizationIdPlan_Request = {
|
|
|
3232
3232
|
parameters: {
|
|
3233
3233
|
path: operations['change_plan_v1_organizations__organization_id__plan_patch']['parameters']['path'];
|
|
3234
3234
|
};
|
|
3235
|
-
requestBody:
|
|
3235
|
+
requestBody: PlanIdRequest;
|
|
3236
3236
|
}
|
|
3237
3237
|
/**
|
|
3238
3238
|
* Path parameters for PATCH /v1/organizations/{organization_id}/plan
|
package/src/helpers/schemas.d.ts
CHANGED
|
@@ -2256,53 +2256,37 @@ export type Permission = components['schemas']['Permission'];
|
|
|
2256
2256
|
*/
|
|
2257
2257
|
export type PermissionSet = components['schemas']['PermissionSet'];
|
|
2258
2258
|
/**
|
|
2259
|
-
*
|
|
2260
|
-
*
|
|
2261
|
-
* @remarks
|
|
2262
|
-
* Type alias for the `PlanInfo` OpenAPI schema.
|
|
2263
|
-
* This type represents planinfo data structures used in API requests and responses.
|
|
2264
|
-
*
|
|
2265
|
-
* @example
|
|
2266
|
-
* ```typescript
|
|
2267
|
-
* const response = await api.getPlanInfo();
|
|
2268
|
-
* const item: PlanInfo = response.results;
|
|
2269
|
-
* ```
|
|
2270
|
-
*
|
|
2271
|
-
* @see {@link components} - The OpenAPI components schema definition
|
|
2272
|
-
*/
|
|
2273
|
-
export type PlanInfo = components['schemas']['PlanInfo'];
|
|
2274
|
-
/**
|
|
2275
|
-
* PlanRelation
|
|
2259
|
+
* PlanIdRequest
|
|
2276
2260
|
*
|
|
2277
2261
|
* @remarks
|
|
2278
|
-
* Type alias for the `
|
|
2279
|
-
* This type represents
|
|
2262
|
+
* Type alias for the `PlanIdRequest` OpenAPI schema.
|
|
2263
|
+
* This type represents planidrequest data structures used in API requests and responses.
|
|
2280
2264
|
*
|
|
2281
2265
|
* @example
|
|
2282
2266
|
* ```typescript
|
|
2283
|
-
* const response = await api.
|
|
2284
|
-
* const item:
|
|
2267
|
+
* const response = await api.getPlanIdRequest();
|
|
2268
|
+
* const item: PlanIdRequest = response.results;
|
|
2285
2269
|
* ```
|
|
2286
2270
|
*
|
|
2287
2271
|
* @see {@link components} - The OpenAPI components schema definition
|
|
2288
2272
|
*/
|
|
2289
|
-
export type
|
|
2273
|
+
export type PlanIdRequest = components['schemas']['PlanIdRequest'];
|
|
2290
2274
|
/**
|
|
2291
|
-
*
|
|
2275
|
+
* PlanInfo
|
|
2292
2276
|
*
|
|
2293
2277
|
* @remarks
|
|
2294
|
-
* Type alias for the `
|
|
2295
|
-
* This type represents
|
|
2278
|
+
* Type alias for the `PlanInfo` OpenAPI schema.
|
|
2279
|
+
* This type represents planinfo data structures used in API requests and responses.
|
|
2296
2280
|
*
|
|
2297
2281
|
* @example
|
|
2298
2282
|
* ```typescript
|
|
2299
|
-
* const response = await api.
|
|
2300
|
-
* const item:
|
|
2283
|
+
* const response = await api.getPlanInfo();
|
|
2284
|
+
* const item: PlanInfo = response.results;
|
|
2301
2285
|
* ```
|
|
2302
2286
|
*
|
|
2303
2287
|
* @see {@link components} - The OpenAPI components schema definition
|
|
2304
2288
|
*/
|
|
2305
|
-
export type
|
|
2289
|
+
export type PlanInfo = components['schemas']['PlanInfo'];
|
|
2306
2290
|
/**
|
|
2307
2291
|
* PostTransferRequirements
|
|
2308
2292
|
*
|
package/src/openapi.yaml
CHANGED
|
@@ -1395,6 +1395,11 @@ components:
|
|
|
1395
1395
|
- $ref: '#/components/schemas/ContactIdList'
|
|
1396
1396
|
description: The contacts of the domain
|
|
1397
1397
|
title: Contacts
|
|
1398
|
+
create_zone:
|
|
1399
|
+
default: false
|
|
1400
|
+
description: Create a zone for the domain on OpusDNS nameserver infrastructure
|
|
1401
|
+
title: Create Zone
|
|
1402
|
+
type: boolean
|
|
1398
1403
|
name:
|
|
1399
1404
|
description: The domain to be created
|
|
1400
1405
|
title: Name
|
|
@@ -2122,6 +2127,11 @@ components:
|
|
|
2122
2127
|
- $ref: '#/components/schemas/ContactIdList'
|
|
2123
2128
|
description: The contacts of the domain
|
|
2124
2129
|
title: Contacts
|
|
2130
|
+
create_zone:
|
|
2131
|
+
default: false
|
|
2132
|
+
description: Create a zone for the domain on OpusDNS nameserver infrastructure
|
|
2133
|
+
title: Create Zone
|
|
2134
|
+
type: boolean
|
|
2125
2135
|
name:
|
|
2126
2136
|
description: The domain to be created
|
|
2127
2137
|
title: Name
|
|
@@ -3791,6 +3801,16 @@ components:
|
|
|
3791
3801
|
type: array
|
|
3792
3802
|
title: PermissionSet
|
|
3793
3803
|
type: object
|
|
3804
|
+
PlanIdRequest:
|
|
3805
|
+
properties:
|
|
3806
|
+
plan_id:
|
|
3807
|
+
description: Plan ID from available plans
|
|
3808
|
+
title: Plan Id
|
|
3809
|
+
type: string
|
|
3810
|
+
required:
|
|
3811
|
+
- plan_id
|
|
3812
|
+
title: PlanIdRequest
|
|
3813
|
+
type: object
|
|
3794
3814
|
PlanInfo:
|
|
3795
3815
|
properties:
|
|
3796
3816
|
amount:
|
|
@@ -3829,22 +3849,6 @@ components:
|
|
|
3829
3849
|
- amount
|
|
3830
3850
|
title: PlanInfo
|
|
3831
3851
|
type: object
|
|
3832
|
-
PlanRelation:
|
|
3833
|
-
enum:
|
|
3834
|
-
- basic
|
|
3835
|
-
- enterprise
|
|
3836
|
-
- corporate
|
|
3837
|
-
- premium
|
|
3838
|
-
- starter
|
|
3839
|
-
title: PlanRelation
|
|
3840
|
-
type: string
|
|
3841
|
-
PlanUpdate:
|
|
3842
|
-
properties:
|
|
3843
|
-
plan:
|
|
3844
|
-
$ref: '#/components/schemas/PlanRelation'
|
|
3845
|
-
default: basic
|
|
3846
|
-
title: PlanUpdate
|
|
3847
|
-
type: object
|
|
3848
3852
|
PostTransferRequirements:
|
|
3849
3853
|
enum:
|
|
3850
3854
|
- update_contacts
|
|
@@ -5124,7 +5128,7 @@ info:
|
|
|
5124
5128
|
'
|
|
5125
5129
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
5126
5130
|
title: OpusDNS API
|
|
5127
|
-
version: 2025-09-
|
|
5131
|
+
version: 2025-09-25-064650
|
|
5128
5132
|
x-logo:
|
|
5129
5133
|
altText: OpusDNS API Reference
|
|
5130
5134
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -8949,7 +8953,7 @@ paths:
|
|
|
8949
8953
|
content:
|
|
8950
8954
|
application/json:
|
|
8951
8955
|
schema:
|
|
8952
|
-
$ref: '#/components/schemas/
|
|
8956
|
+
$ref: '#/components/schemas/PlanIdRequest'
|
|
8953
8957
|
required: true
|
|
8954
8958
|
responses:
|
|
8955
8959
|
'200':
|
package/src/schema.d.ts
CHANGED
|
@@ -2164,6 +2164,12 @@ export interface components {
|
|
|
2164
2164
|
* @description The contacts of the domain
|
|
2165
2165
|
*/
|
|
2166
2166
|
contacts: components["schemas"]["DomainContactHandles"] | components["schemas"]["ContactIdList"];
|
|
2167
|
+
/**
|
|
2168
|
+
* Create Zone
|
|
2169
|
+
* @description Create a zone for the domain on OpusDNS nameserver infrastructure
|
|
2170
|
+
* @default false
|
|
2171
|
+
*/
|
|
2172
|
+
create_zone: boolean;
|
|
2167
2173
|
/**
|
|
2168
2174
|
* Name
|
|
2169
2175
|
* @description The domain to be created
|
|
@@ -2635,6 +2641,12 @@ export interface components {
|
|
|
2635
2641
|
* @description The contacts of the domain
|
|
2636
2642
|
*/
|
|
2637
2643
|
contacts: components["schemas"]["DomainContactHandles"] | components["schemas"]["ContactIdList"];
|
|
2644
|
+
/**
|
|
2645
|
+
* Create Zone
|
|
2646
|
+
* @description Create a zone for the domain on OpusDNS nameserver infrastructure
|
|
2647
|
+
* @default false
|
|
2648
|
+
*/
|
|
2649
|
+
create_zone: boolean;
|
|
2638
2650
|
/**
|
|
2639
2651
|
* Name
|
|
2640
2652
|
* @description The domain to be created
|
|
@@ -3691,6 +3703,14 @@ export interface components {
|
|
|
3691
3703
|
/** Permissions */
|
|
3692
3704
|
permissions?: components["schemas"]["Permission"][];
|
|
3693
3705
|
};
|
|
3706
|
+
/** PlanIdRequest */
|
|
3707
|
+
PlanIdRequest: {
|
|
3708
|
+
/**
|
|
3709
|
+
* Plan Id
|
|
3710
|
+
* @description Plan ID from available plans
|
|
3711
|
+
*/
|
|
3712
|
+
plan_id: string;
|
|
3713
|
+
};
|
|
3694
3714
|
/** PlanInfo */
|
|
3695
3715
|
PlanInfo: {
|
|
3696
3716
|
/**
|
|
@@ -3724,16 +3744,6 @@ export interface components {
|
|
|
3724
3744
|
*/
|
|
3725
3745
|
plan_type?: string | null;
|
|
3726
3746
|
};
|
|
3727
|
-
/**
|
|
3728
|
-
* PlanRelation
|
|
3729
|
-
* @enum {string}
|
|
3730
|
-
*/
|
|
3731
|
-
PlanRelation: "basic" | "enterprise" | "corporate" | "premium" | "starter";
|
|
3732
|
-
/** PlanUpdate */
|
|
3733
|
-
PlanUpdate: {
|
|
3734
|
-
/** @default basic */
|
|
3735
|
-
plan: components["schemas"]["PlanRelation"];
|
|
3736
|
-
};
|
|
3737
3747
|
/**
|
|
3738
3748
|
* PostTransferRequirements
|
|
3739
3749
|
* @enum {string}
|
|
@@ -8008,7 +8018,7 @@ export interface operations {
|
|
|
8008
8018
|
};
|
|
8009
8019
|
requestBody: {
|
|
8010
8020
|
content: {
|
|
8011
|
-
"application/json": components["schemas"]["
|
|
8021
|
+
"application/json": components["schemas"]["PlanIdRequest"];
|
|
8012
8022
|
};
|
|
8013
8023
|
};
|
|
8014
8024
|
responses: {
|