@opusdns/api 1.214.0 → 1.215.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.214.0",
6
+ "version": "1.215.0",
7
7
  "description": "TypeScript types for the OpusDNS OpenAPI specification",
8
8
  "main": "./src/index.ts",
9
9
  "module": "./src/index.ts",
@@ -12,6 +12,7 @@ import type {
12
12
  BillingTransactionStatus,
13
13
  ComplianceStatus,
14
14
  ConditionOperator,
15
+ ConnectedAccountType,
15
16
  ContactAttributeSetSortField,
16
17
  ContactIncludeField,
17
18
  ContactSortField,
@@ -351,6 +352,18 @@ export const CONDITION_OPERATOR_VALUES = [
351
352
  'not_in',
352
353
  ] as const satisfies ReadonlyArray<ConditionOperator>;
353
354
 
355
+ export const CONNECTED_ACCOUNT_TYPE = {
356
+ DEFAULT: "default",
357
+ AMS: "ams",
358
+ RAS: "ras",
359
+ } as const satisfies Record<string, ConnectedAccountType>;
360
+
361
+ export const CONNECTED_ACCOUNT_TYPE_VALUES = [
362
+ 'default',
363
+ 'ams',
364
+ 'ras',
365
+ ] as const satisfies ReadonlyArray<ConnectedAccountType>;
366
+
354
367
  export const CONTACT_ATTRIBUTE_SET_SORT_FIELD = {
355
368
  LABEL: "label",
356
369
  TLD: "tld",
@@ -3060,6 +3060,7 @@ export const KEYS_DOMAIN_STATUSES_BASE = [
3060
3060
  KEY_DOMAIN_STATUSES_BASE_SUPPORTED_STATUSES,
3061
3061
  ] as const satisfies (keyof DomainStatusesBase)[];
3062
3062
 
3063
+ export const KEY_DOMAIN_SUMMARY_DATA_BY_ACCOUNT_TYPE = 'by_account_type' satisfies keyof DomainSummaryData;
3063
3064
  export const KEY_DOMAIN_SUMMARY_DATA_BY_ORGANIZATION = 'by_organization' satisfies keyof DomainSummaryData;
3064
3065
  export const KEY_DOMAIN_SUMMARY_DATA_BY_STATUS = 'by_status' satisfies keyof DomainSummaryData;
3065
3066
  export const KEY_DOMAIN_SUMMARY_DATA_BY_STATUS_TAG = 'by_status_tag' satisfies keyof DomainSummaryData;
@@ -3068,6 +3069,7 @@ export const KEY_DOMAIN_SUMMARY_DATA_EXPIRING_SOON = 'expiring_soon' satisfies k
3068
3069
  export const KEY_DOMAIN_SUMMARY_DATA_TOTAL_COUNT = 'total_count' satisfies keyof DomainSummaryData;
3069
3070
 
3070
3071
  export const KEYS_DOMAIN_SUMMARY_DATA = [
3072
+ KEY_DOMAIN_SUMMARY_DATA_BY_ACCOUNT_TYPE,
3071
3073
  KEY_DOMAIN_SUMMARY_DATA_BY_ORGANIZATION,
3072
3074
  KEY_DOMAIN_SUMMARY_DATA_BY_STATUS,
3073
3075
  KEY_DOMAIN_SUMMARY_DATA_BY_STATUS_TAG,
@@ -51,6 +51,7 @@ export type CommandError = components['schemas']['CommandError'];
51
51
  export type Communication = components['schemas']['Communication'];
52
52
  export type ComplianceStatus = components['schemas']['ComplianceStatus'];
53
53
  export type ConditionOperator = components['schemas']['ConditionOperator'];
54
+ export type ConnectedAccountType = components['schemas']['ConnectedAccountType'];
54
55
  export type ContactAttestReq = components['schemas']['ContactAttestReq'];
55
56
  export type ContactAttestRes = components['schemas']['ContactAttestRes'];
56
57
  export type ContactAttestVerificationReq = components['schemas']['ContactAttestVerificationReq'];
package/src/openapi.yaml CHANGED
@@ -8269,6 +8269,21 @@ components:
8269
8269
  - not_in
8270
8270
  title: ConditionOperator
8271
8271
  type: string
8272
+ ConnectedAccountType:
8273
+ description: 'Which domain-lifecycle product family an account bills against,
8274
+ orthogonal to the EPP backend.
8275
+
8276
+
8277
+ DEFAULT = the native `domain_lifecycle` product; AMS = the per-TLD `ams_domain_lifecycle`
8278
+
8279
+ product for domains migrated onto an OpusDNS account; RAS = the mirror / management-fee
8280
+ family.'
8281
+ enum:
8282
+ - default
8283
+ - ams
8284
+ - ras
8285
+ title: ConnectedAccountType
8286
+ type: string
8272
8287
  ContactAttestReq:
8273
8288
  properties:
8274
8289
  attestations:
@@ -13938,6 +13953,16 @@ components:
13938
13953
  type: object
13939
13954
  DomainSummaryData:
13940
13955
  properties:
13956
+ by_account_type:
13957
+ additionalProperties:
13958
+ type: integer
13959
+ description: 'The organization''s domain counts by the type of registry
13960
+ account they are held on (account_type: count), only account types with
13961
+ at least one domain; the types are those of the `account_type` list filter'
13962
+ propertyNames:
13963
+ $ref: '#/components/schemas/ConnectedAccountType'
13964
+ title: By Account Type
13965
+ type: object
13941
13966
  by_organization:
13942
13967
  additionalProperties:
13943
13968
  type: integer
@@ -13978,6 +14003,7 @@ components:
13978
14003
  - by_status
13979
14004
  - by_status_tag
13980
14005
  - by_tld
14006
+ - by_account_type
13981
14007
  - by_organization
13982
14008
  - expiring_soon
13983
14009
  title: DomainSummaryData
@@ -24856,7 +24882,7 @@ info:
24856
24882
  \n\n"
24857
24883
  summary: OpusDNS - your gateway to a seamless domain management experience.
24858
24884
  title: OpusDNS API
24859
- version: 2026-10-07-204706
24885
+ version: 2026-10-08-191153
24860
24886
  x-logo:
24861
24887
  altText: OpusDNS API Reference
24862
24888
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -33494,6 +33520,48 @@ paths:
33494
33520
  whose `connected_account` field carries the registrar, so domains OpusDNS
33495
33521
  sponsors never match.
33496
33522
  title: Registrar
33523
+ - description: 'Filter domains by the type of the registry account they are
33524
+ held on: `ras` for domains on a registrar-abstraction (RAS) account synced
33525
+ from a connected external registrar, including those whose credential has
33526
+ since been deleted (their `connected_account` is null); `ams` for domains
33527
+ managed on a customer''s own registry accreditation; `default` for all others,
33528
+ manually managed domains included (their accounts are typed `default`).
33529
+ Can be specified multiple times (union of all provided values).'
33530
+ in: query
33531
+ name: account_type
33532
+ required: false
33533
+ schema:
33534
+ anyOf:
33535
+ - items:
33536
+ $ref: '#/components/schemas/ConnectedAccountType'
33537
+ type: array
33538
+ - type: 'null'
33539
+ description: 'Filter domains by the type of the registry account they are
33540
+ held on: `ras` for domains on a registrar-abstraction (RAS) account synced
33541
+ from a connected external registrar, including those whose credential
33542
+ has since been deleted (their `connected_account` is null); `ams` for
33543
+ domains managed on a customer''s own registry accreditation; `default`
33544
+ for all others, manually managed domains included (their accounts are
33545
+ typed `default`). Can be specified multiple times (union of all provided
33546
+ values).'
33547
+ title: Account Type
33548
+ - description: 'How to apply `account_type`: `match_any` keeps the domains on
33549
+ any of the listed types, `match_none` the domains on none of them (so `account_type=ras&account_type_mode=match_none`
33550
+ lists every domain not on a RAS account, and listing every type returns
33551
+ nothing). Has no effect without `account_type`. `match_all` is refused:
33552
+ a domain has exactly one account type.'
33553
+ in: query
33554
+ name: account_type_mode
33555
+ required: false
33556
+ schema:
33557
+ $ref: '#/components/schemas/TagFilterMode'
33558
+ default: match_any
33559
+ description: 'How to apply `account_type`: `match_any` keeps the domains
33560
+ on any of the listed types, `match_none` the domains on none of them (so
33561
+ `account_type=ras&account_type_mode=match_none` lists every domain not
33562
+ on a RAS account, and listing every type returns nothing). Has no effect
33563
+ without `account_type`. `match_all` is refused: a domain has exactly one
33564
+ account type.'
33497
33565
  - description: Extra data to include in each result. `tags` populates the `tags`
33498
33566
  (user tags) and `status_tags` fields, which are otherwise null; filtering
33499
33567
  by `tag_ids` or `status_tags` alone does not populate them. `connected_account`
@@ -33944,9 +34012,10 @@ paths:
33944
34012
  /v1/domains/summary:
33945
34013
  get:
33946
34014
  description: 'Retrieves a summary of your organization''s domains, with counts
33947
- by status, status tag, TLD and
34015
+ by status, status tag, TLD,
33948
34016
 
33949
- expiration timeframe. Only `by_organization` includes sub-organizations.'
34017
+ registry account type and expiration timeframe. Only `by_organization` includes
34018
+ sub-organizations.'
33950
34019
  operationId: get_domain_summary_v1_domains_summary_get
33951
34020
  parameters:
33952
34021
  - $ref: '#/components/parameters/DatetimeFormatHeader'
package/src/schema.d.ts CHANGED
@@ -1211,8 +1211,8 @@ export interface paths {
1211
1211
  };
1212
1212
  /**
1213
1213
  * Get domain summary
1214
- * @description Retrieves a summary of your organization's domains, with counts by status, status tag, TLD and
1215
- * expiration timeframe. Only `by_organization` includes sub-organizations.
1214
+ * @description Retrieves a summary of your organization's domains, with counts by status, status tag, TLD,
1215
+ * registry account type and expiration timeframe. Only `by_organization` includes sub-organizations.
1216
1216
  */
1217
1217
  get: operations["get_domain_summary_v1_domains_summary_get"];
1218
1218
  put?: never;
@@ -9429,6 +9429,15 @@ export interface components {
9429
9429
  * @enum {string}
9430
9430
  */
9431
9431
  ConditionOperator: "equals" | "not_equals" | "in" | "not_in";
9432
+ /**
9433
+ * ConnectedAccountType
9434
+ * @description Which domain-lifecycle product family an account bills against, orthogonal to the EPP backend.
9435
+ *
9436
+ * DEFAULT = the native `domain_lifecycle` product; AMS = the per-TLD `ams_domain_lifecycle`
9437
+ * product for domains migrated onto an OpusDNS account; RAS = the mirror / management-fee family.
9438
+ * @enum {string}
9439
+ */
9440
+ ConnectedAccountType: "default" | "ams" | "ras";
9432
9441
  /** ContactAttestReq */
9433
9442
  ContactAttestReq: {
9434
9443
  /** Attestations */
@@ -13132,6 +13141,13 @@ export interface components {
13132
13141
  };
13133
13142
  /** DomainSummaryData */
13134
13143
  DomainSummaryData: {
13144
+ /**
13145
+ * By Account Type
13146
+ * @description The organization's domain counts by the type of registry account they are held on (account_type: count), only account types with at least one domain; the types are those of the `account_type` list filter
13147
+ */
13148
+ by_account_type: {
13149
+ [key: string]: number;
13150
+ };
13135
13151
  /**
13136
13152
  * By Organization
13137
13153
  * @description Domain counts for the organization and its sub-organizations, by name (name: count), only organizations with at least one domain
@@ -26701,6 +26717,10 @@ export interface operations {
26701
26717
  registrar_credential_id?: TypeId<"registrar_credential">[] | null;
26702
26718
  /** @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. */
26703
26719
  registrar?: components["schemas"]["Registrar"][] | null;
26720
+ /** @description Filter domains by the type of the registry account they are held on: `ras` for domains on a registrar-abstraction (RAS) account synced from a connected external registrar, including those whose credential has since been deleted (their `connected_account` is null); `ams` for domains managed on a customer's own registry accreditation; `default` for all others, manually managed domains included (their accounts are typed `default`). Can be specified multiple times (union of all provided values). */
26721
+ account_type?: components["schemas"]["ConnectedAccountType"][] | null;
26722
+ /** @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` lists every domain not on a RAS account, and listing every type returns nothing). Has no effect without `account_type`. `match_all` is refused: a domain has exactly one account type. */
26723
+ account_type_mode?: components["schemas"]["TagFilterMode"];
26704
26724
  /** @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. */
26705
26725
  include?: components["schemas"]["DomainListIncludeField"][] | null;
26706
26726
  };