@opusdns/api 0.32.0 → 0.34.0

package/src/helpers/requests.d.ts

@@ -34,7 +34,7 @@ import { operations } from '../schema';
 
 import { DomainDnssecDataCreateArray, OrganizationAttributeUpdateArray } from './schemas-arrays.d';
 
-import { OrganizationCredentialExtra, SignupCreate, ContactCreate, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatchOps, DnsZoneRrsetsCreate, DomainCreate, DomainUpdate, DomainRenewRequest, DomainTransferIn, EmailForwardAlias, EmailForwardAliasUpdate, NotificationCreate, NotificationUpdate, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate, PlanUpdate, UserCreate, UserUpdate, SpiceDbRelationshipUpdate } from './schemas.d';
+import { OrganizationCredentialExtra, SignupCreate, ContactCreate, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatchOps, DnsZoneRrsetsCreate, DomainCreate, DomainUpdate, DomainRenewRequest, DomainTransferIn, EmailForwardAlias, EmailForwardAliasUpdate, NotificationCreate, NotificationUpdate, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate, PlanUpdate, UserCreate, StartPasswordReset, PasswordUpdate, UserUpdate, SpiceDbRelationshipUpdate } from './schemas.d';
 
 /**
  * Request type for GET AuthClientCredentials endpoint
@@ -3513,6 +3513,80 @@ export type POST_Users_Request = {
  */
 export type POST_Users_Request_Body = POST_Users_Request['requestBody'];
 
+/**
+ * Request type for POST UsersEmailPasswordReset endpoint
+ *
+ * Create User Password Reset
+ *
+ * @remarks
+ * This type defines the complete request structure for the POST UsersEmailPasswordReset endpoint.
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
+ * Use this type to ensure type safety when making API requests to this endpoint.
+ *
+ * @example
+ * Use this type to ensure type safety when making API requests to this endpoint.
+ *
+ * @path /v1/users/email/password-reset
+ *
+ * @see {@link POST_UsersEmailPasswordReset_Request_Query} - Query parameters type
+ * @see {@link POST_UsersEmailPasswordReset_Request_Path} - Path parameters type
+ * @see {@link POST_UsersEmailPasswordReset_Request_Body} - Request body type
+ */
+export type POST_UsersEmailPasswordReset_Request = {
+  requestBody: StartPasswordReset;
+}
+/**
+ * Request body for POST /v1/users/email/password-reset
+ *
+ * @remarks
+ * This type defines the request body structure for the POST /v1/users/email/password-reset endpoint.
+ * It provides type safety for the request body as defined in the OpenAPI specification.
+ *
+ * @example
+ * Use this type to ensure type safety for request body structure.
+ *
+ * @path /v1/users/email/password-reset
+ */
+export type POST_UsersEmailPasswordReset_Request_Body = POST_UsersEmailPasswordReset_Request['requestBody'];
+
+/**
+ * Request type for GET UsersEmailVerify endpoint
+ *
+ * Redirect Verify User
+ *
+ * @remarks
+ * This type defines the complete request structure for the GET UsersEmailVerify endpoint.
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
+ * Use this type to ensure type safety when making API requests to this endpoint.
+ *
+ * @example
+ * Use this type to ensure type safety when making API requests to this endpoint.
+ *
+ * @path /v1/users/email/verify
+ *
+ * @see {@link GET_UsersEmailVerify_Request_Query} - Query parameters type
+ * @see {@link GET_UsersEmailVerify_Request_Path} - Path parameters type
+ * @see {@link GET_UsersEmailVerify_Request_Body} - Request body type
+ */
+export type GET_UsersEmailVerify_Request = {
+  parameters: {
+    query: operations['redirect_verify_user_v1_users_email_verify_get']['parameters']['query'];
+  };
+}
+/**
+ * Query parameters for GET /v1/users/email/verify
+ *
+ * @remarks
+ * This type defines the query parameters for the GET /v1/users/email/verify endpoint.
+ * It provides type safety for all query parameters as defined in the OpenAPI specification.
+ *
+ * @example
+ * Use this type to ensure type safety for query parameters.
+ *
+ * @path /v1/users/email/verify
+ */
+export type GET_UsersEmailVerify_Request_Query = GET_UsersEmailVerify_Request['parameters']['query'];
+
 /**
  * Request type for GET UsersMe endpoint
  *
@@ -3551,6 +3625,162 @@ export type GET_UsersMe_Request = {
  */
 export type GET_UsersMe_Request_Query = GET_UsersMe_Request['parameters']['query'];
 
+/**
+ * Request type for PATCH UsersMePasswordReset endpoint
+ *
+ * Confirm User Password Reset Me
+ *
+ * @remarks
+ * This type defines the complete request structure for the PATCH UsersMePasswordReset endpoint.
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
+ * Use this type to ensure type safety when making API requests to this endpoint.
+ *
+ * @example
+ * Use this type to ensure type safety when making API requests to this endpoint.
+ *
+ * @path /v1/users/me/password-reset
+ *
+ * @see {@link PATCH_UsersMePasswordReset_Request_Query} - Query parameters type
+ * @see {@link PATCH_UsersMePasswordReset_Request_Path} - Path parameters type
+ * @see {@link PATCH_UsersMePasswordReset_Request_Body} - Request body type
+ */
+export type PATCH_UsersMePasswordReset_Request = {
+  requestBody: PasswordUpdate;
+}
+/**
+ * Request body for PATCH /v1/users/me/password-reset
+ *
+ * @remarks
+ * This type defines the request body structure for the PATCH /v1/users/me/password-reset endpoint.
+ * It provides type safety for the request body as defined in the OpenAPI specification.
+ *
+ * @example
+ * Use this type to ensure type safety for request body structure.
+ *
+ * @path /v1/users/me/password-reset
+ */
+export type PATCH_UsersMePasswordReset_Request_Body = PATCH_UsersMePasswordReset_Request['requestBody'];
+
+/**
+ * Request type for DELETE UsersMeVerification endpoint
+ *
+ * Cancel Verification Me
+ *
+ * @remarks
+ * This type defines the complete request structure for the DELETE UsersMeVerification endpoint.
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
+ * Use this type to ensure type safety when making API requests to this endpoint.
+ *
+ * @example
+ * Use this type to ensure type safety when making API requests to this endpoint.
+ *
+ * @path /v1/users/me/verification
+ *
+ * @see {@link DELETE_UsersMeVerification_Request_Query} - Query parameters type
+ * @see {@link DELETE_UsersMeVerification_Request_Path} - Path parameters type
+ * @see {@link DELETE_UsersMeVerification_Request_Body} - Request body type
+ */
+export type DELETE_UsersMeVerification_Request = {
+}
+
+/**
+ * Request type for GET UsersMeVerification endpoint
+ *
+ * Get Verification Status Me
+ *
+ * @remarks
+ * This type defines the complete request structure for the GET UsersMeVerification endpoint.
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
+ * Use this type to ensure type safety when making API requests to this endpoint.
+ *
+ * @example
+ * Use this type to ensure type safety when making API requests to this endpoint.
+ *
+ * @path /v1/users/me/verification
+ *
+ * @see {@link GET_UsersMeVerification_Request_Query} - Query parameters type
+ * @see {@link GET_UsersMeVerification_Request_Path} - Path parameters type
+ * @see {@link GET_UsersMeVerification_Request_Body} - Request body type
+ */
+export type GET_UsersMeVerification_Request = {
+}
+
+/**
+ * Request type for PATCH UsersMeVerification endpoint
+ *
+ * Update Verification Me
+ *
+ * @remarks
+ * This type defines the complete request structure for the PATCH UsersMeVerification endpoint.
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
+ * Use this type to ensure type safety when making API requests to this endpoint.
+ *
+ * @example
+ * Use this type to ensure type safety when making API requests to this endpoint.
+ *
+ * @path /v1/users/me/verification
+ *
+ * @see {@link PATCH_UsersMeVerification_Request_Query} - Query parameters type
+ * @see {@link PATCH_UsersMeVerification_Request_Path} - Path parameters type
+ * @see {@link PATCH_UsersMeVerification_Request_Body} - Request body type
+ */
+export type PATCH_UsersMeVerification_Request = {
+  parameters: {
+    query: operations['update_verification_me_v1_users_me_verification_patch']['parameters']['query'];
+  };
+}
+/**
+ * Query parameters for PATCH /v1/users/me/verification
+ *
+ * @remarks
+ * This type defines the query parameters for the PATCH /v1/users/me/verification endpoint.
+ * It provides type safety for all query parameters as defined in the OpenAPI specification.
+ *
+ * @example
+ * Use this type to ensure type safety for query parameters.
+ *
+ * @path /v1/users/me/verification
+ */
+export type PATCH_UsersMeVerification_Request_Query = PATCH_UsersMeVerification_Request['parameters']['query'];
+
+/**
+ * Request type for POST UsersMeVerification endpoint
+ *
+ * Create Verification Me
+ *
+ * @remarks
+ * This type defines the complete request structure for the POST UsersMeVerification endpoint.
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
+ * Use this type to ensure type safety when making API requests to this endpoint.
+ *
+ * @example
+ * Use this type to ensure type safety when making API requests to this endpoint.
+ *
+ * @path /v1/users/me/verification
+ *
+ * @see {@link POST_UsersMeVerification_Request_Query} - Query parameters type
+ * @see {@link POST_UsersMeVerification_Request_Path} - Path parameters type
+ * @see {@link POST_UsersMeVerification_Request_Body} - Request body type
+ */
+export type POST_UsersMeVerification_Request = {
+  parameters: {
+    query: operations['create_verification_me_v1_users_me_verification_post']['parameters']['query'];
+  };
+}
+/**
+ * Query parameters for POST /v1/users/me/verification
+ *
+ * @remarks
+ * This type defines the query parameters for the POST /v1/users/me/verification endpoint.
+ * It provides type safety for all query parameters as defined in the OpenAPI specification.
+ *
+ * @example
+ * Use this type to ensure type safety for query parameters.
+ *
+ * @path /v1/users/me/verification
+ */
+export type POST_UsersMeVerification_Request_Query = POST_UsersMeVerification_Request['parameters']['query'];
+
 /**
  * Request type for DELETE UsersUserId endpoint
  *
@@ -3821,3 +4051,183 @@ export type PATCH_UsersUserIdRoles_Request_Path = PATCH_UsersUserIdRoles_Request
  */
 export type PATCH_UsersUserIdRoles_Request_Body = PATCH_UsersUserIdRoles_Request['requestBody'];
 
+/**
+ * Request type for DELETE UsersUserIdVerification endpoint
+ *
+ * Cancel Verification
+ *
+ * @remarks
+ * This type defines the complete request structure for the DELETE UsersUserIdVerification endpoint.
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
+ * Use this type to ensure type safety when making API requests to this endpoint.
+ *
+ * @example
+ * Use this type to ensure type safety when making API requests to this endpoint.
+ *
+ * @path /v1/users/{user_id}/verification
+ *
+ * @see {@link DELETE_UsersUserIdVerification_Request_Query} - Query parameters type
+ * @see {@link DELETE_UsersUserIdVerification_Request_Path} - Path parameters type
+ * @see {@link DELETE_UsersUserIdVerification_Request_Body} - Request body type
+ */
+export type DELETE_UsersUserIdVerification_Request = {
+  parameters: {
+    path: operations['cancel_verification_v1_users__user_id__verification_delete']['parameters']['path'];
+  };
+}
+/**
+ * Path parameters for DELETE /v1/users/{user_id}/verification
+ *
+ * @remarks
+ * This type defines the path parameters for the DELETE /v1/users/{user_id}/verification endpoint.
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
+ *
+ * @example
+ * Use this type to ensure type safety for path parameters.
+ *
+ * @path /v1/users/{user_id}/verification
+ */
+export type DELETE_UsersUserIdVerification_Request_Path = DELETE_UsersUserIdVerification_Request['parameters']['path'];
+
+/**
+ * Request type for GET UsersUserIdVerification endpoint
+ *
+ * Get Verification Status
+ *
+ * @remarks
+ * This type defines the complete request structure for the GET UsersUserIdVerification endpoint.
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
+ * Use this type to ensure type safety when making API requests to this endpoint.
+ *
+ * @example
+ * Use this type to ensure type safety when making API requests to this endpoint.
+ *
+ * @path /v1/users/{user_id}/verification
+ *
+ * @see {@link GET_UsersUserIdVerification_Request_Query} - Query parameters type
+ * @see {@link GET_UsersUserIdVerification_Request_Path} - Path parameters type
+ * @see {@link GET_UsersUserIdVerification_Request_Body} - Request body type
+ */
+export type GET_UsersUserIdVerification_Request = {
+  parameters: {
+    path: operations['get_verification_status_v1_users__user_id__verification_get']['parameters']['path'];
+  };
+}
+/**
+ * Path parameters for GET /v1/users/{user_id}/verification
+ *
+ * @remarks
+ * This type defines the path parameters for the GET /v1/users/{user_id}/verification endpoint.
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
+ *
+ * @example
+ * Use this type to ensure type safety for path parameters.
+ *
+ * @path /v1/users/{user_id}/verification
+ */
+export type GET_UsersUserIdVerification_Request_Path = GET_UsersUserIdVerification_Request['parameters']['path'];
+
+/**
+ * Request type for PATCH UsersUserIdVerification endpoint
+ *
+ * Update Verification
+ *
+ * @remarks
+ * This type defines the complete request structure for the PATCH UsersUserIdVerification endpoint.
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
+ * Use this type to ensure type safety when making API requests to this endpoint.
+ *
+ * @example
+ * Use this type to ensure type safety when making API requests to this endpoint.
+ *
+ * @path /v1/users/{user_id}/verification
+ *
+ * @see {@link PATCH_UsersUserIdVerification_Request_Query} - Query parameters type
+ * @see {@link PATCH_UsersUserIdVerification_Request_Path} - Path parameters type
+ * @see {@link PATCH_UsersUserIdVerification_Request_Body} - Request body type
+ */
+export type PATCH_UsersUserIdVerification_Request = {
+  parameters: {
+    query: operations['update_verification_v1_users__user_id__verification_patch']['parameters']['query'];
+    path: operations['update_verification_v1_users__user_id__verification_patch']['parameters']['path'];
+  };
+}
+/**
+ * Query parameters for PATCH /v1/users/{user_id}/verification
+ *
+ * @remarks
+ * This type defines the query parameters for the PATCH /v1/users/{user_id}/verification endpoint.
+ * It provides type safety for all query parameters as defined in the OpenAPI specification.
+ *
+ * @example
+ * Use this type to ensure type safety for query parameters.
+ *
+ * @path /v1/users/{user_id}/verification
+ */
+export type PATCH_UsersUserIdVerification_Request_Query = PATCH_UsersUserIdVerification_Request['parameters']['query'];
+/**
+ * Path parameters for PATCH /v1/users/{user_id}/verification
+ *
+ * @remarks
+ * This type defines the path parameters for the PATCH /v1/users/{user_id}/verification endpoint.
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
+ *
+ * @example
+ * Use this type to ensure type safety for path parameters.
+ *
+ * @path /v1/users/{user_id}/verification
+ */
+export type PATCH_UsersUserIdVerification_Request_Path = PATCH_UsersUserIdVerification_Request['parameters']['path'];
+
+/**
+ * Request type for POST UsersUserIdVerification endpoint
+ *
+ * Create Verification
+ *
+ * @remarks
+ * This type defines the complete request structure for the POST UsersUserIdVerification endpoint.
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
+ * Use this type to ensure type safety when making API requests to this endpoint.
+ *
+ * @example
+ * Use this type to ensure type safety when making API requests to this endpoint.
+ *
+ * @path /v1/users/{user_id}/verification
+ *
+ * @see {@link POST_UsersUserIdVerification_Request_Query} - Query parameters type
+ * @see {@link POST_UsersUserIdVerification_Request_Path} - Path parameters type
+ * @see {@link POST_UsersUserIdVerification_Request_Body} - Request body type
+ */
+export type POST_UsersUserIdVerification_Request = {
+  parameters: {
+    query: operations['create_verification_v1_users__user_id__verification_post']['parameters']['query'];
+    path: operations['create_verification_v1_users__user_id__verification_post']['parameters']['path'];
+  };
+}
+/**
+ * Query parameters for POST /v1/users/{user_id}/verification
+ *
+ * @remarks
+ * This type defines the query parameters for the POST /v1/users/{user_id}/verification endpoint.
+ * It provides type safety for all query parameters as defined in the OpenAPI specification.
+ *
+ * @example
+ * Use this type to ensure type safety for query parameters.
+ *
+ * @path /v1/users/{user_id}/verification
+ */
+export type POST_UsersUserIdVerification_Request_Query = POST_UsersUserIdVerification_Request['parameters']['query'];
+/**
+ * Path parameters for POST /v1/users/{user_id}/verification
+ *
+ * @remarks
+ * This type defines the path parameters for the POST /v1/users/{user_id}/verification endpoint.
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
+ *
+ * @example
+ * Use this type to ensure type safety for path parameters.
+ *
+ * @path /v1/users/{user_id}/verification
+ */
+export type POST_UsersUserIdVerification_Request_Path = POST_UsersUserIdVerification_Request['parameters']['path'];
+