@opusdns/api 0.58.0 → 0.60.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 +52 -0
- package/src/helpers/requests.d.ts +12 -13
- package/src/helpers/responses.d.ts +17 -18
- package/src/openapi.yaml +16 -5
- package/src/schema.d.ts +14 -7
package/package.json
CHANGED
package/src/helpers/keys.ts
CHANGED
|
@@ -14316,6 +14316,56 @@ export const KEYS_PREMIUM_DOMAINS_BASE = [
|
|
|
14316
14316
|
* @see {@link KEYS_PRICE_INFO} - Array of all keys for this type
|
|
14317
14317
|
*/
|
|
14318
14318
|
export const KEY_PRICE_INFO_CURRENCY = 'currency' as keyof PriceInfo;
|
|
14319
|
+
/**
|
|
14320
|
+
* Period Unit
|
|
14321
|
+
*
|
|
14322
|
+
* Period unit: 'y' (year), 'm' (month), 'd' (day)
|
|
14323
|
+
*
|
|
14324
|
+
*
|
|
14325
|
+
*
|
|
14326
|
+
* @remarks
|
|
14327
|
+
* This key constant provides type-safe access to the `period_unit` property of PriceInfo objects.
|
|
14328
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
14329
|
+
*
|
|
14330
|
+
* @example
|
|
14331
|
+
* ```typescript
|
|
14332
|
+
* // Direct property access
|
|
14333
|
+
* const value = priceinfo[KEY_PRICE_INFO_PERIOD_UNIT];
|
|
14334
|
+
*
|
|
14335
|
+
* // Dynamic property access
|
|
14336
|
+
* const propertyName = KEY_PRICE_INFO_PERIOD_UNIT;
|
|
14337
|
+
* const value = priceinfo[propertyName];
|
|
14338
|
+
* ```
|
|
14339
|
+
*
|
|
14340
|
+
* @see {@link PriceInfo} - The TypeScript type definition
|
|
14341
|
+
* @see {@link KEYS_PRICE_INFO} - Array of all keys for this type
|
|
14342
|
+
*/
|
|
14343
|
+
export const KEY_PRICE_INFO_PERIOD_UNIT = 'period_unit' as keyof PriceInfo;
|
|
14344
|
+
/**
|
|
14345
|
+
* Period Value
|
|
14346
|
+
*
|
|
14347
|
+
* Period value (e.g., 1 for 1 year)
|
|
14348
|
+
*
|
|
14349
|
+
*
|
|
14350
|
+
*
|
|
14351
|
+
* @remarks
|
|
14352
|
+
* This key constant provides type-safe access to the `period_value` property of PriceInfo objects.
|
|
14353
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
14354
|
+
*
|
|
14355
|
+
* @example
|
|
14356
|
+
* ```typescript
|
|
14357
|
+
* // Direct property access
|
|
14358
|
+
* const value = priceinfo[KEY_PRICE_INFO_PERIOD_VALUE];
|
|
14359
|
+
*
|
|
14360
|
+
* // Dynamic property access
|
|
14361
|
+
* const propertyName = KEY_PRICE_INFO_PERIOD_VALUE;
|
|
14362
|
+
* const value = priceinfo[propertyName];
|
|
14363
|
+
* ```
|
|
14364
|
+
*
|
|
14365
|
+
* @see {@link PriceInfo} - The TypeScript type definition
|
|
14366
|
+
* @see {@link KEYS_PRICE_INFO} - Array of all keys for this type
|
|
14367
|
+
*/
|
|
14368
|
+
export const KEY_PRICE_INFO_PERIOD_VALUE = 'period_value' as keyof PriceInfo;
|
|
14319
14369
|
/**
|
|
14320
14370
|
* Price
|
|
14321
14371
|
*
|
|
@@ -14437,6 +14487,8 @@ export const KEY_PRICE_INFO_PRODUCT_TYPE = 'product_type' as keyof PriceInfo;
|
|
|
14437
14487
|
*/
|
|
14438
14488
|
export const KEYS_PRICE_INFO = [
|
|
14439
14489
|
KEY_PRICE_INFO_CURRENCY,
|
|
14490
|
+
KEY_PRICE_INFO_PERIOD_UNIT,
|
|
14491
|
+
KEY_PRICE_INFO_PERIOD_VALUE,
|
|
14440
14492
|
KEY_PRICE_INFO_PRICE,
|
|
14441
14493
|
KEY_PRICE_INFO_PRODUCT_ACTION,
|
|
14442
14494
|
KEY_PRICE_INFO_PRODUCT_CLASS,
|
|
@@ -3328,41 +3328,40 @@ export type GET_UsersMe_Request = {
|
|
|
3328
3328
|
export type GET_UsersMe_Request_Query = GET_UsersMe_Request['parameters']['query'];
|
|
3329
3329
|
|
|
3330
3330
|
/**
|
|
3331
|
-
* Request type for PATCH
|
|
3331
|
+
* Request type for PATCH UsersMePasswordReset endpoint
|
|
3332
3332
|
*
|
|
3333
|
-
* Change
|
|
3334
|
-
* Change the password of the current user.
|
|
3333
|
+
* Change Password
|
|
3335
3334
|
*
|
|
3336
3335
|
* @remarks
|
|
3337
|
-
* This type defines the complete request structure for the PATCH
|
|
3336
|
+
* This type defines the complete request structure for the PATCH UsersMePasswordReset endpoint.
|
|
3338
3337
|
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
3339
3338
|
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
3340
3339
|
*
|
|
3341
3340
|
* @example
|
|
3342
3341
|
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
3343
3342
|
*
|
|
3344
|
-
* @path /v1/users/me/
|
|
3343
|
+
* @path /v1/users/me/password-reset
|
|
3345
3344
|
*
|
|
3346
|
-
* @see {@link
|
|
3347
|
-
* @see {@link
|
|
3348
|
-
* @see {@link
|
|
3345
|
+
* @see {@link PATCH_UsersMePasswordReset_Request_Query} - Query parameters type
|
|
3346
|
+
* @see {@link PATCH_UsersMePasswordReset_Request_Path} - Path parameters type
|
|
3347
|
+
* @see {@link PATCH_UsersMePasswordReset_Request_Body} - Request body type
|
|
3349
3348
|
*/
|
|
3350
|
-
export type
|
|
3349
|
+
export type PATCH_UsersMePasswordReset_Request = {
|
|
3351
3350
|
requestBody: PasswordUpdate;
|
|
3352
3351
|
}
|
|
3353
3352
|
/**
|
|
3354
|
-
* Request body for PATCH /v1/users/me/
|
|
3353
|
+
* Request body for PATCH /v1/users/me/password-reset
|
|
3355
3354
|
*
|
|
3356
3355
|
* @remarks
|
|
3357
|
-
* This type defines the request body structure for the PATCH /v1/users/me/
|
|
3356
|
+
* This type defines the request body structure for the PATCH /v1/users/me/password-reset endpoint.
|
|
3358
3357
|
* It provides type safety for the request body as defined in the OpenAPI specification.
|
|
3359
3358
|
*
|
|
3360
3359
|
* @example
|
|
3361
3360
|
* Use this type to ensure type safety for request body structure.
|
|
3362
3361
|
*
|
|
3363
|
-
* @path /v1/users/me/
|
|
3362
|
+
* @path /v1/users/me/password-reset
|
|
3364
3363
|
*/
|
|
3365
|
-
export type
|
|
3364
|
+
export type PATCH_UsersMePasswordReset_Request_Body = PATCH_UsersMePasswordReset_Request['requestBody'];
|
|
3366
3365
|
|
|
3367
3366
|
/**
|
|
3368
3367
|
* Request type for DELETE UsersUserId endpoint
|
|
@@ -5345,58 +5345,57 @@ export type GET_UsersMe_Response_200 = UserWithRelationPermissions
|
|
|
5345
5345
|
export type GET_UsersMe_Response_422 = HTTPValidationError
|
|
5346
5346
|
|
|
5347
5347
|
/**
|
|
5348
|
-
* Response types for PATCH
|
|
5348
|
+
* Response types for PATCH UsersMePasswordReset endpoint
|
|
5349
5349
|
*
|
|
5350
|
-
* Change
|
|
5351
|
-
* Change the password of the current user.
|
|
5350
|
+
* Change Password
|
|
5352
5351
|
*
|
|
5353
5352
|
* @remarks
|
|
5354
|
-
* This type defines all possible response structures for the PATCH
|
|
5353
|
+
* This type defines all possible response structures for the PATCH UsersMePasswordReset endpoint.
|
|
5355
5354
|
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
5356
5355
|
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
5357
5356
|
*
|
|
5358
5357
|
|
|
5359
5358
|
*
|
|
5360
|
-
* @path /v1/users/me/
|
|
5359
|
+
* @path /v1/users/me/password-reset
|
|
5361
5360
|
*
|
|
5362
|
-
* @see {@link
|
|
5363
|
-
* @see {@link
|
|
5361
|
+
* @see {@link PATCH_UsersMePasswordReset_Response_401} - 401 response type
|
|
5362
|
+
* @see {@link PATCH_UsersMePasswordReset_Response_422} - 422 response type
|
|
5364
5363
|
*
|
|
5365
5364
|
|
|
5366
5365
|
*/
|
|
5367
|
-
export type
|
|
5366
|
+
export type PATCH_UsersMePasswordReset_Response = PATCH_UsersMePasswordReset_Response_401 | PATCH_UsersMePasswordReset_Response_422;
|
|
5368
5367
|
|
|
5369
5368
|
/**
|
|
5370
|
-
* 401 response for PATCH
|
|
5369
|
+
* 401 response for PATCH UsersMePasswordReset endpoint
|
|
5371
5370
|
*
|
|
5372
5371
|
* @remarks
|
|
5373
5372
|
* This type defines the response structure for the 401 status code
|
|
5374
|
-
* of the PATCH
|
|
5373
|
+
* of the PATCH UsersMePasswordReset endpoint.
|
|
5375
5374
|
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
5376
5375
|
*
|
|
5377
5376
|
|
|
5378
5377
|
*
|
|
5379
|
-
* @path /v1/users/me/
|
|
5378
|
+
* @path /v1/users/me/password-reset
|
|
5380
5379
|
*
|
|
5381
|
-
* @see {@link
|
|
5380
|
+
* @see {@link PATCH_UsersMePasswordReset_Response} - The main response type definition
|
|
5382
5381
|
* @see {@link Problem} - The actual schema type definition
|
|
5383
5382
|
*/
|
|
5384
|
-
export type
|
|
5383
|
+
export type PATCH_UsersMePasswordReset_Response_401 = Problem
|
|
5385
5384
|
|
|
5386
5385
|
/**
|
|
5387
|
-
* 422 response for PATCH
|
|
5386
|
+
* 422 response for PATCH UsersMePasswordReset endpoint
|
|
5388
5387
|
*
|
|
5389
5388
|
* @remarks
|
|
5390
5389
|
* This type defines the response structure for the 422 status code
|
|
5391
|
-
* of the PATCH
|
|
5390
|
+
* of the PATCH UsersMePasswordReset endpoint.
|
|
5392
5391
|
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
5393
5392
|
*
|
|
5394
5393
|
|
|
5395
5394
|
*
|
|
5396
|
-
* @path /v1/users/me/
|
|
5395
|
+
* @path /v1/users/me/password-reset
|
|
5397
5396
|
*
|
|
5398
|
-
* @see {@link
|
|
5397
|
+
* @see {@link PATCH_UsersMePasswordReset_Response} - The main response type definition
|
|
5399
5398
|
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
5400
5399
|
*/
|
|
5401
|
-
export type
|
|
5400
|
+
export type PATCH_UsersMePasswordReset_Response_422 = HTTPValidationError
|
|
5402
5401
|
|
package/src/openapi.yaml
CHANGED
|
@@ -3756,6 +3756,18 @@ components:
|
|
|
3756
3756
|
currency:
|
|
3757
3757
|
title: Currency
|
|
3758
3758
|
type: string
|
|
3759
|
+
period_unit:
|
|
3760
|
+
anyOf:
|
|
3761
|
+
- type: string
|
|
3762
|
+
- type: 'null'
|
|
3763
|
+
description: 'Period unit: ''y'' (year), ''m'' (month), ''d'' (day)'
|
|
3764
|
+
title: Period Unit
|
|
3765
|
+
period_value:
|
|
3766
|
+
anyOf:
|
|
3767
|
+
- type: integer
|
|
3768
|
+
- type: 'null'
|
|
3769
|
+
description: Period value (e.g., 1 for 1 year)
|
|
3770
|
+
title: Period Value
|
|
3759
3771
|
price:
|
|
3760
3772
|
title: Price
|
|
3761
3773
|
type: string
|
|
@@ -4908,7 +4920,7 @@ info:
|
|
|
4908
4920
|
'
|
|
4909
4921
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
4910
4922
|
title: OpusDNS API
|
|
4911
|
-
version: 2025-09-22-
|
|
4923
|
+
version: 2025-09-22-190002
|
|
4912
4924
|
x-logo:
|
|
4913
4925
|
altText: OpusDNS API Reference
|
|
4914
4926
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -8759,10 +8771,9 @@ paths:
|
|
|
8759
8771
|
summary: Get Current User
|
|
8760
8772
|
tags:
|
|
8761
8773
|
- user
|
|
8762
|
-
/v1/users/me/
|
|
8774
|
+
/v1/users/me/password-reset:
|
|
8763
8775
|
patch:
|
|
8764
|
-
|
|
8765
|
-
operationId: change_password_v1_users_me_change_password_patch
|
|
8776
|
+
operationId: change_password_v1_users_me_password_reset_patch
|
|
8766
8777
|
requestBody:
|
|
8767
8778
|
content:
|
|
8768
8779
|
application/json:
|
|
@@ -8792,7 +8803,7 @@ paths:
|
|
|
8792
8803
|
description: Validation Error
|
|
8793
8804
|
security:
|
|
8794
8805
|
- OAuth2PasswordBearer: []
|
|
8795
|
-
summary: Change
|
|
8806
|
+
summary: Change Password
|
|
8796
8807
|
tags:
|
|
8797
8808
|
- user
|
|
8798
8809
|
/v1/users/{user_id}:
|
package/src/schema.d.ts
CHANGED
|
@@ -1019,7 +1019,7 @@ export interface paths {
|
|
|
1019
1019
|
patch?: never;
|
|
1020
1020
|
trace?: never;
|
|
1021
1021
|
};
|
|
1022
|
-
"/v1/users/me/
|
|
1022
|
+
"/v1/users/me/password-reset": {
|
|
1023
1023
|
parameters: {
|
|
1024
1024
|
query?: never;
|
|
1025
1025
|
header?: never;
|
|
@@ -1032,11 +1032,8 @@ export interface paths {
|
|
|
1032
1032
|
delete?: never;
|
|
1033
1033
|
options?: never;
|
|
1034
1034
|
head?: never;
|
|
1035
|
-
/**
|
|
1036
|
-
|
|
1037
|
-
* @description Change the password of the current user.
|
|
1038
|
-
*/
|
|
1039
|
-
patch: operations["change_password_v1_users_me_change_password_patch"];
|
|
1035
|
+
/** Change Password */
|
|
1036
|
+
patch: operations["change_password_v1_users_me_password_reset_patch"];
|
|
1040
1037
|
trace?: never;
|
|
1041
1038
|
};
|
|
1042
1039
|
"/v1/users/{user_id}": {
|
|
@@ -3548,6 +3545,16 @@ export interface components {
|
|
|
3548
3545
|
PriceInfo: {
|
|
3549
3546
|
/** Currency */
|
|
3550
3547
|
currency: string;
|
|
3548
|
+
/**
|
|
3549
|
+
* Period Unit
|
|
3550
|
+
* @description Period unit: 'y' (year), 'm' (month), 'd' (day)
|
|
3551
|
+
*/
|
|
3552
|
+
period_unit?: string | null;
|
|
3553
|
+
/**
|
|
3554
|
+
* Period Value
|
|
3555
|
+
* @description Period value (e.g., 1 for 1 year)
|
|
3556
|
+
*/
|
|
3557
|
+
period_value?: number | null;
|
|
3551
3558
|
/** Price */
|
|
3552
3559
|
price: string;
|
|
3553
3560
|
/** Product Action */
|
|
@@ -7786,7 +7793,7 @@ export interface operations {
|
|
|
7786
7793
|
};
|
|
7787
7794
|
};
|
|
7788
7795
|
};
|
|
7789
|
-
|
|
7796
|
+
change_password_v1_users_me_password_reset_patch: {
|
|
7790
7797
|
parameters: {
|
|
7791
7798
|
query?: never;
|
|
7792
7799
|
header?: never;
|