@opusdns/api 0.55.0 → 0.57.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/keys.ts +26 -838
- package/src/helpers/requests.d.ts +1 -315
- package/src/helpers/responses.d.ts +1 -585
- package/src/helpers/schemas.d.ts +0 -80
- package/src/openapi.yaml +39 -628
- package/src/schema.d.ts +47 -717
|
@@ -34,7 +34,7 @@ import { operations } from '../schema';
|
|
|
34
34
|
|
|
35
35
|
import { DomainDnssecDataCreateArray, OrganizationAttributeUpdateArray } from './schemas-arrays.d';
|
|
36
36
|
|
|
37
|
-
import { OrganizationCredentialExtra, SignupCreate, ContactCreate, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatchOps, DnsZoneRrsetsCreate, DomainCreate, DomainUpdate, DomainRenewRequest, DomainRestoreRequest, DomainTransferIn, EmailForwardAlias, EmailForwardAliasUpdate, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate, PlanUpdate, UserCreate,
|
|
37
|
+
import { OrganizationCredentialExtra, SignupCreate, ContactCreate, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatchOps, DnsZoneRrsetsCreate, DomainCreate, DomainUpdate, DomainRenewRequest, DomainRestoreRequest, DomainTransferIn, EmailForwardAlias, EmailForwardAliasUpdate, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate, PlanUpdate, UserCreate, PasswordUpdate, UserUpdate, SpiceDbRelationshipUpdate } from './schemas.d';
|
|
38
38
|
|
|
39
39
|
/**
|
|
40
40
|
* Request type for GET AuthClientCredentials endpoint
|
|
@@ -3325,80 +3325,6 @@ export type POST_Users_Request = {
|
|
|
3325
3325
|
*/
|
|
3326
3326
|
export type POST_Users_Request_Body = POST_Users_Request['requestBody'];
|
|
3327
3327
|
|
|
3328
|
-
/**
|
|
3329
|
-
* Request type for POST UsersEmailPasswordReset endpoint
|
|
3330
|
-
*
|
|
3331
|
-
* Create User Password Reset
|
|
3332
|
-
*
|
|
3333
|
-
* @remarks
|
|
3334
|
-
* This type defines the complete request structure for the POST UsersEmailPasswordReset endpoint.
|
|
3335
|
-
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
3336
|
-
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
3337
|
-
*
|
|
3338
|
-
* @example
|
|
3339
|
-
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
3340
|
-
*
|
|
3341
|
-
* @path /v1/users/email/password-reset
|
|
3342
|
-
*
|
|
3343
|
-
* @see {@link POST_UsersEmailPasswordReset_Request_Query} - Query parameters type
|
|
3344
|
-
* @see {@link POST_UsersEmailPasswordReset_Request_Path} - Path parameters type
|
|
3345
|
-
* @see {@link POST_UsersEmailPasswordReset_Request_Body} - Request body type
|
|
3346
|
-
*/
|
|
3347
|
-
export type POST_UsersEmailPasswordReset_Request = {
|
|
3348
|
-
requestBody: StartPasswordReset;
|
|
3349
|
-
}
|
|
3350
|
-
/**
|
|
3351
|
-
* Request body for POST /v1/users/email/password-reset
|
|
3352
|
-
*
|
|
3353
|
-
* @remarks
|
|
3354
|
-
* This type defines the request body structure for the POST /v1/users/email/password-reset endpoint.
|
|
3355
|
-
* It provides type safety for the request body as defined in the OpenAPI specification.
|
|
3356
|
-
*
|
|
3357
|
-
* @example
|
|
3358
|
-
* Use this type to ensure type safety for request body structure.
|
|
3359
|
-
*
|
|
3360
|
-
* @path /v1/users/email/password-reset
|
|
3361
|
-
*/
|
|
3362
|
-
export type POST_UsersEmailPasswordReset_Request_Body = POST_UsersEmailPasswordReset_Request['requestBody'];
|
|
3363
|
-
|
|
3364
|
-
/**
|
|
3365
|
-
* Request type for GET UsersEmailVerify endpoint
|
|
3366
|
-
*
|
|
3367
|
-
* Redirect Verify User
|
|
3368
|
-
*
|
|
3369
|
-
* @remarks
|
|
3370
|
-
* This type defines the complete request structure for the GET UsersEmailVerify endpoint.
|
|
3371
|
-
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
3372
|
-
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
3373
|
-
*
|
|
3374
|
-
* @example
|
|
3375
|
-
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
3376
|
-
*
|
|
3377
|
-
* @path /v1/users/email/verify
|
|
3378
|
-
*
|
|
3379
|
-
* @see {@link GET_UsersEmailVerify_Request_Query} - Query parameters type
|
|
3380
|
-
* @see {@link GET_UsersEmailVerify_Request_Path} - Path parameters type
|
|
3381
|
-
* @see {@link GET_UsersEmailVerify_Request_Body} - Request body type
|
|
3382
|
-
*/
|
|
3383
|
-
export type GET_UsersEmailVerify_Request = {
|
|
3384
|
-
parameters: {
|
|
3385
|
-
query: operations['redirect_verify_user_v1_users_email_verify_get']['parameters']['query'];
|
|
3386
|
-
};
|
|
3387
|
-
}
|
|
3388
|
-
/**
|
|
3389
|
-
* Query parameters for GET /v1/users/email/verify
|
|
3390
|
-
*
|
|
3391
|
-
* @remarks
|
|
3392
|
-
* This type defines the query parameters for the GET /v1/users/email/verify endpoint.
|
|
3393
|
-
* It provides type safety for all query parameters as defined in the OpenAPI specification.
|
|
3394
|
-
*
|
|
3395
|
-
* @example
|
|
3396
|
-
* Use this type to ensure type safety for query parameters.
|
|
3397
|
-
*
|
|
3398
|
-
* @path /v1/users/email/verify
|
|
3399
|
-
*/
|
|
3400
|
-
export type GET_UsersEmailVerify_Request_Query = GET_UsersEmailVerify_Request['parameters']['query'];
|
|
3401
|
-
|
|
3402
3328
|
/**
|
|
3403
3329
|
* Request type for GET UsersMe endpoint
|
|
3404
3330
|
*
|
|
@@ -3473,104 +3399,6 @@ export type PATCH_UsersMePasswordReset_Request = {
|
|
|
3473
3399
|
*/
|
|
3474
3400
|
export type PATCH_UsersMePasswordReset_Request_Body = PATCH_UsersMePasswordReset_Request['requestBody'];
|
|
3475
3401
|
|
|
3476
|
-
/**
|
|
3477
|
-
* Request type for GET UsersMeVerification endpoint
|
|
3478
|
-
*
|
|
3479
|
-
* Get Verification Status Me
|
|
3480
|
-
*
|
|
3481
|
-
* @remarks
|
|
3482
|
-
* This type defines the complete request structure for the GET UsersMeVerification endpoint.
|
|
3483
|
-
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
3484
|
-
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
3485
|
-
*
|
|
3486
|
-
* @example
|
|
3487
|
-
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
3488
|
-
*
|
|
3489
|
-
* @path /v1/users/me/verification
|
|
3490
|
-
*
|
|
3491
|
-
* @see {@link GET_UsersMeVerification_Request_Query} - Query parameters type
|
|
3492
|
-
* @see {@link GET_UsersMeVerification_Request_Path} - Path parameters type
|
|
3493
|
-
* @see {@link GET_UsersMeVerification_Request_Body} - Request body type
|
|
3494
|
-
*/
|
|
3495
|
-
export type GET_UsersMeVerification_Request = {
|
|
3496
|
-
}
|
|
3497
|
-
|
|
3498
|
-
/**
|
|
3499
|
-
* Request type for PATCH UsersMeVerification endpoint
|
|
3500
|
-
*
|
|
3501
|
-
* Update Verification Me
|
|
3502
|
-
*
|
|
3503
|
-
* @remarks
|
|
3504
|
-
* This type defines the complete request structure for the PATCH UsersMeVerification endpoint.
|
|
3505
|
-
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
3506
|
-
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
3507
|
-
*
|
|
3508
|
-
* @example
|
|
3509
|
-
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
3510
|
-
*
|
|
3511
|
-
* @path /v1/users/me/verification
|
|
3512
|
-
*
|
|
3513
|
-
* @see {@link PATCH_UsersMeVerification_Request_Query} - Query parameters type
|
|
3514
|
-
* @see {@link PATCH_UsersMeVerification_Request_Path} - Path parameters type
|
|
3515
|
-
* @see {@link PATCH_UsersMeVerification_Request_Body} - Request body type
|
|
3516
|
-
*/
|
|
3517
|
-
export type PATCH_UsersMeVerification_Request = {
|
|
3518
|
-
parameters: {
|
|
3519
|
-
query: operations['update_verification_me_v1_users_me_verification_patch']['parameters']['query'];
|
|
3520
|
-
};
|
|
3521
|
-
}
|
|
3522
|
-
/**
|
|
3523
|
-
* Query parameters for PATCH /v1/users/me/verification
|
|
3524
|
-
*
|
|
3525
|
-
* @remarks
|
|
3526
|
-
* This type defines the query parameters for the PATCH /v1/users/me/verification endpoint.
|
|
3527
|
-
* It provides type safety for all query parameters as defined in the OpenAPI specification.
|
|
3528
|
-
*
|
|
3529
|
-
* @example
|
|
3530
|
-
* Use this type to ensure type safety for query parameters.
|
|
3531
|
-
*
|
|
3532
|
-
* @path /v1/users/me/verification
|
|
3533
|
-
*/
|
|
3534
|
-
export type PATCH_UsersMeVerification_Request_Query = PATCH_UsersMeVerification_Request['parameters']['query'];
|
|
3535
|
-
|
|
3536
|
-
/**
|
|
3537
|
-
* Request type for POST UsersMeVerification endpoint
|
|
3538
|
-
*
|
|
3539
|
-
* Create Verification Me
|
|
3540
|
-
*
|
|
3541
|
-
* @remarks
|
|
3542
|
-
* This type defines the complete request structure for the POST UsersMeVerification endpoint.
|
|
3543
|
-
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
3544
|
-
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
3545
|
-
*
|
|
3546
|
-
* @example
|
|
3547
|
-
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
3548
|
-
*
|
|
3549
|
-
* @path /v1/users/me/verification
|
|
3550
|
-
*
|
|
3551
|
-
* @see {@link POST_UsersMeVerification_Request_Query} - Query parameters type
|
|
3552
|
-
* @see {@link POST_UsersMeVerification_Request_Path} - Path parameters type
|
|
3553
|
-
* @see {@link POST_UsersMeVerification_Request_Body} - Request body type
|
|
3554
|
-
*/
|
|
3555
|
-
export type POST_UsersMeVerification_Request = {
|
|
3556
|
-
parameters: {
|
|
3557
|
-
query: operations['create_verification_me_v1_users_me_verification_post']['parameters']['query'];
|
|
3558
|
-
};
|
|
3559
|
-
}
|
|
3560
|
-
/**
|
|
3561
|
-
* Query parameters for POST /v1/users/me/verification
|
|
3562
|
-
*
|
|
3563
|
-
* @remarks
|
|
3564
|
-
* This type defines the query parameters for the POST /v1/users/me/verification endpoint.
|
|
3565
|
-
* It provides type safety for all query parameters as defined in the OpenAPI specification.
|
|
3566
|
-
*
|
|
3567
|
-
* @example
|
|
3568
|
-
* Use this type to ensure type safety for query parameters.
|
|
3569
|
-
*
|
|
3570
|
-
* @path /v1/users/me/verification
|
|
3571
|
-
*/
|
|
3572
|
-
export type POST_UsersMeVerification_Request_Query = POST_UsersMeVerification_Request['parameters']['query'];
|
|
3573
|
-
|
|
3574
3402
|
/**
|
|
3575
3403
|
* Request type for DELETE UsersUserId endpoint
|
|
3576
3404
|
*
|
|
@@ -3841,145 +3669,3 @@ export type PATCH_UsersUserIdRoles_Request_Path = PATCH_UsersUserIdRoles_Request
|
|
|
3841
3669
|
*/
|
|
3842
3670
|
export type PATCH_UsersUserIdRoles_Request_Body = PATCH_UsersUserIdRoles_Request['requestBody'];
|
|
3843
3671
|
|
|
3844
|
-
/**
|
|
3845
|
-
* Request type for GET UsersUserIdVerification endpoint
|
|
3846
|
-
*
|
|
3847
|
-
* Get Verification Status
|
|
3848
|
-
*
|
|
3849
|
-
* @remarks
|
|
3850
|
-
* This type defines the complete request structure for the GET UsersUserIdVerification endpoint.
|
|
3851
|
-
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
3852
|
-
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
3853
|
-
*
|
|
3854
|
-
* @example
|
|
3855
|
-
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
3856
|
-
*
|
|
3857
|
-
* @path /v1/users/{user_id}/verification
|
|
3858
|
-
*
|
|
3859
|
-
* @see {@link GET_UsersUserIdVerification_Request_Query} - Query parameters type
|
|
3860
|
-
* @see {@link GET_UsersUserIdVerification_Request_Path} - Path parameters type
|
|
3861
|
-
* @see {@link GET_UsersUserIdVerification_Request_Body} - Request body type
|
|
3862
|
-
*/
|
|
3863
|
-
export type GET_UsersUserIdVerification_Request = {
|
|
3864
|
-
parameters: {
|
|
3865
|
-
path: operations['get_verification_status_v1_users__user_id__verification_get']['parameters']['path'];
|
|
3866
|
-
};
|
|
3867
|
-
}
|
|
3868
|
-
/**
|
|
3869
|
-
* Path parameters for GET /v1/users/{user_id}/verification
|
|
3870
|
-
*
|
|
3871
|
-
* @remarks
|
|
3872
|
-
* This type defines the path parameters for the GET /v1/users/{user_id}/verification endpoint.
|
|
3873
|
-
* It provides type safety for all path parameters as defined in the OpenAPI specification.
|
|
3874
|
-
*
|
|
3875
|
-
* @example
|
|
3876
|
-
* Use this type to ensure type safety for path parameters.
|
|
3877
|
-
*
|
|
3878
|
-
* @path /v1/users/{user_id}/verification
|
|
3879
|
-
*/
|
|
3880
|
-
export type GET_UsersUserIdVerification_Request_Path = GET_UsersUserIdVerification_Request['parameters']['path'];
|
|
3881
|
-
|
|
3882
|
-
/**
|
|
3883
|
-
* Request type for PATCH UsersUserIdVerification endpoint
|
|
3884
|
-
*
|
|
3885
|
-
* Update Verification
|
|
3886
|
-
*
|
|
3887
|
-
* @remarks
|
|
3888
|
-
* This type defines the complete request structure for the PATCH UsersUserIdVerification endpoint.
|
|
3889
|
-
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
3890
|
-
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
3891
|
-
*
|
|
3892
|
-
* @example
|
|
3893
|
-
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
3894
|
-
*
|
|
3895
|
-
* @path /v1/users/{user_id}/verification
|
|
3896
|
-
*
|
|
3897
|
-
* @see {@link PATCH_UsersUserIdVerification_Request_Query} - Query parameters type
|
|
3898
|
-
* @see {@link PATCH_UsersUserIdVerification_Request_Path} - Path parameters type
|
|
3899
|
-
* @see {@link PATCH_UsersUserIdVerification_Request_Body} - Request body type
|
|
3900
|
-
*/
|
|
3901
|
-
export type PATCH_UsersUserIdVerification_Request = {
|
|
3902
|
-
parameters: {
|
|
3903
|
-
query: operations['update_verification_v1_users__user_id__verification_patch']['parameters']['query'];
|
|
3904
|
-
path: operations['update_verification_v1_users__user_id__verification_patch']['parameters']['path'];
|
|
3905
|
-
};
|
|
3906
|
-
}
|
|
3907
|
-
/**
|
|
3908
|
-
* Query parameters for PATCH /v1/users/{user_id}/verification
|
|
3909
|
-
*
|
|
3910
|
-
* @remarks
|
|
3911
|
-
* This type defines the query parameters for the PATCH /v1/users/{user_id}/verification endpoint.
|
|
3912
|
-
* It provides type safety for all query parameters as defined in the OpenAPI specification.
|
|
3913
|
-
*
|
|
3914
|
-
* @example
|
|
3915
|
-
* Use this type to ensure type safety for query parameters.
|
|
3916
|
-
*
|
|
3917
|
-
* @path /v1/users/{user_id}/verification
|
|
3918
|
-
*/
|
|
3919
|
-
export type PATCH_UsersUserIdVerification_Request_Query = PATCH_UsersUserIdVerification_Request['parameters']['query'];
|
|
3920
|
-
/**
|
|
3921
|
-
* Path parameters for PATCH /v1/users/{user_id}/verification
|
|
3922
|
-
*
|
|
3923
|
-
* @remarks
|
|
3924
|
-
* This type defines the path parameters for the PATCH /v1/users/{user_id}/verification endpoint.
|
|
3925
|
-
* It provides type safety for all path parameters as defined in the OpenAPI specification.
|
|
3926
|
-
*
|
|
3927
|
-
* @example
|
|
3928
|
-
* Use this type to ensure type safety for path parameters.
|
|
3929
|
-
*
|
|
3930
|
-
* @path /v1/users/{user_id}/verification
|
|
3931
|
-
*/
|
|
3932
|
-
export type PATCH_UsersUserIdVerification_Request_Path = PATCH_UsersUserIdVerification_Request['parameters']['path'];
|
|
3933
|
-
|
|
3934
|
-
/**
|
|
3935
|
-
* Request type for POST UsersUserIdVerification endpoint
|
|
3936
|
-
*
|
|
3937
|
-
* Create Verification
|
|
3938
|
-
*
|
|
3939
|
-
* @remarks
|
|
3940
|
-
* This type defines the complete request structure for the POST UsersUserIdVerification endpoint.
|
|
3941
|
-
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
3942
|
-
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
3943
|
-
*
|
|
3944
|
-
* @example
|
|
3945
|
-
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
3946
|
-
*
|
|
3947
|
-
* @path /v1/users/{user_id}/verification
|
|
3948
|
-
*
|
|
3949
|
-
* @see {@link POST_UsersUserIdVerification_Request_Query} - Query parameters type
|
|
3950
|
-
* @see {@link POST_UsersUserIdVerification_Request_Path} - Path parameters type
|
|
3951
|
-
* @see {@link POST_UsersUserIdVerification_Request_Body} - Request body type
|
|
3952
|
-
*/
|
|
3953
|
-
export type POST_UsersUserIdVerification_Request = {
|
|
3954
|
-
parameters: {
|
|
3955
|
-
query: operations['create_verification_v1_users__user_id__verification_post']['parameters']['query'];
|
|
3956
|
-
path: operations['create_verification_v1_users__user_id__verification_post']['parameters']['path'];
|
|
3957
|
-
};
|
|
3958
|
-
}
|
|
3959
|
-
/**
|
|
3960
|
-
* Query parameters for POST /v1/users/{user_id}/verification
|
|
3961
|
-
*
|
|
3962
|
-
* @remarks
|
|
3963
|
-
* This type defines the query parameters for the POST /v1/users/{user_id}/verification endpoint.
|
|
3964
|
-
* It provides type safety for all query parameters as defined in the OpenAPI specification.
|
|
3965
|
-
*
|
|
3966
|
-
* @example
|
|
3967
|
-
* Use this type to ensure type safety for query parameters.
|
|
3968
|
-
*
|
|
3969
|
-
* @path /v1/users/{user_id}/verification
|
|
3970
|
-
*/
|
|
3971
|
-
export type POST_UsersUserIdVerification_Request_Query = POST_UsersUserIdVerification_Request['parameters']['query'];
|
|
3972
|
-
/**
|
|
3973
|
-
* Path parameters for POST /v1/users/{user_id}/verification
|
|
3974
|
-
*
|
|
3975
|
-
* @remarks
|
|
3976
|
-
* This type defines the path parameters for the POST /v1/users/{user_id}/verification endpoint.
|
|
3977
|
-
* It provides type safety for all path parameters as defined in the OpenAPI specification.
|
|
3978
|
-
*
|
|
3979
|
-
* @example
|
|
3980
|
-
* Use this type to ensure type safety for path parameters.
|
|
3981
|
-
*
|
|
3982
|
-
* @path /v1/users/{user_id}/verification
|
|
3983
|
-
*/
|
|
3984
|
-
export type POST_UsersUserIdVerification_Request_Path = POST_UsersUserIdVerification_Request['parameters']['path'];
|
|
3985
|
-
|