@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/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;
@@ -971,6 +917,23 @@ export interface paths {
971
917
  patch: operations["update_organization_v1_organizations__organization_id__patch"];
972
918
  trace?: never;
973
919
  };
920
+ "/v1/organizations/{organization_id}/plan": {
921
+ parameters: {
922
+ query?: never;
923
+ header?: never;
924
+ path?: never;
925
+ cookie?: never;
926
+ };
927
+ get?: never;
928
+ put?: never;
929
+ post?: never;
930
+ delete?: never;
931
+ options?: never;
932
+ head?: never;
933
+ /** Change Plan */
934
+ patch: operations["change_plan_v1_organizations__organization_id__plan_patch"];
935
+ trace?: never;
936
+ };
974
937
  "/v1/organizations/{organization_id}/plans": {
975
938
  parameters: {
976
939
  query?: never;
@@ -2908,184 +2871,6 @@ export interface components {
2908
2871
  */
2909
2872
  ip_addresses?: string[];
2910
2873
  };
2911
- /** Notification */
2912
- Notification: {
2913
- /**
2914
- * Author
2915
- * @description The user or system that created the notification
2916
- */
2917
- author: string;
2918
- /**
2919
- * Created On
2920
- * Format: date-time
2921
- * @description The date/time the entry was created on
2922
- */
2923
- created_on?: Date;
2924
- /**
2925
- * Message
2926
- * @description The message content of the notification
2927
- */
2928
- message: string;
2929
- /**
2930
- * Notification Id
2931
- * Format: typeid
2932
- */
2933
- notification_id?: TypeId<"notification">;
2934
- /**
2935
- * Publish Date
2936
- * Format: date-time
2937
- * @description The date/time the notification is to be published
2938
- */
2939
- publish_date?: Date;
2940
- /**
2941
- * Source
2942
- * @description Source of the notification
2943
- */
2944
- source: string;
2945
- /**
2946
- * Subject
2947
- * @description The subject of the notification
2948
- */
2949
- subject: string;
2950
- /**
2951
- * Target
2952
- * @description Target audience (broadcast, account, user)
2953
- */
2954
- target: string;
2955
- /**
2956
- * Type
2957
- * @description The type of notification
2958
- */
2959
- type: string;
2960
- /**
2961
- * Updated On
2962
- * Format: date-time
2963
- * @description The date/time the entry was last updated on
2964
- */
2965
- updated_on?: Date;
2966
- };
2967
- /** NotificationCreate */
2968
- NotificationCreate: {
2969
- /**
2970
- * Author
2971
- * @description The user or system that created the notification
2972
- */
2973
- author: string;
2974
- /**
2975
- * Message
2976
- * @description The message content of the notification
2977
- */
2978
- message: string;
2979
- /**
2980
- * Publish Date
2981
- * Format: date-time
2982
- * @description The date/time the notification is to be published
2983
- */
2984
- publish_date?: Date;
2985
- /**
2986
- * Source
2987
- * @description Source of the notification
2988
- */
2989
- source: string;
2990
- /**
2991
- * Subject
2992
- * @description The subject of the notification
2993
- */
2994
- subject: string;
2995
- /**
2996
- * Target
2997
- * @description Target audience (broadcast, account, user)
2998
- */
2999
- target: string;
3000
- /**
3001
- * Type
3002
- * @description The type of notification
3003
- */
3004
- type: string;
3005
- };
3006
- /** NotificationSummary */
3007
- NotificationSummary: {
3008
- /**
3009
- * Author
3010
- * @description The user or system that created the notification
3011
- */
3012
- author: string;
3013
- /**
3014
- * Message
3015
- * @description The message content of the notification
3016
- */
3017
- message: string;
3018
- /**
3019
- * Notification Id
3020
- * Format: typeid
3021
- */
3022
- notification_id?: TypeId<"notification">;
3023
- /**
3024
- * Publish Date
3025
- * Format: date-time
3026
- * @description The date/time the notification is to be published
3027
- */
3028
- publish_date?: Date;
3029
- /**
3030
- * Source
3031
- * @description Source of the notification
3032
- */
3033
- source: string;
3034
- /**
3035
- * Subject
3036
- * @description The subject of the notification
3037
- */
3038
- subject: string;
3039
- /**
3040
- * Target
3041
- * @description Target audience (broadcast, account, user)
3042
- */
3043
- target: string;
3044
- /**
3045
- * Type
3046
- * @description The type of notification
3047
- */
3048
- type: string;
3049
- };
3050
- /** NotificationUpdate */
3051
- NotificationUpdate: {
3052
- /**
3053
- * Author
3054
- * @description The user or system that created the notification
3055
- */
3056
- author: string;
3057
- /**
3058
- * Message
3059
- * @description The message content of the notification
3060
- */
3061
- message: string;
3062
- /**
3063
- * Publish Date
3064
- * Format: date-time
3065
- * @description The date/time the notification is to be published
3066
- */
3067
- publish_date?: Date;
3068
- /**
3069
- * Source
3070
- * @description Source of the notification
3071
- */
3072
- source: string;
3073
- /**
3074
- * Subject
3075
- * @description The subject of the notification
3076
- */
3077
- subject: string;
3078
- /**
3079
- * Target
3080
- * @description Target audience (broadcast, account, user)
3081
- */
3082
- target: string;
3083
- /**
3084
- * Type
3085
- * @description The type of notification
3086
- */
3087
- type: string;
3088
- };
3089
2874
  /** Organization */
3090
2875
  Organization: {
3091
2876
  /**
@@ -3720,12 +3505,6 @@ export interface components {
3720
3505
  /** Results */
3721
3506
  results: components["schemas"]["Organization"][];
3722
3507
  };
3723
- /** Pagination[UserNotificationSummary] */
3724
- Pagination_UserNotificationSummary_: {
3725
- pagination: components["schemas"]["PaginationMetadata"];
3726
- /** Results */
3727
- results: components["schemas"]["UserNotificationSummary"][];
3728
- };
3729
3508
  /** Pagination[User] */
3730
3509
  Pagination_User_: {
3731
3510
  pagination: components["schemas"]["PaginationMetadata"];
@@ -3801,6 +3580,16 @@ export interface components {
3801
3580
  */
3802
3581
  plan_type?: string | null;
3803
3582
  };
3583
+ /**
3584
+ * PlanRelation
3585
+ * @enum {string}
3586
+ */
3587
+ PlanRelation: "basic" | "enterprise" | "corporate" | "premium" | "starter";
3588
+ /** PlanUpdate */
3589
+ PlanUpdate: {
3590
+ /** @default basic */
3591
+ plan: components["schemas"]["PlanRelation"];
3592
+ };
3804
3593
  /**
3805
3594
  * PostTransferRequirements
3806
3595
  * @enum {string}
@@ -4307,64 +4096,6 @@ export interface components {
4307
4096
  */
4308
4097
  username: string;
4309
4098
  };
4310
- /** UserNotification */
4311
- UserNotification: {
4312
- /**
4313
- * Created On
4314
- * Format: date-time
4315
- * @description The date/time the entry was created on
4316
- */
4317
- created_on?: Date;
4318
- notification: components["schemas"]["Notification"];
4319
- /**
4320
- * Notification Id
4321
- * Format: typeid
4322
- * @description Unique identifier for the notification
4323
- * @default None
4324
- */
4325
- notification_id: TypeId<"notification">;
4326
- /**
4327
- * @description Whether the user has read the notification
4328
- * @default unread
4329
- */
4330
- status: components["schemas"]["UserNotificationStatus"];
4331
- /**
4332
- * Updated On
4333
- * Format: date-time
4334
- * @description The date/time the entry was last updated on
4335
- */
4336
- updated_on?: Date;
4337
- /**
4338
- * User Id
4339
- * Format: typeid
4340
- * @default None
4341
- */
4342
- user_id: TypeId<"user">;
4343
- /**
4344
- * User Notification Id
4345
- * Format: typeid
4346
- */
4347
- user_notification_id?: TypeId<"user_notification">;
4348
- };
4349
- /**
4350
- * UserNotificationStatus
4351
- * @enum {string}
4352
- */
4353
- UserNotificationStatus: "read" | "unread";
4354
- /** UserNotificationSummary */
4355
- UserNotificationSummary: {
4356
- notification: components["schemas"]["NotificationSummary"];
4357
- /**
4358
- * @description Whether the user has read the notification
4359
- * @default unread
4360
- */
4361
- status: components["schemas"]["UserNotificationStatus"];
4362
- /**
4363
- * User Notification Id
4364
- * Format: typeid
4365
- */
4366
- user_notification_id?: TypeId<"user_notification">;
4367
- };
4368
4099
  /** UserPasswordResetEmailResponse */
4369
4100
  UserPasswordResetEmailResponse: {
4370
4101
  /**
@@ -7594,202 +7325,6 @@ export interface operations {
7594
7325
  };
7595
7326
  };
7596
7327
  };
7597
- list_notifications_v1_notifications_get: {
7598
- parameters: {
7599
- query: {
7600
- user_id: TypeId<"user">;
7601
- page?: number;
7602
- page_size?: number;
7603
- };
7604
- header?: never;
7605
- path?: never;
7606
- cookie?: never;
7607
- };
7608
- requestBody?: never;
7609
- responses: {
7610
- /** @description Successful Response */
7611
- 200: {
7612
- headers: {
7613
- [name: string]: unknown;
7614
- };
7615
- content: {
7616
- "application/json": components["schemas"]["Pagination_UserNotificationSummary_"];
7617
- };
7618
- };
7619
- /** @description Validation Error */
7620
- 422: {
7621
- headers: {
7622
- [name: string]: unknown;
7623
- };
7624
- content: {
7625
- "application/problem+json": components["schemas"]["HTTPValidationError"];
7626
- };
7627
- };
7628
- };
7629
- };
7630
- create_notification_v1_notifications_post: {
7631
- parameters: {
7632
- query?: never;
7633
- header?: never;
7634
- path?: never;
7635
- cookie?: never;
7636
- };
7637
- requestBody: {
7638
- content: {
7639
- "application/json": components["schemas"]["NotificationCreate"];
7640
- };
7641
- };
7642
- responses: {
7643
- /** @description Successful Response */
7644
- 201: {
7645
- headers: {
7646
- [name: string]: unknown;
7647
- };
7648
- content: {
7649
- "application/json": components["schemas"]["Notification"];
7650
- };
7651
- };
7652
- /** @description Validation Error */
7653
- 422: {
7654
- headers: {
7655
- [name: string]: unknown;
7656
- };
7657
- content: {
7658
- "application/problem+json": components["schemas"]["HTTPValidationError"];
7659
- };
7660
- };
7661
- };
7662
- };
7663
- get_notification_v1_notifications__notification_id__get: {
7664
- parameters: {
7665
- query: {
7666
- user_id: TypeId<"user">;
7667
- };
7668
- header?: never;
7669
- path: {
7670
- notification_id: TypeId<"notification">;
7671
- };
7672
- cookie?: never;
7673
- };
7674
- requestBody?: never;
7675
- responses: {
7676
- /** @description Successful Response */
7677
- 200: {
7678
- headers: {
7679
- [name: string]: unknown;
7680
- };
7681
- content: {
7682
- "application/json": components["schemas"]["UserNotification"];
7683
- };
7684
- };
7685
- /** @description Validation Error */
7686
- 422: {
7687
- headers: {
7688
- [name: string]: unknown;
7689
- };
7690
- content: {
7691
- "application/problem+json": components["schemas"]["HTTPValidationError"];
7692
- };
7693
- };
7694
- };
7695
- };
7696
- update_notification_v1_notifications__notification_id__put: {
7697
- parameters: {
7698
- query?: never;
7699
- header?: never;
7700
- path: {
7701
- notification_id: TypeId<"notification">;
7702
- };
7703
- cookie?: never;
7704
- };
7705
- requestBody: {
7706
- content: {
7707
- "application/json": components["schemas"]["NotificationUpdate"];
7708
- };
7709
- };
7710
- responses: {
7711
- /** @description Successful Response */
7712
- 200: {
7713
- headers: {
7714
- [name: string]: unknown;
7715
- };
7716
- content: {
7717
- "application/json": components["schemas"]["Notification"];
7718
- };
7719
- };
7720
- /** @description Validation Error */
7721
- 422: {
7722
- headers: {
7723
- [name: string]: unknown;
7724
- };
7725
- content: {
7726
- "application/problem+json": components["schemas"]["HTTPValidationError"];
7727
- };
7728
- };
7729
- };
7730
- };
7731
- delete_notification_v1_notifications__notification_id__delete: {
7732
- parameters: {
7733
- query?: never;
7734
- header?: never;
7735
- path: {
7736
- notification_id: TypeId<"notification">;
7737
- };
7738
- cookie?: never;
7739
- };
7740
- requestBody?: never;
7741
- responses: {
7742
- /** @description Successful Response */
7743
- 200: {
7744
- headers: {
7745
- [name: string]: unknown;
7746
- };
7747
- content: {
7748
- "application/json": unknown;
7749
- };
7750
- };
7751
- /** @description Validation Error */
7752
- 422: {
7753
- headers: {
7754
- [name: string]: unknown;
7755
- };
7756
- content: {
7757
- "application/problem+json": components["schemas"]["HTTPValidationError"];
7758
- };
7759
- };
7760
- };
7761
- };
7762
- update_notification_read_v1_notifications__notification_id__read_patch: {
7763
- parameters: {
7764
- query?: never;
7765
- header?: never;
7766
- path: {
7767
- notification_id: TypeId<"notification">;
7768
- };
7769
- cookie?: never;
7770
- };
7771
- requestBody?: never;
7772
- responses: {
7773
- /** @description Successful Response */
7774
- 200: {
7775
- headers: {
7776
- [name: string]: unknown;
7777
- };
7778
- content: {
7779
- "application/json": unknown;
7780
- };
7781
- };
7782
- /** @description Validation Error */
7783
- 422: {
7784
- headers: {
7785
- [name: string]: unknown;
7786
- };
7787
- content: {
7788
- "application/problem+json": components["schemas"]["HTTPValidationError"];
7789
- };
7790
- };
7791
- };
7792
- };
7793
7328
  list_organizations_v1_organizations_get: {
7794
7329
  parameters: {
7795
7330
  query?: {
@@ -8287,6 +7822,41 @@ export interface operations {
8287
7822
  };
8288
7823
  };
8289
7824
  };
7825
+ change_plan_v1_organizations__organization_id__plan_patch: {
7826
+ parameters: {
7827
+ query?: never;
7828
+ header?: never;
7829
+ path: {
7830
+ organization_id: TypeId<"organization">;
7831
+ };
7832
+ cookie?: never;
7833
+ };
7834
+ requestBody: {
7835
+ content: {
7836
+ "application/json": components["schemas"]["PlanUpdate"];
7837
+ };
7838
+ };
7839
+ responses: {
7840
+ /** @description Successful Response */
7841
+ 200: {
7842
+ headers: {
7843
+ [name: string]: unknown;
7844
+ };
7845
+ content: {
7846
+ "application/json": components["schemas"]["OrganizationWithBillingData"];
7847
+ };
7848
+ };
7849
+ /** @description Validation Error */
7850
+ 422: {
7851
+ headers: {
7852
+ [name: string]: unknown;
7853
+ };
7854
+ content: {
7855
+ "application/problem+json": components["schemas"]["HTTPValidationError"];
7856
+ };
7857
+ };
7858
+ };
7859
+ };
8290
7860
  get_current_available_plans_v1_organizations__organization_id__plans_get: {
8291
7861
  parameters: {
8292
7862
  query?: never;