@opusdns/api 0.85.0 → 0.86.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 CHANGED
@@ -3,7 +3,7 @@
3
3
  "@opusdns/api-spec-ts-generator": "^0.9.1"
4
4
  },
5
5
  "name": "@opusdns/api",
6
- "version": "0.85.0",
6
+ "version": "0.86.0",
7
7
  "description": "TypeScript types for the OpusDNS OpenAPI specification",
8
8
  "main": "./src/index.ts",
9
9
  "module": "./src/index.ts",
@@ -21,7 +21,7 @@
21
21
  * ```
22
22
  */
23
23
 
24
- import { AllocationMethodType, AttributeType, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ContactRoleType, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAttributeKey, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainSortField, DomainStatus, EmailVerificationStatus, EventObjectType, EventSubtype, EventType, GrantType, LaunchPhaseType, LocalPresenceRequirementType, OrganizationStatus, PatchOp, PeriodUnit, Permission, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TransferAckType, UserStatus, VerificationType, ZoneSortField } from './schemas';
24
+ import { AllocationMethodType, AttributeType, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ContactRoleType, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAttributeKey, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainSortField, DomainStatus, EmailVerificationStatus, EventObjectType, EventSortField, EventSubtype, EventType, GrantType, LaunchPhaseType, LocalPresenceRequirementType, OrganizationStatus, PatchOp, PeriodUnit, Permission, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TransferAckType, UserStatus, VerificationType, ZoneSortField } from './schemas';
25
25
 
26
26
  /**
27
27
  * AllocationMethodType. Auto-generated enum for AllocationMethodType
@@ -1387,6 +1387,56 @@ export const EVENT_OBJECT_TYPE_VALUES = [
1387
1387
  'UNKNOWN'
1388
1388
  ] as const satisfies [string, ...string[]] | EventObjectType[];
1389
1389
 
1390
+ /**
1391
+ * EventSortField. Auto-generated enum for EventSortField
1392
+ *
1393
+ * @remarks
1394
+ * This constant provides both object and array forms for the EventSortField enum.
1395
+ * The object form allows key-value access, while the array form enables iteration and validation.
1396
+ *
1397
+ * @example
1398
+ * ```typescript
1399
+ * // Using the object form for key-value access
1400
+ * const status = EVENT_SORT_FIELD.SUCCESS;
1401
+ *
1402
+ * // Using the array form for iteration
1403
+ * const allStatuses = EVENT_SORT_FIELD_VALUES;
1404
+ * console.log(`Available statuses: ${allStatuses.join(', ')}`);
1405
+ * ```
1406
+ *
1407
+ * @see {@link EventSortField} - The TypeScript type definition
1408
+ */
1409
+ export const EVENT_SORT_FIELD = {
1410
+ OBJECT_ID: "object_id",
1411
+ CREATED_ON: "created_on",
1412
+ } as const satisfies Record<string, EventSortField>;
1413
+
1414
+ /**
1415
+ * Array of all EventSortField enum values
1416
+ *
1417
+ * @remarks
1418
+ * This constant provides a array containing all valid EventSortField enum values.
1419
+ * Useful for iteration, validation, and generating dynamic UI components.
1420
+ *
1421
+ * @example
1422
+ * ```typescript
1423
+ * // Iterating through all values
1424
+ * for (const value of EVENT_SORT_FIELD_VALUES) {
1425
+ * console.log(`Processing: ${value}`);
1426
+ * }
1427
+ *
1428
+ * // Validation
1429
+ * const isValid = EVENT_SORT_FIELD_VALUES.includes(someValue);
1430
+ * ```
1431
+ *
1432
+ * @see {@link EventSortField} - The TypeScript type definition
1433
+ * @see {@link EVENT_SORT_FIELD} - The object form of this enum
1434
+ */
1435
+ export const EVENT_SORT_FIELD_VALUES = [
1436
+ 'object_id',
1437
+ 'created_on'
1438
+ ] as const satisfies [string, ...string[]] | EventSortField[];
1439
+
1390
1440
  /**
1391
1441
  * EventSubtype. Auto-generated enum for EventSubtype
1392
1442
  *
@@ -2443,7 +2443,7 @@ export type PATCH_EmailForwardsZoneNameEnable_Request_Path = PATCH_EmailForwards
2443
2443
  * Request type for GET Events endpoint
2444
2444
  *
2445
2445
  * Get pending events
2446
- * Retrieves a paginated list of pending events for the organization
2446
+ * Retrieves a paginated list of events for the organization
2447
2447
  *
2448
2448
  * @remarks
2449
2449
  * This type defines the complete request structure for the GET Events endpoint.
@@ -3581,7 +3581,7 @@ export type PATCH_EmailForwardsByZoneNameEnable_Response_422 = HTTPValidationErr
3581
3581
  * Response types for GET Events endpoint
3582
3582
  *
3583
3583
  * Get pending events
3584
- * Retrieves a paginated list of pending events for the organization
3584
+ * Retrieves a paginated list of events for the organization
3585
3585
  *
3586
3586
  * @remarks
3587
3587
  * This type defines all possible response structures for the GET Events endpoint.
@@ -1450,6 +1450,22 @@ export type EventResponse = components['schemas']['EventResponse'];
1450
1450
  * @see {@link components} - The OpenAPI components schema definition
1451
1451
  */
1452
1452
  export type EventSchema = components['schemas']['EventSchema'];
1453
+ /**
1454
+ * EventSortField
1455
+ *
1456
+ * @remarks
1457
+ * Type alias for the `EventSortField` OpenAPI schema.
1458
+ * This type represents eventsortfield data structures used in API requests and responses.
1459
+ *
1460
+ * @example
1461
+ * ```typescript
1462
+ * const response = await api.getEventSortField();
1463
+ * const item: EventSortField = response.results;
1464
+ * ```
1465
+ *
1466
+ * @see {@link components} - The OpenAPI components schema definition
1467
+ */
1468
+ export type EventSortField = components['schemas']['EventSortField'];
1453
1469
  /**
1454
1470
  * EventSubtype
1455
1471
  *
package/src/openapi.yaml CHANGED
@@ -2383,6 +2383,12 @@ components:
2383
2383
  - source
2384
2384
  title: EventSchema
2385
2385
  type: object
2386
+ EventSortField:
2387
+ enum:
2388
+ - object_id
2389
+ - created_on
2390
+ title: EventSortField
2391
+ type: string
2386
2392
  EventSubtype:
2387
2393
  enum:
2388
2394
  - NOTIFICATION
@@ -4946,7 +4952,7 @@ info:
4946
4952
  '
4947
4953
  summary: OpusDNS - your gateway to a seamless domain management experience.
4948
4954
  title: OpusDNS API
4949
- version: 2025-10-20-101702
4955
+ version: 2025-10-27-080440
4950
4956
  x-logo:
4951
4957
  altText: OpusDNS API Reference
4952
4958
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -8033,9 +8039,62 @@ paths:
8033
8039
  - email_forward
8034
8040
  /v1/events:
8035
8041
  get:
8036
- description: Retrieves a paginated list of pending events for the organization
8042
+ description: Retrieves a paginated list of events for the organization
8037
8043
  operationId: get_events_v1_events_get
8038
8044
  parameters:
8045
+ - in: query
8046
+ name: sort_by
8047
+ required: false
8048
+ schema:
8049
+ $ref: '#/components/schemas/EventSortField'
8050
+ default: created_on
8051
+ - in: query
8052
+ name: sort_order
8053
+ required: false
8054
+ schema:
8055
+ $ref: '#/components/schemas/SortOrder'
8056
+ default: desc
8057
+ - in: query
8058
+ name: object_type
8059
+ required: false
8060
+ schema:
8061
+ anyOf:
8062
+ - $ref: '#/components/schemas/EventObjectType'
8063
+ - type: 'null'
8064
+ title: Object Type
8065
+ - in: query
8066
+ name: object_id
8067
+ required: false
8068
+ schema:
8069
+ anyOf:
8070
+ - type: string
8071
+ - type: 'null'
8072
+ title: Object Id
8073
+ - in: query
8074
+ name: type
8075
+ required: false
8076
+ schema:
8077
+ anyOf:
8078
+ - $ref: '#/components/schemas/EventType'
8079
+ - type: 'null'
8080
+ title: Type
8081
+ - in: query
8082
+ name: subtype
8083
+ required: false
8084
+ schema:
8085
+ anyOf:
8086
+ - $ref: '#/components/schemas/EventSubtype'
8087
+ - type: 'null'
8088
+ title: Subtype
8089
+ - in: query
8090
+ name: acknowledged
8091
+ required: false
8092
+ schema:
8093
+ anyOf:
8094
+ - type: boolean
8095
+ - type: 'null'
8096
+ default: false
8097
+ title: Acknowledged
8039
8098
  - in: query
8040
8099
  name: page
8041
8100
  required: false
package/src/schema.d.ts CHANGED
@@ -688,7 +688,7 @@ export interface paths {
688
688
  };
689
689
  /**
690
690
  * Get pending events
691
- * @description Retrieves a paginated list of pending events for the organization
691
+ * @description Retrieves a paginated list of events for the organization
692
692
  */
693
693
  get: operations["get_events_v1_events_get"];
694
694
  put?: never;
@@ -2797,6 +2797,11 @@ export interface components {
2797
2797
  /** @description The type of the event - indicates the kind of operation occurring (e.g., 'ACCOUNT_CREATE', 'DOMAIN_MODIFICATION') */
2798
2798
  type?: components["schemas"]["EventType"] | null;
2799
2799
  };
2800
+ /**
2801
+ * EventSortField
2802
+ * @enum {string}
2803
+ */
2804
+ EventSortField: "object_id" | "created_on";
2800
2805
  /**
2801
2806
  * EventSubtype
2802
2807
  * @enum {string}
@@ -7095,6 +7100,13 @@ export interface operations {
7095
7100
  get_events_v1_events_get: {
7096
7101
  parameters: {
7097
7102
  query?: {
7103
+ sort_by?: components["schemas"]["EventSortField"];
7104
+ sort_order?: components["schemas"]["SortOrder"];
7105
+ object_type?: components["schemas"]["EventObjectType"] | null;
7106
+ object_id?: string | null;
7107
+ type?: components["schemas"]["EventType"] | null;
7108
+ subtype?: components["schemas"]["EventSubtype"] | null;
7109
+ acknowledged?: boolean | null;
7098
7110
  page?: number;
7099
7111
  page_size?: number;
7100
7112
  };