@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.
- package/package.json +1 -1
- package/src/helpers/constants.ts +1 -51
- package/src/helpers/keys.ts +0 -1273
- package/src/helpers/requests.d.ts +1 -255
- package/src/helpers/responses.d.ts +1 -295
- package/src/helpers/schemas-arrays.d.ts +1 -15
- package/src/helpers/schemas.d.ts +0 -128
- package/src/openapi.yaml +1 -503
- package/src/schema.d.ts +0 -492
package/src/schema.d.ts
CHANGED
|
@@ -744,60 +744,6 @@ export interface paths {
|
|
|
744
744
|
patch: operations["acknowledge_event_v1_events__event_id__patch"];
|
|
745
745
|
trace?: never;
|
|
746
746
|
};
|
|
747
|
-
"/v1/notifications": {
|
|
748
|
-
parameters: {
|
|
749
|
-
query?: never;
|
|
750
|
-
header?: never;
|
|
751
|
-
path?: never;
|
|
752
|
-
cookie?: never;
|
|
753
|
-
};
|
|
754
|
-
/** List Notifications */
|
|
755
|
-
get: operations["list_notifications_v1_notifications_get"];
|
|
756
|
-
put?: never;
|
|
757
|
-
/** Create Notification */
|
|
758
|
-
post: operations["create_notification_v1_notifications_post"];
|
|
759
|
-
delete?: never;
|
|
760
|
-
options?: never;
|
|
761
|
-
head?: never;
|
|
762
|
-
patch?: never;
|
|
763
|
-
trace?: never;
|
|
764
|
-
};
|
|
765
|
-
"/v1/notifications/{notification_id}": {
|
|
766
|
-
parameters: {
|
|
767
|
-
query?: never;
|
|
768
|
-
header?: never;
|
|
769
|
-
path?: never;
|
|
770
|
-
cookie?: never;
|
|
771
|
-
};
|
|
772
|
-
/** Get Notification */
|
|
773
|
-
get: operations["get_notification_v1_notifications__notification_id__get"];
|
|
774
|
-
/** Update Notification */
|
|
775
|
-
put: operations["update_notification_v1_notifications__notification_id__put"];
|
|
776
|
-
post?: never;
|
|
777
|
-
/** Delete Notification */
|
|
778
|
-
delete: operations["delete_notification_v1_notifications__notification_id__delete"];
|
|
779
|
-
options?: never;
|
|
780
|
-
head?: never;
|
|
781
|
-
patch?: never;
|
|
782
|
-
trace?: never;
|
|
783
|
-
};
|
|
784
|
-
"/v1/notifications/{notification_id}/read": {
|
|
785
|
-
parameters: {
|
|
786
|
-
query?: never;
|
|
787
|
-
header?: never;
|
|
788
|
-
path?: never;
|
|
789
|
-
cookie?: never;
|
|
790
|
-
};
|
|
791
|
-
get?: never;
|
|
792
|
-
put?: never;
|
|
793
|
-
post?: never;
|
|
794
|
-
delete?: never;
|
|
795
|
-
options?: never;
|
|
796
|
-
head?: never;
|
|
797
|
-
/** Update Notification Read */
|
|
798
|
-
patch: operations["update_notification_read_v1_notifications__notification_id__read_patch"];
|
|
799
|
-
trace?: never;
|
|
800
|
-
};
|
|
801
747
|
"/v1/organizations": {
|
|
802
748
|
parameters: {
|
|
803
749
|
query?: never;
|
|
@@ -2925,184 +2871,6 @@ export interface components {
|
|
|
2925
2871
|
*/
|
|
2926
2872
|
ip_addresses?: string[];
|
|
2927
2873
|
};
|
|
2928
|
-
/** Notification */
|
|
2929
|
-
Notification: {
|
|
2930
|
-
/**
|
|
2931
|
-
* Author
|
|
2932
|
-
* @description The user or system that created the notification
|
|
2933
|
-
*/
|
|
2934
|
-
author: string;
|
|
2935
|
-
/**
|
|
2936
|
-
* Created On
|
|
2937
|
-
* Format: date-time
|
|
2938
|
-
* @description The date/time the entry was created on
|
|
2939
|
-
*/
|
|
2940
|
-
created_on?: Date;
|
|
2941
|
-
/**
|
|
2942
|
-
* Message
|
|
2943
|
-
* @description The message content of the notification
|
|
2944
|
-
*/
|
|
2945
|
-
message: string;
|
|
2946
|
-
/**
|
|
2947
|
-
* Notification Id
|
|
2948
|
-
* Format: typeid
|
|
2949
|
-
*/
|
|
2950
|
-
notification_id?: TypeId<"notification">;
|
|
2951
|
-
/**
|
|
2952
|
-
* Publish Date
|
|
2953
|
-
* Format: date-time
|
|
2954
|
-
* @description The date/time the notification is to be published
|
|
2955
|
-
*/
|
|
2956
|
-
publish_date?: Date;
|
|
2957
|
-
/**
|
|
2958
|
-
* Source
|
|
2959
|
-
* @description Source of the notification
|
|
2960
|
-
*/
|
|
2961
|
-
source: string;
|
|
2962
|
-
/**
|
|
2963
|
-
* Subject
|
|
2964
|
-
* @description The subject of the notification
|
|
2965
|
-
*/
|
|
2966
|
-
subject: string;
|
|
2967
|
-
/**
|
|
2968
|
-
* Target
|
|
2969
|
-
* @description Target audience (broadcast, account, user)
|
|
2970
|
-
*/
|
|
2971
|
-
target: string;
|
|
2972
|
-
/**
|
|
2973
|
-
* Type
|
|
2974
|
-
* @description The type of notification
|
|
2975
|
-
*/
|
|
2976
|
-
type: string;
|
|
2977
|
-
/**
|
|
2978
|
-
* Updated On
|
|
2979
|
-
* Format: date-time
|
|
2980
|
-
* @description The date/time the entry was last updated on
|
|
2981
|
-
*/
|
|
2982
|
-
updated_on?: Date;
|
|
2983
|
-
};
|
|
2984
|
-
/** NotificationCreate */
|
|
2985
|
-
NotificationCreate: {
|
|
2986
|
-
/**
|
|
2987
|
-
* Author
|
|
2988
|
-
* @description The user or system that created the notification
|
|
2989
|
-
*/
|
|
2990
|
-
author: string;
|
|
2991
|
-
/**
|
|
2992
|
-
* Message
|
|
2993
|
-
* @description The message content of the notification
|
|
2994
|
-
*/
|
|
2995
|
-
message: string;
|
|
2996
|
-
/**
|
|
2997
|
-
* Publish Date
|
|
2998
|
-
* Format: date-time
|
|
2999
|
-
* @description The date/time the notification is to be published
|
|
3000
|
-
*/
|
|
3001
|
-
publish_date?: Date;
|
|
3002
|
-
/**
|
|
3003
|
-
* Source
|
|
3004
|
-
* @description Source of the notification
|
|
3005
|
-
*/
|
|
3006
|
-
source: string;
|
|
3007
|
-
/**
|
|
3008
|
-
* Subject
|
|
3009
|
-
* @description The subject of the notification
|
|
3010
|
-
*/
|
|
3011
|
-
subject: string;
|
|
3012
|
-
/**
|
|
3013
|
-
* Target
|
|
3014
|
-
* @description Target audience (broadcast, account, user)
|
|
3015
|
-
*/
|
|
3016
|
-
target: string;
|
|
3017
|
-
/**
|
|
3018
|
-
* Type
|
|
3019
|
-
* @description The type of notification
|
|
3020
|
-
*/
|
|
3021
|
-
type: string;
|
|
3022
|
-
};
|
|
3023
|
-
/** NotificationSummary */
|
|
3024
|
-
NotificationSummary: {
|
|
3025
|
-
/**
|
|
3026
|
-
* Author
|
|
3027
|
-
* @description The user or system that created the notification
|
|
3028
|
-
*/
|
|
3029
|
-
author: string;
|
|
3030
|
-
/**
|
|
3031
|
-
* Message
|
|
3032
|
-
* @description The message content of the notification
|
|
3033
|
-
*/
|
|
3034
|
-
message: string;
|
|
3035
|
-
/**
|
|
3036
|
-
* Notification Id
|
|
3037
|
-
* Format: typeid
|
|
3038
|
-
*/
|
|
3039
|
-
notification_id?: TypeId<"notification">;
|
|
3040
|
-
/**
|
|
3041
|
-
* Publish Date
|
|
3042
|
-
* Format: date-time
|
|
3043
|
-
* @description The date/time the notification is to be published
|
|
3044
|
-
*/
|
|
3045
|
-
publish_date?: Date;
|
|
3046
|
-
/**
|
|
3047
|
-
* Source
|
|
3048
|
-
* @description Source of the notification
|
|
3049
|
-
*/
|
|
3050
|
-
source: string;
|
|
3051
|
-
/**
|
|
3052
|
-
* Subject
|
|
3053
|
-
* @description The subject of the notification
|
|
3054
|
-
*/
|
|
3055
|
-
subject: string;
|
|
3056
|
-
/**
|
|
3057
|
-
* Target
|
|
3058
|
-
* @description Target audience (broadcast, account, user)
|
|
3059
|
-
*/
|
|
3060
|
-
target: string;
|
|
3061
|
-
/**
|
|
3062
|
-
* Type
|
|
3063
|
-
* @description The type of notification
|
|
3064
|
-
*/
|
|
3065
|
-
type: string;
|
|
3066
|
-
};
|
|
3067
|
-
/** NotificationUpdate */
|
|
3068
|
-
NotificationUpdate: {
|
|
3069
|
-
/**
|
|
3070
|
-
* Author
|
|
3071
|
-
* @description The user or system that created the notification
|
|
3072
|
-
*/
|
|
3073
|
-
author: string;
|
|
3074
|
-
/**
|
|
3075
|
-
* Message
|
|
3076
|
-
* @description The message content of the notification
|
|
3077
|
-
*/
|
|
3078
|
-
message: string;
|
|
3079
|
-
/**
|
|
3080
|
-
* Publish Date
|
|
3081
|
-
* Format: date-time
|
|
3082
|
-
* @description The date/time the notification is to be published
|
|
3083
|
-
*/
|
|
3084
|
-
publish_date?: Date;
|
|
3085
|
-
/**
|
|
3086
|
-
* Source
|
|
3087
|
-
* @description Source of the notification
|
|
3088
|
-
*/
|
|
3089
|
-
source: string;
|
|
3090
|
-
/**
|
|
3091
|
-
* Subject
|
|
3092
|
-
* @description The subject of the notification
|
|
3093
|
-
*/
|
|
3094
|
-
subject: string;
|
|
3095
|
-
/**
|
|
3096
|
-
* Target
|
|
3097
|
-
* @description Target audience (broadcast, account, user)
|
|
3098
|
-
*/
|
|
3099
|
-
target: string;
|
|
3100
|
-
/**
|
|
3101
|
-
* Type
|
|
3102
|
-
* @description The type of notification
|
|
3103
|
-
*/
|
|
3104
|
-
type: string;
|
|
3105
|
-
};
|
|
3106
2874
|
/** Organization */
|
|
3107
2875
|
Organization: {
|
|
3108
2876
|
/**
|
|
@@ -3737,12 +3505,6 @@ export interface components {
|
|
|
3737
3505
|
/** Results */
|
|
3738
3506
|
results: components["schemas"]["Organization"][];
|
|
3739
3507
|
};
|
|
3740
|
-
/** Pagination[UserNotificationSummary] */
|
|
3741
|
-
Pagination_UserNotificationSummary_: {
|
|
3742
|
-
pagination: components["schemas"]["PaginationMetadata"];
|
|
3743
|
-
/** Results */
|
|
3744
|
-
results: components["schemas"]["UserNotificationSummary"][];
|
|
3745
|
-
};
|
|
3746
3508
|
/** Pagination[User] */
|
|
3747
3509
|
Pagination_User_: {
|
|
3748
3510
|
pagination: components["schemas"]["PaginationMetadata"];
|
|
@@ -4334,64 +4096,6 @@ export interface components {
|
|
|
4334
4096
|
*/
|
|
4335
4097
|
username: string;
|
|
4336
4098
|
};
|
|
4337
|
-
/** UserNotification */
|
|
4338
|
-
UserNotification: {
|
|
4339
|
-
/**
|
|
4340
|
-
* Created On
|
|
4341
|
-
* Format: date-time
|
|
4342
|
-
* @description The date/time the entry was created on
|
|
4343
|
-
*/
|
|
4344
|
-
created_on?: Date;
|
|
4345
|
-
notification: components["schemas"]["Notification"];
|
|
4346
|
-
/**
|
|
4347
|
-
* Notification Id
|
|
4348
|
-
* Format: typeid
|
|
4349
|
-
* @description Unique identifier for the notification
|
|
4350
|
-
* @default None
|
|
4351
|
-
*/
|
|
4352
|
-
notification_id: TypeId<"notification">;
|
|
4353
|
-
/**
|
|
4354
|
-
* @description Whether the user has read the notification
|
|
4355
|
-
* @default unread
|
|
4356
|
-
*/
|
|
4357
|
-
status: components["schemas"]["UserNotificationStatus"];
|
|
4358
|
-
/**
|
|
4359
|
-
* Updated On
|
|
4360
|
-
* Format: date-time
|
|
4361
|
-
* @description The date/time the entry was last updated on
|
|
4362
|
-
*/
|
|
4363
|
-
updated_on?: Date;
|
|
4364
|
-
/**
|
|
4365
|
-
* User Id
|
|
4366
|
-
* Format: typeid
|
|
4367
|
-
* @default None
|
|
4368
|
-
*/
|
|
4369
|
-
user_id: TypeId<"user">;
|
|
4370
|
-
/**
|
|
4371
|
-
* User Notification Id
|
|
4372
|
-
* Format: typeid
|
|
4373
|
-
*/
|
|
4374
|
-
user_notification_id?: TypeId<"user_notification">;
|
|
4375
|
-
};
|
|
4376
|
-
/**
|
|
4377
|
-
* UserNotificationStatus
|
|
4378
|
-
* @enum {string}
|
|
4379
|
-
*/
|
|
4380
|
-
UserNotificationStatus: "read" | "unread";
|
|
4381
|
-
/** UserNotificationSummary */
|
|
4382
|
-
UserNotificationSummary: {
|
|
4383
|
-
notification: components["schemas"]["NotificationSummary"];
|
|
4384
|
-
/**
|
|
4385
|
-
* @description Whether the user has read the notification
|
|
4386
|
-
* @default unread
|
|
4387
|
-
*/
|
|
4388
|
-
status: components["schemas"]["UserNotificationStatus"];
|
|
4389
|
-
/**
|
|
4390
|
-
* User Notification Id
|
|
4391
|
-
* Format: typeid
|
|
4392
|
-
*/
|
|
4393
|
-
user_notification_id?: TypeId<"user_notification">;
|
|
4394
|
-
};
|
|
4395
4099
|
/** UserPasswordResetEmailResponse */
|
|
4396
4100
|
UserPasswordResetEmailResponse: {
|
|
4397
4101
|
/**
|
|
@@ -7621,202 +7325,6 @@ export interface operations {
|
|
|
7621
7325
|
};
|
|
7622
7326
|
};
|
|
7623
7327
|
};
|
|
7624
|
-
list_notifications_v1_notifications_get: {
|
|
7625
|
-
parameters: {
|
|
7626
|
-
query: {
|
|
7627
|
-
user_id: TypeId<"user">;
|
|
7628
|
-
page?: number;
|
|
7629
|
-
page_size?: number;
|
|
7630
|
-
};
|
|
7631
|
-
header?: never;
|
|
7632
|
-
path?: never;
|
|
7633
|
-
cookie?: never;
|
|
7634
|
-
};
|
|
7635
|
-
requestBody?: never;
|
|
7636
|
-
responses: {
|
|
7637
|
-
/** @description Successful Response */
|
|
7638
|
-
200: {
|
|
7639
|
-
headers: {
|
|
7640
|
-
[name: string]: unknown;
|
|
7641
|
-
};
|
|
7642
|
-
content: {
|
|
7643
|
-
"application/json": components["schemas"]["Pagination_UserNotificationSummary_"];
|
|
7644
|
-
};
|
|
7645
|
-
};
|
|
7646
|
-
/** @description Validation Error */
|
|
7647
|
-
422: {
|
|
7648
|
-
headers: {
|
|
7649
|
-
[name: string]: unknown;
|
|
7650
|
-
};
|
|
7651
|
-
content: {
|
|
7652
|
-
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
7653
|
-
};
|
|
7654
|
-
};
|
|
7655
|
-
};
|
|
7656
|
-
};
|
|
7657
|
-
create_notification_v1_notifications_post: {
|
|
7658
|
-
parameters: {
|
|
7659
|
-
query?: never;
|
|
7660
|
-
header?: never;
|
|
7661
|
-
path?: never;
|
|
7662
|
-
cookie?: never;
|
|
7663
|
-
};
|
|
7664
|
-
requestBody: {
|
|
7665
|
-
content: {
|
|
7666
|
-
"application/json": components["schemas"]["NotificationCreate"];
|
|
7667
|
-
};
|
|
7668
|
-
};
|
|
7669
|
-
responses: {
|
|
7670
|
-
/** @description Successful Response */
|
|
7671
|
-
201: {
|
|
7672
|
-
headers: {
|
|
7673
|
-
[name: string]: unknown;
|
|
7674
|
-
};
|
|
7675
|
-
content: {
|
|
7676
|
-
"application/json": components["schemas"]["Notification"];
|
|
7677
|
-
};
|
|
7678
|
-
};
|
|
7679
|
-
/** @description Validation Error */
|
|
7680
|
-
422: {
|
|
7681
|
-
headers: {
|
|
7682
|
-
[name: string]: unknown;
|
|
7683
|
-
};
|
|
7684
|
-
content: {
|
|
7685
|
-
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
7686
|
-
};
|
|
7687
|
-
};
|
|
7688
|
-
};
|
|
7689
|
-
};
|
|
7690
|
-
get_notification_v1_notifications__notification_id__get: {
|
|
7691
|
-
parameters: {
|
|
7692
|
-
query: {
|
|
7693
|
-
user_id: TypeId<"user">;
|
|
7694
|
-
};
|
|
7695
|
-
header?: never;
|
|
7696
|
-
path: {
|
|
7697
|
-
notification_id: TypeId<"notification">;
|
|
7698
|
-
};
|
|
7699
|
-
cookie?: never;
|
|
7700
|
-
};
|
|
7701
|
-
requestBody?: never;
|
|
7702
|
-
responses: {
|
|
7703
|
-
/** @description Successful Response */
|
|
7704
|
-
200: {
|
|
7705
|
-
headers: {
|
|
7706
|
-
[name: string]: unknown;
|
|
7707
|
-
};
|
|
7708
|
-
content: {
|
|
7709
|
-
"application/json": components["schemas"]["UserNotification"];
|
|
7710
|
-
};
|
|
7711
|
-
};
|
|
7712
|
-
/** @description Validation Error */
|
|
7713
|
-
422: {
|
|
7714
|
-
headers: {
|
|
7715
|
-
[name: string]: unknown;
|
|
7716
|
-
};
|
|
7717
|
-
content: {
|
|
7718
|
-
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
7719
|
-
};
|
|
7720
|
-
};
|
|
7721
|
-
};
|
|
7722
|
-
};
|
|
7723
|
-
update_notification_v1_notifications__notification_id__put: {
|
|
7724
|
-
parameters: {
|
|
7725
|
-
query?: never;
|
|
7726
|
-
header?: never;
|
|
7727
|
-
path: {
|
|
7728
|
-
notification_id: TypeId<"notification">;
|
|
7729
|
-
};
|
|
7730
|
-
cookie?: never;
|
|
7731
|
-
};
|
|
7732
|
-
requestBody: {
|
|
7733
|
-
content: {
|
|
7734
|
-
"application/json": components["schemas"]["NotificationUpdate"];
|
|
7735
|
-
};
|
|
7736
|
-
};
|
|
7737
|
-
responses: {
|
|
7738
|
-
/** @description Successful Response */
|
|
7739
|
-
200: {
|
|
7740
|
-
headers: {
|
|
7741
|
-
[name: string]: unknown;
|
|
7742
|
-
};
|
|
7743
|
-
content: {
|
|
7744
|
-
"application/json": components["schemas"]["Notification"];
|
|
7745
|
-
};
|
|
7746
|
-
};
|
|
7747
|
-
/** @description Validation Error */
|
|
7748
|
-
422: {
|
|
7749
|
-
headers: {
|
|
7750
|
-
[name: string]: unknown;
|
|
7751
|
-
};
|
|
7752
|
-
content: {
|
|
7753
|
-
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
7754
|
-
};
|
|
7755
|
-
};
|
|
7756
|
-
};
|
|
7757
|
-
};
|
|
7758
|
-
delete_notification_v1_notifications__notification_id__delete: {
|
|
7759
|
-
parameters: {
|
|
7760
|
-
query?: never;
|
|
7761
|
-
header?: never;
|
|
7762
|
-
path: {
|
|
7763
|
-
notification_id: TypeId<"notification">;
|
|
7764
|
-
};
|
|
7765
|
-
cookie?: never;
|
|
7766
|
-
};
|
|
7767
|
-
requestBody?: never;
|
|
7768
|
-
responses: {
|
|
7769
|
-
/** @description Successful Response */
|
|
7770
|
-
200: {
|
|
7771
|
-
headers: {
|
|
7772
|
-
[name: string]: unknown;
|
|
7773
|
-
};
|
|
7774
|
-
content: {
|
|
7775
|
-
"application/json": unknown;
|
|
7776
|
-
};
|
|
7777
|
-
};
|
|
7778
|
-
/** @description Validation Error */
|
|
7779
|
-
422: {
|
|
7780
|
-
headers: {
|
|
7781
|
-
[name: string]: unknown;
|
|
7782
|
-
};
|
|
7783
|
-
content: {
|
|
7784
|
-
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
7785
|
-
};
|
|
7786
|
-
};
|
|
7787
|
-
};
|
|
7788
|
-
};
|
|
7789
|
-
update_notification_read_v1_notifications__notification_id__read_patch: {
|
|
7790
|
-
parameters: {
|
|
7791
|
-
query?: never;
|
|
7792
|
-
header?: never;
|
|
7793
|
-
path: {
|
|
7794
|
-
notification_id: TypeId<"notification">;
|
|
7795
|
-
};
|
|
7796
|
-
cookie?: never;
|
|
7797
|
-
};
|
|
7798
|
-
requestBody?: never;
|
|
7799
|
-
responses: {
|
|
7800
|
-
/** @description Successful Response */
|
|
7801
|
-
200: {
|
|
7802
|
-
headers: {
|
|
7803
|
-
[name: string]: unknown;
|
|
7804
|
-
};
|
|
7805
|
-
content: {
|
|
7806
|
-
"application/json": unknown;
|
|
7807
|
-
};
|
|
7808
|
-
};
|
|
7809
|
-
/** @description Validation Error */
|
|
7810
|
-
422: {
|
|
7811
|
-
headers: {
|
|
7812
|
-
[name: string]: unknown;
|
|
7813
|
-
};
|
|
7814
|
-
content: {
|
|
7815
|
-
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
7816
|
-
};
|
|
7817
|
-
};
|
|
7818
|
-
};
|
|
7819
|
-
};
|
|
7820
7328
|
list_organizations_v1_organizations_get: {
|
|
7821
7329
|
parameters: {
|
|
7822
7330
|
query?: {
|