@opusdns/api 0.78.0 → 0.79.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
@@ -1,12 +1,5 @@
1
1
  components:
2
2
  schemas:
3
- AgreementType:
4
- enum:
5
- - terms_and_conditions
6
- - master_service_agreement
7
- - acting_as_trader
8
- title: AgreementType
9
- type: string
10
3
  AllocationMethodType:
11
4
  enum:
12
5
  - fcfs
@@ -199,42 +192,6 @@ components:
199
192
  - canceled
200
193
  title: BillingTransactionStatus
201
194
  type: string
202
- Body_issue_organization_token_v1_auth_token_post:
203
- properties:
204
- client_id:
205
- anyOf:
206
- - examples:
207
- - organization_01h45ytscbebyvny4gc8cr8ma2
208
- format: typeid
209
- pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
210
- type: string
211
- x-typeid-prefix: organization
212
- - type: 'null'
213
- description: The organization ID associated with the credentials.
214
- title: Client Id
215
- client_secret:
216
- anyOf:
217
- - type: string
218
- - type: 'null'
219
- description: Client secret for authentication.
220
- title: Client Secret
221
- grant_type:
222
- $ref: '#/components/schemas/GrantType'
223
- description: The grant type for the authentication request.
224
- password:
225
- anyOf:
226
- - type: string
227
- - type: 'null'
228
- description: Password for the user.
229
- title: Password
230
- username:
231
- anyOf:
232
- - type: string
233
- - type: 'null'
234
- description: Username for authentication.
235
- title: Username
236
- title: Body_issue_organization_token_v1_auth_token_post
237
- type: object
238
195
  CheckoutSessionRequest:
239
196
  properties: {}
240
197
  title: CheckoutSessionRequest
@@ -3217,164 +3174,6 @@ components:
3217
3174
  - name
3218
3175
  title: OrganizationCreate
3219
3176
  type: object
3220
- OrganizationCredential:
3221
- properties:
3222
- api_key_description:
3223
- anyOf:
3224
- - type: string
3225
- - type: 'null'
3226
- description: Description of the organization credential.
3227
- title: Api Key Description
3228
- api_key_id:
3229
- description: Unique identifier of the organization credential.
3230
- examples:
3231
- - api_key_01h45ytscbebyvny4gc8cr8ma2
3232
- format: typeid
3233
- pattern: ^api_key_[0-7][0-9a-hjkmnpq-tv-z]{25}$
3234
- title: Api Key Id
3235
- type: string
3236
- x-typeid-prefix: api_key
3237
- api_key_name:
3238
- anyOf:
3239
- - type: string
3240
- - type: 'null'
3241
- description: Name of the organization credential. Only a-z, A-Z, 0-9, underscore,
3242
- and hyphen are allowed.
3243
- title: Api Key Name
3244
- created_on:
3245
- description: The date/time the entry was created on
3246
- format: date-time
3247
- title: Created On
3248
- type: string
3249
- deleted_on:
3250
- anyOf:
3251
- - format: date-time
3252
- type: string
3253
- - type: 'null'
3254
- description: The date/time the entry was deleted on
3255
- title: Deleted On
3256
- last_used_on:
3257
- anyOf:
3258
- - format: date-time
3259
- type: string
3260
- - type: 'null'
3261
- description: The date/time the entry was deleted on
3262
- title: Last Used On
3263
- organization_id:
3264
- default: None
3265
- examples:
3266
- - organization_01h45ytscbebyvny4gc8cr8ma2
3267
- format: typeid
3268
- pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
3269
- title: Organization Id
3270
- type: string
3271
- x-typeid-prefix: organization
3272
- status:
3273
- $ref: '#/components/schemas/OrganizationCredentialStatus'
3274
- description: The status of the organization credential.
3275
- readOnly: true
3276
- required:
3277
- - api_key_id
3278
- - status
3279
- title: OrganizationCredential
3280
- type: object
3281
- OrganizationCredentialCreated:
3282
- properties:
3283
- api_key:
3284
- description: Unique identifier of the organization credential.
3285
- examples:
3286
- - api_key_01h45ytscbebyvny4gc8cr8ma2
3287
- format: typeid
3288
- pattern: ^api_key_[0-7][0-9a-hjkmnpq-tv-z]{25}$
3289
- title: Api Key
3290
- type: string
3291
- x-typeid-prefix: api_key
3292
- api_key_description:
3293
- anyOf:
3294
- - type: string
3295
- - type: 'null'
3296
- description: Description of the organization credential.
3297
- title: Api Key Description
3298
- api_key_name:
3299
- anyOf:
3300
- - type: string
3301
- - type: 'null'
3302
- description: Name of the organization credential. Only a-z, A-Z, 0-9, underscore,
3303
- and hyphen are allowed.
3304
- title: Api Key Name
3305
- client_id:
3306
- default: None
3307
- examples:
3308
- - organization_01h45ytscbebyvny4gc8cr8ma2
3309
- format: typeid
3310
- pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
3311
- title: Client Id
3312
- type: string
3313
- x-typeid-prefix: organization
3314
- client_secret:
3315
- anyOf:
3316
- - type: string
3317
- - type: 'null'
3318
- description: Plaintext secret to be hashed (not stored directly in the DB).
3319
- title: Client Secret
3320
- created_on:
3321
- description: The date/time the entry was created on
3322
- format: date-time
3323
- title: Created On
3324
- type: string
3325
- deleted_on:
3326
- anyOf:
3327
- - format: date-time
3328
- type: string
3329
- - type: 'null'
3330
- description: The date/time the entry was deleted on
3331
- title: Deleted On
3332
- last_used_on:
3333
- anyOf:
3334
- - format: date-time
3335
- type: string
3336
- - type: 'null'
3337
- description: The date/time the entry was deleted on
3338
- title: Last Used On
3339
- status:
3340
- $ref: '#/components/schemas/OrganizationCredentialStatus'
3341
- description: The status of the organization credential.
3342
- readOnly: true
3343
- required:
3344
- - api_key
3345
- - status
3346
- title: OrganizationCredentialCreated
3347
- type: object
3348
- OrganizationCredentialExtra:
3349
- properties:
3350
- api_key_description:
3351
- anyOf:
3352
- - type: string
3353
- - type: 'null'
3354
- description: Description of the organization credential.
3355
- title: Api Key Description
3356
- api_key_name:
3357
- anyOf:
3358
- - type: string
3359
- - type: 'null'
3360
- description: Name of the organization credential. Only a-z, A-Z, 0-9, underscore,
3361
- and hyphen are allowed.
3362
- title: Api Key Name
3363
- expires_at:
3364
- anyOf:
3365
- - format: date-time
3366
- type: string
3367
- - type: 'null'
3368
- description: The date and time the credential expiration.
3369
- title: Expires At
3370
- title: OrganizationCredentialExtra
3371
- type: object
3372
- OrganizationCredentialStatus:
3373
- enum:
3374
- - active
3375
- - revoked
3376
- title: OrganizationCredentialStatus
3377
- type: string
3378
3177
  OrganizationStatus:
3379
3178
  enum:
3380
3179
  - active
@@ -3758,20 +3557,6 @@ components:
3758
3557
  - pagination
3759
3558
  title: Pagination[EventResponse]
3760
3559
  type: object
3761
- Pagination_OrganizationCredential_:
3762
- properties:
3763
- pagination:
3764
- $ref: '#/components/schemas/PaginationMetadata'
3765
- results:
3766
- items:
3767
- $ref: '#/components/schemas/OrganizationCredential'
3768
- title: Results
3769
- type: array
3770
- required:
3771
- - results
3772
- - pagination
3773
- title: Pagination[OrganizationCredential]
3774
- type: object
3775
3560
  Pagination_Organization_:
3776
3561
  properties:
3777
3562
  pagination:
@@ -4058,6 +3843,32 @@ components:
4058
3843
  - status
4059
3844
  title: Problem
4060
3845
  type: object
3846
+ PublicAuthRequestForm:
3847
+ properties:
3848
+ client_id:
3849
+ description: The organization ID associated with the credentials.
3850
+ examples:
3851
+ - organization_01h45ytscbebyvny4gc8cr8ma2
3852
+ format: typeid
3853
+ pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
3854
+ title: Client Id
3855
+ type: string
3856
+ x-typeid-prefix: organization
3857
+ client_secret:
3858
+ description: Client secret for authentication.
3859
+ title: Client Secret
3860
+ type: string
3861
+ grant_type:
3862
+ description: The grant type for the authentication request (should always
3863
+ be 'client_credentials').
3864
+ title: Grant Type
3865
+ type: string
3866
+ required:
3867
+ - grant_type
3868
+ - client_id
3869
+ - client_secret
3870
+ title: PublicAuthRequestForm
3871
+ type: object
4061
3872
  RdapBase:
4062
3873
  properties:
4063
3874
  rdap_server:
@@ -4198,43 +4009,6 @@ components:
4198
4009
  type: boolean
4199
4010
  title: RgpOperations
4200
4011
  type: object
4201
- SignupCreate:
4202
- properties:
4203
- agreements:
4204
- anyOf:
4205
- - items:
4206
- $ref: '#/components/schemas/UserAgreementAcceptance'
4207
- type: array
4208
- - type: 'null'
4209
- description: User agreement acceptances.
4210
- title: Agreements
4211
- organization:
4212
- $ref: '#/components/schemas/OrganizationCreate'
4213
- description: Organization signup.
4214
- terms_of_service:
4215
- anyOf:
4216
- - $ref: '#/components/schemas/TermsOfServiceAccept'
4217
- - type: 'null'
4218
- description: Terms of service acceptance (legacy).
4219
- user:
4220
- $ref: '#/components/schemas/UserCreate'
4221
- description: User signup to platform.
4222
- required:
4223
- - user
4224
- - organization
4225
- title: SignupCreate
4226
- type: object
4227
- SignupResponse:
4228
- properties:
4229
- organization:
4230
- $ref: '#/components/schemas/Organization'
4231
- user:
4232
- $ref: '#/components/schemas/User'
4233
- required:
4234
- - user
4235
- - organization
4236
- title: SignupResponse
4237
- type: object
4238
4012
  SldLength:
4239
4013
  properties:
4240
4014
  max:
@@ -4289,16 +4063,6 @@ components:
4289
4063
  - ccTLD
4290
4064
  title: TLDType
4291
4065
  type: string
4292
- TermsOfServiceAccept:
4293
- properties:
4294
- accepted:
4295
- description: The organization accepts Terms of Service.
4296
- title: Accepted
4297
- type: boolean
4298
- required:
4299
- - accepted
4300
- title: TermsOfServiceAccept
4301
- type: object
4302
4066
  TldBase:
4303
4067
  properties:
4304
4068
  name:
@@ -4646,35 +4410,6 @@ components:
4646
4410
  - status
4647
4411
  title: User
4648
4412
  type: object
4649
- UserAgreementAcceptance:
4650
- properties:
4651
- accepted:
4652
- description: Whether the agreement has been accepted.
4653
- title: Accepted
4654
- type: boolean
4655
- type:
4656
- $ref: '#/components/schemas/AgreementType'
4657
- description: Type of agreement being accepted.
4658
- url:
4659
- anyOf:
4660
- - format: uri
4661
- maxLength: 2083
4662
- minLength: 1
4663
- type: string
4664
- - type: 'null'
4665
- description: URL where the agreement can be found.
4666
- title: Url
4667
- version:
4668
- anyOf:
4669
- - type: string
4670
- - type: 'null'
4671
- description: Version of the agreement being accepted.
4672
- title: Version
4673
- required:
4674
- - type
4675
- - accepted
4676
- title: UserAgreementAcceptance
4677
- type: object
4678
4413
  UserAttributeBase:
4679
4414
  properties:
4680
4415
  key:
@@ -5236,239 +4971,12 @@ info:
5236
4971
  '
5237
4972
  summary: OpusDNS - your gateway to a seamless domain management experience.
5238
4973
  title: OpusDNS API
5239
- version: 2025-10-02-163917
4974
+ version: 2025-10-02-195210
5240
4975
  x-logo:
5241
4976
  altText: OpusDNS API Reference
5242
4977
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
5243
4978
  openapi: 3.1.0
5244
4979
  paths:
5245
- /v1/auth/client_credentials:
5246
- get:
5247
- operationId: list_api_keys_v1_auth_client_credentials_get
5248
- parameters:
5249
- - description: Optional status to filter the results
5250
- in: query
5251
- name: status
5252
- required: false
5253
- schema:
5254
- anyOf:
5255
- - $ref: '#/components/schemas/OrganizationCredentialStatus'
5256
- - type: 'null'
5257
- description: Optional status to filter the results
5258
- title: Status
5259
- - in: query
5260
- name: page
5261
- required: false
5262
- schema:
5263
- default: 1
5264
- minimum: 1
5265
- title: Page
5266
- type: integer
5267
- - in: query
5268
- name: page_size
5269
- required: false
5270
- schema:
5271
- default: 10
5272
- maximum: 100
5273
- minimum: 1
5274
- title: Page Size
5275
- type: integer
5276
- responses:
5277
- '200':
5278
- content:
5279
- application/json:
5280
- schema:
5281
- $ref: '#/components/schemas/Pagination_OrganizationCredential_'
5282
- description: Successful Response
5283
- '401':
5284
- content:
5285
- application/problem+json:
5286
- example:
5287
- code: ERROR_AUTHENTICATION
5288
- detail: Additional error context.
5289
- status: 401
5290
- title: Authentication Error
5291
- type: authentication
5292
- schema:
5293
- $ref: '#/components/schemas/Problem'
5294
- description: Unauthorized
5295
- '422':
5296
- content:
5297
- application/problem+json:
5298
- schema:
5299
- $ref: '#/components/schemas/HTTPValidationError'
5300
- description: Validation Error
5301
- security:
5302
- - OAuth2PasswordBearer: []
5303
- summary: List all API keys
5304
- tags:
5305
- - authentication
5306
- post:
5307
- operationId: issue_api_key_v1_auth_client_credentials_post
5308
- requestBody:
5309
- content:
5310
- application/json:
5311
- schema:
5312
- $ref: '#/components/schemas/OrganizationCredentialExtra'
5313
- required: true
5314
- responses:
5315
- '200':
5316
- content:
5317
- application/json:
5318
- schema:
5319
- $ref: '#/components/schemas/OrganizationCredentialCreated'
5320
- description: Successful Response
5321
- '401':
5322
- content:
5323
- application/problem+json:
5324
- example:
5325
- code: ERROR_AUTHENTICATION
5326
- detail: Additional error context.
5327
- status: 401
5328
- title: Authentication Error
5329
- type: authentication
5330
- schema:
5331
- $ref: '#/components/schemas/Problem'
5332
- description: Unauthorized
5333
- '422':
5334
- content:
5335
- application/problem+json:
5336
- schema:
5337
- $ref: '#/components/schemas/HTTPValidationError'
5338
- description: Validation Error
5339
- security:
5340
- - OAuth2PasswordBearer: []
5341
- summary: Issue an API key
5342
- tags:
5343
- - authentication
5344
- /v1/auth/client_credentials/{api_key_id}:
5345
- delete:
5346
- operationId: delete_api_key_v1_auth_client_credentials__api_key_id__delete
5347
- parameters:
5348
- - in: path
5349
- name: api_key_id
5350
- required: true
5351
- schema:
5352
- examples:
5353
- - api_key_01h45ytscbebyvny4gc8cr8ma2
5354
- format: typeid
5355
- pattern: ^api_key_[0-7][0-9a-hjkmnpq-tv-z]{25}$
5356
- title: Api Key Id
5357
- type: string
5358
- x-typeid-prefix: api_key
5359
- responses:
5360
- '204':
5361
- description: Successful Response
5362
- '401':
5363
- content:
5364
- application/problem+json:
5365
- example:
5366
- code: ERROR_AUTHENTICATION
5367
- detail: Additional error context.
5368
- status: 401
5369
- title: Authentication Error
5370
- type: authentication
5371
- schema:
5372
- $ref: '#/components/schemas/Problem'
5373
- description: Unauthorized
5374
- '404':
5375
- content:
5376
- application/problem+json:
5377
- example:
5378
- code: ERROR_ORGANIZATION_CREDENTIAL_NOT_FOUND
5379
- credential_id: Additional error context.
5380
- detail: Organization credential with ID Additional error context.
5381
- not found
5382
- status: 404
5383
- title: Organization Management Error
5384
- type: organization-credential-not-found
5385
- schema:
5386
- $ref: '#/components/schemas/Problem'
5387
- description: Not Found
5388
- '422':
5389
- content:
5390
- application/problem+json:
5391
- schema:
5392
- $ref: '#/components/schemas/HTTPValidationError'
5393
- description: Validation Error
5394
- security:
5395
- - OAuth2PasswordBearer: []
5396
- summary: Delete an API key
5397
- tags:
5398
- - authentication
5399
- /v1/auth/logout:
5400
- post:
5401
- operationId: logout_v1_auth_logout_post
5402
- responses:
5403
- '204':
5404
- description: Successful Response
5405
- '401':
5406
- content:
5407
- application/problem+json:
5408
- example:
5409
- code: ERROR_AUTHENTICATION
5410
- detail: Additional error context.
5411
- status: 401
5412
- title: Authentication Error
5413
- type: authentication
5414
- schema:
5415
- $ref: '#/components/schemas/Problem'
5416
- description: Unauthorized
5417
- security:
5418
- - OAuth2PasswordBearer: []
5419
- summary: Logout
5420
- tags:
5421
- - authentication
5422
- /v1/auth/signup:
5423
- post:
5424
- operationId: signup_v1_auth_signup_post
5425
- requestBody:
5426
- content:
5427
- application/json:
5428
- schema:
5429
- $ref: '#/components/schemas/SignupCreate'
5430
- required: true
5431
- responses:
5432
- '200':
5433
- content:
5434
- application/json:
5435
- schema:
5436
- $ref: '#/components/schemas/SignupResponse'
5437
- description: Successful Response
5438
- '403':
5439
- content:
5440
- application/problem+json:
5441
- example:
5442
- code: ERROR_SIGNUP_NOT_ALLOWED
5443
- detail: Additional error context.
5444
- status: 403
5445
- title: Organization Management Error
5446
- type: signup-not-allowed
5447
- schema:
5448
- $ref: '#/components/schemas/Problem'
5449
- description: Forbidden
5450
- '409':
5451
- content:
5452
- application/problem+json:
5453
- example:
5454
- code: ERROR_USER_EXISTS
5455
- detail: User with username or email already exists
5456
- status: 409
5457
- title: User Management Error
5458
- type: user-already-present
5459
- user: Additional error context.
5460
- schema:
5461
- $ref: '#/components/schemas/Problem'
5462
- description: Conflict
5463
- '422':
5464
- content:
5465
- application/problem+json:
5466
- schema:
5467
- $ref: '#/components/schemas/HTTPValidationError'
5468
- description: Validation Error
5469
- summary: Signup
5470
- tags:
5471
- - authentication
5472
4980
  /v1/auth/token:
5473
4981
  post:
5474
4982
  operationId: issue_organization_token_v1_auth_token_post
@@ -5476,7 +4984,7 @@ paths:
5476
4984
  content:
5477
4985
  application/x-www-form-urlencoded:
5478
4986
  schema:
5479
- $ref: '#/components/schemas/Body_issue_organization_token_v1_auth_token_post'
4987
+ $ref: '#/components/schemas/PublicAuthRequestForm'
5480
4988
  responses:
5481
4989
  '200':
5482
4990
  content: