@opusdns/api 0.138.0 → 0.140.0

package/src/helpers/requests.d.ts

@@ -34,7 +34,7 @@ import { operations } from '../schema';
 
 import { DomainDnssecDataCreateArray, OrganizationAttributeUpdateArray } from './schemas-arrays.d';
 
-import { ContactCreate, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatchOps, DnsZoneRrsetsCreate, DomainForwardPatchOps, DomainForwardCreateRequest, DomainForwardRequest, DomainForwardSetRequest, DomainCreate, DomainUpdate, DomainRenewRequest, DomainRestoreRequest, DomainWithdrawRequest, DomainTransitRequest, DomainTransferIn, EmailForwardCreate, EmailForwardAliasCreate, EmailForwardAliasUpdate, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate, UserCreate, PasswordUpdate, UserUpdate, SpiceDbRelationshipUpdate } from './schemas.d';
+import { ContactCreate, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatchOps, DnsZoneRrsetsCreate, DomainForwardPatchOps, DomainForwardCreateRequest, DomainForwardSetCreateRequest, DomainForwardSetRequest, DomainCreate, DomainUpdate, DomainRenewRequest, DomainRestoreRequest, DomainWithdrawRequest, DomainTransitRequest, DomainTransferIn, EmailForwardCreate, EmailForwardAliasCreate, EmailForwardAliasUpdate, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate, UserCreate, PasswordUpdate, UserUpdate, SpiceDbRelationshipUpdate } from './schemas.d';
 
 /**
  * Request type for GET ArchiveEmailForwardLogsAliasesEmailForwardAliasId endpoint
@@ -1609,8 +1609,8 @@ export type GET_DomainForwardsHostname_Request_Path = GET_DomainForwardsHostname
 /**
  * Request type for POST DomainForwardsHostname endpoint
  *
- * Create a domain forward (deprecated)
- * **DEPRECATED**: Use POST /v1/domain-forwards instead. Creates a new domain forward configuration for the specified hostname.
+ * Create domain forward set
+ * Creates a new domain forward set for a specific protocol (HTTP or HTTPS). Raises an error if the set already exists.
  *
  * @remarks
  * This type defines the complete request structure for the POST DomainForwardsHostname endpoint.
@@ -1629,9 +1629,9 @@ export type GET_DomainForwardsHostname_Request_Path = GET_DomainForwardsHostname
  */
 export type POST_DomainForwardsHostname_Request = {
   parameters: {
-    path: operations['create_domain_forward_v1_domain_forwards__hostname__post']['parameters']['path'];
+    path: operations['create_domain_forward_set_v1_domain_forwards__hostname__post']['parameters']['path'];
   };
-  requestBody: DomainForwardRequest;
+  requestBody: DomainForwardSetCreateRequest;
 }
 /**
  * Path parameters for POST /v1/domain-forwards/{hostname}
@@ -1828,8 +1828,8 @@ export type GET_DomainForwardsHostnameProtocol_Request_Path = GET_DomainForwards
 /**
  * Request type for POST DomainForwardsHostnameProtocol endpoint
  *
- * Create domain forward set
- * Creates a new domain forward set for a specific protocol (HTTP or HTTPS). Raises an error if the set already exists.
+ * Create domain forward set (deprecated)
+ * Deprecated: Use POST /{hostname} with protocol in body instead. Creates a new domain forward set for a specific protocol (HTTP or HTTPS).
  *
  * @remarks
  * This type defines the complete request structure for the POST DomainForwardsHostnameProtocol endpoint.
@@ -1848,7 +1848,7 @@ export type GET_DomainForwardsHostnameProtocol_Request_Path = GET_DomainForwards
  */
 export type POST_DomainForwardsHostnameProtocol_Request = {
   parameters: {
-    path: operations['create_domain_forward_set_v1_domain_forwards__hostname___protocol__post']['parameters']['path'];
+    path: operations['create_domain_forward_set_deprecated_v1_domain_forwards__hostname___protocol__post']['parameters']['path'];
   };
   requestBody: DomainForwardSetRequest;
 }

package/src/helpers/responses.d.ts

@@ -34,7 +34,7 @@
 
 import { DomainDnssecDataArray, OrganizationAttribute2Array, IpRestrictionArray, TldResponseShortArray } from './schemas-arrays.d';
 
-import { Pagination_EmailForwardLog, HTTPValidationError, Pagination_ObjectLog, Pagination_RequestHistory, Problem, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DomainForwardZone, EmailForwardZone, Pagination_DomainForwardZone, Pagination_EmailForwardZone, DnsZoneSummary, Pagination_DomainForward, DomainForward, DomainForwardSet, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, DomainWithdraw, RequestAuthcode, DomainTransit, RequestAuthcode2, Pagination_EmailForward, EmailForward, EmailForwardAlias, Pagination_Event, EventSchema, Pagination_Organization, Organization, OrganizationWithBillingData, Pagination_Invoice, GetPrices, Pagination_BillingTransaction, BillingTransaction, IpRestriction, Pagination_User, TldSpecification, User, UserWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
+import { Pagination_EmailForwardLog, HTTPValidationError, Pagination_ObjectLog, Pagination_RequestHistory, Problem, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DomainForwardZone, EmailForwardZone, Pagination_DomainForwardZone, Pagination_EmailForwardZone, DnsZoneSummary, Pagination_DomainForward, DomainForward, DomainForwardSet, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, DomainWithdraw, RequestAuthcode, DomainTransit, RequestAuthcode2, Pagination_EmailForward, EmailForward, EmailForwardAlias, Pagination_Event, EventSchema, Pagination_Organization, Organization, OrganizationWithBillingData, Pagination_Invoice, GetPrices, Pagination_BillingTransaction, BillingTransaction, IpRestriction, Pagination_UserPublic, TldSpecification, UserPublic, UserPublicWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
 
 /**
  * Response types for GET ArchiveEmailForwardLogsAliasesByEmailForwardAliasId endpoint
@@ -2903,8 +2903,8 @@ export type GET_DomainForwardsByHostname_Response_422 = HTTPValidationError
 /**
  * Response types for POST DomainForwardsByHostname endpoint
  *
- * Create a domain forward (deprecated)
- * **DEPRECATED**: Use POST /v1/domain-forwards instead. Creates a new domain forward configuration for the specified hostname.
+ * Create domain forward set
+ * Creates a new domain forward set for a specific protocol (HTTP or HTTPS). Raises an error if the set already exists.
  *
  * @remarks
  * This type defines all possible response structures for the POST DomainForwardsByHostname endpoint.
@@ -2941,9 +2941,9 @@ export type POST_DomainForwardsByHostname_Response = POST_DomainForwardsByHostna
  * @param hostname (path) - Hostname
  *
  * @see {@link POST_DomainForwardsByHostname_Response} - The main response type definition
- * @see {@link DomainForward} - The actual schema type definition
+ * @see {@link DomainForwardSet} - The actual schema type definition
  */
-export type POST_DomainForwardsByHostname_Response_201 = DomainForward
+export type POST_DomainForwardsByHostname_Response_201 = DomainForwardSet
 
 /**
  * 401 response for POST DomainForwardsByHostname endpoint
@@ -3251,8 +3251,8 @@ export type GET_DomainForwardsByHostnameByProtocol_Response_422 = HTTPValidation
 /**
  * Response types for POST DomainForwardsByHostnameByProtocol endpoint
  *
- * Create domain forward set
- * Creates a new domain forward set for a specific protocol (HTTP or HTTPS). Raises an error if the set already exists.
+ * Create domain forward set (deprecated)
+ * Deprecated: Use POST /{hostname} with protocol in body instead. Creates a new domain forward set for a specific protocol (HTTP or HTTPS).
  *
  * @remarks
  * This type defines all possible response structures for the POST DomainForwardsByHostnameByProtocol endpoint.
@@ -8135,9 +8135,9 @@ export type GET_OrganizationsUsers_Response = GET_OrganizationsUsers_Response_20
  * @path /v1/organizations/users
  *
  * @see {@link GET_OrganizationsUsers_Response} - The main response type definition
- * @see {@link Pagination_User} - The actual schema type definition
+ * @see {@link Pagination_UserPublic} - The actual schema type definition
  */
-export type GET_OrganizationsUsers_Response_200 = Pagination_User
+export type GET_OrganizationsUsers_Response_200 = Pagination_UserPublic
 
 /**
  * 401 response for GET OrganizationsUsers endpoint
@@ -8393,9 +8393,9 @@ export type POST_Users_Response = POST_Users_Response_200 | POST_Users_Response_
  * @path /v1/users
  *
  * @see {@link POST_Users_Response} - The main response type definition
- * @see {@link User} - The actual schema type definition
+ * @see {@link UserPublic} - The actual schema type definition
  */
-export type POST_Users_Response_200 = User
+export type POST_Users_Response_200 = UserPublic
 
 /**
  * 422 response for POST Users endpoint
@@ -8505,9 +8505,9 @@ export type GET_UsersByUserId_Response = GET_UsersByUserId_Response_200 | GET_Us
  * @path /v1/users/{user_id}
  *
  * @see {@link GET_UsersByUserId_Response} - The main response type definition
- * @see {@link UserWithAttributes} - The actual schema type definition
+ * @see {@link UserPublicWithAttributes} - The actual schema type definition
  */
-export type GET_UsersByUserId_Response_200 = UserWithAttributes
+export type GET_UsersByUserId_Response_200 = UserPublicWithAttributes
 
 /**
  * 422 response for GET UsersByUserId endpoint
@@ -8561,9 +8561,9 @@ export type PATCH_UsersByUserId_Response = PATCH_UsersByUserId_Response_200 | PA
  * @path /v1/users/{user_id}
  *
  * @see {@link PATCH_UsersByUserId_Response} - The main response type definition
- * @see {@link UserWithAttributes} - The actual schema type definition
+ * @see {@link UserPublicWithAttributes} - The actual schema type definition
  */
-export type PATCH_UsersByUserId_Response_200 = UserWithAttributes
+export type PATCH_UsersByUserId_Response_200 = UserPublicWithAttributes
 
 /**
  * 422 response for PATCH UsersByUserId endpoint

package/src/helpers/schemas-arrays.d.ts

@@ -21,7 +21,7 @@
  * This file is auto-generated from the OpenAPI specification.
  * Do not edit manually.
  */
-import { DomainDnssecData, DomainDnssecDataCreate, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, TldResponseShort, RegistryHandleAttributeType, ContactAttributeDefinition, ContactRoleAttributeRequirement, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, ContactHandle, Nameserver, DomainForwardPatchOp, HttpRedirectList, DomainForward, DeletePolicyType, SyncOperationType, DomainContact, DomainHost, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, EmailForwardAliasCreate, EmailForwardLogEvent, EmailForwardAlias, EmailForward, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, DomainContactType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactSchema, DnsZone, DomainForwardZone, Domain, EmailForwardLog, EmailForwardZone, EventResponse, Invoice, ObjectLog, Organization, RequestHistory, Period, Permission, PremiumAffectsType, Relation, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
+import { DomainDnssecData, DomainDnssecDataCreate, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, TldResponseShort, RegistryHandleAttributeType, ContactAttributeDefinition, ContactRoleAttributeRequirement, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, ContactHandle, Nameserver, DomainForwardPatchOp, HttpRedirectList, DomainForward, DeletePolicyType, SyncOperationType, DomainContact, DomainHost, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, EmailForwardAliasCreate, EmailForwardLogEvent, EmailForwardAlias, EmailForward, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, DomainContactType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactSchema, DnsZone, DomainForwardZone, Domain, EmailForwardLog, EmailForwardZone, EventResponse, Invoice, ObjectLog, Organization, RequestHistory, UserPublic, Period, Permission, PremiumAffectsType, Relation, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
 
 /**
  * DomainDnssecDataResponse
@@ -807,6 +807,20 @@ export type OrganizationArray = Organization[];
  * @see {@link RequestHistory} - The individual RequestHistory type definition
  */
 export type RequestHistoryArray = RequestHistory[];
+/**
+ * UserPublic
+ *
+ * @remarks
+ * Array type for UserPublic objects. Used when the API returns a collection of UserPublic instances.
+ *
+ * @example
+ * ```typescript
+ * const items: UserPublicArray = await api.getUserPublics();
+ * ```
+ *
+ * @see {@link UserPublic} - The individual UserPublic type definition
+ */
+export type UserPublicArray = UserPublic[];
 /**
  * Period
  *

package/src/helpers/schemas.d.ts

@@ -1115,21 +1115,21 @@ export type DomainForwardProtocolSetRequest = components['schemas']['DomainForwa
  */
 export type DomainForwardProtocolSet = components['schemas']['DomainForwardProtocolSetResponse'];
 /**
- * DomainForwardRequest
+ * DomainForwardSetCreateRequest
  *
  * @remarks
- * Type alias for the `DomainForwardRequest` OpenAPI schema.
- * This type represents domainforwardrequest data structures used in API requests and responses.
+ * Type alias for the `DomainForwardSetCreateRequest` OpenAPI schema.
+ * This type represents domainforwardsetcreaterequest data structures used in API requests and responses.
  *
  * @example
  * ```typescript
- * const response = await api.getDomainForwardRequest();
- * const item: DomainForwardRequest = response.results;
+ * const response = await api.getDomainForwardSetCreateRequest();
+ * const item: DomainForwardSetCreateRequest = response.results;
  * ```
  *
  * @see {@link components} - The OpenAPI components schema definition
  */
-export type DomainForwardRequest = components['schemas']['DomainForwardRequest'];
+export type DomainForwardSetCreateRequest = components['schemas']['DomainForwardSetCreateRequest'];
 /**
  * DomainForwardSetRequest
  *
@@ -2816,21 +2816,21 @@ export type Pagination_Organization = components['schemas']['Pagination_Organiza
  */
 export type Pagination_RequestHistory = components['schemas']['Pagination_RequestHistory_'];
 /**
- * Pagination[User]
+ * Pagination[UserPublic]
  *
  * @remarks
- * Type alias for the `Pagination_User_` OpenAPI schema.
- * This type represents pagination[user] data structures used in API requests and responses.
+ * Type alias for the `Pagination_UserPublic_` OpenAPI schema.
+ * This type represents pagination[userpublic] data structures used in API requests and responses.
  *
  * @example
  * ```typescript
- * const response = await api.getPagination_User();
- * const item: Pagination_User = response.results;
+ * const response = await api.getPagination_UserPublic();
+ * const item: Pagination_UserPublic = response.results;
  * ```
  *
  * @see {@link components} - The OpenAPI components schema definition
  */
-export type Pagination_User = components['schemas']['Pagination_User_'];
+export type Pagination_UserPublic = components['schemas']['Pagination_UserPublic_'];
 /**
  * PasswordUpdate
  *
@@ -3583,6 +3583,38 @@ export type UserAttribute = components['schemas']['UserAttributeResponse'];
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type UserCreate = components['schemas']['UserCreate'];
+/**
+ * UserPublic
+ *
+ * @remarks
+ * Type alias for the `UserPublic` OpenAPI schema.
+ * This type represents userpublic data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getUserPublic();
+ * const item: UserPublic = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type UserPublic = components['schemas']['UserPublic'];
+/**
+ * UserPublicWithAttributes
+ *
+ * @remarks
+ * Type alias for the `UserPublicWithAttributes` OpenAPI schema.
+ * This type represents userpublicwithattributes data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getUserPublicWithAttributes();
+ * const item: UserPublicWithAttributes = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type UserPublicWithAttributes = components['schemas']['UserPublicWithAttributes'];
 /**
  * UserStatus
  *
@@ -3631,22 +3663,6 @@ export type UserToken = components['schemas']['UserTokenResponse'];
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type UserUpdate = components['schemas']['UserUpdate'];
-/**
- * UserWithAttributes
- *
- * @remarks
- * Type alias for the `UserWithAttributes` OpenAPI schema.
- * This type represents userwithattributes data structures used in API requests and responses.
- *
- * @example
- * ```typescript
- * const response = await api.getUserWithAttributes();
- * const item: UserWithAttributes = response.results;
- * ```
- *
- * @see {@link components} - The OpenAPI components schema definition
- */
-export type UserWithAttributes = components['schemas']['UserWithAttributes'];
 /**
  * UserWithRelationPermissions
  *