@opusdns/api 1.191.0 → 1.192.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.191.0",
6
+ "version": "1.192.0",
7
7
  "description": "TypeScript types for the OpusDNS OpenAPI specification",
8
8
  "main": "./src/index.ts",
9
9
  "module": "./src/index.ts",
@@ -787,23 +787,23 @@ export const DOMAIN_FORWARD_ZONE_SORT_FIELD_VALUES = [
787
787
  export const DOMAIN_INCLUDE_FIELD = {
788
788
  TAGS: "tags",
789
789
  RENEWAL_PRICE: "renewal_price",
790
- REGISTRAR_CREDENTIAL: "registrar_credential",
790
+ CONNECTED_ACCOUNT: "connected_account",
791
791
  } as const satisfies Record<string, DomainIncludeField>;
792
792
 
793
793
  export const DOMAIN_INCLUDE_FIELD_VALUES = [
794
794
  'tags',
795
795
  'renewal_price',
796
- 'registrar_credential',
796
+ 'connected_account',
797
797
  ] as const satisfies ReadonlyArray<DomainIncludeField>;
798
798
 
799
799
  export const DOMAIN_LIST_INCLUDE_FIELD = {
800
800
  TAGS: "tags",
801
- REGISTRAR_CREDENTIAL: "registrar_credential",
801
+ CONNECTED_ACCOUNT: "connected_account",
802
802
  } as const satisfies Record<string, DomainListIncludeField>;
803
803
 
804
804
  export const DOMAIN_LIST_INCLUDE_FIELD_VALUES = [
805
805
  'tags',
806
- 'registrar_credential',
806
+ 'connected_account',
807
807
  ] as const satisfies ReadonlyArray<DomainListIncludeField>;
808
808
 
809
809
  export const DOMAIN_SORT_FIELD = {
@@ -2616,11 +2616,13 @@ export const KEYS_DOMAIN_RECOMMENDATIONS_CONTEXT_CREATE = [
2616
2616
  export const KEY_DOMAIN_REGISTRAR_CREDENTIAL_NAME = 'name' satisfies keyof DomainRegistrarCredential;
2617
2617
  export const KEY_DOMAIN_REGISTRAR_CREDENTIAL_REGISTRAR = 'registrar' satisfies keyof DomainRegistrarCredential;
2618
2618
  export const KEY_DOMAIN_REGISTRAR_CREDENTIAL_REGISTRAR_CREDENTIAL_ID = 'registrar_credential_id' satisfies keyof DomainRegistrarCredential;
2619
+ export const KEY_DOMAIN_REGISTRAR_CREDENTIAL_TYPE = 'type' satisfies keyof DomainRegistrarCredential;
2619
2620
 
2620
2621
  export const KEYS_DOMAIN_REGISTRAR_CREDENTIAL = [
2621
2622
  KEY_DOMAIN_REGISTRAR_CREDENTIAL_NAME,
2622
2623
  KEY_DOMAIN_REGISTRAR_CREDENTIAL_REGISTRAR,
2623
2624
  KEY_DOMAIN_REGISTRAR_CREDENTIAL_REGISTRAR_CREDENTIAL_ID,
2625
+ KEY_DOMAIN_REGISTRAR_CREDENTIAL_TYPE,
2624
2626
  ] as const satisfies (keyof DomainRegistrarCredential)[];
2625
2627
 
2626
2628
  export const KEY_DOMAIN_RENEW_REQUEST_CURRENT_EXPIRY_DATE = 'current_expiry_date' satisfies keyof DomainRenewRequest;
@@ -2666,6 +2668,7 @@ export const KEYS_DOMAIN_RENEWAL_PRICE = [
2666
2668
  export const KEY_DOMAIN_AUTH_CODE = 'auth_code' satisfies keyof Domain;
2667
2669
  export const KEY_DOMAIN_AUTH_CODE_EXPIRES_ON = 'auth_code_expires_on' satisfies keyof Domain;
2668
2670
  export const KEY_DOMAIN_CANCELED_ON = 'canceled_on' satisfies keyof Domain;
2671
+ export const KEY_DOMAIN_CONNECTED_ACCOUNT = 'connected_account' satisfies keyof Domain;
2669
2672
  export const KEY_DOMAIN_CONTACTS = 'contacts' satisfies keyof Domain;
2670
2673
  export const KEY_DOMAIN_CREATED_ON = 'created_on' satisfies keyof Domain;
2671
2674
  export const KEY_DOMAIN_DELETED_ON = 'deleted_on' satisfies keyof Domain;
@@ -2678,7 +2681,6 @@ export const KEY_DOMAIN_NAMESERVERS = 'nameservers' satisfies keyof Domain;
2678
2681
  export const KEY_DOMAIN_OWNER_ID = 'owner_id' satisfies keyof Domain;
2679
2682
  export const KEY_DOMAIN_READ_ONLY = 'read_only' satisfies keyof Domain;
2680
2683
  export const KEY_DOMAIN_REGISTERED_ON = 'registered_on' satisfies keyof Domain;
2681
- export const KEY_DOMAIN_REGISTRAR_CREDENTIAL = 'registrar_credential' satisfies keyof Domain;
2682
2684
  export const KEY_DOMAIN_REGISTRY_ACCOUNT_ID = 'registry_account_id' satisfies keyof Domain;
2683
2685
  export const KEY_DOMAIN_REGISTRY_STATUSES = 'registry_statuses' satisfies keyof Domain;
2684
2686
  export const KEY_DOMAIN_RENEWAL_MODE = 'renewal_mode' satisfies keyof Domain;
@@ -2698,6 +2700,7 @@ export const KEYS_DOMAIN = [
2698
2700
  KEY_DOMAIN_AUTH_CODE,
2699
2701
  KEY_DOMAIN_AUTH_CODE_EXPIRES_ON,
2700
2702
  KEY_DOMAIN_CANCELED_ON,
2703
+ KEY_DOMAIN_CONNECTED_ACCOUNT,
2701
2704
  KEY_DOMAIN_CONTACTS,
2702
2705
  KEY_DOMAIN_CREATED_ON,
2703
2706
  KEY_DOMAIN_DELETED_ON,
@@ -2710,7 +2713,6 @@ export const KEYS_DOMAIN = [
2710
2713
  KEY_DOMAIN_OWNER_ID,
2711
2714
  KEY_DOMAIN_READ_ONLY,
2712
2715
  KEY_DOMAIN_REGISTERED_ON,
2713
- KEY_DOMAIN_REGISTRAR_CREDENTIAL,
2714
2716
  KEY_DOMAIN_REGISTRY_ACCOUNT_ID,
2715
2717
  KEY_DOMAIN_REGISTRY_STATUSES,
2716
2718
  KEY_DOMAIN_RENEWAL_MODE,
package/src/openapi.yaml CHANGED
@@ -5442,7 +5442,7 @@ components:
5442
5442
  enum:
5443
5443
  - tags
5444
5444
  - renewal_price
5445
- - registrar_credential
5445
+ - connected_account
5446
5446
  title: DomainIncludeField
5447
5447
  type: string
5448
5448
  DomainLifecycleBase:
@@ -5604,7 +5604,7 @@ components:
5604
5604
  implement every member.'
5605
5605
  enum:
5606
5606
  - tags
5607
- - registrar_credential
5607
+ - connected_account
5608
5608
  title: DomainListIncludeField
5609
5609
  type: string
5610
5610
  DomainNameParts:
@@ -5727,7 +5727,14 @@ components:
5727
5727
  title: Registrar Credential Id
5728
5728
  type: string
5729
5729
  x-typeid-prefix: registrar_credential
5730
+ type:
5731
+ const: ras
5732
+ description: 'Kind of connected account. `ras`: a registrar credential managed
5733
+ under `/v1/connect/registrars`.'
5734
+ title: Type
5735
+ type: string
5730
5736
  required:
5737
+ - type
5731
5738
  - registrar_credential_id
5732
5739
  - name
5733
5740
  - registrar
@@ -5844,6 +5851,20 @@ components:
5844
5851
  - type: 'null'
5845
5852
  description: When the domain was deleted
5846
5853
  title: Canceled On
5854
+ connected_account:
5855
+ anyOf:
5856
+ - discriminator:
5857
+ mapping:
5858
+ ras: '#/components/schemas/DomainRegistrarCredentialResponse'
5859
+ propertyName: type
5860
+ oneOf:
5861
+ - $ref: '#/components/schemas/DomainRegistrarCredentialResponse'
5862
+ - type: 'null'
5863
+ description: The connected account this domain is synced from. Null unless
5864
+ `include=connected_account` is requested, and null even then for natively
5865
+ registered domains, for domains on operator-managed registry accounts,
5866
+ and when the connected account was deleted.
5867
+ title: Connected Account
5847
5868
  contacts:
5848
5869
  description: The contacts of the domain
5849
5870
  items:
@@ -5931,14 +5952,6 @@ components:
5931
5952
  - type: 'null'
5932
5953
  description: When the domain was registered
5933
5954
  title: Registered On
5934
- registrar_credential:
5935
- anyOf:
5936
- - $ref: '#/components/schemas/DomainRegistrarCredentialResponse'
5937
- - type: 'null'
5938
- description: The connected registrar credential this domain is synced from.
5939
- Null unless `include=registrar_credential` is requested, and null even
5940
- then for natively registered domains, for domains on operator-managed
5941
- registry accounts, and when the credential was deleted.
5942
5955
  registry_account_id:
5943
5956
  default: None
5944
5957
  examples:
@@ -17178,7 +17191,7 @@ info:
17178
17191
  \n\n"
17179
17192
  summary: OpusDNS - your gateway to a seamless domain management experience.
17180
17193
  title: OpusDNS API
17181
- version: 2026-09-22-143714
17194
+ version: 2026-09-22-153526
17182
17195
  x-logo:
17183
17196
  altText: OpusDNS API Reference
17184
17197
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -25416,7 +25429,7 @@ paths:
25416
25429
  - description: Filter domains held at an external registrar by the connected
25417
25430
  registrar credential they were synced from. Can be specified multiple times
25418
25431
  (union of all provided values); combined with `registrar`, both must match.
25419
- Matches exactly the domains whose `registrar_credential` field carries the
25432
+ Matches exactly the domains whose `connected_account` field carries the
25420
25433
  id, so domains OpusDNS sponsors never match.
25421
25434
  in: query
25422
25435
  name: registrar_credential_id
@@ -25435,13 +25448,13 @@ paths:
25435
25448
  description: Filter domains held at an external registrar by the connected
25436
25449
  registrar credential they were synced from. Can be specified multiple
25437
25450
  times (union of all provided values); combined with `registrar`, both
25438
- must match. Matches exactly the domains whose `registrar_credential` field
25451
+ must match. Matches exactly the domains whose `connected_account` field
25439
25452
  carries the id, so domains OpusDNS sponsors never match.
25440
25453
  title: Registrar Credential Id
25441
25454
  - description: Filter domains held at an external registrar by that registrar.
25442
25455
  Can be specified multiple times (union of all provided values); combined
25443
25456
  with `registrar_credential_id`, both must match. Matches exactly the domains
25444
- whose `registrar_credential` field carries the registrar, so domains OpusDNS
25457
+ whose `connected_account` field carries the registrar, so domains OpusDNS
25445
25458
  sponsors never match.
25446
25459
  in: query
25447
25460
  name: registrar
@@ -25455,13 +25468,13 @@ paths:
25455
25468
  description: Filter domains held at an external registrar by that registrar.
25456
25469
  Can be specified multiple times (union of all provided values); combined
25457
25470
  with `registrar_credential_id`, both must match. Matches exactly the domains
25458
- whose `registrar_credential` field carries the registrar, so domains OpusDNS
25471
+ whose `connected_account` field carries the registrar, so domains OpusDNS
25459
25472
  sponsors never match.
25460
25473
  title: Registrar
25461
25474
  - description: Extra data to include in each result. `tags` populates the `tags`
25462
25475
  (user tags) and `status_tags` fields, which are otherwise null; filtering
25463
- by `tag_ids` or `status_tags` alone does not populate them. `registrar_credential`
25464
- populates the `registrar_credential` field for domains held at an external
25476
+ by `tag_ids` or `status_tags` alone does not populate them. `connected_account`
25477
+ populates the `connected_account` field for domains held at an external
25465
25478
  registrar.
25466
25479
  in: query
25467
25480
  name: include
@@ -25475,8 +25488,8 @@ paths:
25475
25488
  description: Extra data to include in each result. `tags` populates the
25476
25489
  `tags` (user tags) and `status_tags` fields, which are otherwise null;
25477
25490
  filtering by `tag_ids` or `status_tags` alone does not populate them.
25478
- `registrar_credential` populates the `registrar_credential` field for
25479
- domains held at an external registrar.
25491
+ `connected_account` populates the `connected_account` field for domains
25492
+ held at an external registrar.
25480
25493
  title: Include
25481
25494
  - $ref: '#/components/parameters/DatetimeFormatHeader'
25482
25495
  responses:
@@ -27131,7 +27144,7 @@ paths:
27131
27144
  title: Domain Reference
27132
27145
  - description: Extra data to include in the response. `tags` populates the `tags`
27133
27146
  and `status_tags` fields, which are otherwise null. `renewal_price` resolves
27134
- the domain's renewal price. `registrar_credential` populates the `registrar_credential`
27147
+ the domain's renewal price. `connected_account` populates the `connected_account`
27135
27148
  field for domains held at an external registrar.
27136
27149
  in: query
27137
27150
  name: include
@@ -27144,8 +27157,8 @@ paths:
27144
27157
  - type: 'null'
27145
27158
  description: Extra data to include in the response. `tags` populates the
27146
27159
  `tags` and `status_tags` fields, which are otherwise null. `renewal_price`
27147
- resolves the domain's renewal price. `registrar_credential` populates
27148
- the `registrar_credential` field for domains held at an external registrar.
27160
+ resolves the domain's renewal price. `connected_account` populates the
27161
+ `connected_account` field for domains held at an external registrar.
27149
27162
  title: Include
27150
27163
  - $ref: '#/components/parameters/DatetimeFormatHeader'
27151
27164
  responses:
package/src/schema.d.ts CHANGED
@@ -6772,7 +6772,7 @@ export interface components {
6772
6772
  * DomainIncludeField
6773
6773
  * @enum {string}
6774
6774
  */
6775
- DomainIncludeField: "tags" | "renewal_price" | "registrar_credential";
6775
+ DomainIncludeField: "tags" | "renewal_price" | "connected_account";
6776
6776
  /** DomainLifecycleBase */
6777
6777
  DomainLifecycleBase: {
6778
6778
  /**
@@ -6861,7 +6861,7 @@ export interface components {
6861
6861
  * implement every member.
6862
6862
  * @enum {string}
6863
6863
  */
6864
- DomainListIncludeField: "tags" | "registrar_credential";
6864
+ DomainListIncludeField: "tags" | "connected_account";
6865
6865
  /** DomainNameParts */
6866
6866
  DomainNameParts: {
6867
6867
  /**
@@ -6949,6 +6949,11 @@ export interface components {
6949
6949
  * @example registrar_credential_01h45ytscbebyvny4gc8cr8ma2
6950
6950
  */
6951
6951
  registrar_credential_id: TypeId<"registrar_credential">;
6952
+ /**
6953
+ * @description Kind of connected account. `ras`: a registrar credential managed under `/v1/connect/registrars`. (enum property replaced by openapi-typescript)
6954
+ * @enum {string}
6955
+ */
6956
+ type: "ras";
6952
6957
  };
6953
6958
  /** DomainRenewRequest */
6954
6959
  DomainRenewRequest: {
@@ -7034,6 +7039,11 @@ export interface components {
7034
7039
  * @description When the domain was deleted
7035
7040
  */
7036
7041
  canceled_on?: Date | null;
7042
+ /**
7043
+ * Connected Account
7044
+ * @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.
7045
+ */
7046
+ connected_account?: components["schemas"]["DomainRegistrarCredentialResponse"] | null;
7037
7047
  /**
7038
7048
  * Contacts
7039
7049
  * @description The contacts of the domain
@@ -7102,8 +7112,6 @@ export interface components {
7102
7112
  * @description When the domain was registered
7103
7113
  */
7104
7114
  registered_on?: Date | null;
7105
- /** @description The connected registrar credential this domain is synced from. Null unless `include=registrar_credential` is requested, and null even then for natively registered domains, for domains on operator-managed registry accounts, and when the credential was deleted. */
7106
- registrar_credential?: components["schemas"]["DomainRegistrarCredentialResponse"] | null;
7107
7115
  /**
7108
7116
  * Registry Account Id
7109
7117
  * Format: typeid
@@ -20773,11 +20781,11 @@ export interface operations {
20773
20781
  transferred_before?: Date | null;
20774
20782
  /** @description Filter domains by registry status. Can be specified multiple times (union of all provided values). */
20775
20783
  registry_statuses?: string[] | null;
20776
- /** @description Filter domains held at an external registrar by the connected registrar credential they were synced from. Can be specified multiple times (union of all provided values); combined with `registrar`, both must match. Matches exactly the domains whose `registrar_credential` field carries the id, so domains OpusDNS sponsors never match. */
20784
+ /** @description Filter domains held at an external registrar by the connected registrar credential they were synced from. Can be specified multiple times (union of all provided values); combined with `registrar`, both must match. Matches exactly the domains whose `connected_account` field carries the id, so domains OpusDNS sponsors never match. */
20777
20785
  registrar_credential_id?: TypeId<"registrar_credential">[] | null;
20778
- /** @description Filter domains held at an external registrar by that registrar. Can be specified multiple times (union of all provided values); combined with `registrar_credential_id`, both must match. Matches exactly the domains whose `registrar_credential` field carries the registrar, so domains OpusDNS sponsors never match. */
20786
+ /** @description Filter domains held at an external registrar by that registrar. Can be specified multiple times (union of all provided values); combined with `registrar_credential_id`, both must match. Matches exactly the domains whose `connected_account` field carries the registrar, so domains OpusDNS sponsors never match. */
20779
20787
  registrar?: components["schemas"]["Registrar"][] | null;
20780
- /** @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. `registrar_credential` populates the `registrar_credential` field for domains held at an external registrar. */
20788
+ /** @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. */
20781
20789
  include?: components["schemas"]["DomainListIncludeField"][] | null;
20782
20790
  };
20783
20791
  header?: {
@@ -22247,7 +22255,7 @@ export interface operations {
22247
22255
  get_domain_v1_domains__domain_reference__get: {
22248
22256
  parameters: {
22249
22257
  query?: {
22250
- /** @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. `registrar_credential` populates the `registrar_credential` field for domains held at an external registrar. */
22258
+ /** @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. */
22251
22259
  include?: components["schemas"]["DomainIncludeField"][] | null;
22252
22260
  };
22253
22261
  header?: {