@opusdns/api 1.226.0 → 1.228.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": "^1.6.0"
4
4
  },
5
5
  "name": "@opusdns/api",
6
- "version": "1.226.0",
6
+ "version": "1.228.0",
7
7
  "description": "TypeScript types for the OpusDNS OpenAPI specification",
8
8
  "main": "./src/index.ts",
9
9
  "module": "./src/index.ts",
@@ -131,6 +131,7 @@ import type {
131
131
  DnsZoneUpdatePayloadData,
132
132
  DnsZoneUpdateWorkerPayload,
133
133
  DnsZoneVanitySetUpdateRes,
134
+ DomainAmsAccount,
134
135
  DomainAuthCode,
135
136
  DomainAvailability,
136
137
  DomainAvailabilityError,
@@ -325,6 +326,7 @@ import type {
325
326
  NorIdDeclaration,
326
327
  NorIdResellerDeclarationRequest,
327
328
  ObjectLog,
329
+ ObjectLogChange,
328
330
  ObjectTagChanges,
329
331
  ObjectTagChanges2,
330
332
  Organization,
@@ -2108,6 +2110,16 @@ export const KEYS_DNS_ZONE_VANITY_SET_UPDATE_RES = [
2108
2110
  KEY_DNS_ZONE_VANITY_SET_UPDATE_RES_ZONE,
2109
2111
  ] as const satisfies (keyof DnsZoneVanitySetUpdateRes)[];
2110
2112
 
2113
+ export const KEY_DOMAIN_AMS_ACCOUNT_REGISTRY = 'registry' satisfies keyof DomainAmsAccount;
2114
+ export const KEY_DOMAIN_AMS_ACCOUNT_REGISTRY_ACCOUNT_ID = 'registry_account_id' satisfies keyof DomainAmsAccount;
2115
+ export const KEY_DOMAIN_AMS_ACCOUNT_TYPE = 'type' satisfies keyof DomainAmsAccount;
2116
+
2117
+ export const KEYS_DOMAIN_AMS_ACCOUNT = [
2118
+ KEY_DOMAIN_AMS_ACCOUNT_REGISTRY,
2119
+ KEY_DOMAIN_AMS_ACCOUNT_REGISTRY_ACCOUNT_ID,
2120
+ KEY_DOMAIN_AMS_ACCOUNT_TYPE,
2121
+ ] as const satisfies (keyof DomainAmsAccount)[];
2122
+
2111
2123
  export const KEY_DOMAIN_AUTH_CODE_AUTH_CODE = 'auth_code' satisfies keyof DomainAuthCode;
2112
2124
  export const KEY_DOMAIN_AUTH_CODE_AUTH_CODE_EXPIRES_ON = 'auth_code_expires_on' satisfies keyof DomainAuthCode;
2113
2125
  export const KEY_DOMAIN_AUTH_CODE_DELIVERY = 'delivery' satisfies keyof DomainAuthCode;
@@ -4533,6 +4545,7 @@ export const KEYS_NOR_ID_RESELLER_DECLARATION_REQUEST = [
4533
4545
  ] as const satisfies (keyof NorIdResellerDeclarationRequest)[];
4534
4546
 
4535
4547
  export const KEY_OBJECT_LOG_ACTION = 'action' satisfies keyof ObjectLog;
4548
+ export const KEY_OBJECT_LOG_CHANGES = 'changes' satisfies keyof ObjectLog;
4536
4549
  export const KEY_OBJECT_LOG_CREATED_ON = 'created_on' satisfies keyof ObjectLog;
4537
4550
  export const KEY_OBJECT_LOG_DETAILS = 'details' satisfies keyof ObjectLog;
4538
4551
  export const KEY_OBJECT_LOG_OBJECT_ID = 'object_id' satisfies keyof ObjectLog;
@@ -4544,6 +4557,7 @@ export const KEY_OBJECT_LOG_SERVER_REQUEST_ID = 'server_request_id' satisfies ke
4544
4557
 
4545
4558
  export const KEYS_OBJECT_LOG = [
4546
4559
  KEY_OBJECT_LOG_ACTION,
4560
+ KEY_OBJECT_LOG_CHANGES,
4547
4561
  KEY_OBJECT_LOG_CREATED_ON,
4548
4562
  KEY_OBJECT_LOG_DETAILS,
4549
4563
  KEY_OBJECT_LOG_OBJECT_ID,
@@ -4554,6 +4568,16 @@ export const KEYS_OBJECT_LOG = [
4554
4568
  KEY_OBJECT_LOG_SERVER_REQUEST_ID,
4555
4569
  ] as const satisfies (keyof ObjectLog)[];
4556
4570
 
4571
+ export const KEY_OBJECT_LOG_CHANGE_FIELD = 'field' satisfies keyof ObjectLogChange;
4572
+ export const KEY_OBJECT_LOG_CHANGE_NEW_VALUE = 'new_value' satisfies keyof ObjectLogChange;
4573
+ export const KEY_OBJECT_LOG_CHANGE_OLD_VALUE = 'old_value' satisfies keyof ObjectLogChange;
4574
+
4575
+ export const KEYS_OBJECT_LOG_CHANGE = [
4576
+ KEY_OBJECT_LOG_CHANGE_FIELD,
4577
+ KEY_OBJECT_LOG_CHANGE_NEW_VALUE,
4578
+ KEY_OBJECT_LOG_CHANGE_OLD_VALUE,
4579
+ ] as const satisfies (keyof ObjectLogChange)[];
4580
+
4557
4581
  export const KEY_OBJECT_TAG_CHANGES_ADD = 'add' satisfies keyof ObjectTagChanges;
4558
4582
  export const KEY_OBJECT_TAG_CHANGES_REMOVE = 'remove' satisfies keyof ObjectTagChanges;
4559
4583
 
@@ -172,6 +172,7 @@ export type DnssecModeType = components['schemas']['DnssecModeType'];
172
172
  export type DnssecRecordType = components['schemas']['DnssecRecordType'];
173
173
  export type DnssecRegistryPublishOutcome = components['schemas']['DnssecRegistryPublishOutcome'];
174
174
  export type DnssecStatus = components['schemas']['DnssecStatus'];
175
+ export type DomainAmsAccount = components['schemas']['DomainAmsAccountResponse'];
175
176
  export type DomainAttributeKey = components['schemas']['DomainAttributeKey'];
176
177
  export type DomainAuthCode = components['schemas']['DomainAuthCodeResponse'];
177
178
  export type DomainAvailability = components['schemas']['DomainAvailability'];
@@ -414,6 +415,7 @@ export type NorIdDeclarationStatus = components['schemas']['NorIdDeclarationStat
414
415
  export type NorIdResellerDeclarationRequest = components['schemas']['NorIdResellerDeclarationRequest'];
415
416
  export type ObjectEventType = components['schemas']['ObjectEventType'];
416
417
  export type ObjectLog = components['schemas']['ObjectLog'];
418
+ export type ObjectLogChange = components['schemas']['ObjectLogChange'];
417
419
  export type ObjectLogSortField = components['schemas']['ObjectLogSortField'];
418
420
  export type ObjectTagChanges = components['schemas']['ObjectTagChanges'];
419
421
  export type ObjectTagChanges2 = components['schemas']['ObjectTagChangesResponse'];
package/src/openapi.yaml CHANGED
@@ -11410,6 +11410,32 @@ components:
11410
11410
  - disabled
11411
11411
  title: DnssecStatus
11412
11412
  type: string
11413
+ DomainAmsAccountResponse:
11414
+ properties:
11415
+ registry:
11416
+ $ref: '#/components/schemas/RegistryServiceBackend'
11417
+ description: The registry the account is accredited at
11418
+ registry_account_id:
11419
+ description: The registry account the domain is held on
11420
+ examples:
11421
+ - registry_account_01h45ytscbebyvny4gc8cr8ma2
11422
+ format: typeid
11423
+ pattern: ^registry_account_[0-7][0-9a-hjkmnpq-tv-z]{25}$
11424
+ title: Registry Account Id
11425
+ type: string
11426
+ x-typeid-prefix: registry_account
11427
+ type:
11428
+ const: ams
11429
+ description: 'Kind of connected account. `ams`: the organization''s own
11430
+ registry accreditation, on which OpusDNS manages the domain.'
11431
+ title: Type
11432
+ type: string
11433
+ required:
11434
+ - type
11435
+ - registry_account_id
11436
+ - registry
11437
+ title: DomainAmsAccountResponse
11438
+ type: object
11413
11439
  DomainAttributeKey:
11414
11440
  enum:
11415
11441
  - auto_renew_period
@@ -13502,15 +13528,18 @@ components:
13502
13528
  anyOf:
13503
13529
  - discriminator:
13504
13530
  mapping:
13531
+ ams: '#/components/schemas/DomainAmsAccountResponse'
13505
13532
  ras: '#/components/schemas/DomainRegistrarCredentialResponse'
13506
13533
  propertyName: type
13507
13534
  oneOf:
13508
13535
  - $ref: '#/components/schemas/DomainRegistrarCredentialResponse'
13536
+ - $ref: '#/components/schemas/DomainAmsAccountResponse'
13509
13537
  - type: 'null'
13510
- description: The connected account this domain is synced from. Null unless
13511
- `include=connected_account` is requested, and null even then for natively
13512
- registered domains, for domains on operator-managed registry accounts,
13513
- and when the connected account was deleted.
13538
+ description: 'The connected account this domain is synced from or managed
13539
+ on: a registrar credential (`ras`) or the organization''s own registry
13540
+ accreditation (`ams`). Null unless `include=connected_account` is requested,
13541
+ and null even then for natively registered domains, for domains on operator-managed
13542
+ registry accounts, and when the connected account was deleted.'
13514
13543
  title: Connected Account
13515
13544
  contacts:
13516
13545
  description: The contacts of the domain
@@ -18380,6 +18409,19 @@ components:
18380
18409
  action:
18381
18410
  $ref: '#/components/schemas/ObjectEventType'
18382
18411
  description: Action performed
18412
+ changes:
18413
+ anyOf:
18414
+ - items:
18415
+ $ref: '#/components/schemas/ObjectLogChange'
18416
+ type: array
18417
+ - type: 'null'
18418
+ description: 'Fields that differ from the object''s previous log in the
18419
+ same organization. Empty when nothing changed; `null` when there was no
18420
+ previous log to compare with: the object''s first log in the organization,
18421
+ or a log written before changes were recorded. `updated_on` is not compared,
18422
+ arrays are compared regardless of order and reported whole, and sensitive
18423
+ values such as `auth_code` read `***REDACTED***`.'
18424
+ title: Changes
18383
18425
  created_on:
18384
18426
  description: Timestamp when the log was created
18385
18427
  format: date-time
@@ -18390,7 +18432,8 @@ components:
18390
18432
  - additionalProperties: true
18391
18433
  type: object
18392
18434
  - type: 'null'
18393
- description: Changes made to the object
18435
+ description: Snapshot of the whole object after the action; its shape depends
18436
+ on `object_type`
18394
18437
  title: Details
18395
18438
  object_id:
18396
18439
  description: ID of the object
@@ -18429,6 +18472,26 @@ components:
18429
18472
  - created_on
18430
18473
  title: ObjectLog
18431
18474
  type: object
18475
+ ObjectLogChange:
18476
+ properties:
18477
+ field:
18478
+ description: Dot-separated path of the field in the object, for example
18479
+ `renewal_mode` or `contacts.registrant`
18480
+ title: Field
18481
+ type: string
18482
+ new_value:
18483
+ description: Value of the field in this log; `null` when the field was absent
18484
+ title: New Value
18485
+ old_value:
18486
+ description: Value of the field in the object's previous log; `null` when
18487
+ the field was absent
18488
+ title: Old Value
18489
+ required:
18490
+ - field
18491
+ - old_value
18492
+ - new_value
18493
+ title: ObjectLogChange
18494
+ type: object
18432
18495
  ObjectLogSortField:
18433
18496
  enum:
18434
18497
  - object_log_id
@@ -25072,7 +25135,7 @@ info:
25072
25135
  \n\n"
25073
25136
  summary: OpusDNS - your gateway to a seamless domain management experience.
25074
25137
  title: OpusDNS API
25075
- version: 2026-10-14-124056
25138
+ version: 2026-10-15-162027
25076
25139
  x-logo:
25077
25140
  altText: OpusDNS API Reference
25078
25141
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -33766,7 +33829,7 @@ paths:
33766
33829
  (user tags) and `status_tags` fields, which are otherwise null; filtering
33767
33830
  by `tag_ids` or `status_tags` alone does not populate them. `connected_account`
33768
33831
  populates the `connected_account` field for domains held at an external
33769
- registrar.
33832
+ registrar or on the organization's own registry accreditation (AMS).
33770
33833
  in: query
33771
33834
  name: include
33772
33835
  required: false
@@ -33780,7 +33843,8 @@ paths:
33780
33843
  `tags` (user tags) and `status_tags` fields, which are otherwise null;
33781
33844
  filtering by `tag_ids` or `status_tags` alone does not populate them.
33782
33845
  `connected_account` populates the `connected_account` field for domains
33783
- held at an external registrar.
33846
+ held at an external registrar or on the organization's own registry accreditation
33847
+ (AMS).
33784
33848
  title: Include
33785
33849
  - $ref: '#/components/parameters/DatetimeFormatHeader'
33786
33850
  responses:
@@ -35541,8 +35605,9 @@ paths:
35541
35605
  - description: Extra data to include in the response. `tags` populates the `tags`
35542
35606
  and `status_tags` fields, which are otherwise null. `renewal_price` resolves
35543
35607
  the domain's renewal price. `connected_account` populates the `connected_account`
35544
- field for domains held at an external registrar. `registrant_change` populates
35545
- the `registrant_change` field with the change of registrant in progress.
35608
+ field for domains held at an external registrar or on the organization's
35609
+ own registry accreditation (AMS). `registrant_change` populates the `registrant_change`
35610
+ field with the change of registrant in progress.
35546
35611
  in: query
35547
35612
  name: include
35548
35613
  required: false
@@ -35555,7 +35620,8 @@ paths:
35555
35620
  description: Extra data to include in the response. `tags` populates the
35556
35621
  `tags` and `status_tags` fields, which are otherwise null. `renewal_price`
35557
35622
  resolves the domain's renewal price. `connected_account` populates the
35558
- `connected_account` field for domains held at an external registrar. `registrant_change`
35623
+ `connected_account` field for domains held at an external registrar or
35624
+ on the organization's own registry accreditation (AMS). `registrant_change`
35559
35625
  populates the `registrant_change` field with the change of registrant
35560
35626
  in progress.
35561
35627
  title: Include
package/src/schema.d.ts CHANGED
@@ -11473,6 +11473,23 @@ export interface components {
11473
11473
  * @enum {string}
11474
11474
  */
11475
11475
  DnssecStatus: "enabled" | "disabled";
11476
+ /** DomainAmsAccountResponse */
11477
+ DomainAmsAccountResponse: {
11478
+ /** @description The registry the account is accredited at */
11479
+ registry: components["schemas"]["RegistryServiceBackend"];
11480
+ /**
11481
+ * Registry Account Id
11482
+ * Format: typeid
11483
+ * @description The registry account the domain is held on
11484
+ * @example registry_account_01h45ytscbebyvny4gc8cr8ma2
11485
+ */
11486
+ registry_account_id: TypeId<"registry_account">;
11487
+ /**
11488
+ * @description Kind of connected account. `ams`: the organization's own registry accreditation, on which OpusDNS manages the domain. (enum property replaced by openapi-typescript)
11489
+ * @enum {string}
11490
+ */
11491
+ type: "ams";
11492
+ };
11476
11493
  /**
11477
11494
  * DomainAttributeKey
11478
11495
  * @enum {string}
@@ -12885,9 +12902,9 @@ export interface components {
12885
12902
  canceled_on?: Date | null;
12886
12903
  /**
12887
12904
  * Connected Account
12888
- * @description The connected account this domain is synced from. Null unless `include=connected_account` is requested, and null even then for natively registered domains, for domains on operator-managed registry accounts, and when the connected account was deleted.
12905
+ * @description The connected account this domain is synced from or managed on: a registrar credential (`ras`) or the organization's own registry accreditation (`ams`). Null unless `include=connected_account` is requested, and null even then for natively registered domains, for domains on operator-managed registry accounts, and when the connected account was deleted.
12889
12906
  */
12890
- connected_account?: components["schemas"]["DomainRegistrarCredentialResponse"] | null;
12907
+ connected_account?: (components["schemas"]["DomainRegistrarCredentialResponse"] | components["schemas"]["DomainAmsAccountResponse"]) | null;
12891
12908
  /**
12892
12909
  * Contacts
12893
12910
  * @description The contacts of the domain
@@ -16304,6 +16321,11 @@ export interface components {
16304
16321
  ObjectLog: {
16305
16322
  /** @description Action performed */
16306
16323
  action: components["schemas"]["ObjectEventType"];
16324
+ /**
16325
+ * Changes
16326
+ * @description Fields that differ from the object's previous log in the same organization. Empty when nothing changed; `null` when there was no previous log to compare with: the object's first log in the organization, or a log written before changes were recorded. `updated_on` is not compared, arrays are compared regardless of order and reported whole, and sensitive values such as `auth_code` read `***REDACTED***`.
16327
+ */
16328
+ changes?: components["schemas"]["ObjectLogChange"][] | null;
16307
16329
  /**
16308
16330
  * Created On
16309
16331
  * Format: date-time
@@ -16312,7 +16334,7 @@ export interface components {
16312
16334
  created_on: Date;
16313
16335
  /**
16314
16336
  * Details
16315
- * @description Changes made to the object
16337
+ * @description Snapshot of the whole object after the action; its shape depends on `object_type`
16316
16338
  */
16317
16339
  details?: {
16318
16340
  [key: string]: unknown;
@@ -16345,6 +16367,24 @@ export interface components {
16345
16367
  */
16346
16368
  server_request_id?: string | null;
16347
16369
  };
16370
+ /** ObjectLogChange */
16371
+ ObjectLogChange: {
16372
+ /**
16373
+ * Field
16374
+ * @description Dot-separated path of the field in the object, for example `renewal_mode` or `contacts.registrant`
16375
+ */
16376
+ field: string;
16377
+ /**
16378
+ * New Value
16379
+ * @description Value of the field in this log; `null` when the field was absent
16380
+ */
16381
+ new_value: unknown;
16382
+ /**
16383
+ * Old Value
16384
+ * @description Value of the field in the object's previous log; `null` when the field was absent
16385
+ */
16386
+ old_value: unknown;
16387
+ };
16348
16388
  /**
16349
16389
  * ObjectLogSortField
16350
16390
  * @enum {string}
@@ -26991,7 +27031,7 @@ export interface operations {
26991
27031
  account_type?: components["schemas"]["ConnectedAccountType"][] | null;
26992
27032
  /** @description How to apply `account_type`: `match_any` keeps the domains on any of the listed types, `match_none` the domains on none of them (so `account_type=ras&account_type_mode=match_none` keeps every domain not on a RAS account, and naming every type keeps none). Has no effect without `account_type`. */
26993
27033
  account_type_mode?: components["schemas"]["AccountTypeFilterMode"];
26994
- /** @description Extra data to include in each result. `tags` populates the `tags` (user tags) and `status_tags` fields, which are otherwise null; filtering by `tag_ids` or `status_tags` alone does not populate them. `connected_account` populates the `connected_account` field for domains held at an external registrar. */
27034
+ /** @description Extra data to include in each result. `tags` populates the `tags` (user tags) and `status_tags` fields, which are otherwise null; filtering by `tag_ids` or `status_tags` alone does not populate them. `connected_account` populates the `connected_account` field for domains held at an external registrar or on the organization's own registry accreditation (AMS). */
26995
27035
  include?: components["schemas"]["DomainListIncludeField"][] | null;
26996
27036
  };
26997
27037
  header?: {
@@ -28496,7 +28536,7 @@ export interface operations {
28496
28536
  get_domain_v1_domains__domain_reference__get: {
28497
28537
  parameters: {
28498
28538
  query?: {
28499
- /** @description Extra data to include in the response. `tags` populates the `tags` and `status_tags` fields, which are otherwise null. `renewal_price` resolves the domain's renewal price. `connected_account` populates the `connected_account` field for domains held at an external registrar. `registrant_change` populates the `registrant_change` field with the change of registrant in progress. */
28539
+ /** @description Extra data to include in the response. `tags` populates the `tags` and `status_tags` fields, which are otherwise null. `renewal_price` resolves the domain's renewal price. `connected_account` populates the `connected_account` field for domains held at an external registrar or on the organization's own registry accreditation (AMS). `registrant_change` populates the `registrant_change` field with the change of registrant in progress. */
28500
28540
  include?: components["schemas"]["DomainIncludeField"][] | null;
28501
28541
  };
28502
28542
  header?: {