@opusdns/api 0.55.0 → 0.57.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/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
@@ -4003,16 +4009,6 @@ components:
4003
4009
  title: Remove
4004
4010
  title: SpiceDbRelationshipUpdate
4005
4011
  type: object
4006
- StartPasswordReset:
4007
- properties:
4008
- email:
4009
- format: email
4010
- title: Email
4011
- type: string
4012
- required:
4013
- - email
4014
- title: StartPasswordReset
4015
- type: object
4016
4012
  SyncOperationType:
4017
4013
  enum:
4018
4014
  - registration
@@ -4487,17 +4483,6 @@ components:
4487
4483
  - password
4488
4484
  title: UserCreate
4489
4485
  type: object
4490
- UserPasswordResetEmailResponse:
4491
- properties:
4492
- message:
4493
- default: A password reset link will be sent to this email if an account
4494
- is registered under it.
4495
- description: Message to the user. This message is always displayed regarding
4496
- the password reset process to prevent leaking information.
4497
- title: Message
4498
- type: string
4499
- title: UserPasswordResetEmailResponse
4500
- type: object
4501
4486
  UserStatus:
4502
4487
  enum:
4503
4488
  - active
@@ -4584,181 +4569,6 @@ components:
4584
4569
  title: Username
4585
4570
  title: UserUpdate
4586
4571
  type: object
4587
- UserVerificationApiResponse:
4588
- properties:
4589
- canceled_on:
4590
- anyOf:
4591
- - format: date-time
4592
- type: string
4593
- - type: 'null'
4594
- description: The date the verification was cancelled
4595
- title: Canceled On
4596
- created_on:
4597
- description: The date/time the entry was created on
4598
- format: date-time
4599
- title: Created On
4600
- type: string
4601
- status:
4602
- $ref: '#/components/schemas/EmailVerificationStatus'
4603
- default: pending
4604
- description: Current status of the email verification
4605
- token:
4606
- description: The token to verify the email address
4607
- maxLength: 256
4608
- minLength: 35
4609
- title: Token
4610
- type: string
4611
- type:
4612
- $ref: '#/components/schemas/VerificationType'
4613
- description: 'The type of verification: ''api'' for retrieving token via
4614
- API, ''email'' for retrieving via email'
4615
- updated_on:
4616
- description: The date/time the entry was last updated on
4617
- format: date-time
4618
- title: Updated On
4619
- type: string
4620
- user_id:
4621
- default: None
4622
- description: The user's id
4623
- examples:
4624
- - user_01h45ytscbebyvny4gc8cr8ma2
4625
- format: typeid
4626
- pattern: ^user_[0-7][0-9a-hjkmnpq-tv-z]{25}$
4627
- title: User Id
4628
- type: string
4629
- x-typeid-prefix: user
4630
- user_verification_id:
4631
- examples:
4632
- - user_verification_01h45ytscbebyvny4gc8cr8ma2
4633
- format: typeid
4634
- pattern: ^user_verification_[0-7][0-9a-hjkmnpq-tv-z]{25}$
4635
- title: User Verification Id
4636
- type: string
4637
- x-typeid-prefix: user_verification
4638
- verified_on:
4639
- anyOf:
4640
- - format: date-time
4641
- type: string
4642
- - type: 'null'
4643
- description: The date the verification was verified
4644
- title: Verified On
4645
- required:
4646
- - token
4647
- - type
4648
- title: UserVerificationApiResponse
4649
- type: object
4650
- UserVerificationEmailResponse:
4651
- properties:
4652
- canceled_on:
4653
- anyOf:
4654
- - format: date-time
4655
- type: string
4656
- - type: 'null'
4657
- description: The date the verification was cancelled
4658
- title: Canceled On
4659
- created_on:
4660
- description: The date/time the entry was created on
4661
- format: date-time
4662
- title: Created On
4663
- type: string
4664
- status:
4665
- $ref: '#/components/schemas/EmailVerificationStatus'
4666
- default: pending
4667
- description: Current status of the email verification
4668
- type:
4669
- $ref: '#/components/schemas/VerificationType'
4670
- description: 'The type of verification: ''api'' for retrieving token via
4671
- API, ''email'' for retrieving via email'
4672
- updated_on:
4673
- description: The date/time the entry was last updated on
4674
- format: date-time
4675
- title: Updated On
4676
- type: string
4677
- user_id:
4678
- default: None
4679
- description: The user's id
4680
- examples:
4681
- - user_01h45ytscbebyvny4gc8cr8ma2
4682
- format: typeid
4683
- pattern: ^user_[0-7][0-9a-hjkmnpq-tv-z]{25}$
4684
- title: User Id
4685
- type: string
4686
- x-typeid-prefix: user
4687
- user_verification_id:
4688
- examples:
4689
- - user_verification_01h45ytscbebyvny4gc8cr8ma2
4690
- format: typeid
4691
- pattern: ^user_verification_[0-7][0-9a-hjkmnpq-tv-z]{25}$
4692
- title: User Verification Id
4693
- type: string
4694
- x-typeid-prefix: user_verification
4695
- verified_on:
4696
- anyOf:
4697
- - format: date-time
4698
- type: string
4699
- - type: 'null'
4700
- description: The date the verification was verified
4701
- title: Verified On
4702
- required:
4703
- - type
4704
- title: UserVerificationEmailResponse
4705
- type: object
4706
- UserVerificationResponse:
4707
- properties:
4708
- canceled_on:
4709
- anyOf:
4710
- - format: date-time
4711
- type: string
4712
- - type: 'null'
4713
- description: The date the verification was cancelled
4714
- title: Canceled On
4715
- created_on:
4716
- description: The date/time the entry was created on
4717
- format: date-time
4718
- title: Created On
4719
- type: string
4720
- status:
4721
- $ref: '#/components/schemas/EmailVerificationStatus'
4722
- default: pending
4723
- description: Current status of the email verification
4724
- type:
4725
- $ref: '#/components/schemas/VerificationType'
4726
- description: 'The type of verification: ''api'' for retrieving token via
4727
- API, ''email'' for retrieving via email'
4728
- updated_on:
4729
- description: The date/time the entry was last updated on
4730
- format: date-time
4731
- title: Updated On
4732
- type: string
4733
- user_id:
4734
- default: None
4735
- description: The user's id
4736
- examples:
4737
- - user_01h45ytscbebyvny4gc8cr8ma2
4738
- format: typeid
4739
- pattern: ^user_[0-7][0-9a-hjkmnpq-tv-z]{25}$
4740
- title: User Id
4741
- type: string
4742
- x-typeid-prefix: user
4743
- user_verification_id:
4744
- examples:
4745
- - user_verification_01h45ytscbebyvny4gc8cr8ma2
4746
- format: typeid
4747
- pattern: ^user_verification_[0-7][0-9a-hjkmnpq-tv-z]{25}$
4748
- title: User Verification Id
4749
- type: string
4750
- x-typeid-prefix: user_verification
4751
- verified_on:
4752
- anyOf:
4753
- - format: date-time
4754
- type: string
4755
- - type: 'null'
4756
- description: The date the verification was verified
4757
- title: Verified On
4758
- required:
4759
- - type
4760
- title: UserVerificationResponse
4761
- type: object
4762
4572
  UserWithAttributes:
4763
4573
  properties:
4764
4574
  created_on:
@@ -5098,7 +4908,7 @@ info:
5098
4908
  '
5099
4909
  summary: OpusDNS - your gateway to a seamless domain management experience.
5100
4910
  title: OpusDNS API
5101
- version: 2025-09-18-185443
4911
+ version: 2025-09-20-161341
5102
4912
  x-logo:
5103
4913
  altText: OpusDNS API Reference
5104
4914
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -8944,56 +8754,6 @@ paths:
8944
8754
  summary: Create User
8945
8755
  tags:
8946
8756
  - user
8947
- /v1/users/email/password-reset:
8948
- post:
8949
- operationId: create_user_password_reset_v1_users_email_password_reset_post
8950
- requestBody:
8951
- content:
8952
- application/json:
8953
- schema:
8954
- $ref: '#/components/schemas/StartPasswordReset'
8955
- required: true
8956
- responses:
8957
- '201':
8958
- content:
8959
- application/json:
8960
- schema:
8961
- $ref: '#/components/schemas/UserPasswordResetEmailResponse'
8962
- description: Successful Response
8963
- '422':
8964
- content:
8965
- application/problem+json:
8966
- schema:
8967
- $ref: '#/components/schemas/HTTPValidationError'
8968
- description: Validation Error
8969
- summary: Create User Password Reset
8970
- tags:
8971
- - user
8972
- /v1/users/email/verify:
8973
- get:
8974
- operationId: redirect_verify_user_v1_users_email_verify_get
8975
- parameters:
8976
- - in: query
8977
- name: token
8978
- required: true
8979
- schema:
8980
- title: Token
8981
- type: string
8982
- responses:
8983
- '200':
8984
- content:
8985
- application/json:
8986
- schema: {}
8987
- description: Successful Response
8988
- '422':
8989
- content:
8990
- application/problem+json:
8991
- schema:
8992
- $ref: '#/components/schemas/HTTPValidationError'
8993
- description: Validation Error
8994
- summary: Redirect Verify User
8995
- tags:
8996
- - user
8997
8757
  /v1/users/me:
8998
8758
  get:
8999
8759
  operationId: get_current_user_v1_users_me_get
@@ -9061,203 +8821,49 @@ paths:
9061
8821
  summary: Confirm User Password Reset Me
9062
8822
  tags:
9063
8823
  - user
9064
- /v1/users/me/verification:
9065
- get:
9066
- operationId: get_verification_status_me_v1_users_me_verification_get
8824
+ /v1/users/{user_id}:
8825
+ delete:
8826
+ operationId: delete_user_v1_users__user_id__delete
8827
+ parameters:
8828
+ - in: path
8829
+ name: user_id
8830
+ required: true
8831
+ schema:
8832
+ examples:
8833
+ - user_01h45ytscbebyvny4gc8cr8ma2
8834
+ format: typeid
8835
+ pattern: ^user_[0-7][0-9a-hjkmnpq-tv-z]{25}$
8836
+ title: User Id
8837
+ type: string
8838
+ x-typeid-prefix: user
9067
8839
  responses:
9068
- '200':
9069
- content:
9070
- application/json:
9071
- schema:
9072
- $ref: '#/components/schemas/UserVerificationResponse'
8840
+ '204':
9073
8841
  description: Successful Response
9074
- '401':
8842
+ '409':
9075
8843
  content:
9076
8844
  application/problem+json:
9077
8845
  example:
9078
- code: ERROR_AUTHENTICATION
9079
- detail: Additional error context.
9080
- status: 401
9081
- title: Authentication Error
9082
- type: authentication
8846
+ code: ERROR_USER_IS_LAST_ADMIN
8847
+ detail: User is the last admin for the organization
8848
+ status: 409
8849
+ title: User Management Error
8850
+ type: user-is-last-admin
9083
8851
  schema:
9084
8852
  $ref: '#/components/schemas/Problem'
9085
- description: Unauthorized
8853
+ description: Conflict
8854
+ '422':
8855
+ content:
8856
+ application/problem+json:
8857
+ schema:
8858
+ $ref: '#/components/schemas/HTTPValidationError'
8859
+ description: Validation Error
9086
8860
  security:
9087
8861
  - OAuth2PasswordBearer: []
9088
- summary: Get Verification Status Me
8862
+ summary: Delete User
9089
8863
  tags:
9090
8864
  - user
9091
- patch:
9092
- operationId: update_verification_me_v1_users_me_verification_patch
9093
- parameters:
9094
- - in: query
9095
- name: token
9096
- required: true
9097
- schema:
9098
- title: Token
9099
- type: string
9100
- responses:
9101
- '204':
9102
- description: Successful Response
9103
- '400':
9104
- content:
9105
- application/problem+json:
9106
- examples:
9107
- User Management Error:
9108
- value:
9109
- code: ERROR_USER_VERIFICATION_TOKEN_INVALID
9110
- detail: Invalid verification token
9111
- status: 400
9112
- title: User Management Error
9113
- type: user-verification-token-invalid
9114
- schema:
9115
- $ref: '#/components/schemas/Problem'
9116
- description: Bad Request
9117
- '401':
9118
- content:
9119
- application/problem+json:
9120
- example:
9121
- code: ERROR_AUTHENTICATION
9122
- detail: Additional error context.
9123
- status: 401
9124
- title: Authentication Error
9125
- type: authentication
9126
- schema:
9127
- $ref: '#/components/schemas/Problem'
9128
- description: Unauthorized
9129
- '404':
9130
- content:
9131
- application/problem+json:
9132
- example:
9133
- code: ERROR_USER_VERIFICATION_NOT_FOUND
9134
- detail: 'No user verification found for user: user_id=Additional error
9135
- context.'
9136
- status: 404
9137
- title: User Management Error
9138
- type: user-verification-not-found
9139
- schema:
9140
- $ref: '#/components/schemas/Problem'
9141
- description: Not Found
9142
- '422':
9143
- content:
9144
- application/problem+json:
9145
- schema:
9146
- $ref: '#/components/schemas/HTTPValidationError'
9147
- description: Validation Error
9148
- security:
9149
- - OAuth2PasswordBearer: []
9150
- summary: Update Verification Me
9151
- tags:
9152
- - user
9153
- post:
9154
- operationId: create_verification_me_v1_users_me_verification_post
9155
- parameters:
9156
- - in: query
9157
- name: type
9158
- required: true
9159
- schema:
9160
- $ref: '#/components/schemas/VerificationType'
9161
- responses:
9162
- '201':
9163
- content:
9164
- application/json:
9165
- schema:
9166
- anyOf:
9167
- - $ref: '#/components/schemas/UserVerificationEmailResponse'
9168
- - $ref: '#/components/schemas/UserVerificationApiResponse'
9169
- title: Response Create Verification Me V1 Users Me Verification Post
9170
- description: Successful Response
9171
- '401':
9172
- content:
9173
- application/problem+json:
9174
- example:
9175
- code: ERROR_AUTHENTICATION
9176
- detail: Additional error context.
9177
- status: 401
9178
- title: Authentication Error
9179
- type: authentication
9180
- schema:
9181
- $ref: '#/components/schemas/Problem'
9182
- description: Unauthorized
9183
- '404':
9184
- content:
9185
- application/problem+json:
9186
- example:
9187
- code: ERROR_USER_NOT_FOUND
9188
- detail: Additional error context.
9189
- status: 404
9190
- title: User Management Error
9191
- type: user-not-found
9192
- schema:
9193
- $ref: '#/components/schemas/Problem'
9194
- description: Not Found
9195
- '405':
9196
- content:
9197
- application/problem+json:
9198
- example:
9199
- code: ERROR_USER_VERIFICATION_INVALID_TYPE
9200
- detail: 'Invalid verification type: Additional error context.'
9201
- status: 405
9202
- title: User Management Error
9203
- type: user-verification-type-invalid
9204
- schema:
9205
- $ref: '#/components/schemas/Problem'
9206
- description: Method Not Allowed
9207
- '422':
9208
- content:
9209
- application/problem+json:
9210
- schema:
9211
- $ref: '#/components/schemas/HTTPValidationError'
9212
- description: Validation Error
9213
- security:
9214
- - OAuth2PasswordBearer: []
9215
- summary: Create Verification Me
9216
- tags:
9217
- - user
9218
- /v1/users/{user_id}:
9219
- delete:
9220
- operationId: delete_user_v1_users__user_id__delete
9221
- parameters:
9222
- - in: path
9223
- name: user_id
9224
- required: true
9225
- schema:
9226
- examples:
9227
- - user_01h45ytscbebyvny4gc8cr8ma2
9228
- format: typeid
9229
- pattern: ^user_[0-7][0-9a-hjkmnpq-tv-z]{25}$
9230
- title: User Id
9231
- type: string
9232
- x-typeid-prefix: user
9233
- responses:
9234
- '204':
9235
- description: Successful Response
9236
- '409':
9237
- content:
9238
- application/problem+json:
9239
- example:
9240
- code: ERROR_USER_IS_LAST_ADMIN
9241
- detail: User is the last admin for the organization
9242
- status: 409
9243
- title: User Management Error
9244
- type: user-is-last-admin
9245
- schema:
9246
- $ref: '#/components/schemas/Problem'
9247
- description: Conflict
9248
- '422':
9249
- content:
9250
- application/problem+json:
9251
- schema:
9252
- $ref: '#/components/schemas/HTTPValidationError'
9253
- description: Validation Error
9254
- security:
9255
- - OAuth2PasswordBearer: []
9256
- summary: Delete User
9257
- tags:
9258
- - user
9259
- get:
9260
- operationId: get_user_v1_users__user_id__get
8865
+ get:
8866
+ operationId: get_user_v1_users__user_id__get
9261
8867
  parameters:
9262
8868
  - in: path
9263
8869
  name: user_id
@@ -9440,201 +9046,6 @@ paths:
9440
9046
  summary: Update User Relations
9441
9047
  tags:
9442
9048
  - user
9443
- /v1/users/{user_id}/verification:
9444
- get:
9445
- operationId: get_verification_status_v1_users__user_id__verification_get
9446
- parameters:
9447
- - in: path
9448
- name: user_id
9449
- required: true
9450
- schema:
9451
- examples:
9452
- - user_01h45ytscbebyvny4gc8cr8ma2
9453
- format: typeid
9454
- pattern: ^user_[0-7][0-9a-hjkmnpq-tv-z]{25}$
9455
- title: User Id
9456
- type: string
9457
- x-typeid-prefix: user
9458
- responses:
9459
- '200':
9460
- content:
9461
- application/json:
9462
- schema:
9463
- $ref: '#/components/schemas/UserVerificationResponse'
9464
- description: Successful Response
9465
- '401':
9466
- content:
9467
- application/problem+json:
9468
- example:
9469
- code: ERROR_AUTHENTICATION
9470
- detail: Additional error context.
9471
- status: 401
9472
- title: Authentication Error
9473
- type: authentication
9474
- schema:
9475
- $ref: '#/components/schemas/Problem'
9476
- description: Unauthorized
9477
- '422':
9478
- content:
9479
- application/problem+json:
9480
- schema:
9481
- $ref: '#/components/schemas/HTTPValidationError'
9482
- description: Validation Error
9483
- security:
9484
- - OAuth2PasswordBearer: []
9485
- summary: Get Verification Status
9486
- tags:
9487
- - user
9488
- patch:
9489
- operationId: update_verification_v1_users__user_id__verification_patch
9490
- parameters:
9491
- - in: path
9492
- name: user_id
9493
- required: true
9494
- schema:
9495
- examples:
9496
- - user_01h45ytscbebyvny4gc8cr8ma2
9497
- format: typeid
9498
- pattern: ^user_[0-7][0-9a-hjkmnpq-tv-z]{25}$
9499
- title: User Id
9500
- type: string
9501
- x-typeid-prefix: user
9502
- - in: query
9503
- name: token
9504
- required: true
9505
- schema:
9506
- title: Token
9507
- type: string
9508
- responses:
9509
- '204':
9510
- description: Successful Response
9511
- '400':
9512
- content:
9513
- application/problem+json:
9514
- examples:
9515
- User Management Error:
9516
- value:
9517
- code: ERROR_USER_VERIFICATION_TOKEN_INVALID
9518
- detail: Invalid verification token
9519
- status: 400
9520
- title: User Management Error
9521
- type: user-verification-token-invalid
9522
- schema:
9523
- $ref: '#/components/schemas/Problem'
9524
- description: Bad Request
9525
- '401':
9526
- content:
9527
- application/problem+json:
9528
- example:
9529
- code: ERROR_AUTHENTICATION
9530
- detail: Additional error context.
9531
- status: 401
9532
- title: Authentication Error
9533
- type: authentication
9534
- schema:
9535
- $ref: '#/components/schemas/Problem'
9536
- description: Unauthorized
9537
- '404':
9538
- content:
9539
- application/problem+json:
9540
- example:
9541
- code: ERROR_USER_VERIFICATION_NOT_FOUND
9542
- detail: 'No user verification found for user: user_id=Additional error
9543
- context.'
9544
- status: 404
9545
- title: User Management Error
9546
- type: user-verification-not-found
9547
- schema:
9548
- $ref: '#/components/schemas/Problem'
9549
- description: Not Found
9550
- '422':
9551
- content:
9552
- application/problem+json:
9553
- schema:
9554
- $ref: '#/components/schemas/HTTPValidationError'
9555
- description: Validation Error
9556
- security:
9557
- - OAuth2PasswordBearer: []
9558
- summary: Update Verification
9559
- tags:
9560
- - user
9561
- post:
9562
- operationId: create_verification_v1_users__user_id__verification_post
9563
- parameters:
9564
- - in: path
9565
- name: user_id
9566
- required: true
9567
- schema:
9568
- examples:
9569
- - user_01h45ytscbebyvny4gc8cr8ma2
9570
- format: typeid
9571
- pattern: ^user_[0-7][0-9a-hjkmnpq-tv-z]{25}$
9572
- title: User Id
9573
- type: string
9574
- x-typeid-prefix: user
9575
- - in: query
9576
- name: type
9577
- required: true
9578
- schema:
9579
- $ref: '#/components/schemas/VerificationType'
9580
- responses:
9581
- '201':
9582
- content:
9583
- application/json:
9584
- schema:
9585
- anyOf:
9586
- - $ref: '#/components/schemas/UserVerificationEmailResponse'
9587
- - $ref: '#/components/schemas/UserVerificationApiResponse'
9588
- title: Response Create Verification V1 Users User Id Verification
9589
- Post
9590
- description: Successful Response
9591
- '401':
9592
- content:
9593
- application/problem+json:
9594
- example:
9595
- code: ERROR_AUTHENTICATION
9596
- detail: Additional error context.
9597
- status: 401
9598
- title: Authentication Error
9599
- type: authentication
9600
- schema:
9601
- $ref: '#/components/schemas/Problem'
9602
- description: Unauthorized
9603
- '404':
9604
- content:
9605
- application/problem+json:
9606
- example:
9607
- code: ERROR_USER_NOT_FOUND
9608
- detail: Additional error context.
9609
- status: 404
9610
- title: User Management Error
9611
- type: user-not-found
9612
- schema:
9613
- $ref: '#/components/schemas/Problem'
9614
- description: Not Found
9615
- '405':
9616
- content:
9617
- application/problem+json:
9618
- example:
9619
- code: ERROR_USER_VERIFICATION_INVALID_TYPE
9620
- detail: 'Invalid verification type: Additional error context.'
9621
- status: 405
9622
- title: User Management Error
9623
- type: user-verification-type-invalid
9624
- schema:
9625
- $ref: '#/components/schemas/Problem'
9626
- description: Method Not Allowed
9627
- '422':
9628
- content:
9629
- application/problem+json:
9630
- schema:
9631
- $ref: '#/components/schemas/HTTPValidationError'
9632
- description: Validation Error
9633
- security:
9634
- - OAuth2PasswordBearer: []
9635
- summary: Create Verification
9636
- tags:
9637
- - user
9638
9049
  servers:
9639
9050
  - description: Production environment
9640
9051
  url: https://api.opusdns.com