@opusdns/api 0.75.0 → 0.77.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 +49 -1
- package/src/helpers/keys.ts +53 -1
- package/src/helpers/schemas.d.ts +16 -0
- package/src/openapi.yaml +24 -7
- package/src/schema.d.ts +18 -1
package/package.json
CHANGED
package/src/helpers/constants.ts
CHANGED
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
* ```
|
|
22
22
|
*/
|
|
23
23
|
|
|
24
|
-
import { AgreementType, AllocationMethodType, AttributeType, 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';
|
|
24
|
+
import { AgreementType, AllocationMethodType, AttributeType, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ContactRoleType, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAttributeKey, 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
|
|
@@ -957,6 +957,54 @@ export const DNSSEC_STATUS_VALUES = [
|
|
|
957
957
|
'disabled'
|
|
958
958
|
] as const satisfies [string, ...string[]] | DnssecStatus[];
|
|
959
959
|
|
|
960
|
+
/**
|
|
961
|
+
* DomainAttributeKey. Auto-generated enum for DomainAttributeKey
|
|
962
|
+
*
|
|
963
|
+
* @remarks
|
|
964
|
+
* This constant provides both object and array forms for the DomainAttributeKey enum.
|
|
965
|
+
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
966
|
+
*
|
|
967
|
+
* @example
|
|
968
|
+
* ```typescript
|
|
969
|
+
* // Using the object form for key-value access
|
|
970
|
+
* const status = DOMAIN_ATTRIBUTE_KEY.SUCCESS;
|
|
971
|
+
*
|
|
972
|
+
* // Using the array form for iteration
|
|
973
|
+
* const allStatuses = DOMAIN_ATTRIBUTE_KEY_VALUES;
|
|
974
|
+
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
975
|
+
* ```
|
|
976
|
+
*
|
|
977
|
+
* @see {@link DomainAttributeKey} - The TypeScript type definition
|
|
978
|
+
*/
|
|
979
|
+
export const DOMAIN_ATTRIBUTE_KEY = {
|
|
980
|
+
AUTO_RENEW_PERIOD: "auto_renew_period",
|
|
981
|
+
} as const satisfies Record<string, DomainAttributeKey>;
|
|
982
|
+
|
|
983
|
+
/**
|
|
984
|
+
* Array of all DomainAttributeKey enum values
|
|
985
|
+
*
|
|
986
|
+
* @remarks
|
|
987
|
+
* This constant provides a array containing all valid DomainAttributeKey enum values.
|
|
988
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
989
|
+
*
|
|
990
|
+
* @example
|
|
991
|
+
* ```typescript
|
|
992
|
+
* // Iterating through all values
|
|
993
|
+
* for (const value of DOMAIN_ATTRIBUTE_KEY_VALUES) {
|
|
994
|
+
* console.log(`Processing: ${value}`);
|
|
995
|
+
* }
|
|
996
|
+
*
|
|
997
|
+
* // Validation
|
|
998
|
+
* const isValid = DOMAIN_ATTRIBUTE_KEY_VALUES.includes(someValue);
|
|
999
|
+
* ```
|
|
1000
|
+
*
|
|
1001
|
+
* @see {@link DomainAttributeKey} - The TypeScript type definition
|
|
1002
|
+
* @see {@link DOMAIN_ATTRIBUTE_KEY} - The object form of this enum
|
|
1003
|
+
*/
|
|
1004
|
+
export const DOMAIN_ATTRIBUTE_KEY_VALUES = [
|
|
1005
|
+
'auto_renew_period'
|
|
1006
|
+
] as const satisfies [string, ...string[]] | DomainAttributeKey[];
|
|
1007
|
+
|
|
960
1008
|
/**
|
|
961
1009
|
* DomainAvailabilityStatus. Auto-generated enum for DomainAvailabilityStatus
|
|
962
1010
|
*
|
package/src/helpers/keys.ts
CHANGED
|
@@ -6110,7 +6110,7 @@ export const KEY_DOMAIN_CREATE_NAMESERVERS = 'nameservers' as keyof DomainCreate
|
|
|
6110
6110
|
/**
|
|
6111
6111
|
* period property
|
|
6112
6112
|
*
|
|
6113
|
-
*
|
|
6113
|
+
* The registration period of the domain
|
|
6114
6114
|
*
|
|
6115
6115
|
*
|
|
6116
6116
|
*
|
|
@@ -8959,6 +8959,31 @@ export const KEYS_DOMAIN_SUMMARY = [
|
|
|
8959
8959
|
KEY_DOMAIN_SUMMARY_ORGANIZATION_ID,
|
|
8960
8960
|
] as const satisfies (keyof DomainSummary)[];
|
|
8961
8961
|
|
|
8962
|
+
/**
|
|
8963
|
+
* Attributes
|
|
8964
|
+
*
|
|
8965
|
+
* Additional attributes of the domain
|
|
8966
|
+
*
|
|
8967
|
+
*
|
|
8968
|
+
*
|
|
8969
|
+
* @remarks
|
|
8970
|
+
* This key constant provides type-safe access to the `attributes` property of DomainTransferIn objects.
|
|
8971
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
8972
|
+
*
|
|
8973
|
+
* @example
|
|
8974
|
+
* ```typescript
|
|
8975
|
+
* // Direct property access
|
|
8976
|
+
* const value = domaintransferin[KEY_DOMAIN_TRANSFER_IN_ATTRIBUTES];
|
|
8977
|
+
*
|
|
8978
|
+
* // Dynamic property access
|
|
8979
|
+
* const propertyName = KEY_DOMAIN_TRANSFER_IN_ATTRIBUTES;
|
|
8980
|
+
* const value = domaintransferin[propertyName];
|
|
8981
|
+
* ```
|
|
8982
|
+
*
|
|
8983
|
+
* @see {@link DomainTransferIn} - The TypeScript type definition
|
|
8984
|
+
* @see {@link KEYS_DOMAIN_TRANSFER_IN} - Array of all keys for this type
|
|
8985
|
+
*/
|
|
8986
|
+
export const KEY_DOMAIN_TRANSFER_IN_ATTRIBUTES = 'attributes' as keyof DomainTransferIn;
|
|
8962
8987
|
/**
|
|
8963
8988
|
* Auth Code
|
|
8964
8989
|
*
|
|
@@ -9134,6 +9159,7 @@ export const KEY_DOMAIN_TRANSFER_IN_RENEWAL_MODE = 'renewal_mode' as keyof Domai
|
|
|
9134
9159
|
* @see {@link DomainTransferIn} - The TypeScript type definition
|
|
9135
9160
|
*/
|
|
9136
9161
|
export const KEYS_DOMAIN_TRANSFER_IN = [
|
|
9162
|
+
KEY_DOMAIN_TRANSFER_IN_ATTRIBUTES,
|
|
9137
9163
|
KEY_DOMAIN_TRANSFER_IN_AUTH_CODE,
|
|
9138
9164
|
KEY_DOMAIN_TRANSFER_IN_CONTACTS,
|
|
9139
9165
|
KEY_DOMAIN_TRANSFER_IN_CREATE_ZONE,
|
|
@@ -19720,6 +19746,31 @@ export const KEY_WALLET_CREDIT_RESPONSE_WITH_BALANCE_AMOUNT = 'amount' as keyof
|
|
|
19720
19746
|
* @see {@link KEYS_WALLET_CREDIT_RESPONSE_WITH_BALANCE} - Array of all keys for this type
|
|
19721
19747
|
*/
|
|
19722
19748
|
export const KEY_WALLET_CREDIT_RESPONSE_WITH_BALANCE_BALANCE = 'balance' as keyof WalletCreditResponseWithBalance;
|
|
19749
|
+
/**
|
|
19750
|
+
* Client Secret
|
|
19751
|
+
*
|
|
19752
|
+
* Client secret for 3DS authentication
|
|
19753
|
+
*
|
|
19754
|
+
*
|
|
19755
|
+
*
|
|
19756
|
+
* @remarks
|
|
19757
|
+
* This key constant provides type-safe access to the `client_secret` property of WalletCreditResponseWithBalance objects.
|
|
19758
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
19759
|
+
*
|
|
19760
|
+
* @example
|
|
19761
|
+
* ```typescript
|
|
19762
|
+
* // Direct property access
|
|
19763
|
+
* const value = walletcreditresponsewithbalance[KEY_WALLET_CREDIT_RESPONSE_WITH_BALANCE_CLIENT_SECRET];
|
|
19764
|
+
*
|
|
19765
|
+
* // Dynamic property access
|
|
19766
|
+
* const propertyName = KEY_WALLET_CREDIT_RESPONSE_WITH_BALANCE_CLIENT_SECRET;
|
|
19767
|
+
* const value = walletcreditresponsewithbalance[propertyName];
|
|
19768
|
+
* ```
|
|
19769
|
+
*
|
|
19770
|
+
* @see {@link WalletCreditResponseWithBalance} - The TypeScript type definition
|
|
19771
|
+
* @see {@link KEYS_WALLET_CREDIT_RESPONSE_WITH_BALANCE} - Array of all keys for this type
|
|
19772
|
+
*/
|
|
19773
|
+
export const KEY_WALLET_CREDIT_RESPONSE_WITH_BALANCE_CLIENT_SECRET = 'client_secret' as keyof WalletCreditResponseWithBalance;
|
|
19723
19774
|
/**
|
|
19724
19775
|
* Credit Id
|
|
19725
19776
|
*
|
|
@@ -19820,6 +19871,7 @@ export const KEY_WALLET_CREDIT_RESPONSE_WITH_BALANCE_STATUS = 'status' as keyof
|
|
|
19820
19871
|
export const KEYS_WALLET_CREDIT_RESPONSE_WITH_BALANCE = [
|
|
19821
19872
|
KEY_WALLET_CREDIT_RESPONSE_WITH_BALANCE_AMOUNT,
|
|
19822
19873
|
KEY_WALLET_CREDIT_RESPONSE_WITH_BALANCE_BALANCE,
|
|
19874
|
+
KEY_WALLET_CREDIT_RESPONSE_WITH_BALANCE_CLIENT_SECRET,
|
|
19823
19875
|
KEY_WALLET_CREDIT_RESPONSE_WITH_BALANCE_CREDIT_ID,
|
|
19824
19876
|
KEY_WALLET_CREDIT_RESPONSE_WITH_BALANCE_MESSAGE,
|
|
19825
19877
|
KEY_WALLET_CREDIT_RESPONSE_WITH_BALANCE_STATUS,
|
package/src/helpers/schemas.d.ts
CHANGED
|
@@ -906,6 +906,22 @@ export type DnssecRecordType = components['schemas']['DnssecRecordType'];
|
|
|
906
906
|
* @see {@link components} - The OpenAPI components schema definition
|
|
907
907
|
*/
|
|
908
908
|
export type DnssecStatus = components['schemas']['DnssecStatus'];
|
|
909
|
+
/**
|
|
910
|
+
* DomainAttributeKey
|
|
911
|
+
*
|
|
912
|
+
* @remarks
|
|
913
|
+
* Type alias for the `DomainAttributeKey` OpenAPI schema.
|
|
914
|
+
* This type represents domainattributekey data structures used in API requests and responses.
|
|
915
|
+
*
|
|
916
|
+
* @example
|
|
917
|
+
* ```typescript
|
|
918
|
+
* const response = await api.getDomainAttributeKey();
|
|
919
|
+
* const item: DomainAttributeKey = response.results;
|
|
920
|
+
* ```
|
|
921
|
+
*
|
|
922
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
923
|
+
*/
|
|
924
|
+
export type DomainAttributeKey = components['schemas']['DomainAttributeKey'];
|
|
909
925
|
/**
|
|
910
926
|
* DomainAvailability
|
|
911
927
|
*
|
package/src/openapi.yaml
CHANGED
|
@@ -1366,6 +1366,11 @@ components:
|
|
|
1366
1366
|
- disabled
|
|
1367
1367
|
title: DnssecStatus
|
|
1368
1368
|
type: string
|
|
1369
|
+
DomainAttributeKey:
|
|
1370
|
+
enum:
|
|
1371
|
+
- auto_renew_period
|
|
1372
|
+
title: DomainAttributeKey
|
|
1373
|
+
type: string
|
|
1369
1374
|
DomainAvailability:
|
|
1370
1375
|
properties:
|
|
1371
1376
|
domain:
|
|
@@ -1490,7 +1495,7 @@ components:
|
|
|
1490
1495
|
title: Nameservers
|
|
1491
1496
|
period:
|
|
1492
1497
|
$ref: '#/components/schemas/DomainPeriod'
|
|
1493
|
-
description:
|
|
1498
|
+
description: The registration period of the domain
|
|
1494
1499
|
renewal_mode:
|
|
1495
1500
|
$ref: '#/components/schemas/RenewalMode'
|
|
1496
1501
|
description: The renewal mode of the domain
|
|
@@ -2193,6 +2198,16 @@ components:
|
|
|
2193
2198
|
type: object
|
|
2194
2199
|
DomainTransferIn:
|
|
2195
2200
|
properties:
|
|
2201
|
+
attributes:
|
|
2202
|
+
anyOf:
|
|
2203
|
+
- additionalProperties:
|
|
2204
|
+
type: string
|
|
2205
|
+
propertyNames:
|
|
2206
|
+
$ref: '#/components/schemas/DomainAttributeKey'
|
|
2207
|
+
type: object
|
|
2208
|
+
- type: 'null'
|
|
2209
|
+
description: Additional attributes of the domain
|
|
2210
|
+
title: Attributes
|
|
2196
2211
|
auth_code:
|
|
2197
2212
|
description: The auth code for the domain
|
|
2198
2213
|
title: Auth Code
|
|
@@ -5090,6 +5105,12 @@ components:
|
|
|
5090
5105
|
description: Updated wallet balance after the credit
|
|
5091
5106
|
title: Balance
|
|
5092
5107
|
type: string
|
|
5108
|
+
client_secret:
|
|
5109
|
+
anyOf:
|
|
5110
|
+
- type: string
|
|
5111
|
+
- type: 'null'
|
|
5112
|
+
description: Client secret for 3DS authentication
|
|
5113
|
+
title: Client Secret
|
|
5093
5114
|
credit_id:
|
|
5094
5115
|
description: Unique identifier of the wallet credit transaction
|
|
5095
5116
|
title: Credit Id
|
|
@@ -5107,6 +5128,7 @@ components:
|
|
|
5107
5128
|
- credit_id
|
|
5108
5129
|
- amount
|
|
5109
5130
|
- status
|
|
5131
|
+
- client_secret
|
|
5110
5132
|
- balance
|
|
5111
5133
|
title: WalletCreditResponseWithBalance
|
|
5112
5134
|
type: object
|
|
@@ -5214,7 +5236,7 @@ info:
|
|
|
5214
5236
|
'
|
|
5215
5237
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
5216
5238
|
title: OpusDNS API
|
|
5217
|
-
version: 2025-09-30-
|
|
5239
|
+
version: 2025-09-30-180117
|
|
5218
5240
|
x-logo:
|
|
5219
5241
|
altText: OpusDNS API Reference
|
|
5220
5242
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -8875,7 +8897,6 @@ paths:
|
|
|
8875
8897
|
summary: Create checkout session
|
|
8876
8898
|
tags:
|
|
8877
8899
|
- organization
|
|
8878
|
-
- organization
|
|
8879
8900
|
/v1/organizations/{organization_id}/billing/payment-methods:
|
|
8880
8901
|
get:
|
|
8881
8902
|
description: List all available payment methods for the organization
|
|
@@ -8914,7 +8935,6 @@ paths:
|
|
|
8914
8935
|
summary: List all payment methods
|
|
8915
8936
|
tags:
|
|
8916
8937
|
- organization
|
|
8917
|
-
- organization
|
|
8918
8938
|
/v1/organizations/{organization_id}/billing/payment-methods/{payment_method_id}:
|
|
8919
8939
|
delete:
|
|
8920
8940
|
description: Delete a payment method for the organization
|
|
@@ -8951,7 +8971,6 @@ paths:
|
|
|
8951
8971
|
summary: Delete a payment method
|
|
8952
8972
|
tags:
|
|
8953
8973
|
- organization
|
|
8954
|
-
- organization
|
|
8955
8974
|
/v1/organizations/{organization_id}/billing/payment-methods/{payment_method_id}/default:
|
|
8956
8975
|
patch:
|
|
8957
8976
|
description: Set the provided payment method as default for the specified organization
|
|
@@ -8996,7 +9015,6 @@ paths:
|
|
|
8996
9015
|
summary: Set payment method as default
|
|
8997
9016
|
tags:
|
|
8998
9017
|
- organization
|
|
8999
|
-
- organization
|
|
9000
9018
|
/v1/organizations/{organization_id}/billing/wallet/credits:
|
|
9001
9019
|
post:
|
|
9002
9020
|
description: Credit the organization's wallet using the provided amount and
|
|
@@ -9038,7 +9056,6 @@ paths:
|
|
|
9038
9056
|
summary: Credit wallet
|
|
9039
9057
|
tags:
|
|
9040
9058
|
- organization
|
|
9041
|
-
- organization
|
|
9042
9059
|
/v1/organizations/{organization_id}/plan:
|
|
9043
9060
|
patch:
|
|
9044
9061
|
description: Changes the plan for an organization
|
package/src/schema.d.ts
CHANGED
|
@@ -2251,6 +2251,11 @@ export interface components {
|
|
|
2251
2251
|
* @enum {string}
|
|
2252
2252
|
*/
|
|
2253
2253
|
DnssecStatus: "enabled" | "disabled";
|
|
2254
|
+
/**
|
|
2255
|
+
* DomainAttributeKey
|
|
2256
|
+
* @enum {string}
|
|
2257
|
+
*/
|
|
2258
|
+
DomainAttributeKey: "auto_renew_period";
|
|
2254
2259
|
/** DomainAvailability */
|
|
2255
2260
|
DomainAvailability: {
|
|
2256
2261
|
/** Domain */
|
|
@@ -2326,7 +2331,7 @@ export interface components {
|
|
|
2326
2331
|
* @description The name servers for the domain
|
|
2327
2332
|
*/
|
|
2328
2333
|
nameservers?: components["schemas"]["Nameserver"][] | null;
|
|
2329
|
-
/** @description
|
|
2334
|
+
/** @description The registration period of the domain */
|
|
2330
2335
|
period: components["schemas"]["DomainPeriod"];
|
|
2331
2336
|
/** @description The renewal mode of the domain */
|
|
2332
2337
|
renewal_mode: components["schemas"]["RenewalMode"];
|
|
@@ -2777,6 +2782,13 @@ export interface components {
|
|
|
2777
2782
|
};
|
|
2778
2783
|
/** DomainTransferIn */
|
|
2779
2784
|
DomainTransferIn: {
|
|
2785
|
+
/**
|
|
2786
|
+
* Attributes
|
|
2787
|
+
* @description Additional attributes of the domain
|
|
2788
|
+
*/
|
|
2789
|
+
attributes?: {
|
|
2790
|
+
[key: string]: string;
|
|
2791
|
+
} | null;
|
|
2780
2792
|
/**
|
|
2781
2793
|
* Auth Code
|
|
2782
2794
|
* @description The auth code for the domain
|
|
@@ -4648,6 +4660,11 @@ export interface components {
|
|
|
4648
4660
|
* @description Updated wallet balance after the credit
|
|
4649
4661
|
*/
|
|
4650
4662
|
balance: string;
|
|
4663
|
+
/**
|
|
4664
|
+
* Client Secret
|
|
4665
|
+
* @description Client secret for 3DS authentication
|
|
4666
|
+
*/
|
|
4667
|
+
client_secret: string | null;
|
|
4651
4668
|
/**
|
|
4652
4669
|
* Credit Id
|
|
4653
4670
|
* @description Unique identifier of the wallet credit transaction
|