@opusdns/api 0.99.0 → 0.101.0

package/src/helpers/requests.d.ts

@@ -36,6 +36,137 @@ import { DomainDnssecDataCreateArray, OrganizationAttributeUpdateArray } from '.
 
 import { ContactCreate, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatchOps, DnsZoneRrsetsCreate, DomainForwardPatchOps, DomainForwardRequest, DomainForwardSetRequest, DomainCreate, DomainUpdate, DomainRenewRequest, DomainRestoreRequest, DomainTransferIn, EmailForwardAlias, EmailForwardAliasUpdate, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate, UserCreate, PasswordUpdate, UserUpdate, SpiceDbRelationshipUpdate } from './schemas.d';
 
+/**
+ * Request type for GET ArchiveObjectLogs endpoint
+ *
+ * Get organization logs
+ * Retrieve paginated audit logs for a specific organization with optional filtering and sorting
+ *
+ * @remarks
+ * This type defines the complete request structure for the GET ArchiveObjectLogs 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/archive/object-logs
+ *
+ * @see {@link GET_ArchiveObjectLogs_Request_Query} - Query parameters type
+ * @see {@link GET_ArchiveObjectLogs_Request_Path} - Path parameters type
+ * @see {@link GET_ArchiveObjectLogs_Request_Body} - Request body type
+ */
+export type GET_ArchiveObjectLogs_Request = {
+  parameters: {
+    query: operations['get_object_logs_v1_archive_object_logs_get']['parameters']['query'];
+  };
+}
+/**
+ * Query parameters for GET /v1/archive/object-logs
+ *
+ * @remarks
+ * This type defines the query parameters for the GET /v1/archive/object-logs 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/archive/object-logs
+ */
+export type GET_ArchiveObjectLogs_Request_Query = GET_ArchiveObjectLogs_Request['parameters']['query'];
+
+/**
+ * Request type for GET ArchiveObjectLogsObjectId endpoint
+ *
+ * Get organization logs
+ * Retrieve paginated audit logs for a specific organization with optional filtering and sorting
+ *
+ * @remarks
+ * This type defines the complete request structure for the GET ArchiveObjectLogsObjectId 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/archive/object-logs/{object_id}
+ *
+ * @see {@link GET_ArchiveObjectLogsObjectId_Request_Query} - Query parameters type
+ * @see {@link GET_ArchiveObjectLogsObjectId_Request_Path} - Path parameters type
+ * @see {@link GET_ArchiveObjectLogsObjectId_Request_Body} - Request body type
+ */
+export type GET_ArchiveObjectLogsObjectId_Request = {
+  parameters: {
+    query: operations['get_object_logs_by_object_id_v1_archive_object_logs__object_id__get']['parameters']['query'];
+    path: operations['get_object_logs_by_object_id_v1_archive_object_logs__object_id__get']['parameters']['path'];
+  };
+}
+/**
+ * Query parameters for GET /v1/archive/object-logs/{object_id}
+ *
+ * @remarks
+ * This type defines the query parameters for the GET /v1/archive/object-logs/{object_id} 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/archive/object-logs/{object_id}
+ */
+export type GET_ArchiveObjectLogsObjectId_Request_Query = GET_ArchiveObjectLogsObjectId_Request['parameters']['query'];
+/**
+ * Path parameters for GET /v1/archive/object-logs/{object_id}
+ *
+ * @remarks
+ * This type defines the path parameters for the GET /v1/archive/object-logs/{object_id} 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/archive/object-logs/{object_id}
+ */
+export type GET_ArchiveObjectLogsObjectId_Request_Path = GET_ArchiveObjectLogsObjectId_Request['parameters']['path'];
+
+/**
+ * Request type for GET ArchiveRequestHistory endpoint
+ *
+ * Get request history logs
+ * Retrieves a paginated list of request history logs
+ *
+ * @remarks
+ * This type defines the complete request structure for the GET ArchiveRequestHistory 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/archive/request-history
+ *
+ * @see {@link GET_ArchiveRequestHistory_Request_Query} - Query parameters type
+ * @see {@link GET_ArchiveRequestHistory_Request_Path} - Path parameters type
+ * @see {@link GET_ArchiveRequestHistory_Request_Body} - Request body type
+ */
+export type GET_ArchiveRequestHistory_Request = {
+  parameters: {
+    query: operations['get_request_history_v1_archive_request_history_get']['parameters']['query'];
+  };
+}
+/**
+ * Query parameters for GET /v1/archive/request-history
+ *
+ * @remarks
+ * This type defines the query parameters for the GET /v1/archive/request-history 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/archive/request-history
+ */
+export type GET_ArchiveRequestHistory_Request_Query = GET_ArchiveRequestHistory_Request['parameters']['query'];
+
 /**
  * Request type for POST AuthToken endpoint
  *

package/src/helpers/responses.d.ts

@@ -34,7 +34,175 @@
 
 import { DomainDnssecDataArray, OrganizationAttribute2Array, IpRestrictionArray, TldResponseShortArray } from './schemas-arrays.d';
 
-import { Problem, HTTPValidationError, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DomainForwardZone, Pagination_DomainForwardZone, DnsZoneSummary, Pagination_DomainForward, DomainForward, DomainForwardSet, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, Pagination_EmailForwardAlias, 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_ObjectLog, HTTPValidationError, Pagination_RequestHistory, Problem, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DomainForwardZone, Pagination_DomainForwardZone, DnsZoneSummary, Pagination_DomainForward, DomainForward, DomainForwardSet, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, Pagination_EmailForwardAlias, 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';
+
+/**
+ * Response types for GET ArchiveObjectLogs endpoint
+ *
+ * Get organization logs
+ * Retrieve paginated audit logs for a specific organization with optional filtering and sorting
+ *
+ * @remarks
+ * This type defines all possible response structures for the GET ArchiveObjectLogs endpoint.
+ * Each response code maps to a specific response type as defined in the OpenAPI specification.
+ * Use this type to ensure type safety when handling API responses from this endpoint.
+ *
+
+ *
+ * @path /v1/archive/object-logs
+ *
+ * @see {@link GET_ArchiveObjectLogs_Response_200} - 200 response type
+ * @see {@link GET_ArchiveObjectLogs_Response_422} - 422 response type
+ *
+
+ */
+export type GET_ArchiveObjectLogs_Response = GET_ArchiveObjectLogs_Response_200 | GET_ArchiveObjectLogs_Response_422;
+
+/**
+ * 200 response for GET ArchiveObjectLogs endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 200 status code
+ * of the GET ArchiveObjectLogs endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/archive/object-logs
+ *
+ * @see {@link GET_ArchiveObjectLogs_Response} - The main response type definition
+ * @see {@link Pagination_ObjectLog} - The actual schema type definition
+ */
+export type GET_ArchiveObjectLogs_Response_200 = Pagination_ObjectLog
+
+/**
+ * 422 response for GET ArchiveObjectLogs endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 422 status code
+ * of the GET ArchiveObjectLogs endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/archive/object-logs
+ *
+ * @see {@link GET_ArchiveObjectLogs_Response} - The main response type definition
+ * @see {@link HTTPValidationError} - The actual schema type definition
+ */
+export type GET_ArchiveObjectLogs_Response_422 = HTTPValidationError
+
+/**
+ * Response types for GET ArchiveObjectLogsByObjectId endpoint
+ *
+ * Get organization logs
+ * Retrieve paginated audit logs for a specific organization with optional filtering and sorting
+ *
+ * @remarks
+ * This type defines all possible response structures for the GET ArchiveObjectLogsByObjectId endpoint.
+ * Each response code maps to a specific response type as defined in the OpenAPI specification.
+ * Use this type to ensure type safety when handling API responses from this endpoint.
+ *
+
+ *
+ * @path /v1/archive/object-logs/{object_id}
+ *
+ * @see {@link GET_ArchiveObjectLogsByObjectId_Response_200} - 200 response type
+ * @see {@link GET_ArchiveObjectLogsByObjectId_Response_422} - 422 response type
+ *
+
+ */
+export type GET_ArchiveObjectLogsByObjectId_Response = GET_ArchiveObjectLogsByObjectId_Response_200 | GET_ArchiveObjectLogsByObjectId_Response_422;
+
+/**
+ * 200 response for GET ArchiveObjectLogsByObjectId endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 200 status code
+ * of the GET ArchiveObjectLogsByObjectId endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/archive/object-logs/{object_id}
+ *
+ * @see {@link GET_ArchiveObjectLogsByObjectId_Response} - The main response type definition
+ * @see {@link Pagination_ObjectLog} - The actual schema type definition
+ */
+export type GET_ArchiveObjectLogsByObjectId_Response_200 = Pagination_ObjectLog
+
+/**
+ * 422 response for GET ArchiveObjectLogsByObjectId endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 422 status code
+ * of the GET ArchiveObjectLogsByObjectId endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/archive/object-logs/{object_id}
+ *
+ * @see {@link GET_ArchiveObjectLogsByObjectId_Response} - The main response type definition
+ * @see {@link HTTPValidationError} - The actual schema type definition
+ */
+export type GET_ArchiveObjectLogsByObjectId_Response_422 = HTTPValidationError
+
+/**
+ * Response types for GET ArchiveRequestHistory endpoint
+ *
+ * Get request history logs
+ * Retrieves a paginated list of request history logs
+ *
+ * @remarks
+ * This type defines all possible response structures for the GET ArchiveRequestHistory endpoint.
+ * Each response code maps to a specific response type as defined in the OpenAPI specification.
+ * Use this type to ensure type safety when handling API responses from this endpoint.
+ *
+
+ *
+ * @path /v1/archive/request-history
+ *
+ * @see {@link GET_ArchiveRequestHistory_Response_200} - 200 response type
+ * @see {@link GET_ArchiveRequestHistory_Response_422} - 422 response type
+ *
+
+ */
+export type GET_ArchiveRequestHistory_Response = GET_ArchiveRequestHistory_Response_200 | GET_ArchiveRequestHistory_Response_422;
+
+/**
+ * 200 response for GET ArchiveRequestHistory endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 200 status code
+ * of the GET ArchiveRequestHistory endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/archive/request-history
+ *
+ * @see {@link GET_ArchiveRequestHistory_Response} - The main response type definition
+ * @see {@link Pagination_RequestHistory} - The actual schema type definition
+ */
+export type GET_ArchiveRequestHistory_Response_200 = Pagination_RequestHistory
+
+/**
+ * 422 response for GET ArchiveRequestHistory endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 422 status code
+ * of the GET ArchiveRequestHistory endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/archive/request-history
+ *
+ * @see {@link GET_ArchiveRequestHistory_Response} - The main response type definition
+ * @see {@link HTTPValidationError} - The actual schema type definition
+ */
+export type GET_ArchiveRequestHistory_Response_422 = HTTPValidationError
 
 /**
  * Response types for POST AuthToken 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, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, ContactRoleType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactSchema, DnsZone, DomainForwardZone, Domain, EmailForwardAlias, EventResponse, Invoice, Organization, 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, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, ContactRoleType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactSchema, DnsZone, DomainForwardZone, Domain, EmailForwardAlias, EventResponse, Invoice, ObjectLog, Organization, RequestHistory, Period, Permission, PremiumAffectsType, Relation, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
 
 /**
  * DomainDnssecDataResponse
@@ -681,6 +681,20 @@ export type EventResponseArray = EventResponse[];
  * @see {@link Invoice} - The individual InvoiceResponse type definition
  */
 export type InvoiceArray = Invoice[];
+/**
+ * ObjectLog
+ *
+ * @remarks
+ * Array type for ObjectLog objects. Used when the API returns a collection of ObjectLog instances.
+ *
+ * @example
+ * ```typescript
+ * const items: ObjectLogArray = await api.getObjectLogs();
+ * ```
+ *
+ * @see {@link ObjectLog} - The individual ObjectLog type definition
+ */
+export type ObjectLogArray = ObjectLog[];
 /**
  * Organization
  *
@@ -695,6 +709,20 @@ export type InvoiceArray = Invoice[];
  * @see {@link Organization} - The individual Organization type definition
  */
 export type OrganizationArray = Organization[];
+/**
+ * RequestHistory
+ *
+ * @remarks
+ * Array type for RequestHistory objects. Used when the API returns a collection of RequestHistory instances.
+ *
+ * @example
+ * ```typescript
+ * const items: RequestHistoryArray = await api.getRequestHistorys();
+ * ```
+ *
+ * @see {@link RequestHistory} - The individual RequestHistory type definition
+ */
+export type RequestHistoryArray = RequestHistory[];
 /**
  * Period
  *

package/src/helpers/schemas.d.ts

@@ -2063,6 +2063,54 @@ export type LocalPresenceRequirementType = components['schemas']['LocalPresenceR
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type Nameserver = components['schemas']['Nameserver'];
+/**
+ * ObjectEventType
+ *
+ * @remarks
+ * Type alias for the `ObjectEventType` OpenAPI schema.
+ * This type represents objecteventtype data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getObjectEventType();
+ * const item: ObjectEventType = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type ObjectEventType = components['schemas']['ObjectEventType'];
+/**
+ * ObjectLog
+ *
+ * @remarks
+ * Type alias for the `ObjectLog` OpenAPI schema.
+ * This type represents objectlog data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getObjectLog();
+ * const item: ObjectLog = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type ObjectLog = components['schemas']['ObjectLog'];
+/**
+ * ObjectLogSortField
+ *
+ * @remarks
+ * Type alias for the `ObjectLogSortField` OpenAPI schema.
+ * This type represents objectlogsortfield data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getObjectLogSortField();
+ * const item: ObjectLogSortField = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type ObjectLogSortField = components['schemas']['ObjectLogSortField'];
 /**
  * Organization
  *
@@ -2383,6 +2431,22 @@ export type Pagination_Event = components['schemas']['Pagination_EventResponse_'
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type Pagination_Invoice = components['schemas']['Pagination_InvoiceResponse_'];
+/**
+ * Pagination[ObjectLog]
+ *
+ * @remarks
+ * Type alias for the `Pagination_ObjectLog_` OpenAPI schema.
+ * This type represents pagination[objectlog] data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getPagination_ObjectLog();
+ * const item: Pagination_ObjectLog = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type Pagination_ObjectLog = components['schemas']['Pagination_ObjectLog_'];
 /**
  * Pagination[Organization]
  *
@@ -2399,6 +2463,22 @@ export type Pagination_Invoice = components['schemas']['Pagination_InvoiceRespon
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type Pagination_Organization = components['schemas']['Pagination_Organization_'];
+/**
+ * Pagination[RequestHistory]
+ *
+ * @remarks
+ * Type alias for the `Pagination_RequestHistory_` OpenAPI schema.
+ * This type represents pagination[requesthistory] data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getPagination_RequestHistory();
+ * const item: Pagination_RequestHistory = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type Pagination_RequestHistory = components['schemas']['Pagination_RequestHistory_'];
 /**
  * Pagination[User]
  *
@@ -2799,6 +2879,38 @@ export type RelationSet = components['schemas']['RelationSet'];
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type RenewalMode = components['schemas']['RenewalMode'];
+/**
+ * RequestHistory
+ *
+ * @remarks
+ * Type alias for the `RequestHistory` OpenAPI schema.
+ * This type represents requesthistory data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getRequestHistory();
+ * const item: RequestHistory = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type RequestHistory = components['schemas']['RequestHistory'];
+/**
+ * RequestHistorySortField
+ *
+ * @remarks
+ * Type alias for the `RequestHistorySortField` OpenAPI schema.
+ * This type represents requesthistorysortfield data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getRequestHistorySortField();
+ * const item: RequestHistorySortField = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type RequestHistorySortField = components['schemas']['RequestHistorySortField'];
 /**
  * ReservedDomainsBase
  *