@opusdns/api 0.54.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.
@@ -1663,70 +1663,6 @@ export type LocalPresenceRequirementType = components['schemas']['LocalPresenceR
1663
1663
  * @see {@link components} - The OpenAPI components schema definition
1664
1664
  */
1665
1665
  export type Nameserver = components['schemas']['Nameserver'];
1666
- /**
1667
- * Notification
1668
- *
1669
- * @remarks
1670
- * Type alias for the `Notification` OpenAPI schema.
1671
- * This type represents notification data structures used in API requests and responses.
1672
- *
1673
- * @example
1674
- * ```typescript
1675
- * const response = await api.getNotification();
1676
- * const item: Notification = response.results;
1677
- * ```
1678
- *
1679
- * @see {@link components} - The OpenAPI components schema definition
1680
- */
1681
- export type Notification = components['schemas']['Notification'];
1682
- /**
1683
- * NotificationCreate
1684
- *
1685
- * @remarks
1686
- * Type alias for the `NotificationCreate` OpenAPI schema.
1687
- * This type represents notificationcreate data structures used in API requests and responses.
1688
- *
1689
- * @example
1690
- * ```typescript
1691
- * const response = await api.getNotificationCreate();
1692
- * const item: NotificationCreate = response.results;
1693
- * ```
1694
- *
1695
- * @see {@link components} - The OpenAPI components schema definition
1696
- */
1697
- export type NotificationCreate = components['schemas']['NotificationCreate'];
1698
- /**
1699
- * NotificationSummary
1700
- *
1701
- * @remarks
1702
- * Type alias for the `NotificationSummary` OpenAPI schema.
1703
- * This type represents notificationsummary data structures used in API requests and responses.
1704
- *
1705
- * @example
1706
- * ```typescript
1707
- * const response = await api.getNotificationSummary();
1708
- * const item: NotificationSummary = response.results;
1709
- * ```
1710
- *
1711
- * @see {@link components} - The OpenAPI components schema definition
1712
- */
1713
- export type NotificationSummary = components['schemas']['NotificationSummary'];
1714
- /**
1715
- * NotificationUpdate
1716
- *
1717
- * @remarks
1718
- * Type alias for the `NotificationUpdate` OpenAPI schema.
1719
- * This type represents notificationupdate data structures used in API requests and responses.
1720
- *
1721
- * @example
1722
- * ```typescript
1723
- * const response = await api.getNotificationUpdate();
1724
- * const item: NotificationUpdate = response.results;
1725
- * ```
1726
- *
1727
- * @see {@link components} - The OpenAPI components schema definition
1728
- */
1729
- export type NotificationUpdate = components['schemas']['NotificationUpdate'];
1730
1666
  /**
1731
1667
  * Organization
1732
1668
  *
@@ -2079,22 +2015,6 @@ export type Pagination_OrganizationCredential = components['schemas']['Paginatio
2079
2015
  * @see {@link components} - The OpenAPI components schema definition
2080
2016
  */
2081
2017
  export type Pagination_Organization = components['schemas']['Pagination_Organization_'];
2082
- /**
2083
- * Pagination[UserNotificationSummary]
2084
- *
2085
- * @remarks
2086
- * Type alias for the `Pagination_UserNotificationSummary_` OpenAPI schema.
2087
- * This type represents pagination[usernotificationsummary] data structures used in API requests and responses.
2088
- *
2089
- * @example
2090
- * ```typescript
2091
- * const response = await api.getPagination_UserNotificationSummary();
2092
- * const item: Pagination_UserNotificationSummary = response.results;
2093
- * ```
2094
- *
2095
- * @see {@link components} - The OpenAPI components schema definition
2096
- */
2097
- export type Pagination_UserNotificationSummary = components['schemas']['Pagination_UserNotificationSummary_'];
2098
2018
  /**
2099
2019
  * Pagination[User]
2100
2020
  *
@@ -2831,54 +2751,6 @@ export type UserAttributeBase = components['schemas']['UserAttributeBase'];
2831
2751
  * @see {@link components} - The OpenAPI components schema definition
2832
2752
  */
2833
2753
  export type UserCreate = components['schemas']['UserCreate'];
2834
- /**
2835
- * UserNotification
2836
- *
2837
- * @remarks
2838
- * Type alias for the `UserNotification` OpenAPI schema.
2839
- * This type represents usernotification data structures used in API requests and responses.
2840
- *
2841
- * @example
2842
- * ```typescript
2843
- * const response = await api.getUserNotification();
2844
- * const item: UserNotification = response.results;
2845
- * ```
2846
- *
2847
- * @see {@link components} - The OpenAPI components schema definition
2848
- */
2849
- export type UserNotification = components['schemas']['UserNotification'];
2850
- /**
2851
- * UserNotificationStatus
2852
- *
2853
- * @remarks
2854
- * Type alias for the `UserNotificationStatus` OpenAPI schema.
2855
- * This type represents usernotificationstatus data structures used in API requests and responses.
2856
- *
2857
- * @example
2858
- * ```typescript
2859
- * const response = await api.getUserNotificationStatus();
2860
- * const item: UserNotificationStatus = response.results;
2861
- * ```
2862
- *
2863
- * @see {@link components} - The OpenAPI components schema definition
2864
- */
2865
- export type UserNotificationStatus = components['schemas']['UserNotificationStatus'];
2866
- /**
2867
- * UserNotificationSummary
2868
- *
2869
- * @remarks
2870
- * Type alias for the `UserNotificationSummary` OpenAPI schema.
2871
- * This type represents usernotificationsummary data structures used in API requests and responses.
2872
- *
2873
- * @example
2874
- * ```typescript
2875
- * const response = await api.getUserNotificationSummary();
2876
- * const item: UserNotificationSummary = response.results;
2877
- * ```
2878
- *
2879
- * @see {@link components} - The OpenAPI components schema definition
2880
- */
2881
- export type UserNotificationSummary = components['schemas']['UserNotificationSummary'];
2882
2754
  /**
2883
2755
  * UserPasswordResetEmailResponse
2884
2756
  *
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:
@@ -4687,81 +4487,6 @@ components:
4687
4487
  - password
4688
4488
  title: UserCreate
4689
4489
  type: object
4690
- UserNotification:
4691
- properties:
4692
- created_on:
4693
- description: The date/time the entry was created on
4694
- format: date-time
4695
- title: Created On
4696
- type: string
4697
- notification:
4698
- $ref: '#/components/schemas/Notification'
4699
- notification_id:
4700
- default: None
4701
- description: Unique identifier for the notification
4702
- examples:
4703
- - notification_01h45ytscbebyvny4gc8cr8ma2
4704
- format: typeid
4705
- pattern: ^notification_[0-7][0-9a-hjkmnpq-tv-z]{25}$
4706
- title: Notification Id
4707
- type: string
4708
- x-typeid-prefix: notification
4709
- status:
4710
- $ref: '#/components/schemas/UserNotificationStatus'
4711
- default: unread
4712
- description: Whether the user has read the notification
4713
- updated_on:
4714
- description: The date/time the entry was last updated on
4715
- format: date-time
4716
- title: Updated On
4717
- type: string
4718
- user_id:
4719
- default: None
4720
- examples:
4721
- - user_01h45ytscbebyvny4gc8cr8ma2
4722
- format: typeid
4723
- pattern: ^user_[0-7][0-9a-hjkmnpq-tv-z]{25}$
4724
- title: User Id
4725
- type: string
4726
- x-typeid-prefix: user
4727
- user_notification_id:
4728
- examples:
4729
- - user_notification_01h45ytscbebyvny4gc8cr8ma2
4730
- format: typeid
4731
- pattern: ^user_notification_[0-7][0-9a-hjkmnpq-tv-z]{25}$
4732
- title: User Notification Id
4733
- type: string
4734
- x-typeid-prefix: user_notification
4735
- required:
4736
- - notification
4737
- title: UserNotification
4738
- type: object
4739
- UserNotificationStatus:
4740
- enum:
4741
- - read
4742
- - unread
4743
- title: UserNotificationStatus
4744
- type: string
4745
- UserNotificationSummary:
4746
- properties:
4747
- notification:
4748
- $ref: '#/components/schemas/NotificationSummary'
4749
- status:
4750
- $ref: '#/components/schemas/UserNotificationStatus'
4751
- default: unread
4752
- description: Whether the user has read the notification
4753
- user_notification_id:
4754
- examples:
4755
- - user_notification_01h45ytscbebyvny4gc8cr8ma2
4756
- format: typeid
4757
- pattern: ^user_notification_[0-7][0-9a-hjkmnpq-tv-z]{25}$
4758
- title: User Notification Id
4759
- type: string
4760
- x-typeid-prefix: user_notification
4761
- required:
4762
- - notification
4763
- title: UserNotificationSummary
4764
- type: object
4765
4490
  UserPasswordResetEmailResponse:
4766
4491
  properties:
4767
4492
  message:
@@ -5373,7 +5098,7 @@ info:
5373
5098
  '
5374
5099
  summary: OpusDNS - your gateway to a seamless domain management experience.
5375
5100
  title: OpusDNS API
5376
- version: 2025-09-18-175712
5101
+ version: 2025-09-18-185443
5377
5102
  x-logo:
5378
5103
  altText: OpusDNS API Reference
5379
5104
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -8435,227 +8160,6 @@ paths:
8435
8160
  summary: Acknowledge Event
8436
8161
  tags:
8437
8162
  - event
8438
- /v1/notifications:
8439
- get:
8440
- operationId: list_notifications_v1_notifications_get
8441
- parameters:
8442
- - in: query
8443
- name: user_id
8444
- required: true
8445
- schema:
8446
- examples:
8447
- - user_01h45ytscbebyvny4gc8cr8ma2
8448
- format: typeid
8449
- pattern: ^user_[0-7][0-9a-hjkmnpq-tv-z]{25}$
8450
- title: User Id
8451
- type: string
8452
- x-typeid-prefix: user
8453
- - in: query
8454
- name: page
8455
- required: false
8456
- schema:
8457
- default: 1
8458
- minimum: 1
8459
- title: Page
8460
- type: integer
8461
- - in: query
8462
- name: page_size
8463
- required: false
8464
- schema:
8465
- default: 10
8466
- maximum: 100
8467
- minimum: 1
8468
- title: Page Size
8469
- type: integer
8470
- responses:
8471
- '200':
8472
- content:
8473
- application/json:
8474
- schema:
8475
- $ref: '#/components/schemas/Pagination_UserNotificationSummary_'
8476
- description: Successful Response
8477
- '422':
8478
- content:
8479
- application/problem+json:
8480
- schema:
8481
- $ref: '#/components/schemas/HTTPValidationError'
8482
- description: Validation Error
8483
- security:
8484
- - OAuth2PasswordBearer: []
8485
- summary: List Notifications
8486
- tags:
8487
- - notification
8488
- post:
8489
- operationId: create_notification_v1_notifications_post
8490
- requestBody:
8491
- content:
8492
- application/json:
8493
- schema:
8494
- $ref: '#/components/schemas/NotificationCreate'
8495
- required: true
8496
- responses:
8497
- '201':
8498
- content:
8499
- application/json:
8500
- schema:
8501
- $ref: '#/components/schemas/Notification'
8502
- description: Successful Response
8503
- '422':
8504
- content:
8505
- application/problem+json:
8506
- schema:
8507
- $ref: '#/components/schemas/HTTPValidationError'
8508
- description: Validation Error
8509
- security:
8510
- - OAuth2PasswordBearer: []
8511
- summary: Create Notification
8512
- tags:
8513
- - notification
8514
- /v1/notifications/{notification_id}:
8515
- delete:
8516
- operationId: delete_notification_v1_notifications__notification_id__delete
8517
- parameters:
8518
- - in: path
8519
- name: notification_id
8520
- required: true
8521
- schema:
8522
- examples:
8523
- - notification_01h45ytscbebyvny4gc8cr8ma2
8524
- format: typeid
8525
- pattern: ^notification_[0-7][0-9a-hjkmnpq-tv-z]{25}$
8526
- title: Notification Id
8527
- type: string
8528
- x-typeid-prefix: notification
8529
- responses:
8530
- '200':
8531
- content:
8532
- application/json:
8533
- schema: {}
8534
- description: Successful Response
8535
- '422':
8536
- content:
8537
- application/problem+json:
8538
- schema:
8539
- $ref: '#/components/schemas/HTTPValidationError'
8540
- description: Validation Error
8541
- security:
8542
- - OAuth2PasswordBearer: []
8543
- summary: Delete Notification
8544
- tags:
8545
- - notification
8546
- get:
8547
- operationId: get_notification_v1_notifications__notification_id__get
8548
- parameters:
8549
- - in: path
8550
- name: notification_id
8551
- required: true
8552
- schema:
8553
- examples:
8554
- - notification_01h45ytscbebyvny4gc8cr8ma2
8555
- format: typeid
8556
- pattern: ^notification_[0-7][0-9a-hjkmnpq-tv-z]{25}$
8557
- title: Notification Id
8558
- type: string
8559
- x-typeid-prefix: notification
8560
- - in: query
8561
- name: user_id
8562
- required: true
8563
- schema:
8564
- examples:
8565
- - user_01h45ytscbebyvny4gc8cr8ma2
8566
- format: typeid
8567
- pattern: ^user_[0-7][0-9a-hjkmnpq-tv-z]{25}$
8568
- title: User Id
8569
- type: string
8570
- x-typeid-prefix: user
8571
- responses:
8572
- '200':
8573
- content:
8574
- application/json:
8575
- schema:
8576
- $ref: '#/components/schemas/UserNotification'
8577
- description: Successful Response
8578
- '422':
8579
- content:
8580
- application/problem+json:
8581
- schema:
8582
- $ref: '#/components/schemas/HTTPValidationError'
8583
- description: Validation Error
8584
- security:
8585
- - OAuth2PasswordBearer: []
8586
- summary: Get Notification
8587
- tags:
8588
- - notification
8589
- put:
8590
- operationId: update_notification_v1_notifications__notification_id__put
8591
- parameters:
8592
- - in: path
8593
- name: notification_id
8594
- required: true
8595
- schema:
8596
- examples:
8597
- - notification_01h45ytscbebyvny4gc8cr8ma2
8598
- format: typeid
8599
- pattern: ^notification_[0-7][0-9a-hjkmnpq-tv-z]{25}$
8600
- title: Notification Id
8601
- type: string
8602
- x-typeid-prefix: notification
8603
- requestBody:
8604
- content:
8605
- application/json:
8606
- schema:
8607
- $ref: '#/components/schemas/NotificationUpdate'
8608
- required: true
8609
- responses:
8610
- '200':
8611
- content:
8612
- application/json:
8613
- schema:
8614
- $ref: '#/components/schemas/Notification'
8615
- description: Successful Response
8616
- '422':
8617
- content:
8618
- application/problem+json:
8619
- schema:
8620
- $ref: '#/components/schemas/HTTPValidationError'
8621
- description: Validation Error
8622
- security:
8623
- - OAuth2PasswordBearer: []
8624
- summary: Update Notification
8625
- tags:
8626
- - notification
8627
- /v1/notifications/{notification_id}/read:
8628
- patch:
8629
- operationId: update_notification_read_v1_notifications__notification_id__read_patch
8630
- parameters:
8631
- - in: path
8632
- name: notification_id
8633
- required: true
8634
- schema:
8635
- examples:
8636
- - notification_01h45ytscbebyvny4gc8cr8ma2
8637
- format: typeid
8638
- pattern: ^notification_[0-7][0-9a-hjkmnpq-tv-z]{25}$
8639
- title: Notification Id
8640
- type: string
8641
- x-typeid-prefix: notification
8642
- responses:
8643
- '200':
8644
- content:
8645
- application/json:
8646
- schema: {}
8647
- description: Successful Response
8648
- '422':
8649
- content:
8650
- application/problem+json:
8651
- schema:
8652
- $ref: '#/components/schemas/HTTPValidationError'
8653
- description: Validation Error
8654
- security:
8655
- - OAuth2PasswordBearer: []
8656
- summary: Update Notification Read
8657
- tags:
8658
- - notification
8659
8163
  /v1/organizations:
8660
8164
  get:
8661
8165
  operationId: list_organizations_v1_organizations_get
@@ -10182,11 +9686,6 @@ tags:
10182
9686
  '
10183
9687
  name: nameserver
10184
9688
  x-displayName: Nameservers
10185
- - description: 'Endpoints for creating and managing notifications.
10186
-
10187
- '
10188
- name: notification
10189
- x-displayName: Notifications
10190
9689
  - description: 'Endpoints for creating and managing organizations.
10191
9690
 
10192
9691
  '
@@ -10225,4 +9724,3 @@ x-tagGroups:
10225
9724
  - email_forward
10226
9725
  - rdap
10227
9726
  - domain_search
10228
- - notification