@opusdns/api 0.56.0 → 0.58.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 CHANGED
@@ -8,7 +8,7 @@
8
8
  "typescript": "^5.8.2"
9
9
  },
10
10
  "name": "@opusdns/api",
11
- "version": "0.56.0",
11
+ "version": "0.58.0",
12
12
  "description": "TypeScript types for the OpusDNS OpenAPI specification",
13
13
  "main": "./src/index.ts",
14
14
  "module": "./src/index.ts",
@@ -403,6 +403,31 @@ export const KEY_BILLING_PLAN_NAME = 'name' as keyof BillingPlan;
403
403
  * @see {@link KEYS_BILLING_PLAN} - Array of all keys for this type
404
404
  */
405
405
  export const KEY_BILLING_PLAN_PLAN_ID = 'plan_id' as keyof BillingPlan;
406
+ /**
407
+ * Plan Level
408
+ *
409
+ * Plan level such as 'basic', 'premium' or 'enterprise'.
410
+ *
411
+ *
412
+ *
413
+ * @remarks
414
+ * This key constant provides type-safe access to the `plan_level` property of BillingPlan objects.
415
+ * Use this constant when you need to access properties dynamically or ensure type safety.
416
+ *
417
+ * @example
418
+ * ```typescript
419
+ * // Direct property access
420
+ * const value = billingplan[KEY_BILLING_PLAN_PLAN_LEVEL];
421
+ *
422
+ * // Dynamic property access
423
+ * const propertyName = KEY_BILLING_PLAN_PLAN_LEVEL;
424
+ * const value = billingplan[propertyName];
425
+ * ```
426
+ *
427
+ * @see {@link BillingPlan} - The TypeScript type definition
428
+ * @see {@link KEYS_BILLING_PLAN} - Array of all keys for this type
429
+ */
430
+ export const KEY_BILLING_PLAN_PLAN_LEVEL = 'plan_level' as keyof BillingPlan;
406
431
  /**
407
432
  * Type
408
433
  *
@@ -454,6 +479,7 @@ export const KEYS_BILLING_PLAN = [
454
479
  KEY_BILLING_PLAN_CURRENCY,
455
480
  KEY_BILLING_PLAN_NAME,
456
481
  KEY_BILLING_PLAN_PLAN_ID,
482
+ KEY_BILLING_PLAN_PLAN_LEVEL,
457
483
  KEY_BILLING_PLAN_TYPE,
458
484
  ] as const satisfies (keyof BillingPlan)[];
459
485
 
@@ -150,42 +150,6 @@ export type DELETE_AuthClientCredentialsApiKeyId_Request = {
150
150
  */
151
151
  export type DELETE_AuthClientCredentialsApiKeyId_Request_Path = DELETE_AuthClientCredentialsApiKeyId_Request['parameters']['path'];
152
152
 
153
- /**
154
- * Request type for POST AuthInternalClientCredentials endpoint
155
- *
156
- * Issue Opusdns Internal Api Key
157
- *
158
- * @remarks
159
- * This type defines the complete request structure for the POST AuthInternalClientCredentials endpoint.
160
- * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
161
- * Use this type to ensure type safety when making API requests to this endpoint.
162
- *
163
- * @example
164
- * Use this type to ensure type safety when making API requests to this endpoint.
165
- *
166
- * @path /v1/auth/internal_client_credentials
167
- *
168
- * @see {@link POST_AuthInternalClientCredentials_Request_Query} - Query parameters type
169
- * @see {@link POST_AuthInternalClientCredentials_Request_Path} - Path parameters type
170
- * @see {@link POST_AuthInternalClientCredentials_Request_Body} - Request body type
171
- */
172
- export type POST_AuthInternalClientCredentials_Request = {
173
- requestBody: OrganizationCredentialExtra;
174
- }
175
- /**
176
- * Request body for POST /v1/auth/internal_client_credentials
177
- *
178
- * @remarks
179
- * This type defines the request body structure for the POST /v1/auth/internal_client_credentials endpoint.
180
- * It provides type safety for the request body as defined in the OpenAPI specification.
181
- *
182
- * @example
183
- * Use this type to ensure type safety for request body structure.
184
- *
185
- * @path /v1/auth/internal_client_credentials
186
- */
187
- export type POST_AuthInternalClientCredentials_Request_Body = POST_AuthInternalClientCredentials_Request['requestBody'];
188
-
189
153
  /**
190
154
  * Request type for POST AuthLogout endpoint
191
155
  *
@@ -3364,40 +3328,41 @@ export type GET_UsersMe_Request = {
3364
3328
  export type GET_UsersMe_Request_Query = GET_UsersMe_Request['parameters']['query'];
3365
3329
 
3366
3330
  /**
3367
- * Request type for PATCH UsersMePasswordReset endpoint
3331
+ * Request type for PATCH UsersMeChangePassword endpoint
3368
3332
  *
3369
- * Confirm User Password Reset Me
3333
+ * Change password
3334
+ * Change the password of the current user.
3370
3335
  *
3371
3336
  * @remarks
3372
- * This type defines the complete request structure for the PATCH UsersMePasswordReset endpoint.
3337
+ * This type defines the complete request structure for the PATCH UsersMeChangePassword endpoint.
3373
3338
  * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
3374
3339
  * Use this type to ensure type safety when making API requests to this endpoint.
3375
3340
  *
3376
3341
  * @example
3377
3342
  * Use this type to ensure type safety when making API requests to this endpoint.
3378
3343
  *
3379
- * @path /v1/users/me/password-reset
3344
+ * @path /v1/users/me/change_password
3380
3345
  *
3381
- * @see {@link PATCH_UsersMePasswordReset_Request_Query} - Query parameters type
3382
- * @see {@link PATCH_UsersMePasswordReset_Request_Path} - Path parameters type
3383
- * @see {@link PATCH_UsersMePasswordReset_Request_Body} - Request body type
3346
+ * @see {@link PATCH_UsersMeChangePassword_Request_Query} - Query parameters type
3347
+ * @see {@link PATCH_UsersMeChangePassword_Request_Path} - Path parameters type
3348
+ * @see {@link PATCH_UsersMeChangePassword_Request_Body} - Request body type
3384
3349
  */
3385
- export type PATCH_UsersMePasswordReset_Request = {
3350
+ export type PATCH_UsersMeChangePassword_Request = {
3386
3351
  requestBody: PasswordUpdate;
3387
3352
  }
3388
3353
  /**
3389
- * Request body for PATCH /v1/users/me/password-reset
3354
+ * Request body for PATCH /v1/users/me/change_password
3390
3355
  *
3391
3356
  * @remarks
3392
- * This type defines the request body structure for the PATCH /v1/users/me/password-reset endpoint.
3357
+ * This type defines the request body structure for the PATCH /v1/users/me/change_password endpoint.
3393
3358
  * It provides type safety for the request body as defined in the OpenAPI specification.
3394
3359
  *
3395
3360
  * @example
3396
3361
  * Use this type to ensure type safety for request body structure.
3397
3362
  *
3398
- * @path /v1/users/me/password-reset
3363
+ * @path /v1/users/me/change_password
3399
3364
  */
3400
- export type PATCH_UsersMePasswordReset_Request_Body = PATCH_UsersMePasswordReset_Request['requestBody'];
3365
+ export type PATCH_UsersMeChangePassword_Request_Body = PATCH_UsersMeChangePassword_Request['requestBody'];
3401
3366
 
3402
3367
  /**
3403
3368
  * Request type for DELETE UsersUserId endpoint
@@ -259,61 +259,6 @@ export type DELETE_AuthClientCredentialsByApiKeyId_Response_404 = Problem
259
259
  */
260
260
  export type DELETE_AuthClientCredentialsByApiKeyId_Response_422 = HTTPValidationError
261
261
 
262
- /**
263
- * Response types for POST AuthInternalClientCredentials endpoint
264
- *
265
- * Issue Opusdns Internal Api Key
266
- *
267
- * @remarks
268
- * This type defines all possible response structures for the POST AuthInternalClientCredentials endpoint.
269
- * Each response code maps to a specific response type as defined in the OpenAPI specification.
270
- * Use this type to ensure type safety when handling API responses from this endpoint.
271
- *
272
-
273
- *
274
- * @path /v1/auth/internal_client_credentials
275
- *
276
- * @see {@link POST_AuthInternalClientCredentials_Response_200} - 200 response type
277
- * @see {@link POST_AuthInternalClientCredentials_Response_422} - 422 response type
278
- *
279
-
280
- */
281
- export type POST_AuthInternalClientCredentials_Response = POST_AuthInternalClientCredentials_Response_200 | POST_AuthInternalClientCredentials_Response_422;
282
-
283
- /**
284
- * 200 response for POST AuthInternalClientCredentials endpoint
285
- *
286
- * @remarks
287
- * This type defines the response structure for the 200 status code
288
- * of the POST AuthInternalClientCredentials endpoint.
289
- * It provides type safety for handling this specific response as defined in the OpenAPI specification.
290
- *
291
-
292
- *
293
- * @path /v1/auth/internal_client_credentials
294
- *
295
- * @see {@link POST_AuthInternalClientCredentials_Response} - The main response type definition
296
- * @see {@link OrganizationCredentialCreated} - The actual schema type definition
297
- */
298
- export type POST_AuthInternalClientCredentials_Response_200 = OrganizationCredentialCreated
299
-
300
- /**
301
- * 422 response for POST AuthInternalClientCredentials endpoint
302
- *
303
- * @remarks
304
- * This type defines the response structure for the 422 status code
305
- * of the POST AuthInternalClientCredentials endpoint.
306
- * It provides type safety for handling this specific response as defined in the OpenAPI specification.
307
- *
308
-
309
- *
310
- * @path /v1/auth/internal_client_credentials
311
- *
312
- * @see {@link POST_AuthInternalClientCredentials_Response} - The main response type definition
313
- * @see {@link HTTPValidationError} - The actual schema type definition
314
- */
315
- export type POST_AuthInternalClientCredentials_Response_422 = HTTPValidationError
316
-
317
262
  /**
318
263
  * Response types for POST AuthLogout endpoint
319
264
  *
@@ -5400,57 +5345,58 @@ export type GET_UsersMe_Response_200 = UserWithRelationPermissions
5400
5345
  export type GET_UsersMe_Response_422 = HTTPValidationError
5401
5346
 
5402
5347
  /**
5403
- * Response types for PATCH UsersMePasswordReset endpoint
5348
+ * Response types for PATCH UsersMeChangePassword endpoint
5404
5349
  *
5405
- * Confirm User Password Reset Me
5350
+ * Change password
5351
+ * Change the password of the current user.
5406
5352
  *
5407
5353
  * @remarks
5408
- * This type defines all possible response structures for the PATCH UsersMePasswordReset endpoint.
5354
+ * This type defines all possible response structures for the PATCH UsersMeChangePassword endpoint.
5409
5355
  * Each response code maps to a specific response type as defined in the OpenAPI specification.
5410
5356
  * Use this type to ensure type safety when handling API responses from this endpoint.
5411
5357
  *
5412
5358
 
5413
5359
  *
5414
- * @path /v1/users/me/password-reset
5360
+ * @path /v1/users/me/change_password
5415
5361
  *
5416
- * @see {@link PATCH_UsersMePasswordReset_Response_401} - 401 response type
5417
- * @see {@link PATCH_UsersMePasswordReset_Response_422} - 422 response type
5362
+ * @see {@link PATCH_UsersMeChangePassword_Response_401} - 401 response type
5363
+ * @see {@link PATCH_UsersMeChangePassword_Response_422} - 422 response type
5418
5364
  *
5419
5365
 
5420
5366
  */
5421
- export type PATCH_UsersMePasswordReset_Response = PATCH_UsersMePasswordReset_Response_401 | PATCH_UsersMePasswordReset_Response_422;
5367
+ export type PATCH_UsersMeChangePassword_Response = PATCH_UsersMeChangePassword_Response_401 | PATCH_UsersMeChangePassword_Response_422;
5422
5368
 
5423
5369
  /**
5424
- * 401 response for PATCH UsersMePasswordReset endpoint
5370
+ * 401 response for PATCH UsersMeChangePassword endpoint
5425
5371
  *
5426
5372
  * @remarks
5427
5373
  * This type defines the response structure for the 401 status code
5428
- * of the PATCH UsersMePasswordReset endpoint.
5374
+ * of the PATCH UsersMeChangePassword endpoint.
5429
5375
  * It provides type safety for handling this specific response as defined in the OpenAPI specification.
5430
5376
  *
5431
5377
 
5432
5378
  *
5433
- * @path /v1/users/me/password-reset
5379
+ * @path /v1/users/me/change_password
5434
5380
  *
5435
- * @see {@link PATCH_UsersMePasswordReset_Response} - The main response type definition
5381
+ * @see {@link PATCH_UsersMeChangePassword_Response} - The main response type definition
5436
5382
  * @see {@link Problem} - The actual schema type definition
5437
5383
  */
5438
- export type PATCH_UsersMePasswordReset_Response_401 = Problem
5384
+ export type PATCH_UsersMeChangePassword_Response_401 = Problem
5439
5385
 
5440
5386
  /**
5441
- * 422 response for PATCH UsersMePasswordReset endpoint
5387
+ * 422 response for PATCH UsersMeChangePassword endpoint
5442
5388
  *
5443
5389
  * @remarks
5444
5390
  * This type defines the response structure for the 422 status code
5445
- * of the PATCH UsersMePasswordReset endpoint.
5391
+ * of the PATCH UsersMeChangePassword endpoint.
5446
5392
  * It provides type safety for handling this specific response as defined in the OpenAPI specification.
5447
5393
  *
5448
5394
 
5449
5395
  *
5450
- * @path /v1/users/me/password-reset
5396
+ * @path /v1/users/me/change_password
5451
5397
  *
5452
- * @see {@link PATCH_UsersMePasswordReset_Response} - The main response type definition
5398
+ * @see {@link PATCH_UsersMeChangePassword_Response} - The main response type definition
5453
5399
  * @see {@link HTTPValidationError} - The actual schema type definition
5454
5400
  */
5455
- export type PATCH_UsersMePasswordReset_Response_422 = HTTPValidationError
5401
+ export type PATCH_UsersMeChangePassword_Response_422 = HTTPValidationError
5456
5402
 
package/src/openapi.yaml CHANGED
@@ -69,6 +69,12 @@ components:
69
69
  - type: 'null'
70
70
  description: Billing plan ID for the organization.
71
71
  title: Plan Id
72
+ plan_level:
73
+ anyOf:
74
+ - type: string
75
+ - type: 'null'
76
+ description: Plan level such as 'basic', 'premium' or 'enterprise'.
77
+ title: Plan Level
72
78
  type:
73
79
  anyOf:
74
80
  - type: string
@@ -4902,7 +4908,7 @@ info:
4902
4908
  '
4903
4909
  summary: OpusDNS - your gateway to a seamless domain management experience.
4904
4910
  title: OpusDNS API
4905
- version: 2025-09-20-150413
4911
+ version: 2025-09-22-074729
4906
4912
  x-logo:
4907
4913
  altText: OpusDNS API Reference
4908
4914
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -5062,33 +5068,6 @@ paths:
5062
5068
  summary: Delete Api Key
5063
5069
  tags:
5064
5070
  - authentication
5065
- /v1/auth/internal_client_credentials:
5066
- post:
5067
- operationId: issue_opusdns_internal_api_key_v1_auth_internal_client_credentials_post
5068
- requestBody:
5069
- content:
5070
- application/json:
5071
- schema:
5072
- $ref: '#/components/schemas/OrganizationCredentialExtra'
5073
- required: true
5074
- responses:
5075
- '200':
5076
- content:
5077
- application/json:
5078
- schema:
5079
- $ref: '#/components/schemas/OrganizationCredentialCreated'
5080
- description: Successful Response
5081
- '422':
5082
- content:
5083
- application/problem+json:
5084
- schema:
5085
- $ref: '#/components/schemas/HTTPValidationError'
5086
- description: Validation Error
5087
- security:
5088
- - OAuth2PasswordBearer: []
5089
- summary: Issue Opusdns Internal Api Key
5090
- tags:
5091
- - authentication
5092
5071
  /v1/auth/logout:
5093
5072
  post:
5094
5073
  operationId: logout_v1_auth_logout_post
@@ -8780,9 +8759,10 @@ paths:
8780
8759
  summary: Get Current User
8781
8760
  tags:
8782
8761
  - user
8783
- /v1/users/me/password-reset:
8762
+ /v1/users/me/change_password:
8784
8763
  patch:
8785
- operationId: confirm_user_password_reset_me_v1_users_me_password_reset_patch
8764
+ description: Change the password of the current user.
8765
+ operationId: change_password_v1_users_me_change_password_patch
8786
8766
  requestBody:
8787
8767
  content:
8788
8768
  application/json:
@@ -8812,7 +8792,7 @@ paths:
8812
8792
  description: Validation Error
8813
8793
  security:
8814
8794
  - OAuth2PasswordBearer: []
8815
- summary: Confirm User Password Reset Me
8795
+ summary: Change password
8816
8796
  tags:
8817
8797
  - user
8818
8798
  /v1/users/{user_id}:
package/src/schema.d.ts CHANGED
@@ -35,23 +35,6 @@ export interface paths {
35
35
  patch?: never;
36
36
  trace?: never;
37
37
  };
38
- "/v1/auth/internal_client_credentials": {
39
- parameters: {
40
- query?: never;
41
- header?: never;
42
- path?: never;
43
- cookie?: never;
44
- };
45
- get?: never;
46
- put?: never;
47
- /** Issue Opusdns Internal Api Key */
48
- post: operations["issue_opusdns_internal_api_key_v1_auth_internal_client_credentials_post"];
49
- delete?: never;
50
- options?: never;
51
- head?: never;
52
- patch?: never;
53
- trace?: never;
54
- };
55
38
  "/v1/auth/logout": {
56
39
  parameters: {
57
40
  query?: never;
@@ -1036,7 +1019,7 @@ export interface paths {
1036
1019
  patch?: never;
1037
1020
  trace?: never;
1038
1021
  };
1039
- "/v1/users/me/password-reset": {
1022
+ "/v1/users/me/change_password": {
1040
1023
  parameters: {
1041
1024
  query?: never;
1042
1025
  header?: never;
@@ -1049,8 +1032,11 @@ export interface paths {
1049
1032
  delete?: never;
1050
1033
  options?: never;
1051
1034
  head?: never;
1052
- /** Confirm User Password Reset Me */
1053
- patch: operations["confirm_user_password_reset_me_v1_users_me_password_reset_patch"];
1035
+ /**
1036
+ * Change password
1037
+ * @description Change the password of the current user.
1038
+ */
1039
+ patch: operations["change_password_v1_users_me_change_password_patch"];
1054
1040
  trace?: never;
1055
1041
  };
1056
1042
  "/v1/users/{user_id}": {
@@ -1166,6 +1152,11 @@ export interface components {
1166
1152
  * @description Billing plan ID for the organization.
1167
1153
  */
1168
1154
  plan_id?: string | null;
1155
+ /**
1156
+ * Plan Level
1157
+ * @description Plan level such as 'basic', 'premium' or 'enterprise'.
1158
+ */
1159
+ plan_level?: string | null;
1169
1160
  /**
1170
1161
  * Type
1171
1162
  * @description Plan type or billing interval.
@@ -4430,39 +4421,6 @@ export interface operations {
4430
4421
  };
4431
4422
  };
4432
4423
  };
4433
- issue_opusdns_internal_api_key_v1_auth_internal_client_credentials_post: {
4434
- parameters: {
4435
- query?: never;
4436
- header?: never;
4437
- path?: never;
4438
- cookie?: never;
4439
- };
4440
- requestBody: {
4441
- content: {
4442
- "application/json": components["schemas"]["OrganizationCredentialExtra"];
4443
- };
4444
- };
4445
- responses: {
4446
- /** @description Successful Response */
4447
- 200: {
4448
- headers: {
4449
- [name: string]: unknown;
4450
- };
4451
- content: {
4452
- "application/json": components["schemas"]["OrganizationCredentialCreated"];
4453
- };
4454
- };
4455
- /** @description Validation Error */
4456
- 422: {
4457
- headers: {
4458
- [name: string]: unknown;
4459
- };
4460
- content: {
4461
- "application/problem+json": components["schemas"]["HTTPValidationError"];
4462
- };
4463
- };
4464
- };
4465
- };
4466
4424
  logout_v1_auth_logout_post: {
4467
4425
  parameters: {
4468
4426
  query?: never;
@@ -7828,7 +7786,7 @@ export interface operations {
7828
7786
  };
7829
7787
  };
7830
7788
  };
7831
- confirm_user_password_reset_me_v1_users_me_password_reset_patch: {
7789
+ change_password_v1_users_me_change_password_patch: {
7832
7790
  parameters: {
7833
7791
  query?: never;
7834
7792
  header?: never;