@opusdns/api 1.147.0 → 1.149.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.5.0"
4
4
  },
5
5
  "name": "@opusdns/api",
6
- "version": "1.147.0",
6
+ "version": "1.149.0",
7
7
  "description": "TypeScript types for the OpusDNS OpenAPI specification",
8
8
  "main": "./src/index.ts",
9
9
  "module": "./src/index.ts",
@@ -89,6 +89,7 @@ import type {
89
89
  PublicScope,
90
90
  RedirectCode,
91
91
  RegistrantChangeType,
92
+ Registrar,
92
93
  RegistryHandleAttributeType,
93
94
  RegistryServiceBackend,
94
95
  RenewalMode,
@@ -768,19 +769,23 @@ export const DOMAIN_FORWARD_ZONE_SORT_FIELD_VALUES = [
768
769
  export const DOMAIN_INCLUDE_FIELD = {
769
770
  TAGS: "tags",
770
771
  RENEWAL_PRICE: "renewal_price",
772
+ REGISTRAR_CREDENTIAL: "registrar_credential",
771
773
  } as const satisfies Record<string, DomainIncludeField>;
772
774
 
773
775
  export const DOMAIN_INCLUDE_FIELD_VALUES = [
774
776
  'tags',
775
777
  'renewal_price',
778
+ 'registrar_credential',
776
779
  ] as const satisfies ReadonlyArray<DomainIncludeField>;
777
780
 
778
781
  export const DOMAIN_LIST_INCLUDE_FIELD = {
779
782
  TAGS: "tags",
783
+ REGISTRAR_CREDENTIAL: "registrar_credential",
780
784
  } as const satisfies Record<string, DomainListIncludeField>;
781
785
 
782
786
  export const DOMAIN_LIST_INCLUDE_FIELD_VALUES = [
783
787
  'tags',
788
+ 'registrar_credential',
784
789
  ] as const satisfies ReadonlyArray<DomainListIncludeField>;
785
790
 
786
791
  export const DOMAIN_SORT_FIELD = {
@@ -1586,6 +1591,30 @@ export const REGISTRANT_CHANGE_TYPE_VALUES = [
1586
1591
  'trade',
1587
1592
  ] as const satisfies ReadonlyArray<RegistrantChangeType>;
1588
1593
 
1594
+ export const REGISTRAR = {
1595
+ INTERNETX: "INTERNETX",
1596
+ MONIKER: "MONIKER",
1597
+ DOMAIN_BESTELLSYSTEM: "DOMAIN_BESTELLSYSTEM",
1598
+ CENTRALNIC: "CENTRALNIC",
1599
+ NICMANAGER: "NICMANAGER",
1600
+ OPUSDNS: "OPUSDNS",
1601
+ ENOM: "ENOM",
1602
+ OPENSRS: "OPENSRS",
1603
+ NIC_DIRECT: "NIC_DIRECT",
1604
+ } as const satisfies Record<string, Registrar>;
1605
+
1606
+ export const REGISTRAR_VALUES = [
1607
+ 'INTERNETX',
1608
+ 'MONIKER',
1609
+ 'DOMAIN_BESTELLSYSTEM',
1610
+ 'CENTRALNIC',
1611
+ 'NICMANAGER',
1612
+ 'OPUSDNS',
1613
+ 'ENOM',
1614
+ 'OPENSRS',
1615
+ 'NIC_DIRECT',
1616
+ ] as const satisfies ReadonlyArray<Registrar>;
1617
+
1589
1618
  export const REGISTRY_HANDLE_ATTRIBUTE_TYPE = {
1590
1619
  AT_EXT_CONTACT_TYPE: "at-ext-contact:type",
1591
1620
  DE_CONTACT_TYPE: "DE_CONTACT_TYPE",
@@ -177,6 +177,7 @@ import type {
177
177
  DomainPeriod,
178
178
  DomainRecommendationsContext,
179
179
  DomainRecommendationsContextCreate,
180
+ DomainRegistrarCredential,
180
181
  DomainRenewRequest,
181
182
  DomainRenew,
182
183
  DomainRenewalDetails,
@@ -2552,6 +2553,16 @@ export const KEYS_DOMAIN_RECOMMENDATIONS_CONTEXT_CREATE = [
2552
2553
  KEY_DOMAIN_RECOMMENDATIONS_CONTEXT_CREATE_PAYLOAD,
2553
2554
  ] as const satisfies (keyof DomainRecommendationsContextCreate)[];
2554
2555
 
2556
+ export const KEY_DOMAIN_REGISTRAR_CREDENTIAL_NAME = 'name' satisfies keyof DomainRegistrarCredential;
2557
+ export const KEY_DOMAIN_REGISTRAR_CREDENTIAL_REGISTRAR = 'registrar' satisfies keyof DomainRegistrarCredential;
2558
+ export const KEY_DOMAIN_REGISTRAR_CREDENTIAL_REGISTRAR_CREDENTIAL_ID = 'registrar_credential_id' satisfies keyof DomainRegistrarCredential;
2559
+
2560
+ export const KEYS_DOMAIN_REGISTRAR_CREDENTIAL = [
2561
+ KEY_DOMAIN_REGISTRAR_CREDENTIAL_NAME,
2562
+ KEY_DOMAIN_REGISTRAR_CREDENTIAL_REGISTRAR,
2563
+ KEY_DOMAIN_REGISTRAR_CREDENTIAL_REGISTRAR_CREDENTIAL_ID,
2564
+ ] as const satisfies (keyof DomainRegistrarCredential)[];
2565
+
2555
2566
  export const KEY_DOMAIN_RENEW_REQUEST_CURRENT_EXPIRY_DATE = 'current_expiry_date' satisfies keyof DomainRenewRequest;
2556
2567
  export const KEY_DOMAIN_RENEW_REQUEST_EXPECTED_PRICE = 'expected_price' satisfies keyof DomainRenewRequest;
2557
2568
  export const KEY_DOMAIN_RENEW_REQUEST_PERIOD = 'period' satisfies keyof DomainRenewRequest;
@@ -2607,6 +2618,7 @@ export const KEY_DOMAIN_NAMESERVERS = 'nameservers' satisfies keyof Domain;
2607
2618
  export const KEY_DOMAIN_OWNER_ID = 'owner_id' satisfies keyof Domain;
2608
2619
  export const KEY_DOMAIN_READ_ONLY = 'read_only' satisfies keyof Domain;
2609
2620
  export const KEY_DOMAIN_REGISTERED_ON = 'registered_on' satisfies keyof Domain;
2621
+ export const KEY_DOMAIN_REGISTRAR_CREDENTIAL = 'registrar_credential' satisfies keyof Domain;
2610
2622
  export const KEY_DOMAIN_REGISTRY_ACCOUNT_ID = 'registry_account_id' satisfies keyof Domain;
2611
2623
  export const KEY_DOMAIN_REGISTRY_STATUSES = 'registry_statuses' satisfies keyof Domain;
2612
2624
  export const KEY_DOMAIN_RENEWAL_MODE = 'renewal_mode' satisfies keyof Domain;
@@ -2638,6 +2650,7 @@ export const KEYS_DOMAIN = [
2638
2650
  KEY_DOMAIN_OWNER_ID,
2639
2651
  KEY_DOMAIN_READ_ONLY,
2640
2652
  KEY_DOMAIN_REGISTERED_ON,
2653
+ KEY_DOMAIN_REGISTRAR_CREDENTIAL,
2641
2654
  KEY_DOMAIN_REGISTRY_ACCOUNT_ID,
2642
2655
  KEY_DOMAIN_REGISTRY_STATUSES,
2643
2656
  KEY_DOMAIN_RENEWAL_MODE,
@@ -221,6 +221,7 @@ export type DomainNameParts = components['schemas']['DomainNameParts'];
221
221
  export type DomainPeriod = components['schemas']['DomainPeriod'];
222
222
  export type DomainRecommendationsContext = components['schemas']['DomainRecommendationsContext'];
223
223
  export type DomainRecommendationsContextCreate = components['schemas']['DomainRecommendationsContextCreate'];
224
+ export type DomainRegistrarCredential = components['schemas']['DomainRegistrarCredentialResponse'];
224
225
  export type DomainRenewRequest = components['schemas']['DomainRenewRequest'];
225
226
  export type DomainRenew = components['schemas']['DomainRenewResponse'];
226
227
  export type DomainRenewalDetails = components['schemas']['DomainRenewalDetails'];
@@ -484,6 +485,7 @@ export type RdapBase = components['schemas']['RdapBase'];
484
485
  export type RedirectCode = components['schemas']['RedirectCode'];
485
486
  export type ReferrerStatsBucket = components['schemas']['ReferrerStatsBucket'];
486
487
  export type RegistrantChangeType = components['schemas']['RegistrantChangeType'];
488
+ export type Registrar = components['schemas']['Registrar'];
487
489
  export type RegistrarContact = components['schemas']['RegistrarContact'];
488
490
  export type RegistrarDomain = components['schemas']['RegistrarDomain'];
489
491
  export type RegistrarNameserver = components['schemas']['RegistrarNameserver'];
package/src/openapi.yaml CHANGED
@@ -5192,6 +5192,7 @@ components:
5192
5192
  enum:
5193
5193
  - tags
5194
5194
  - renewal_price
5195
+ - registrar_credential
5195
5196
  title: DomainIncludeField
5196
5197
  type: string
5197
5198
  DomainLifecycleBase:
@@ -5345,9 +5346,15 @@ components:
5345
5346
 
5346
5347
  costs a registry check plus a billing call per premium domain, which a page
5347
5348
 
5348
- of results would multiply into a registry rate-limit problem.'
5349
+ of results would multiply into a registry rate-limit problem.
5350
+
5351
+
5352
+ Also typed on the internal domains-service list request, which implements
5353
+
5354
+ only `TAGS`; the public list route is the only consumer of every member.'
5349
5355
  enum:
5350
5356
  - tags
5357
+ - registrar_credential
5351
5358
  title: DomainListIncludeField
5352
5359
  type: string
5353
5360
  DomainNameParts:
@@ -5452,6 +5459,30 @@ components:
5452
5459
  - payload
5453
5460
  title: DomainRecommendationsContextCreate
5454
5461
  type: object
5462
+ DomainRegistrarCredentialResponse:
5463
+ properties:
5464
+ name:
5465
+ description: Human-readable name for this credential
5466
+ title: Name
5467
+ type: string
5468
+ registrar:
5469
+ $ref: '#/components/schemas/Registrar'
5470
+ description: The registrar this credential is for
5471
+ registrar_credential_id:
5472
+ description: Unique identifier for this credential
5473
+ examples:
5474
+ - registrar_credential_01h45ytscbebyvny4gc8cr8ma2
5475
+ format: typeid
5476
+ pattern: ^registrar_credential_[0-7][0-9a-hjkmnpq-tv-z]{25}$
5477
+ title: Registrar Credential Id
5478
+ type: string
5479
+ x-typeid-prefix: registrar_credential
5480
+ required:
5481
+ - registrar_credential_id
5482
+ - name
5483
+ - registrar
5484
+ title: DomainRegistrarCredentialResponse
5485
+ type: object
5455
5486
  DomainRenewRequest:
5456
5487
  properties:
5457
5488
  current_expiry_date:
@@ -5650,6 +5681,14 @@ components:
5650
5681
  - type: 'null'
5651
5682
  description: When the domain was registered
5652
5683
  title: Registered On
5684
+ registrar_credential:
5685
+ anyOf:
5686
+ - $ref: '#/components/schemas/DomainRegistrarCredentialResponse'
5687
+ - type: 'null'
5688
+ description: The connected registrar credential this domain is synced from.
5689
+ Null unless `include=registrar_credential` is requested, and null even
5690
+ then for natively registered domains, for domains on operator-managed
5691
+ registry accounts, and when the credential was deleted.
5653
5692
  registry_account_id:
5654
5693
  default: None
5655
5694
  examples:
@@ -12267,6 +12306,19 @@ components:
12267
12306
  - trade
12268
12307
  title: RegistrantChangeType
12269
12308
  type: string
12309
+ Registrar:
12310
+ enum:
12311
+ - INTERNETX
12312
+ - MONIKER
12313
+ - DOMAIN_BESTELLSYSTEM
12314
+ - CENTRALNIC
12315
+ - NICMANAGER
12316
+ - OPUSDNS
12317
+ - ENOM
12318
+ - OPENSRS
12319
+ - NIC_DIRECT
12320
+ title: Registrar
12321
+ type: string
12270
12322
  RegistrarContact:
12271
12323
  properties:
12272
12324
  city:
@@ -15898,7 +15950,7 @@ info:
15898
15950
  \n\n"
15899
15951
  summary: OpusDNS - your gateway to a seamless domain management experience.
15900
15952
  title: OpusDNS API
15901
- version: 2026-09-01-130544
15953
+ version: 2026-09-02-191532
15902
15954
  x-logo:
15903
15955
  altText: OpusDNS API Reference
15904
15956
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -24016,7 +24068,9 @@ paths:
24016
24068
  title: Registry Statuses
24017
24069
  - description: Extra data to include in each result. `tags` populates the `tags`
24018
24070
  (user tags) and `status_tags` fields, which are otherwise null; filtering
24019
- by `tag_ids` or `status_tags` alone does not populate them.
24071
+ by `tag_ids` or `status_tags` alone does not populate them. `registrar_credential`
24072
+ populates the `registrar_credential` field for domains held at an external
24073
+ registrar.
24020
24074
  in: query
24021
24075
  name: include
24022
24076
  required: false
@@ -24029,6 +24083,8 @@ paths:
24029
24083
  description: Extra data to include in each result. `tags` populates the
24030
24084
  `tags` (user tags) and `status_tags` fields, which are otherwise null;
24031
24085
  filtering by `tag_ids` or `status_tags` alone does not populate them.
24086
+ `registrar_credential` populates the `registrar_credential` field for
24087
+ domains held at an external registrar.
24032
24088
  title: Include
24033
24089
  - $ref: '#/components/parameters/DatetimeFormatHeader'
24034
24090
  responses:
@@ -25588,7 +25644,8 @@ paths:
25588
25644
  title: Domain Reference
25589
25645
  - description: Extra data to include in the response. `tags` populates the `tags`
25590
25646
  and `status_tags` fields, which are otherwise null. `renewal_price` resolves
25591
- the domain's renewal price.
25647
+ the domain's renewal price. `registrar_credential` populates the `registrar_credential`
25648
+ field for domains held at an external registrar.
25592
25649
  in: query
25593
25650
  name: include
25594
25651
  required: false
@@ -25600,7 +25657,8 @@ paths:
25600
25657
  - type: 'null'
25601
25658
  description: Extra data to include in the response. `tags` populates the
25602
25659
  `tags` and `status_tags` fields, which are otherwise null. `renewal_price`
25603
- resolves the domain's renewal price.
25660
+ resolves the domain's renewal price. `registrar_credential` populates
25661
+ the `registrar_credential` field for domains held at an external registrar.
25604
25662
  title: Include
25605
25663
  - $ref: '#/components/parameters/DatetimeFormatHeader'
25606
25664
  responses:
@@ -29463,13 +29521,15 @@ paths:
29463
29521
  '422':
29464
29522
  content:
29465
29523
  application/problem+json:
29466
- example:
29467
- code: ERROR_INDEPENDENT_BILLING_NOT_ALLOWED
29468
- detail: Independent billing mode is only allowed for sub-organizations
29469
- of a billing organization.
29470
- status: 422
29471
- title: Organization Management Error
29472
- type: independent-billing-not-allowed
29524
+ examples:
29525
+ Organization Management Error:
29526
+ value:
29527
+ code: ERROR_INDEPENDENT_BILLING_NOT_APPROVED
29528
+ detail: The parent organization is not approved to create sub-organizations
29529
+ with independent billing.
29530
+ status: 422
29531
+ title: Organization Management Error
29532
+ type: independent-billing-not-approved
29473
29533
  schema:
29474
29534
  $ref: '#/components/schemas/Problem'
29475
29535
  description: Unprocessable Content
package/src/schema.d.ts CHANGED
@@ -6425,7 +6425,7 @@ export interface components {
6425
6425
  * DomainIncludeField
6426
6426
  * @enum {string}
6427
6427
  */
6428
- DomainIncludeField: "tags" | "renewal_price";
6428
+ DomainIncludeField: "tags" | "renewal_price" | "registrar_credential";
6429
6429
  /** DomainLifecycleBase */
6430
6430
  DomainLifecycleBase: {
6431
6431
  /**
@@ -6509,9 +6509,12 @@ export interface components {
6509
6509
  * Deliberately narrower than `DomainIncludeField`: resolving a renewal price
6510
6510
  * costs a registry check plus a billing call per premium domain, which a page
6511
6511
  * of results would multiply into a registry rate-limit problem.
6512
+ *
6513
+ * Also typed on the internal domains-service list request, which implements
6514
+ * only `TAGS`; the public list route is the only consumer of every member.
6512
6515
  * @enum {string}
6513
6516
  */
6514
- DomainListIncludeField: "tags";
6517
+ DomainListIncludeField: "tags" | "registrar_credential";
6515
6518
  /** DomainNameParts */
6516
6519
  DomainNameParts: {
6517
6520
  /**
@@ -6583,6 +6586,23 @@ export interface components {
6583
6586
  kind: "domain_recommendations";
6584
6587
  payload: components["schemas"]["ContextPayload_DomainSearchSuggestionWithPrice_"];
6585
6588
  };
6589
+ /** DomainRegistrarCredentialResponse */
6590
+ DomainRegistrarCredentialResponse: {
6591
+ /**
6592
+ * Name
6593
+ * @description Human-readable name for this credential
6594
+ */
6595
+ name: string;
6596
+ /** @description The registrar this credential is for */
6597
+ registrar: components["schemas"]["Registrar"];
6598
+ /**
6599
+ * Registrar Credential Id
6600
+ * Format: typeid
6601
+ * @description Unique identifier for this credential
6602
+ * @example registrar_credential_01h45ytscbebyvny4gc8cr8ma2
6603
+ */
6604
+ registrar_credential_id: TypeId<"registrar_credential">;
6605
+ };
6586
6606
  /** DomainRenewRequest */
6587
6607
  DomainRenewRequest: {
6588
6608
  /**
@@ -6735,6 +6755,8 @@ export interface components {
6735
6755
  * @description When the domain was registered
6736
6756
  */
6737
6757
  registered_on?: Date | null;
6758
+ /** @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. */
6759
+ registrar_credential?: components["schemas"]["DomainRegistrarCredentialResponse"] | null;
6738
6760
  /**
6739
6761
  * Registry Account Id
6740
6762
  * Format: typeid
@@ -11117,6 +11139,11 @@ export interface components {
11117
11139
  * @enum {string}
11118
11140
  */
11119
11141
  RegistrantChangeType: "update" | "trade";
11142
+ /**
11143
+ * Registrar
11144
+ * @enum {string}
11145
+ */
11146
+ Registrar: "INTERNETX" | "MONIKER" | "DOMAIN_BESTELLSYSTEM" | "CENTRALNIC" | "NICMANAGER" | "OPUSDNS" | "ENOM" | "OPENSRS" | "NIC_DIRECT";
11120
11147
  /** RegistrarContact */
11121
11148
  RegistrarContact: {
11122
11149
  /** City */
@@ -19537,7 +19564,7 @@ export interface operations {
19537
19564
  transferred_before?: Date | null;
19538
19565
  /** @description Filter domains by registry status. Can be specified multiple times (union of all provided values). */
19539
19566
  registry_statuses?: string[] | null;
19540
- /** @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. */
19567
+ /** @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. */
19541
19568
  include?: components["schemas"]["DomainListIncludeField"][] | null;
19542
19569
  };
19543
19570
  header?: {
@@ -20965,7 +20992,7 @@ export interface operations {
20965
20992
  get_domain_v1_domains__domain_reference__get: {
20966
20993
  parameters: {
20967
20994
  query?: {
20968
- /** @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. */
20995
+ /** @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. */
20969
20996
  include?: components["schemas"]["DomainIncludeField"][] | null;
20970
20997
  };
20971
20998
  header?: {
@@ -24022,13 +24049,6 @@ export interface operations {
24022
24049
  [name: string]: unknown;
24023
24050
  };
24024
24051
  content: {
24025
- /** @example {
24026
- * "code": "ERROR_INDEPENDENT_BILLING_NOT_ALLOWED",
24027
- * "detail": "Independent billing mode is only allowed for sub-organizations of a billing organization.",
24028
- * "status": 422,
24029
- * "title": "Organization Management Error",
24030
- * "type": "independent-billing-not-allowed"
24031
- * } */
24032
24052
  "application/problem+json": components["schemas"]["Problem"];
24033
24053
  };
24034
24054
  };