@opusdns/api 0.225.0 → 0.226.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.19.0"
4
4
  },
5
5
  "name": "@opusdns/api",
6
- "version": "0.225.0",
6
+ "version": "0.226.0",
7
7
  "description": "TypeScript types for the OpusDNS OpenAPI specification",
8
8
  "main": "./src/index.ts",
9
9
  "module": "./src/index.ts",
@@ -190,6 +190,7 @@ import { ReservedDomainsBase } from './schemas';
190
190
  import { RgpOperations } from './schemas';
191
191
  import { SldLength } from './schemas';
192
192
  import { SpiceDbRelationshipUpdate } from './schemas';
193
+ import { StatusChanges } from './schemas';
193
194
  import { StatusCodeStatsBucket } from './schemas';
194
195
  import { TimeSeriesBucket } from './schemas';
195
196
  import { TldBase } from './schemas';
@@ -11960,6 +11961,31 @@ export const KEY_DOMAIN_UPDATE_NAMESERVERS: keyof DomainUpdate = 'nameservers';
11960
11961
  * @see {@link KEYS_DOMAIN_UPDATE} - Array of all keys for this type
11961
11962
  */
11962
11963
  export const KEY_DOMAIN_UPDATE_RENEWAL_MODE: keyof DomainUpdate = 'renewal_mode';
11964
+ /**
11965
+ * status_changes property
11966
+ *
11967
+ * Statuses to add or remove relative to current state
11968
+ *
11969
+ *
11970
+ *
11971
+ * @remarks
11972
+ * This key constant provides type-safe access to the `status_changes` property of DomainUpdate objects.
11973
+ * Use this constant when you need to access properties dynamically or ensure type safety.
11974
+ *
11975
+ * @example
11976
+ * ```typescript
11977
+ * // Direct property access
11978
+ * const value = domainupdate[KEY_DOMAIN_UPDATE_STATUS_CHANGES];
11979
+ *
11980
+ * // Dynamic property access
11981
+ * const propertyName = KEY_DOMAIN_UPDATE_STATUS_CHANGES;
11982
+ * const value = domainupdate[propertyName];
11983
+ * ```
11984
+ *
11985
+ * @see {@link DomainUpdate} - The TypeScript type definition
11986
+ * @see {@link KEYS_DOMAIN_UPDATE} - Array of all keys for this type
11987
+ */
11988
+ export const KEY_DOMAIN_UPDATE_STATUS_CHANGES: keyof DomainUpdate = 'status_changes';
11963
11989
  /**
11964
11990
  * Statuses
11965
11991
  *
@@ -12011,6 +12037,7 @@ export const KEYS_DOMAIN_UPDATE = [
12011
12037
  KEY_DOMAIN_UPDATE_CONTACTS,
12012
12038
  KEY_DOMAIN_UPDATE_NAMESERVERS,
12013
12039
  KEY_DOMAIN_UPDATE_RENEWAL_MODE,
12040
+ KEY_DOMAIN_UPDATE_STATUS_CHANGES,
12014
12041
  KEY_DOMAIN_UPDATE_STATUSES,
12015
12042
  ] as const satisfies (keyof DomainUpdate)[];
12016
12043
 
@@ -23410,6 +23437,84 @@ export const KEYS_SPICE_DB_RELATIONSHIP_UPDATE = [
23410
23437
  KEY_SPICE_DB_RELATIONSHIP_UPDATE_REMOVE,
23411
23438
  ] as const satisfies (keyof SpiceDbRelationshipUpdate)[];
23412
23439
 
23440
+ /**
23441
+ * Add
23442
+ *
23443
+ * Statuses to add to the domain
23444
+ *
23445
+ * @type {array}
23446
+ *
23447
+ *
23448
+ * @remarks
23449
+ * This key constant provides type-safe access to the `add` property of StatusChanges objects.
23450
+ * Use this constant when you need to access properties dynamically or ensure type safety.
23451
+ *
23452
+ * @example
23453
+ * ```typescript
23454
+ * // Direct property access
23455
+ * const value = statuschanges[KEY_STATUS_CHANGES_ADD];
23456
+ *
23457
+ * // Dynamic property access
23458
+ * const propertyName = KEY_STATUS_CHANGES_ADD;
23459
+ * const value = statuschanges[propertyName];
23460
+ * ```
23461
+ *
23462
+ * @see {@link StatusChanges} - The TypeScript type definition
23463
+ * @see {@link KEYS_STATUS_CHANGES} - Array of all keys for this type
23464
+ */
23465
+ export const KEY_STATUS_CHANGES_ADD: keyof StatusChanges = 'add';
23466
+ /**
23467
+ * Remove
23468
+ *
23469
+ * Statuses to remove from the domain
23470
+ *
23471
+ * @type {array}
23472
+ *
23473
+ *
23474
+ * @remarks
23475
+ * This key constant provides type-safe access to the `remove` property of StatusChanges objects.
23476
+ * Use this constant when you need to access properties dynamically or ensure type safety.
23477
+ *
23478
+ * @example
23479
+ * ```typescript
23480
+ * // Direct property access
23481
+ * const value = statuschanges[KEY_STATUS_CHANGES_REMOVE];
23482
+ *
23483
+ * // Dynamic property access
23484
+ * const propertyName = KEY_STATUS_CHANGES_REMOVE;
23485
+ * const value = statuschanges[propertyName];
23486
+ * ```
23487
+ *
23488
+ * @see {@link StatusChanges} - The TypeScript type definition
23489
+ * @see {@link KEYS_STATUS_CHANGES} - Array of all keys for this type
23490
+ */
23491
+ export const KEY_STATUS_CHANGES_REMOVE: keyof StatusChanges = 'remove';
23492
+
23493
+ /**
23494
+ * Array of all StatusChanges property keys
23495
+ *
23496
+ * @remarks
23497
+ * This constant provides a readonly array containing all valid property keys for StatusChanges objects.
23498
+ * Useful for iteration, validation, and generating dynamic UI components.
23499
+ *
23500
+ * @example
23501
+ * ```typescript
23502
+ * // Iterating through all keys
23503
+ * for (const key of KEYS_STATUS_CHANGES) {
23504
+ * console.log(`Property: ${key}, Value: ${statuschanges[key]}`);
23505
+ * }
23506
+ *
23507
+ * // Validation
23508
+ * const isValidKey = KEYS_STATUS_CHANGES.includes(someKey);
23509
+ * ```
23510
+ *
23511
+ * @see {@link StatusChanges} - The TypeScript type definition
23512
+ */
23513
+ export const KEYS_STATUS_CHANGES = [
23514
+ KEY_STATUS_CHANGES_ADD,
23515
+ KEY_STATUS_CHANGES_REMOVE,
23516
+ ] as const satisfies (keyof StatusChanges)[];
23517
+
23413
23518
  /**
23414
23519
  * Key
23415
23520
  *
@@ -4132,6 +4132,22 @@ export type SortOrder = components['schemas']['SortOrder'];
4132
4132
  * @see {@link components} - The OpenAPI components schema definition
4133
4133
  */
4134
4134
  export type SpiceDbRelationshipUpdate = components['schemas']['SpiceDbRelationshipUpdate'];
4135
+ /**
4136
+ * StatusChanges
4137
+ *
4138
+ * @remarks
4139
+ * Type alias for the `StatusChanges` OpenAPI schema.
4140
+ * This type represents statuschanges data structures used in API requests and responses.
4141
+ *
4142
+ * @example
4143
+ * ```typescript
4144
+ * const response = await api.getStatusChanges();
4145
+ * const item: StatusChanges = response.results;
4146
+ * ```
4147
+ *
4148
+ * @see {@link components} - The OpenAPI components schema definition
4149
+ */
4150
+ export type StatusChanges = components['schemas']['StatusChanges'];
4135
4151
  /**
4136
4152
  * StatusCodeStatsBucket
4137
4153
  *
package/src/openapi.yaml CHANGED
@@ -2926,6 +2926,11 @@ components:
2926
2926
  - $ref: '#/components/schemas/RenewalMode'
2927
2927
  - type: 'null'
2928
2928
  description: The new renewal mode of the domain
2929
+ status_changes:
2930
+ anyOf:
2931
+ - $ref: '#/components/schemas/StatusChanges'
2932
+ - type: 'null'
2933
+ description: Statuses to add or remove relative to current state
2929
2934
  statuses:
2930
2935
  anyOf:
2931
2936
  - items:
@@ -6144,6 +6149,22 @@ components:
6144
6149
  title: Remove
6145
6150
  title: SpiceDbRelationshipUpdate
6146
6151
  type: object
6152
+ StatusChanges:
6153
+ properties:
6154
+ add:
6155
+ description: Statuses to add to the domain
6156
+ items:
6157
+ $ref: '#/components/schemas/DomainClientStatus'
6158
+ title: Add
6159
+ type: array
6160
+ remove:
6161
+ description: Statuses to remove from the domain
6162
+ items:
6163
+ $ref: '#/components/schemas/DomainClientStatus'
6164
+ title: Remove
6165
+ type: array
6166
+ title: StatusChanges
6167
+ type: object
6147
6168
  StatusCodeStatsBucket:
6148
6169
  properties:
6149
6170
  key:
@@ -7339,7 +7360,7 @@ info:
7339
7360
  '
7340
7361
  summary: OpusDNS - your gateway to a seamless domain management experience.
7341
7362
  title: OpusDNS API
7342
- version: 2026-03-19-143831
7363
+ version: 2026-03-26-142512
7343
7364
  x-logo:
7344
7365
  altText: OpusDNS API Reference
7345
7366
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
package/src/schema.d.ts CHANGED
@@ -3868,6 +3868,8 @@ export interface components {
3868
3868
  nameservers?: components["schemas"]["Nameserver"][] | null;
3869
3869
  /** @description The new renewal mode of the domain */
3870
3870
  renewal_mode?: components["schemas"]["RenewalMode"] | null;
3871
+ /** @description Statuses to add or remove relative to current state */
3872
+ status_changes?: components["schemas"]["StatusChanges"] | null;
3871
3873
  /**
3872
3874
  * Statuses
3873
3875
  * @description The new statuses of the domain
@@ -5989,6 +5991,19 @@ export interface components {
5989
5991
  /** Remove */
5990
5992
  remove?: components["schemas"]["Relation"][] | null;
5991
5993
  };
5994
+ /** StatusChanges */
5995
+ StatusChanges: {
5996
+ /**
5997
+ * Add
5998
+ * @description Statuses to add to the domain
5999
+ */
6000
+ add?: components["schemas"]["DomainClientStatus"][];
6001
+ /**
6002
+ * Remove
6003
+ * @description Statuses to remove from the domain
6004
+ */
6005
+ remove?: components["schemas"]["DomainClientStatus"][];
6006
+ };
5992
6007
  /** StatusCodeStatsBucket */
5993
6008
  StatusCodeStatsBucket: {
5994
6009
  /** Key */