@opusdns/api 0.54.0 → 0.56.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.
@@ -34,7 +34,7 @@
34
34
 
35
35
  import { DomainDnssecDataArray, OrganizationAttribute2Array, IpRestrictionArray, TldResponseShortArray } from './schemas-arrays.d';
36
36
 
37
- import { Pagination_OrganizationCredential, Problem, HTTPValidationError, OrganizationCredentialCreated, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DnsZoneSummary, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, Pagination_EmailForwardAlias, EmailForwardAlias, Pagination_Event, EventSchema, Pagination_UserNotificationSummary, Notification, UserNotification, Pagination_Organization, Organization, OrganizationWithBillingData, GetCurrentAvailablePlans, GetPrices, IpRestriction, Pagination_User, TldSpecification, User, UserWithAttributes, PermissionSet, RelationSet, UserVerification, UserPasswordResetEmail, UserWithRelationPermissions } from './schemas.d';
37
+ import { Pagination_OrganizationCredential, Problem, HTTPValidationError, OrganizationCredentialCreated, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DnsZoneSummary, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, Pagination_EmailForwardAlias, EmailForwardAlias, Pagination_Event, EventSchema, Pagination_Organization, Organization, OrganizationWithBillingData, GetCurrentAvailablePlans, GetPrices, IpRestriction, Pagination_User, TldSpecification, User, UserWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
38
38
 
39
39
  /**
40
40
  * Response types for GET AuthClientCredentials endpoint
@@ -3868,300 +3868,6 @@ export type PATCH_EventsByEventId_Response_404 = Problem
3868
3868
  */
3869
3869
  export type PATCH_EventsByEventId_Response_422 = HTTPValidationError
3870
3870
 
3871
- /**
3872
- * Response types for GET Notifications endpoint
3873
- *
3874
- * List Notifications
3875
- *
3876
- * @remarks
3877
- * This type defines all possible response structures for the GET Notifications endpoint.
3878
- * Each response code maps to a specific response type as defined in the OpenAPI specification.
3879
- * Use this type to ensure type safety when handling API responses from this endpoint.
3880
- *
3881
-
3882
- *
3883
- * @path /v1/notifications
3884
- *
3885
- * @see {@link GET_Notifications_Response_200} - 200 response type
3886
- * @see {@link GET_Notifications_Response_422} - 422 response type
3887
- *
3888
-
3889
- */
3890
- export type GET_Notifications_Response = GET_Notifications_Response_200 | GET_Notifications_Response_422;
3891
-
3892
- /**
3893
- * 200 response for GET Notifications endpoint
3894
- *
3895
- * @remarks
3896
- * This type defines the response structure for the 200 status code
3897
- * of the GET Notifications endpoint.
3898
- * It provides type safety for handling this specific response as defined in the OpenAPI specification.
3899
- *
3900
-
3901
- *
3902
- * @path /v1/notifications
3903
- *
3904
- * @see {@link GET_Notifications_Response} - The main response type definition
3905
- * @see {@link Pagination_UserNotificationSummary} - The actual schema type definition
3906
- */
3907
- export type GET_Notifications_Response_200 = Pagination_UserNotificationSummary
3908
-
3909
- /**
3910
- * 422 response for GET Notifications endpoint
3911
- *
3912
- * @remarks
3913
- * This type defines the response structure for the 422 status code
3914
- * of the GET Notifications endpoint.
3915
- * It provides type safety for handling this specific response as defined in the OpenAPI specification.
3916
- *
3917
-
3918
- *
3919
- * @path /v1/notifications
3920
- *
3921
- * @see {@link GET_Notifications_Response} - The main response type definition
3922
- * @see {@link HTTPValidationError} - The actual schema type definition
3923
- */
3924
- export type GET_Notifications_Response_422 = HTTPValidationError
3925
-
3926
- /**
3927
- * Response types for POST Notifications endpoint
3928
- *
3929
- * Create Notification
3930
- *
3931
- * @remarks
3932
- * This type defines all possible response structures for the POST Notifications endpoint.
3933
- * Each response code maps to a specific response type as defined in the OpenAPI specification.
3934
- * Use this type to ensure type safety when handling API responses from this endpoint.
3935
- *
3936
-
3937
- *
3938
- * @path /v1/notifications
3939
- *
3940
- * @see {@link POST_Notifications_Response_201} - 201 response type
3941
- * @see {@link POST_Notifications_Response_422} - 422 response type
3942
- *
3943
-
3944
- */
3945
- export type POST_Notifications_Response = POST_Notifications_Response_201 | POST_Notifications_Response_422;
3946
-
3947
- /**
3948
- * 201 response for POST Notifications endpoint
3949
- *
3950
- * @remarks
3951
- * This type defines the response structure for the 201 status code
3952
- * of the POST Notifications endpoint.
3953
- * It provides type safety for handling this specific response as defined in the OpenAPI specification.
3954
- *
3955
-
3956
- *
3957
- * @path /v1/notifications
3958
- *
3959
- * @see {@link POST_Notifications_Response} - The main response type definition
3960
- * @see {@link Notification} - The actual schema type definition
3961
- */
3962
- export type POST_Notifications_Response_201 = Notification
3963
-
3964
- /**
3965
- * 422 response for POST Notifications endpoint
3966
- *
3967
- * @remarks
3968
- * This type defines the response structure for the 422 status code
3969
- * of the POST Notifications endpoint.
3970
- * It provides type safety for handling this specific response as defined in the OpenAPI specification.
3971
- *
3972
-
3973
- *
3974
- * @path /v1/notifications
3975
- *
3976
- * @see {@link POST_Notifications_Response} - The main response type definition
3977
- * @see {@link HTTPValidationError} - The actual schema type definition
3978
- */
3979
- export type POST_Notifications_Response_422 = HTTPValidationError
3980
-
3981
- /**
3982
- * Response types for DELETE NotificationsByNotificationId endpoint
3983
- *
3984
- * Delete Notification
3985
- *
3986
- * @remarks
3987
- * This type defines all possible response structures for the DELETE NotificationsByNotificationId endpoint.
3988
- * Each response code maps to a specific response type as defined in the OpenAPI specification.
3989
- * Use this type to ensure type safety when handling API responses from this endpoint.
3990
- *
3991
-
3992
- *
3993
- * @path /v1/notifications/{notification_id}
3994
- *
3995
- * @see {@link DELETE_NotificationsByNotificationId_Response_422} - 422 response type
3996
- *
3997
-
3998
- */
3999
- export type DELETE_NotificationsByNotificationId_Response = DELETE_NotificationsByNotificationId_Response_422;
4000
-
4001
- /**
4002
- * 422 response for DELETE NotificationsByNotificationId endpoint
4003
- *
4004
- * @remarks
4005
- * This type defines the response structure for the 422 status code
4006
- * of the DELETE NotificationsByNotificationId endpoint.
4007
- * It provides type safety for handling this specific response as defined in the OpenAPI specification.
4008
- *
4009
-
4010
- *
4011
- * @path /v1/notifications/{notification_id}
4012
- *
4013
- * @see {@link DELETE_NotificationsByNotificationId_Response} - The main response type definition
4014
- * @see {@link HTTPValidationError} - The actual schema type definition
4015
- */
4016
- export type DELETE_NotificationsByNotificationId_Response_422 = HTTPValidationError
4017
-
4018
- /**
4019
- * Response types for GET NotificationsByNotificationId endpoint
4020
- *
4021
- * Get Notification
4022
- *
4023
- * @remarks
4024
- * This type defines all possible response structures for the GET NotificationsByNotificationId endpoint.
4025
- * Each response code maps to a specific response type as defined in the OpenAPI specification.
4026
- * Use this type to ensure type safety when handling API responses from this endpoint.
4027
- *
4028
-
4029
- *
4030
- * @path /v1/notifications/{notification_id}
4031
- *
4032
- * @see {@link GET_NotificationsByNotificationId_Response_200} - 200 response type
4033
- * @see {@link GET_NotificationsByNotificationId_Response_422} - 422 response type
4034
- *
4035
-
4036
- */
4037
- export type GET_NotificationsByNotificationId_Response = GET_NotificationsByNotificationId_Response_200 | GET_NotificationsByNotificationId_Response_422;
4038
-
4039
- /**
4040
- * 200 response for GET NotificationsByNotificationId endpoint
4041
- *
4042
- * @remarks
4043
- * This type defines the response structure for the 200 status code
4044
- * of the GET NotificationsByNotificationId endpoint.
4045
- * It provides type safety for handling this specific response as defined in the OpenAPI specification.
4046
- *
4047
-
4048
- *
4049
- * @path /v1/notifications/{notification_id}
4050
- *
4051
- * @see {@link GET_NotificationsByNotificationId_Response} - The main response type definition
4052
- * @see {@link UserNotification} - The actual schema type definition
4053
- */
4054
- export type GET_NotificationsByNotificationId_Response_200 = UserNotification
4055
-
4056
- /**
4057
- * 422 response for GET NotificationsByNotificationId endpoint
4058
- *
4059
- * @remarks
4060
- * This type defines the response structure for the 422 status code
4061
- * of the GET NotificationsByNotificationId endpoint.
4062
- * It provides type safety for handling this specific response as defined in the OpenAPI specification.
4063
- *
4064
-
4065
- *
4066
- * @path /v1/notifications/{notification_id}
4067
- *
4068
- * @see {@link GET_NotificationsByNotificationId_Response} - The main response type definition
4069
- * @see {@link HTTPValidationError} - The actual schema type definition
4070
- */
4071
- export type GET_NotificationsByNotificationId_Response_422 = HTTPValidationError
4072
-
4073
- /**
4074
- * Response types for PUT NotificationsByNotificationId endpoint
4075
- *
4076
- * Update Notification
4077
- *
4078
- * @remarks
4079
- * This type defines all possible response structures for the PUT NotificationsByNotificationId endpoint.
4080
- * Each response code maps to a specific response type as defined in the OpenAPI specification.
4081
- * Use this type to ensure type safety when handling API responses from this endpoint.
4082
- *
4083
-
4084
- *
4085
- * @path /v1/notifications/{notification_id}
4086
- *
4087
- * @see {@link PUT_NotificationsByNotificationId_Response_200} - 200 response type
4088
- * @see {@link PUT_NotificationsByNotificationId_Response_422} - 422 response type
4089
- *
4090
-
4091
- */
4092
- export type PUT_NotificationsByNotificationId_Response = PUT_NotificationsByNotificationId_Response_200 | PUT_NotificationsByNotificationId_Response_422;
4093
-
4094
- /**
4095
- * 200 response for PUT NotificationsByNotificationId endpoint
4096
- *
4097
- * @remarks
4098
- * This type defines the response structure for the 200 status code
4099
- * of the PUT NotificationsByNotificationId endpoint.
4100
- * It provides type safety for handling this specific response as defined in the OpenAPI specification.
4101
- *
4102
-
4103
- *
4104
- * @path /v1/notifications/{notification_id}
4105
- *
4106
- * @see {@link PUT_NotificationsByNotificationId_Response} - The main response type definition
4107
- * @see {@link Notification} - The actual schema type definition
4108
- */
4109
- export type PUT_NotificationsByNotificationId_Response_200 = Notification
4110
-
4111
- /**
4112
- * 422 response for PUT NotificationsByNotificationId endpoint
4113
- *
4114
- * @remarks
4115
- * This type defines the response structure for the 422 status code
4116
- * of the PUT NotificationsByNotificationId endpoint.
4117
- * It provides type safety for handling this specific response as defined in the OpenAPI specification.
4118
- *
4119
-
4120
- *
4121
- * @path /v1/notifications/{notification_id}
4122
- *
4123
- * @see {@link PUT_NotificationsByNotificationId_Response} - The main response type definition
4124
- * @see {@link HTTPValidationError} - The actual schema type definition
4125
- */
4126
- export type PUT_NotificationsByNotificationId_Response_422 = HTTPValidationError
4127
-
4128
- /**
4129
- * Response types for PATCH NotificationsByNotificationIdRead endpoint
4130
- *
4131
- * Update Notification Read
4132
- *
4133
- * @remarks
4134
- * This type defines all possible response structures for the PATCH NotificationsByNotificationIdRead endpoint.
4135
- * Each response code maps to a specific response type as defined in the OpenAPI specification.
4136
- * Use this type to ensure type safety when handling API responses from this endpoint.
4137
- *
4138
-
4139
- *
4140
- * @path /v1/notifications/{notification_id}/read
4141
- *
4142
- * @see {@link PATCH_NotificationsByNotificationIdRead_Response_422} - 422 response type
4143
- *
4144
-
4145
- */
4146
- export type PATCH_NotificationsByNotificationIdRead_Response = PATCH_NotificationsByNotificationIdRead_Response_422;
4147
-
4148
- /**
4149
- * 422 response for PATCH NotificationsByNotificationIdRead endpoint
4150
- *
4151
- * @remarks
4152
- * This type defines the response structure for the 422 status code
4153
- * of the PATCH NotificationsByNotificationIdRead endpoint.
4154
- * It provides type safety for handling this specific response as defined in the OpenAPI specification.
4155
- *
4156
-
4157
- *
4158
- * @path /v1/notifications/{notification_id}/read
4159
- *
4160
- * @see {@link PATCH_NotificationsByNotificationIdRead_Response} - The main response type definition
4161
- * @see {@link HTTPValidationError} - The actual schema type definition
4162
- */
4163
- export type PATCH_NotificationsByNotificationIdRead_Response_422 = HTTPValidationError
4164
-
4165
3871
  /**
4166
3872
  * Response types for GET Organizations endpoint
4167
3873
  *
@@ -5639,696 +5345,112 @@ export type PATCH_UsersByUserIdRoles_Response_200 = RelationSet
5639
5345
  export type PATCH_UsersByUserIdRoles_Response_422 = HTTPValidationError
5640
5346
 
5641
5347
  /**
5642
- * Response types for GET UsersByUserIdVerification endpoint
5348
+ * Response types for GET UsersMe endpoint
5643
5349
  *
5644
- * Get Verification Status
5350
+ * Get Current User
5645
5351
  *
5646
5352
  * @remarks
5647
- * This type defines all possible response structures for the GET UsersByUserIdVerification endpoint.
5353
+ * This type defines all possible response structures for the GET UsersMe endpoint.
5648
5354
  * Each response code maps to a specific response type as defined in the OpenAPI specification.
5649
5355
  * Use this type to ensure type safety when handling API responses from this endpoint.
5650
5356
  *
5651
5357
 
5652
5358
  *
5653
- * @path /v1/users/{user_id}/verification
5359
+ * @path /v1/users/me
5654
5360
  *
5655
- * @see {@link GET_UsersByUserIdVerification_Response_200} - 200 response type
5656
- * @see {@link GET_UsersByUserIdVerification_Response_401} - 401 response type
5657
- * @see {@link GET_UsersByUserIdVerification_Response_422} - 422 response type
5361
+ * @see {@link GET_UsersMe_Response_200} - 200 response type
5362
+ * @see {@link GET_UsersMe_Response_422} - 422 response type
5658
5363
  *
5659
5364
 
5660
5365
  */
5661
- export type GET_UsersByUserIdVerification_Response = GET_UsersByUserIdVerification_Response_200 | GET_UsersByUserIdVerification_Response_401 | GET_UsersByUserIdVerification_Response_422;
5366
+ export type GET_UsersMe_Response = GET_UsersMe_Response_200 | GET_UsersMe_Response_422;
5662
5367
 
5663
5368
  /**
5664
- * 200 response for GET UsersByUserIdVerification endpoint
5369
+ * 200 response for GET UsersMe endpoint
5665
5370
  *
5666
5371
  * @remarks
5667
5372
  * This type defines the response structure for the 200 status code
5668
- * of the GET UsersByUserIdVerification endpoint.
5669
- * It provides type safety for handling this specific response as defined in the OpenAPI specification.
5670
- *
5671
-
5672
- *
5673
- * @path /v1/users/{user_id}/verification
5674
- *
5675
- * @see {@link GET_UsersByUserIdVerification_Response} - The main response type definition
5676
- * @see {@link UserVerification} - The actual schema type definition
5677
- */
5678
- export type GET_UsersByUserIdVerification_Response_200 = UserVerification
5679
-
5680
- /**
5681
- * 401 response for GET UsersByUserIdVerification endpoint
5682
- *
5683
- * @remarks
5684
- * This type defines the response structure for the 401 status code
5685
- * of the GET UsersByUserIdVerification endpoint.
5373
+ * of the GET UsersMe endpoint.
5686
5374
  * It provides type safety for handling this specific response as defined in the OpenAPI specification.
5687
5375
  *
5688
5376
 
5689
5377
  *
5690
- * @path /v1/users/{user_id}/verification
5378
+ * @path /v1/users/me
5691
5379
  *
5692
- * @see {@link GET_UsersByUserIdVerification_Response} - The main response type definition
5693
- * @see {@link Problem} - The actual schema type definition
5380
+ * @see {@link GET_UsersMe_Response} - The main response type definition
5381
+ * @see {@link UserWithRelationPermissions} - The actual schema type definition
5694
5382
  */
5695
- export type GET_UsersByUserIdVerification_Response_401 = Problem
5383
+ export type GET_UsersMe_Response_200 = UserWithRelationPermissions
5696
5384
 
5697
5385
  /**
5698
- * 422 response for GET UsersByUserIdVerification endpoint
5386
+ * 422 response for GET UsersMe endpoint
5699
5387
  *
5700
5388
  * @remarks
5701
5389
  * This type defines the response structure for the 422 status code
5702
- * of the GET UsersByUserIdVerification endpoint.
5390
+ * of the GET UsersMe endpoint.
5703
5391
  * It provides type safety for handling this specific response as defined in the OpenAPI specification.
5704
5392
  *
5705
5393
 
5706
5394
  *
5707
- * @path /v1/users/{user_id}/verification
5395
+ * @path /v1/users/me
5708
5396
  *
5709
- * @see {@link GET_UsersByUserIdVerification_Response} - The main response type definition
5397
+ * @see {@link GET_UsersMe_Response} - The main response type definition
5710
5398
  * @see {@link HTTPValidationError} - The actual schema type definition
5711
5399
  */
5712
- export type GET_UsersByUserIdVerification_Response_422 = HTTPValidationError
5400
+ export type GET_UsersMe_Response_422 = HTTPValidationError
5713
5401
 
5714
5402
  /**
5715
- * Response types for PATCH UsersByUserIdVerification endpoint
5403
+ * Response types for PATCH UsersMePasswordReset endpoint
5716
5404
  *
5717
- * Update Verification
5405
+ * Confirm User Password Reset Me
5718
5406
  *
5719
5407
  * @remarks
5720
- * This type defines all possible response structures for the PATCH UsersByUserIdVerification endpoint.
5408
+ * This type defines all possible response structures for the PATCH UsersMePasswordReset endpoint.
5721
5409
  * Each response code maps to a specific response type as defined in the OpenAPI specification.
5722
5410
  * Use this type to ensure type safety when handling API responses from this endpoint.
5723
5411
  *
5724
5412
 
5725
5413
  *
5726
- * @path /v1/users/{user_id}/verification
5414
+ * @path /v1/users/me/password-reset
5727
5415
  *
5728
- * @see {@link PATCH_UsersByUserIdVerification_Response_400} - 400 response type
5729
- * @see {@link PATCH_UsersByUserIdVerification_Response_401} - 401 response type
5730
- * @see {@link PATCH_UsersByUserIdVerification_Response_404} - 404 response type
5731
- * @see {@link PATCH_UsersByUserIdVerification_Response_422} - 422 response type
5416
+ * @see {@link PATCH_UsersMePasswordReset_Response_401} - 401 response type
5417
+ * @see {@link PATCH_UsersMePasswordReset_Response_422} - 422 response type
5732
5418
  *
5733
5419
 
5734
5420
  */
5735
- export type PATCH_UsersByUserIdVerification_Response = PATCH_UsersByUserIdVerification_Response_400 | PATCH_UsersByUserIdVerification_Response_401 | PATCH_UsersByUserIdVerification_Response_404 | PATCH_UsersByUserIdVerification_Response_422;
5421
+ export type PATCH_UsersMePasswordReset_Response = PATCH_UsersMePasswordReset_Response_401 | PATCH_UsersMePasswordReset_Response_422;
5736
5422
 
5737
5423
  /**
5738
- * 400 response for PATCH UsersByUserIdVerification endpoint
5424
+ * 401 response for PATCH UsersMePasswordReset endpoint
5739
5425
  *
5740
5426
  * @remarks
5741
- * This type defines the response structure for the 400 status code
5742
- * of the PATCH UsersByUserIdVerification endpoint.
5427
+ * This type defines the response structure for the 401 status code
5428
+ * of the PATCH UsersMePasswordReset endpoint.
5743
5429
  * It provides type safety for handling this specific response as defined in the OpenAPI specification.
5744
5430
  *
5745
5431
 
5746
5432
  *
5747
- * @path /v1/users/{user_id}/verification
5433
+ * @path /v1/users/me/password-reset
5748
5434
  *
5749
- * @see {@link PATCH_UsersByUserIdVerification_Response} - The main response type definition
5435
+ * @see {@link PATCH_UsersMePasswordReset_Response} - The main response type definition
5750
5436
  * @see {@link Problem} - The actual schema type definition
5751
5437
  */
5752
- export type PATCH_UsersByUserIdVerification_Response_400 = Problem
5438
+ export type PATCH_UsersMePasswordReset_Response_401 = Problem
5753
5439
 
5754
5440
  /**
5755
- * 401 response for PATCH UsersByUserIdVerification endpoint
5441
+ * 422 response for PATCH UsersMePasswordReset endpoint
5756
5442
  *
5757
5443
  * @remarks
5758
- * This type defines the response structure for the 401 status code
5759
- * of the PATCH UsersByUserIdVerification endpoint.
5444
+ * This type defines the response structure for the 422 status code
5445
+ * of the PATCH UsersMePasswordReset endpoint.
5760
5446
  * It provides type safety for handling this specific response as defined in the OpenAPI specification.
5761
5447
  *
5762
5448
 
5763
5449
  *
5764
- * @path /v1/users/{user_id}/verification
5450
+ * @path /v1/users/me/password-reset
5765
5451
  *
5766
- * @see {@link PATCH_UsersByUserIdVerification_Response} - The main response type definition
5767
- * @see {@link Problem} - The actual schema type definition
5768
- */
5769
- export type PATCH_UsersByUserIdVerification_Response_401 = Problem
5770
-
5771
- /**
5772
- * 404 response for PATCH UsersByUserIdVerification endpoint
5773
- *
5774
- * @remarks
5775
- * This type defines the response structure for the 404 status code
5776
- * of the PATCH UsersByUserIdVerification endpoint.
5777
- * It provides type safety for handling this specific response as defined in the OpenAPI specification.
5778
- *
5779
-
5780
- *
5781
- * @path /v1/users/{user_id}/verification
5782
- *
5783
- * @see {@link PATCH_UsersByUserIdVerification_Response} - The main response type definition
5784
- * @see {@link Problem} - The actual schema type definition
5785
- */
5786
- export type PATCH_UsersByUserIdVerification_Response_404 = Problem
5787
-
5788
- /**
5789
- * 422 response for PATCH UsersByUserIdVerification endpoint
5790
- *
5791
- * @remarks
5792
- * This type defines the response structure for the 422 status code
5793
- * of the PATCH UsersByUserIdVerification endpoint.
5794
- * It provides type safety for handling this specific response as defined in the OpenAPI specification.
5795
- *
5796
-
5797
- *
5798
- * @path /v1/users/{user_id}/verification
5799
- *
5800
- * @see {@link PATCH_UsersByUserIdVerification_Response} - The main response type definition
5801
- * @see {@link HTTPValidationError} - The actual schema type definition
5802
- */
5803
- export type PATCH_UsersByUserIdVerification_Response_422 = HTTPValidationError
5804
-
5805
- /**
5806
- * Response types for POST UsersByUserIdVerification endpoint
5807
- *
5808
- * Create Verification
5809
- *
5810
- * @remarks
5811
- * This type defines all possible response structures for the POST UsersByUserIdVerification endpoint.
5812
- * Each response code maps to a specific response type as defined in the OpenAPI specification.
5813
- * Use this type to ensure type safety when handling API responses from this endpoint.
5814
- *
5815
-
5816
- *
5817
- * @path /v1/users/{user_id}/verification
5818
- *
5819
- * @see {@link POST_UsersByUserIdVerification_Response_401} - 401 response type
5820
- * @see {@link POST_UsersByUserIdVerification_Response_404} - 404 response type
5821
- * @see {@link POST_UsersByUserIdVerification_Response_405} - 405 response type
5822
- * @see {@link POST_UsersByUserIdVerification_Response_422} - 422 response type
5823
- *
5824
-
5825
- */
5826
- export type POST_UsersByUserIdVerification_Response = POST_UsersByUserIdVerification_Response_401 | POST_UsersByUserIdVerification_Response_404 | POST_UsersByUserIdVerification_Response_405 | POST_UsersByUserIdVerification_Response_422;
5827
-
5828
- /**
5829
- * 401 response for POST UsersByUserIdVerification endpoint
5830
- *
5831
- * @remarks
5832
- * This type defines the response structure for the 401 status code
5833
- * of the POST UsersByUserIdVerification endpoint.
5834
- * It provides type safety for handling this specific response as defined in the OpenAPI specification.
5835
- *
5836
-
5837
- *
5838
- * @path /v1/users/{user_id}/verification
5839
- *
5840
- * @see {@link POST_UsersByUserIdVerification_Response} - The main response type definition
5841
- * @see {@link Problem} - The actual schema type definition
5842
- */
5843
- export type POST_UsersByUserIdVerification_Response_401 = Problem
5844
-
5845
- /**
5846
- * 404 response for POST UsersByUserIdVerification endpoint
5847
- *
5848
- * @remarks
5849
- * This type defines the response structure for the 404 status code
5850
- * of the POST UsersByUserIdVerification endpoint.
5851
- * It provides type safety for handling this specific response as defined in the OpenAPI specification.
5852
- *
5853
-
5854
- *
5855
- * @path /v1/users/{user_id}/verification
5856
- *
5857
- * @see {@link POST_UsersByUserIdVerification_Response} - The main response type definition
5858
- * @see {@link Problem} - The actual schema type definition
5859
- */
5860
- export type POST_UsersByUserIdVerification_Response_404 = Problem
5861
-
5862
- /**
5863
- * 405 response for POST UsersByUserIdVerification endpoint
5864
- *
5865
- * @remarks
5866
- * This type defines the response structure for the 405 status code
5867
- * of the POST UsersByUserIdVerification endpoint.
5868
- * It provides type safety for handling this specific response as defined in the OpenAPI specification.
5869
- *
5870
-
5871
- *
5872
- * @path /v1/users/{user_id}/verification
5873
- *
5874
- * @see {@link POST_UsersByUserIdVerification_Response} - The main response type definition
5875
- * @see {@link Problem} - The actual schema type definition
5876
- */
5877
- export type POST_UsersByUserIdVerification_Response_405 = Problem
5878
-
5879
- /**
5880
- * 422 response for POST UsersByUserIdVerification endpoint
5881
- *
5882
- * @remarks
5883
- * This type defines the response structure for the 422 status code
5884
- * of the POST UsersByUserIdVerification endpoint.
5885
- * It provides type safety for handling this specific response as defined in the OpenAPI specification.
5886
- *
5887
-
5888
- *
5889
- * @path /v1/users/{user_id}/verification
5890
- *
5891
- * @see {@link POST_UsersByUserIdVerification_Response} - The main response type definition
5892
- * @see {@link HTTPValidationError} - The actual schema type definition
5893
- */
5894
- export type POST_UsersByUserIdVerification_Response_422 = HTTPValidationError
5895
-
5896
- /**
5897
- * Response types for POST UsersEmailPasswordReset endpoint
5898
- *
5899
- * Create User Password Reset
5900
- *
5901
- * @remarks
5902
- * This type defines all possible response structures for the POST UsersEmailPasswordReset endpoint.
5903
- * Each response code maps to a specific response type as defined in the OpenAPI specification.
5904
- * Use this type to ensure type safety when handling API responses from this endpoint.
5905
- *
5906
-
5907
- *
5908
- * @path /v1/users/email/password-reset
5909
- *
5910
- * @see {@link POST_UsersEmailPasswordReset_Response_201} - 201 response type
5911
- * @see {@link POST_UsersEmailPasswordReset_Response_422} - 422 response type
5912
- *
5913
-
5914
- */
5915
- export type POST_UsersEmailPasswordReset_Response = POST_UsersEmailPasswordReset_Response_201 | POST_UsersEmailPasswordReset_Response_422;
5916
-
5917
- /**
5918
- * 201 response for POST UsersEmailPasswordReset endpoint
5919
- *
5920
- * @remarks
5921
- * This type defines the response structure for the 201 status code
5922
- * of the POST UsersEmailPasswordReset endpoint.
5923
- * It provides type safety for handling this specific response as defined in the OpenAPI specification.
5924
- *
5925
-
5926
- *
5927
- * @path /v1/users/email/password-reset
5928
- *
5929
- * @see {@link POST_UsersEmailPasswordReset_Response} - The main response type definition
5930
- * @see {@link UserPasswordResetEmail} - The actual schema type definition
5931
- */
5932
- export type POST_UsersEmailPasswordReset_Response_201 = UserPasswordResetEmail
5933
-
5934
- /**
5935
- * 422 response for POST UsersEmailPasswordReset endpoint
5936
- *
5937
- * @remarks
5938
- * This type defines the response structure for the 422 status code
5939
- * of the POST UsersEmailPasswordReset endpoint.
5940
- * It provides type safety for handling this specific response as defined in the OpenAPI specification.
5941
- *
5942
-
5943
- *
5944
- * @path /v1/users/email/password-reset
5945
- *
5946
- * @see {@link POST_UsersEmailPasswordReset_Response} - The main response type definition
5947
- * @see {@link HTTPValidationError} - The actual schema type definition
5948
- */
5949
- export type POST_UsersEmailPasswordReset_Response_422 = HTTPValidationError
5950
-
5951
- /**
5952
- * Response types for GET UsersEmailVerify endpoint
5953
- *
5954
- * Redirect Verify User
5955
- *
5956
- * @remarks
5957
- * This type defines all possible response structures for the GET UsersEmailVerify endpoint.
5958
- * Each response code maps to a specific response type as defined in the OpenAPI specification.
5959
- * Use this type to ensure type safety when handling API responses from this endpoint.
5960
- *
5961
-
5962
- *
5963
- * @path /v1/users/email/verify
5964
- *
5965
- * @see {@link GET_UsersEmailVerify_Response_422} - 422 response type
5966
- *
5967
-
5968
- */
5969
- export type GET_UsersEmailVerify_Response = GET_UsersEmailVerify_Response_422;
5970
-
5971
- /**
5972
- * 422 response for GET UsersEmailVerify endpoint
5973
- *
5974
- * @remarks
5975
- * This type defines the response structure for the 422 status code
5976
- * of the GET UsersEmailVerify endpoint.
5977
- * It provides type safety for handling this specific response as defined in the OpenAPI specification.
5978
- *
5979
-
5980
- *
5981
- * @path /v1/users/email/verify
5982
- *
5983
- * @see {@link GET_UsersEmailVerify_Response} - The main response type definition
5984
- * @see {@link HTTPValidationError} - The actual schema type definition
5985
- */
5986
- export type GET_UsersEmailVerify_Response_422 = HTTPValidationError
5987
-
5988
- /**
5989
- * Response types for GET UsersMe endpoint
5990
- *
5991
- * Get Current User
5992
- *
5993
- * @remarks
5994
- * This type defines all possible response structures for the GET UsersMe endpoint.
5995
- * Each response code maps to a specific response type as defined in the OpenAPI specification.
5996
- * Use this type to ensure type safety when handling API responses from this endpoint.
5997
- *
5998
-
5999
- *
6000
- * @path /v1/users/me
6001
- *
6002
- * @see {@link GET_UsersMe_Response_200} - 200 response type
6003
- * @see {@link GET_UsersMe_Response_422} - 422 response type
6004
- *
6005
-
6006
- */
6007
- export type GET_UsersMe_Response = GET_UsersMe_Response_200 | GET_UsersMe_Response_422;
6008
-
6009
- /**
6010
- * 200 response for GET UsersMe endpoint
6011
- *
6012
- * @remarks
6013
- * This type defines the response structure for the 200 status code
6014
- * of the GET UsersMe endpoint.
6015
- * It provides type safety for handling this specific response as defined in the OpenAPI specification.
6016
- *
6017
-
6018
- *
6019
- * @path /v1/users/me
6020
- *
6021
- * @see {@link GET_UsersMe_Response} - The main response type definition
6022
- * @see {@link UserWithRelationPermissions} - The actual schema type definition
6023
- */
6024
- export type GET_UsersMe_Response_200 = UserWithRelationPermissions
6025
-
6026
- /**
6027
- * 422 response for GET UsersMe endpoint
6028
- *
6029
- * @remarks
6030
- * This type defines the response structure for the 422 status code
6031
- * of the GET UsersMe endpoint.
6032
- * It provides type safety for handling this specific response as defined in the OpenAPI specification.
6033
- *
6034
-
6035
- *
6036
- * @path /v1/users/me
6037
- *
6038
- * @see {@link GET_UsersMe_Response} - The main response type definition
6039
- * @see {@link HTTPValidationError} - The actual schema type definition
6040
- */
6041
- export type GET_UsersMe_Response_422 = HTTPValidationError
6042
-
6043
- /**
6044
- * Response types for PATCH UsersMePasswordReset endpoint
6045
- *
6046
- * Confirm User Password Reset Me
6047
- *
6048
- * @remarks
6049
- * This type defines all possible response structures for the PATCH UsersMePasswordReset endpoint.
6050
- * Each response code maps to a specific response type as defined in the OpenAPI specification.
6051
- * Use this type to ensure type safety when handling API responses from this endpoint.
6052
- *
6053
-
6054
- *
6055
- * @path /v1/users/me/password-reset
6056
- *
6057
- * @see {@link PATCH_UsersMePasswordReset_Response_401} - 401 response type
6058
- * @see {@link PATCH_UsersMePasswordReset_Response_422} - 422 response type
6059
- *
6060
-
6061
- */
6062
- export type PATCH_UsersMePasswordReset_Response = PATCH_UsersMePasswordReset_Response_401 | PATCH_UsersMePasswordReset_Response_422;
6063
-
6064
- /**
6065
- * 401 response for PATCH UsersMePasswordReset endpoint
6066
- *
6067
- * @remarks
6068
- * This type defines the response structure for the 401 status code
6069
- * of the PATCH UsersMePasswordReset endpoint.
6070
- * It provides type safety for handling this specific response as defined in the OpenAPI specification.
6071
- *
6072
-
6073
- *
6074
- * @path /v1/users/me/password-reset
6075
- *
6076
- * @see {@link PATCH_UsersMePasswordReset_Response} - The main response type definition
6077
- * @see {@link Problem} - The actual schema type definition
6078
- */
6079
- export type PATCH_UsersMePasswordReset_Response_401 = Problem
6080
-
6081
- /**
6082
- * 422 response for PATCH UsersMePasswordReset endpoint
6083
- *
6084
- * @remarks
6085
- * This type defines the response structure for the 422 status code
6086
- * of the PATCH UsersMePasswordReset endpoint.
6087
- * It provides type safety for handling this specific response as defined in the OpenAPI specification.
6088
- *
6089
-
6090
- *
6091
- * @path /v1/users/me/password-reset
6092
- *
6093
- * @see {@link PATCH_UsersMePasswordReset_Response} - The main response type definition
6094
- * @see {@link HTTPValidationError} - The actual schema type definition
5452
+ * @see {@link PATCH_UsersMePasswordReset_Response} - The main response type definition
5453
+ * @see {@link HTTPValidationError} - The actual schema type definition
6095
5454
  */
6096
5455
  export type PATCH_UsersMePasswordReset_Response_422 = HTTPValidationError
6097
5456
 
6098
- /**
6099
- * Response types for GET UsersMeVerification endpoint
6100
- *
6101
- * Get Verification Status Me
6102
- *
6103
- * @remarks
6104
- * This type defines all possible response structures for the GET UsersMeVerification endpoint.
6105
- * Each response code maps to a specific response type as defined in the OpenAPI specification.
6106
- * Use this type to ensure type safety when handling API responses from this endpoint.
6107
- *
6108
-
6109
- *
6110
- * @path /v1/users/me/verification
6111
- *
6112
- * @see {@link GET_UsersMeVerification_Response_200} - 200 response type
6113
- * @see {@link GET_UsersMeVerification_Response_401} - 401 response type
6114
- *
6115
-
6116
- */
6117
- export type GET_UsersMeVerification_Response = GET_UsersMeVerification_Response_200 | GET_UsersMeVerification_Response_401;
6118
-
6119
- /**
6120
- * 200 response for GET UsersMeVerification endpoint
6121
- *
6122
- * @remarks
6123
- * This type defines the response structure for the 200 status code
6124
- * of the GET UsersMeVerification endpoint.
6125
- * It provides type safety for handling this specific response as defined in the OpenAPI specification.
6126
- *
6127
-
6128
- *
6129
- * @path /v1/users/me/verification
6130
- *
6131
- * @see {@link GET_UsersMeVerification_Response} - The main response type definition
6132
- * @see {@link UserVerification} - The actual schema type definition
6133
- */
6134
- export type GET_UsersMeVerification_Response_200 = UserVerification
6135
-
6136
- /**
6137
- * 401 response for GET UsersMeVerification endpoint
6138
- *
6139
- * @remarks
6140
- * This type defines the response structure for the 401 status code
6141
- * of the GET UsersMeVerification endpoint.
6142
- * It provides type safety for handling this specific response as defined in the OpenAPI specification.
6143
- *
6144
-
6145
- *
6146
- * @path /v1/users/me/verification
6147
- *
6148
- * @see {@link GET_UsersMeVerification_Response} - The main response type definition
6149
- * @see {@link Problem} - The actual schema type definition
6150
- */
6151
- export type GET_UsersMeVerification_Response_401 = Problem
6152
-
6153
- /**
6154
- * Response types for PATCH UsersMeVerification endpoint
6155
- *
6156
- * Update Verification Me
6157
- *
6158
- * @remarks
6159
- * This type defines all possible response structures for the PATCH UsersMeVerification endpoint.
6160
- * Each response code maps to a specific response type as defined in the OpenAPI specification.
6161
- * Use this type to ensure type safety when handling API responses from this endpoint.
6162
- *
6163
-
6164
- *
6165
- * @path /v1/users/me/verification
6166
- *
6167
- * @see {@link PATCH_UsersMeVerification_Response_400} - 400 response type
6168
- * @see {@link PATCH_UsersMeVerification_Response_401} - 401 response type
6169
- * @see {@link PATCH_UsersMeVerification_Response_404} - 404 response type
6170
- * @see {@link PATCH_UsersMeVerification_Response_422} - 422 response type
6171
- *
6172
-
6173
- */
6174
- export type PATCH_UsersMeVerification_Response = PATCH_UsersMeVerification_Response_400 | PATCH_UsersMeVerification_Response_401 | PATCH_UsersMeVerification_Response_404 | PATCH_UsersMeVerification_Response_422;
6175
-
6176
- /**
6177
- * 400 response for PATCH UsersMeVerification endpoint
6178
- *
6179
- * @remarks
6180
- * This type defines the response structure for the 400 status code
6181
- * of the PATCH UsersMeVerification endpoint.
6182
- * It provides type safety for handling this specific response as defined in the OpenAPI specification.
6183
- *
6184
-
6185
- *
6186
- * @path /v1/users/me/verification
6187
- *
6188
- * @see {@link PATCH_UsersMeVerification_Response} - The main response type definition
6189
- * @see {@link Problem} - The actual schema type definition
6190
- */
6191
- export type PATCH_UsersMeVerification_Response_400 = Problem
6192
-
6193
- /**
6194
- * 401 response for PATCH UsersMeVerification endpoint
6195
- *
6196
- * @remarks
6197
- * This type defines the response structure for the 401 status code
6198
- * of the PATCH UsersMeVerification endpoint.
6199
- * It provides type safety for handling this specific response as defined in the OpenAPI specification.
6200
- *
6201
-
6202
- *
6203
- * @path /v1/users/me/verification
6204
- *
6205
- * @see {@link PATCH_UsersMeVerification_Response} - The main response type definition
6206
- * @see {@link Problem} - The actual schema type definition
6207
- */
6208
- export type PATCH_UsersMeVerification_Response_401 = Problem
6209
-
6210
- /**
6211
- * 404 response for PATCH UsersMeVerification endpoint
6212
- *
6213
- * @remarks
6214
- * This type defines the response structure for the 404 status code
6215
- * of the PATCH UsersMeVerification endpoint.
6216
- * It provides type safety for handling this specific response as defined in the OpenAPI specification.
6217
- *
6218
-
6219
- *
6220
- * @path /v1/users/me/verification
6221
- *
6222
- * @see {@link PATCH_UsersMeVerification_Response} - The main response type definition
6223
- * @see {@link Problem} - The actual schema type definition
6224
- */
6225
- export type PATCH_UsersMeVerification_Response_404 = Problem
6226
-
6227
- /**
6228
- * 422 response for PATCH UsersMeVerification endpoint
6229
- *
6230
- * @remarks
6231
- * This type defines the response structure for the 422 status code
6232
- * of the PATCH UsersMeVerification endpoint.
6233
- * It provides type safety for handling this specific response as defined in the OpenAPI specification.
6234
- *
6235
-
6236
- *
6237
- * @path /v1/users/me/verification
6238
- *
6239
- * @see {@link PATCH_UsersMeVerification_Response} - The main response type definition
6240
- * @see {@link HTTPValidationError} - The actual schema type definition
6241
- */
6242
- export type PATCH_UsersMeVerification_Response_422 = HTTPValidationError
6243
-
6244
- /**
6245
- * Response types for POST UsersMeVerification endpoint
6246
- *
6247
- * Create Verification Me
6248
- *
6249
- * @remarks
6250
- * This type defines all possible response structures for the POST UsersMeVerification endpoint.
6251
- * Each response code maps to a specific response type as defined in the OpenAPI specification.
6252
- * Use this type to ensure type safety when handling API responses from this endpoint.
6253
- *
6254
-
6255
- *
6256
- * @path /v1/users/me/verification
6257
- *
6258
- * @see {@link POST_UsersMeVerification_Response_401} - 401 response type
6259
- * @see {@link POST_UsersMeVerification_Response_404} - 404 response type
6260
- * @see {@link POST_UsersMeVerification_Response_405} - 405 response type
6261
- * @see {@link POST_UsersMeVerification_Response_422} - 422 response type
6262
- *
6263
-
6264
- */
6265
- export type POST_UsersMeVerification_Response = POST_UsersMeVerification_Response_401 | POST_UsersMeVerification_Response_404 | POST_UsersMeVerification_Response_405 | POST_UsersMeVerification_Response_422;
6266
-
6267
- /**
6268
- * 401 response for POST UsersMeVerification endpoint
6269
- *
6270
- * @remarks
6271
- * This type defines the response structure for the 401 status code
6272
- * of the POST UsersMeVerification endpoint.
6273
- * It provides type safety for handling this specific response as defined in the OpenAPI specification.
6274
- *
6275
-
6276
- *
6277
- * @path /v1/users/me/verification
6278
- *
6279
- * @see {@link POST_UsersMeVerification_Response} - The main response type definition
6280
- * @see {@link Problem} - The actual schema type definition
6281
- */
6282
- export type POST_UsersMeVerification_Response_401 = Problem
6283
-
6284
- /**
6285
- * 404 response for POST UsersMeVerification endpoint
6286
- *
6287
- * @remarks
6288
- * This type defines the response structure for the 404 status code
6289
- * of the POST UsersMeVerification endpoint.
6290
- * It provides type safety for handling this specific response as defined in the OpenAPI specification.
6291
- *
6292
-
6293
- *
6294
- * @path /v1/users/me/verification
6295
- *
6296
- * @see {@link POST_UsersMeVerification_Response} - The main response type definition
6297
- * @see {@link Problem} - The actual schema type definition
6298
- */
6299
- export type POST_UsersMeVerification_Response_404 = Problem
6300
-
6301
- /**
6302
- * 405 response for POST UsersMeVerification endpoint
6303
- *
6304
- * @remarks
6305
- * This type defines the response structure for the 405 status code
6306
- * of the POST UsersMeVerification endpoint.
6307
- * It provides type safety for handling this specific response as defined in the OpenAPI specification.
6308
- *
6309
-
6310
- *
6311
- * @path /v1/users/me/verification
6312
- *
6313
- * @see {@link POST_UsersMeVerification_Response} - The main response type definition
6314
- * @see {@link Problem} - The actual schema type definition
6315
- */
6316
- export type POST_UsersMeVerification_Response_405 = Problem
6317
-
6318
- /**
6319
- * 422 response for POST UsersMeVerification endpoint
6320
- *
6321
- * @remarks
6322
- * This type defines the response structure for the 422 status code
6323
- * of the POST UsersMeVerification endpoint.
6324
- * It provides type safety for handling this specific response as defined in the OpenAPI specification.
6325
- *
6326
-
6327
- *
6328
- * @path /v1/users/me/verification
6329
- *
6330
- * @see {@link POST_UsersMeVerification_Response} - The main response type definition
6331
- * @see {@link HTTPValidationError} - The actual schema type definition
6332
- */
6333
- export type POST_UsersMeVerification_Response_422 = HTTPValidationError
6334
-