@opusdns/api 0.252.0 → 0.253.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.252.0",
6
+ "version": "0.253.0",
7
7
  "description": "TypeScript types for the OpusDNS OpenAPI specification",
8
8
  "main": "./src/index.ts",
9
9
  "module": "./src/index.ts",
@@ -21,7 +21,7 @@
21
21
  * ```
22
22
  */
23
23
 
24
- import { AllocationMethodType, AttributeType, BatchSortField, BatchStatus, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ComplianceStatus, ConditionOperator, ContactAttributeSetSortField, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsProtectedReason, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAttributeKey, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainForwardSortField, DomainForwardZoneSortField, DomainIncludeField, DomainSortField, DomainStatus, EmailForwardLogSortField, EmailForwardLogStatus, EmailForwardSortField, EmailForwardZoneSortField, EmailVerificationStatus, EventObjectType, EventSortField, EventSubtype, EventType, ExecutingEntity, HTTPMethod, HostStatus, HttpProtocol, InvoiceResponsePaymentStatus, InvoiceResponseStatus, InvoiceResponseType, JobStatus, LaunchPhaseType, LegalRequirementOperationType, LegalRequirementType, LocalPresenceRequirementType, MetricsGrouping, ObjectEventType, ObjectLogSortField, OrganizationSortField, OrganizationStatus, ParkingSortField, PatchOp, PeriodUnit, Permission, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, Protocol, RedirectCode, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, ReportStatus, ReportTriggerType, ReportType, RequestHistorySortField, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TagColor, TimeRange, TransferAckType, UserSortField, UserStatus, VerificationType, ZoneSortField } from './schemas';
24
+ import { AllocationMethodType, AttributeType, BatchSortField, BatchStatus, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ComplianceStatus, ConditionOperator, ContactAttributeSetSortField, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsProtectedReason, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAttributeKey, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainForwardSortField, DomainForwardZoneSortField, DomainIncludeField, DomainSortField, DomainStatus, EmailForwardLogSortField, EmailForwardLogStatus, EmailForwardSortField, EmailForwardZoneSortField, EmailVerificationStatus, EventObjectType, EventSortField, EventSubtype, EventType, ExecutingEntity, HTTPMethod, HostStatus, HttpProtocol, InvoiceResponsePaymentStatus, InvoiceResponseStatus, InvoiceResponseType, JobStatus, LaunchPhaseType, LegalRequirementOperationType, LegalRequirementType, LocalPresenceRequirementType, MetricsGrouping, ObjectEventType, ObjectLogSortField, OrganizationSortField, OrganizationStatus, ParkingSortField, PatchOp, PeriodUnit, Permission, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, Protocol, RedirectCode, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, ReportStatus, ReportTriggerType, ReportType, RequestHistorySortField, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TagColor, TagFilterMode, TimeRange, TransferAckType, UserSortField, UserStatus, VerificationType, ZoneSortField } from './schemas';
25
25
 
26
26
  /**
27
27
  * AllocationMethodType. Auto-generated enum for AllocationMethodType
@@ -4529,6 +4529,56 @@ export const TAG_COLOR_VALUES = [
4529
4529
  'color-10'
4530
4530
  ] as const satisfies [string, ...string[]] | TagColor[];
4531
4531
 
4532
+ /**
4533
+ * TagFilterMode. Auto-generated enum for TagFilterMode
4534
+ *
4535
+ * @remarks
4536
+ * This constant provides both object and array forms for the TagFilterMode enum.
4537
+ * The object form allows key-value access, while the array form enables iteration and validation.
4538
+ *
4539
+ * @example
4540
+ * ```typescript
4541
+ * // Using the object form for key-value access
4542
+ * const status = TAG_FILTER_MODE.SUCCESS;
4543
+ *
4544
+ * // Using the array form for iteration
4545
+ * const allStatuses = TAG_FILTER_MODE_VALUES;
4546
+ * console.log(`Available statuses: ${allStatuses.join(', ')}`);
4547
+ * ```
4548
+ *
4549
+ * @see {@link TagFilterMode} - The TypeScript type definition
4550
+ */
4551
+ export const TAG_FILTER_MODE = {
4552
+ MATCH_ANY: "match_any",
4553
+ MATCH_ALL: "match_all",
4554
+ } as const satisfies Record<string, TagFilterMode>;
4555
+
4556
+ /**
4557
+ * Array of all TagFilterMode enum values
4558
+ *
4559
+ * @remarks
4560
+ * This constant provides a array containing all valid TagFilterMode enum values.
4561
+ * Useful for iteration, validation, and generating dynamic UI components.
4562
+ *
4563
+ * @example
4564
+ * ```typescript
4565
+ * // Iterating through all values
4566
+ * for (const value of TAG_FILTER_MODE_VALUES) {
4567
+ * console.log(`Processing: ${value}`);
4568
+ * }
4569
+ *
4570
+ * // Validation
4571
+ * const isValid = TAG_FILTER_MODE_VALUES.includes(someValue);
4572
+ * ```
4573
+ *
4574
+ * @see {@link TagFilterMode} - The TypeScript type definition
4575
+ * @see {@link TAG_FILTER_MODE} - The object form of this enum
4576
+ */
4577
+ export const TAG_FILTER_MODE_VALUES = [
4578
+ 'match_any',
4579
+ 'match_all'
4580
+ ] as const satisfies [string, ...string[]] | TagFilterMode[];
4581
+
4532
4582
  /**
4533
4583
  * TimeRange. Auto-generated enum for TimeRange
4534
4584
  *
@@ -2639,8 +2639,8 @@ export type GET_DomainSearchSuggest_Request_Query = GET_DomainSearchSuggest_Requ
2639
2639
  * Use this type to ensure type safety when making API requests to this endpoint.
2640
2640
  *
2641
2641
  * @path /v1/domains
2642
+ * @param tag_ids (query) - Filter by tag IDs. Can be specified multiple times.
2642
2643
  * @param registry_statuses (query) - Filter domains by registry status. Can be specified multiple times (union of all provided values).
2643
- * @param tag_ids (query) - Filter domains by tag IDs (OR semantics). Can be specified multiple times.
2644
2644
  * @param include (query) - Include additional data in the response. Can be specified multiple times.
2645
2645
  *
2646
2646
  * @see {@link GET_Domains_Request_Query} - Query parameters type
@@ -2663,8 +2663,8 @@ export type GET_Domains_Request = {
2663
2663
  * Use this type to ensure type safety for query parameters.
2664
2664
  *
2665
2665
  * @path /v1/domains
2666
+ * @param tag_ids (query) - Filter by tag IDs. Can be specified multiple times.
2666
2667
  * @param registry_statuses (query) - Filter domains by registry status. Can be specified multiple times (union of all provided values).
2667
- * @param tag_ids (query) - Filter domains by tag IDs (OR semantics). Can be specified multiple times.
2668
2668
  * @param include (query) - Include additional data in the response. Can be specified multiple times.
2669
2669
  */
2670
2670
  export type GET_Domains_Request_Query = GET_Domains_Request['parameters']['query'];
@@ -5047,8 +5047,8 @@ export type GET_DomainSearchSuggest_Response_502 = Problem
5047
5047
 
5048
5048
  *
5049
5049
  * @path /v1/domains
5050
+ * @param tag_ids (query) - Filter by tag IDs. Can be specified multiple times.
5050
5051
  * @param registry_statuses (query) - Filter domains by registry status. Can be specified multiple times (union of all provided values).
5051
- * @param tag_ids (query) - Filter domains by tag IDs (OR semantics). Can be specified multiple times.
5052
5052
  * @param include (query) - Include additional data in the response. Can be specified multiple times.
5053
5053
  *
5054
5054
  * @see {@link GET_Domains_Response_200} - 200 response type
@@ -5069,8 +5069,8 @@ export type GET_Domains_Response = GET_Domains_Response_200 | GET_Domains_Respon
5069
5069
 
5070
5070
  *
5071
5071
  * @path /v1/domains
5072
+ * @param tag_ids (query) - Filter by tag IDs. Can be specified multiple times.
5072
5073
  * @param registry_statuses (query) - Filter domains by registry status. Can be specified multiple times (union of all provided values).
5073
- * @param tag_ids (query) - Filter domains by tag IDs (OR semantics). Can be specified multiple times.
5074
5074
  * @param include (query) - Include additional data in the response. Can be specified multiple times.
5075
5075
  *
5076
5076
  * @see {@link GET_Domains_Response} - The main response type definition
@@ -5089,8 +5089,8 @@ export type GET_Domains_Response_200 = Pagination_Domain
5089
5089
 
5090
5090
  *
5091
5091
  * @path /v1/domains
5092
+ * @param tag_ids (query) - Filter by tag IDs. Can be specified multiple times.
5092
5093
  * @param registry_statuses (query) - Filter domains by registry status. Can be specified multiple times (union of all provided values).
5093
- * @param tag_ids (query) - Filter domains by tag IDs (OR semantics). Can be specified multiple times.
5094
5094
  * @param include (query) - Include additional data in the response. Can be specified multiple times.
5095
5095
  *
5096
5096
  * @see {@link GET_Domains_Response} - The main response type definition
@@ -5652,6 +5652,22 @@ export type TLDType = components['schemas']['TLDType'];
5652
5652
  * @see {@link components} - The OpenAPI components schema definition
5653
5653
  */
5654
5654
  export type TagColor = components['schemas']['TagColor'];
5655
+ /**
5656
+ * TagFilterMode
5657
+ *
5658
+ * @remarks
5659
+ * Type alias for the `TagFilterMode` OpenAPI schema.
5660
+ * This type represents tagfiltermode data structures used in API requests and responses.
5661
+ *
5662
+ * @example
5663
+ * ```typescript
5664
+ * const response = await api.getTagFilterMode();
5665
+ * const item: TagFilterMode = response.results;
5666
+ * ```
5667
+ *
5668
+ * @see {@link components} - The OpenAPI components schema definition
5669
+ */
5670
+ export type TagFilterMode = components['schemas']['TagFilterMode'];
5655
5671
  /**
5656
5672
  * TimeRange
5657
5673
  *
package/src/openapi.yaml CHANGED
@@ -8676,6 +8676,12 @@ components:
8676
8676
  - color-10
8677
8677
  title: TagColor
8678
8678
  type: string
8679
+ TagFilterMode:
8680
+ enum:
8681
+ - match_any
8682
+ - match_all
8683
+ title: TagFilterMode
8684
+ type: string
8679
8685
  TimeRange:
8680
8686
  enum:
8681
8687
  - 1h
@@ -9860,7 +9866,7 @@ info:
9860
9866
  \n\n"
9861
9867
  summary: OpusDNS - your gateway to a seamless domain management experience.
9862
9868
  title: OpusDNS API
9863
- version: 2026-04-16-100706
9869
+ version: 2026-04-17-091139
9864
9870
  x-logo:
9865
9871
  altText: OpusDNS API Reference
9866
9872
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -15436,6 +15442,29 @@ paths:
15436
15442
  schema:
15437
15443
  $ref: '#/components/schemas/SortOrder'
15438
15444
  default: desc
15445
+ - description: Filter by tag IDs. Can be specified multiple times.
15446
+ in: query
15447
+ name: tag_ids
15448
+ required: false
15449
+ schema:
15450
+ anyOf:
15451
+ - items:
15452
+ examples:
15453
+ - tag_01h45ytscbebyvny4gc8cr8ma2
15454
+ format: typeid
15455
+ pattern: ^tag_[0-7][0-9a-hjkmnpq-tv-z]{25}$
15456
+ type: string
15457
+ x-typeid-prefix: tag
15458
+ type: array
15459
+ - type: 'null'
15460
+ description: Filter by tag IDs. Can be specified multiple times.
15461
+ title: Tag Ids
15462
+ - in: query
15463
+ name: tag_mode
15464
+ required: false
15465
+ schema:
15466
+ $ref: '#/components/schemas/TagFilterMode'
15467
+ default: match_any
15439
15468
  - in: query
15440
15469
  name: name
15441
15470
  required: false
@@ -15586,25 +15615,6 @@ paths:
15586
15615
  description: Filter domains by registry status. Can be specified multiple
15587
15616
  times (union of all provided values).
15588
15617
  title: Registry Statuses
15589
- - description: Filter domains by tag IDs (OR semantics). Can be specified multiple
15590
- times.
15591
- in: query
15592
- name: tag_ids
15593
- required: false
15594
- schema:
15595
- anyOf:
15596
- - items:
15597
- examples:
15598
- - tag_01h45ytscbebyvny4gc8cr8ma2
15599
- format: typeid
15600
- pattern: ^tag_[0-7][0-9a-hjkmnpq-tv-z]{25}$
15601
- type: string
15602
- x-typeid-prefix: tag
15603
- type: array
15604
- - type: 'null'
15605
- description: Filter domains by tag IDs (OR semantics). Can be specified
15606
- multiple times.
15607
- title: Tag Ids
15608
15618
  - description: Include additional data in the response. Can be specified multiple
15609
15619
  times.
15610
15620
  in: query
package/src/schema.d.ts CHANGED
@@ -7941,6 +7941,11 @@ export interface components {
7941
7941
  * @enum {string}
7942
7942
  */
7943
7943
  TagColor: "color-1" | "color-2" | "color-3" | "color-4" | "color-5" | "color-6" | "color-7" | "color-8" | "color-9" | "color-10";
7944
+ /**
7945
+ * TagFilterMode
7946
+ * @enum {string}
7947
+ */
7948
+ TagFilterMode: "match_any" | "match_all";
7944
7949
  /**
7945
7950
  * TimeRange
7946
7951
  * @enum {string}
@@ -12480,6 +12485,9 @@ export interface operations {
12480
12485
  query?: {
12481
12486
  sort_by?: components["schemas"]["DomainSortField"];
12482
12487
  sort_order?: components["schemas"]["SortOrder"];
12488
+ /** @description Filter by tag IDs. Can be specified multiple times. */
12489
+ tag_ids?: TypeId<"tag">[] | null;
12490
+ tag_mode?: components["schemas"]["TagFilterMode"];
12483
12491
  name?: string | null;
12484
12492
  search?: string | null;
12485
12493
  tld?: string | null;
@@ -12498,8 +12506,6 @@ export interface operations {
12498
12506
  registered_before?: Date | null;
12499
12507
  /** @description Filter domains by registry status. Can be specified multiple times (union of all provided values). */
12500
12508
  registry_statuses?: string[] | null;
12501
- /** @description Filter domains by tag IDs (OR semantics). Can be specified multiple times. */
12502
- tag_ids?: TypeId<"tag">[] | null;
12503
12509
  /** @description Include additional data in the response. Can be specified multiple times. */
12504
12510
  include?: components["schemas"]["DomainIncludeField"][] | null;
12505
12511
  page?: number;