@opusdns/api 0.53.0 → 0.55.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
@@ -2582,192 +2582,6 @@ components:
2582
2582
  - hostname
2583
2583
  title: Nameserver
2584
2584
  type: object
2585
- Notification:
2586
- properties:
2587
- author:
2588
- description: The user or system that created the notification
2589
- title: Author
2590
- type: string
2591
- created_on:
2592
- description: The date/time the entry was created on
2593
- format: date-time
2594
- title: Created On
2595
- type: string
2596
- message:
2597
- description: The message content of the notification
2598
- title: Message
2599
- type: string
2600
- notification_id:
2601
- examples:
2602
- - notification_01h45ytscbebyvny4gc8cr8ma2
2603
- format: typeid
2604
- pattern: ^notification_[0-7][0-9a-hjkmnpq-tv-z]{25}$
2605
- title: Notification Id
2606
- type: string
2607
- x-typeid-prefix: notification
2608
- publish_date:
2609
- description: The date/time the notification is to be published
2610
- format: date-time
2611
- title: Publish Date
2612
- type: string
2613
- source:
2614
- description: Source of the notification
2615
- title: Source
2616
- type: string
2617
- subject:
2618
- description: The subject of the notification
2619
- title: Subject
2620
- type: string
2621
- target:
2622
- description: Target audience (broadcast, account, user)
2623
- title: Target
2624
- type: string
2625
- type:
2626
- description: The type of notification
2627
- title: Type
2628
- type: string
2629
- updated_on:
2630
- description: The date/time the entry was last updated on
2631
- format: date-time
2632
- title: Updated On
2633
- type: string
2634
- required:
2635
- - subject
2636
- - type
2637
- - source
2638
- - message
2639
- - author
2640
- - target
2641
- title: Notification
2642
- type: object
2643
- NotificationCreate:
2644
- properties:
2645
- author:
2646
- description: The user or system that created the notification
2647
- title: Author
2648
- type: string
2649
- message:
2650
- description: The message content of the notification
2651
- title: Message
2652
- type: string
2653
- publish_date:
2654
- description: The date/time the notification is to be published
2655
- format: date-time
2656
- title: Publish Date
2657
- type: string
2658
- source:
2659
- description: Source of the notification
2660
- title: Source
2661
- type: string
2662
- subject:
2663
- description: The subject of the notification
2664
- title: Subject
2665
- type: string
2666
- target:
2667
- description: Target audience (broadcast, account, user)
2668
- title: Target
2669
- type: string
2670
- type:
2671
- description: The type of notification
2672
- title: Type
2673
- type: string
2674
- required:
2675
- - subject
2676
- - type
2677
- - source
2678
- - message
2679
- - author
2680
- - target
2681
- title: NotificationCreate
2682
- type: object
2683
- NotificationSummary:
2684
- properties:
2685
- author:
2686
- description: The user or system that created the notification
2687
- title: Author
2688
- type: string
2689
- message:
2690
- description: The message content of the notification
2691
- title: Message
2692
- type: string
2693
- notification_id:
2694
- examples:
2695
- - notification_01h45ytscbebyvny4gc8cr8ma2
2696
- format: typeid
2697
- pattern: ^notification_[0-7][0-9a-hjkmnpq-tv-z]{25}$
2698
- title: Notification Id
2699
- type: string
2700
- x-typeid-prefix: notification
2701
- publish_date:
2702
- description: The date/time the notification is to be published
2703
- format: date-time
2704
- title: Publish Date
2705
- type: string
2706
- source:
2707
- description: Source of the notification
2708
- title: Source
2709
- type: string
2710
- subject:
2711
- description: The subject of the notification
2712
- title: Subject
2713
- type: string
2714
- target:
2715
- description: Target audience (broadcast, account, user)
2716
- title: Target
2717
- type: string
2718
- type:
2719
- description: The type of notification
2720
- title: Type
2721
- type: string
2722
- required:
2723
- - subject
2724
- - type
2725
- - source
2726
- - message
2727
- - author
2728
- - target
2729
- title: NotificationSummary
2730
- type: object
2731
- NotificationUpdate:
2732
- properties:
2733
- author:
2734
- description: The user or system that created the notification
2735
- title: Author
2736
- type: string
2737
- message:
2738
- description: The message content of the notification
2739
- title: Message
2740
- type: string
2741
- publish_date:
2742
- description: The date/time the notification is to be published
2743
- format: date-time
2744
- title: Publish Date
2745
- type: string
2746
- source:
2747
- description: Source of the notification
2748
- title: Source
2749
- type: string
2750
- subject:
2751
- description: The subject of the notification
2752
- title: Subject
2753
- type: string
2754
- target:
2755
- description: Target audience (broadcast, account, user)
2756
- title: Target
2757
- type: string
2758
- type:
2759
- description: The type of notification
2760
- title: Type
2761
- type: string
2762
- required:
2763
- - subject
2764
- - type
2765
- - source
2766
- - message
2767
- - author
2768
- - target
2769
- title: NotificationUpdate
2770
- type: object
2771
2585
  Organization:
2772
2586
  properties:
2773
2587
  address_1:
@@ -3722,20 +3536,6 @@ components:
3722
3536
  - pagination
3723
3537
  title: Pagination[Organization]
3724
3538
  type: object
3725
- Pagination_UserNotificationSummary_:
3726
- properties:
3727
- pagination:
3728
- $ref: '#/components/schemas/PaginationMetadata'
3729
- results:
3730
- items:
3731
- $ref: '#/components/schemas/UserNotificationSummary'
3732
- title: Results
3733
- type: array
3734
- required:
3735
- - results
3736
- - pagination
3737
- title: Pagination[UserNotificationSummary]
3738
- type: object
3739
3539
  Pagination_User_:
3740
3540
  properties:
3741
3541
  pagination:
@@ -3880,6 +3680,22 @@ components:
3880
3680
  - amount
3881
3681
  title: PlanInfo
3882
3682
  type: object
3683
+ PlanRelation:
3684
+ enum:
3685
+ - basic
3686
+ - enterprise
3687
+ - corporate
3688
+ - premium
3689
+ - starter
3690
+ title: PlanRelation
3691
+ type: string
3692
+ PlanUpdate:
3693
+ properties:
3694
+ plan:
3695
+ $ref: '#/components/schemas/PlanRelation'
3696
+ default: basic
3697
+ title: PlanUpdate
3698
+ type: object
3883
3699
  PostTransferRequirements:
3884
3700
  enum:
3885
3701
  - update_contacts
@@ -4671,81 +4487,6 @@ components:
4671
4487
  - password
4672
4488
  title: UserCreate
4673
4489
  type: object
4674
- UserNotification:
4675
- properties:
4676
- created_on:
4677
- description: The date/time the entry was created on
4678
- format: date-time
4679
- title: Created On
4680
- type: string
4681
- notification:
4682
- $ref: '#/components/schemas/Notification'
4683
- notification_id:
4684
- default: None
4685
- description: Unique identifier for the notification
4686
- examples:
4687
- - notification_01h45ytscbebyvny4gc8cr8ma2
4688
- format: typeid
4689
- pattern: ^notification_[0-7][0-9a-hjkmnpq-tv-z]{25}$
4690
- title: Notification Id
4691
- type: string
4692
- x-typeid-prefix: notification
4693
- status:
4694
- $ref: '#/components/schemas/UserNotificationStatus'
4695
- default: unread
4696
- description: Whether the user has read the notification
4697
- updated_on:
4698
- description: The date/time the entry was last updated on
4699
- format: date-time
4700
- title: Updated On
4701
- type: string
4702
- user_id:
4703
- default: None
4704
- examples:
4705
- - user_01h45ytscbebyvny4gc8cr8ma2
4706
- format: typeid
4707
- pattern: ^user_[0-7][0-9a-hjkmnpq-tv-z]{25}$
4708
- title: User Id
4709
- type: string
4710
- x-typeid-prefix: user
4711
- user_notification_id:
4712
- examples:
4713
- - user_notification_01h45ytscbebyvny4gc8cr8ma2
4714
- format: typeid
4715
- pattern: ^user_notification_[0-7][0-9a-hjkmnpq-tv-z]{25}$
4716
- title: User Notification Id
4717
- type: string
4718
- x-typeid-prefix: user_notification
4719
- required:
4720
- - notification
4721
- title: UserNotification
4722
- type: object
4723
- UserNotificationStatus:
4724
- enum:
4725
- - read
4726
- - unread
4727
- title: UserNotificationStatus
4728
- type: string
4729
- UserNotificationSummary:
4730
- properties:
4731
- notification:
4732
- $ref: '#/components/schemas/NotificationSummary'
4733
- status:
4734
- $ref: '#/components/schemas/UserNotificationStatus'
4735
- default: unread
4736
- description: Whether the user has read the notification
4737
- user_notification_id:
4738
- examples:
4739
- - user_notification_01h45ytscbebyvny4gc8cr8ma2
4740
- format: typeid
4741
- pattern: ^user_notification_[0-7][0-9a-hjkmnpq-tv-z]{25}$
4742
- title: User Notification Id
4743
- type: string
4744
- x-typeid-prefix: user_notification
4745
- required:
4746
- - notification
4747
- title: UserNotificationSummary
4748
- type: object
4749
4490
  UserPasswordResetEmailResponse:
4750
4491
  properties:
4751
4492
  message:
@@ -5357,7 +5098,7 @@ info:
5357
5098
  '
5358
5099
  summary: OpusDNS - your gateway to a seamless domain management experience.
5359
5100
  title: OpusDNS API
5360
- version: 2025-09-18-175058
5101
+ version: 2025-09-18-185443
5361
5102
  x-logo:
5362
5103
  altText: OpusDNS API Reference
5363
5104
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -8419,227 +8160,6 @@ paths:
8419
8160
  summary: Acknowledge Event
8420
8161
  tags:
8421
8162
  - event
8422
- /v1/notifications:
8423
- get:
8424
- operationId: list_notifications_v1_notifications_get
8425
- parameters:
8426
- - in: query
8427
- name: user_id
8428
- required: true
8429
- schema:
8430
- examples:
8431
- - user_01h45ytscbebyvny4gc8cr8ma2
8432
- format: typeid
8433
- pattern: ^user_[0-7][0-9a-hjkmnpq-tv-z]{25}$
8434
- title: User Id
8435
- type: string
8436
- x-typeid-prefix: user
8437
- - in: query
8438
- name: page
8439
- required: false
8440
- schema:
8441
- default: 1
8442
- minimum: 1
8443
- title: Page
8444
- type: integer
8445
- - in: query
8446
- name: page_size
8447
- required: false
8448
- schema:
8449
- default: 10
8450
- maximum: 100
8451
- minimum: 1
8452
- title: Page Size
8453
- type: integer
8454
- responses:
8455
- '200':
8456
- content:
8457
- application/json:
8458
- schema:
8459
- $ref: '#/components/schemas/Pagination_UserNotificationSummary_'
8460
- description: Successful Response
8461
- '422':
8462
- content:
8463
- application/problem+json:
8464
- schema:
8465
- $ref: '#/components/schemas/HTTPValidationError'
8466
- description: Validation Error
8467
- security:
8468
- - OAuth2PasswordBearer: []
8469
- summary: List Notifications
8470
- tags:
8471
- - notification
8472
- post:
8473
- operationId: create_notification_v1_notifications_post
8474
- requestBody:
8475
- content:
8476
- application/json:
8477
- schema:
8478
- $ref: '#/components/schemas/NotificationCreate'
8479
- required: true
8480
- responses:
8481
- '201':
8482
- content:
8483
- application/json:
8484
- schema:
8485
- $ref: '#/components/schemas/Notification'
8486
- description: Successful Response
8487
- '422':
8488
- content:
8489
- application/problem+json:
8490
- schema:
8491
- $ref: '#/components/schemas/HTTPValidationError'
8492
- description: Validation Error
8493
- security:
8494
- - OAuth2PasswordBearer: []
8495
- summary: Create Notification
8496
- tags:
8497
- - notification
8498
- /v1/notifications/{notification_id}:
8499
- delete:
8500
- operationId: delete_notification_v1_notifications__notification_id__delete
8501
- parameters:
8502
- - in: path
8503
- name: notification_id
8504
- required: true
8505
- schema:
8506
- examples:
8507
- - notification_01h45ytscbebyvny4gc8cr8ma2
8508
- format: typeid
8509
- pattern: ^notification_[0-7][0-9a-hjkmnpq-tv-z]{25}$
8510
- title: Notification Id
8511
- type: string
8512
- x-typeid-prefix: notification
8513
- responses:
8514
- '200':
8515
- content:
8516
- application/json:
8517
- schema: {}
8518
- description: Successful Response
8519
- '422':
8520
- content:
8521
- application/problem+json:
8522
- schema:
8523
- $ref: '#/components/schemas/HTTPValidationError'
8524
- description: Validation Error
8525
- security:
8526
- - OAuth2PasswordBearer: []
8527
- summary: Delete Notification
8528
- tags:
8529
- - notification
8530
- get:
8531
- operationId: get_notification_v1_notifications__notification_id__get
8532
- parameters:
8533
- - in: path
8534
- name: notification_id
8535
- required: true
8536
- schema:
8537
- examples:
8538
- - notification_01h45ytscbebyvny4gc8cr8ma2
8539
- format: typeid
8540
- pattern: ^notification_[0-7][0-9a-hjkmnpq-tv-z]{25}$
8541
- title: Notification Id
8542
- type: string
8543
- x-typeid-prefix: notification
8544
- - in: query
8545
- name: user_id
8546
- required: true
8547
- schema:
8548
- examples:
8549
- - user_01h45ytscbebyvny4gc8cr8ma2
8550
- format: typeid
8551
- pattern: ^user_[0-7][0-9a-hjkmnpq-tv-z]{25}$
8552
- title: User Id
8553
- type: string
8554
- x-typeid-prefix: user
8555
- responses:
8556
- '200':
8557
- content:
8558
- application/json:
8559
- schema:
8560
- $ref: '#/components/schemas/UserNotification'
8561
- description: Successful Response
8562
- '422':
8563
- content:
8564
- application/problem+json:
8565
- schema:
8566
- $ref: '#/components/schemas/HTTPValidationError'
8567
- description: Validation Error
8568
- security:
8569
- - OAuth2PasswordBearer: []
8570
- summary: Get Notification
8571
- tags:
8572
- - notification
8573
- put:
8574
- operationId: update_notification_v1_notifications__notification_id__put
8575
- parameters:
8576
- - in: path
8577
- name: notification_id
8578
- required: true
8579
- schema:
8580
- examples:
8581
- - notification_01h45ytscbebyvny4gc8cr8ma2
8582
- format: typeid
8583
- pattern: ^notification_[0-7][0-9a-hjkmnpq-tv-z]{25}$
8584
- title: Notification Id
8585
- type: string
8586
- x-typeid-prefix: notification
8587
- requestBody:
8588
- content:
8589
- application/json:
8590
- schema:
8591
- $ref: '#/components/schemas/NotificationUpdate'
8592
- required: true
8593
- responses:
8594
- '200':
8595
- content:
8596
- application/json:
8597
- schema:
8598
- $ref: '#/components/schemas/Notification'
8599
- description: Successful Response
8600
- '422':
8601
- content:
8602
- application/problem+json:
8603
- schema:
8604
- $ref: '#/components/schemas/HTTPValidationError'
8605
- description: Validation Error
8606
- security:
8607
- - OAuth2PasswordBearer: []
8608
- summary: Update Notification
8609
- tags:
8610
- - notification
8611
- /v1/notifications/{notification_id}/read:
8612
- patch:
8613
- operationId: update_notification_read_v1_notifications__notification_id__read_patch
8614
- parameters:
8615
- - in: path
8616
- name: notification_id
8617
- required: true
8618
- schema:
8619
- examples:
8620
- - notification_01h45ytscbebyvny4gc8cr8ma2
8621
- format: typeid
8622
- pattern: ^notification_[0-7][0-9a-hjkmnpq-tv-z]{25}$
8623
- title: Notification Id
8624
- type: string
8625
- x-typeid-prefix: notification
8626
- responses:
8627
- '200':
8628
- content:
8629
- application/json:
8630
- schema: {}
8631
- description: Successful Response
8632
- '422':
8633
- content:
8634
- application/problem+json:
8635
- schema:
8636
- $ref: '#/components/schemas/HTTPValidationError'
8637
- description: Validation Error
8638
- security:
8639
- - OAuth2PasswordBearer: []
8640
- summary: Update Notification Read
8641
- tags:
8642
- - notification
8643
8163
  /v1/organizations:
8644
8164
  get:
8645
8165
  operationId: list_organizations_v1_organizations_get
@@ -9213,6 +8733,45 @@ paths:
9213
8733
  summary: Update Organization
9214
8734
  tags:
9215
8735
  - organization
8736
+ /v1/organizations/{organization_id}/plan:
8737
+ patch:
8738
+ operationId: change_plan_v1_organizations__organization_id__plan_patch
8739
+ parameters:
8740
+ - in: path
8741
+ name: organization_id
8742
+ required: true
8743
+ schema:
8744
+ examples:
8745
+ - organization_01h45ytscbebyvny4gc8cr8ma2
8746
+ format: typeid
8747
+ pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
8748
+ title: Organization Id
8749
+ type: string
8750
+ x-typeid-prefix: organization
8751
+ requestBody:
8752
+ content:
8753
+ application/json:
8754
+ schema:
8755
+ $ref: '#/components/schemas/PlanUpdate'
8756
+ required: true
8757
+ responses:
8758
+ '200':
8759
+ content:
8760
+ application/json:
8761
+ schema:
8762
+ $ref: '#/components/schemas/OrganizationWithBillingData'
8763
+ description: Successful Response
8764
+ '422':
8765
+ content:
8766
+ application/problem+json:
8767
+ schema:
8768
+ $ref: '#/components/schemas/HTTPValidationError'
8769
+ description: Validation Error
8770
+ security:
8771
+ - OAuth2PasswordBearer: []
8772
+ summary: Change Plan
8773
+ tags:
8774
+ - organization
9216
8775
  /v1/organizations/{organization_id}/plans:
9217
8776
  get:
9218
8777
  operationId: get_current_available_plans_v1_organizations__organization_id__plans_get
@@ -10127,11 +9686,6 @@ tags:
10127
9686
  '
10128
9687
  name: nameserver
10129
9688
  x-displayName: Nameservers
10130
- - description: 'Endpoints for creating and managing notifications.
10131
-
10132
- '
10133
- name: notification
10134
- x-displayName: Notifications
10135
9689
  - description: 'Endpoints for creating and managing organizations.
10136
9690
 
10137
9691
  '
@@ -10170,4 +9724,3 @@ x-tagGroups:
10170
9724
  - email_forward
10171
9725
  - rdap
10172
9726
  - domain_search
10173
- - notification