@opusdns/api 0.274.0 → 0.276.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.274.0",
6
+ "version": "0.276.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, TagFilterMode, TagSortField, TagType, TimeRange, TransferAckType, UserSortField, UserStatus, VerificationType, ZoneIncludeField, ZoneSortField } from './schemas';
24
+ import { AllocationMethodType, AttributeType, BatchSortField, BatchStatus, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ComplianceStatus, ConditionOperator, ContactAttributeSetSortField, ContactIncludeField, 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, TagSortField, TagType, TimeRange, TransferAckType, UserSortField, UserStatus, VerificationType, ZoneIncludeField, ZoneSortField } from './schemas';
25
25
 
26
26
  /**
27
27
  * AllocationMethodType. Auto-generated enum for AllocationMethodType
@@ -627,6 +627,54 @@ export const CONTACT_ATTRIBUTE_SET_SORT_FIELD_VALUES = [
627
627
  'updated_on'
628
628
  ] as const satisfies [string, ...string[]] | ContactAttributeSetSortField[];
629
629
 
630
+ /**
631
+ * ContactIncludeField. Auto-generated enum for ContactIncludeField
632
+ *
633
+ * @remarks
634
+ * This constant provides both object and array forms for the ContactIncludeField enum.
635
+ * The object form allows key-value access, while the array form enables iteration and validation.
636
+ *
637
+ * @example
638
+ * ```typescript
639
+ * // Using the object form for key-value access
640
+ * const status = CONTACT_INCLUDE_FIELD.SUCCESS;
641
+ *
642
+ * // Using the array form for iteration
643
+ * const allStatuses = CONTACT_INCLUDE_FIELD_VALUES;
644
+ * console.log(`Available statuses: ${allStatuses.join(', ')}`);
645
+ * ```
646
+ *
647
+ * @see {@link ContactIncludeField} - The TypeScript type definition
648
+ */
649
+ export const CONTACT_INCLUDE_FIELD = {
650
+ TAGS: "tags",
651
+ } as const satisfies Record<string, ContactIncludeField>;
652
+
653
+ /**
654
+ * Array of all ContactIncludeField enum values
655
+ *
656
+ * @remarks
657
+ * This constant provides a array containing all valid ContactIncludeField enum values.
658
+ * Useful for iteration, validation, and generating dynamic UI components.
659
+ *
660
+ * @example
661
+ * ```typescript
662
+ * // Iterating through all values
663
+ * for (const value of CONTACT_INCLUDE_FIELD_VALUES) {
664
+ * console.log(`Processing: ${value}`);
665
+ * }
666
+ *
667
+ * // Validation
668
+ * const isValid = CONTACT_INCLUDE_FIELD_VALUES.includes(someValue);
669
+ * ```
670
+ *
671
+ * @see {@link ContactIncludeField} - The TypeScript type definition
672
+ * @see {@link CONTACT_INCLUDE_FIELD} - The object form of this enum
673
+ */
674
+ export const CONTACT_INCLUDE_FIELD_VALUES = [
675
+ 'tags'
676
+ ] as const satisfies [string, ...string[]] | ContactIncludeField[];
677
+
630
678
  /**
631
679
  * ContactSortField. Auto-generated enum for ContactSortField
632
680
  *
@@ -4740,6 +4740,31 @@ export const KEY_CONTACT_STATE: keyof Contact = 'state';
4740
4740
  * @see {@link KEYS_CONTACT} - Array of all keys for this type
4741
4741
  */
4742
4742
  export const KEY_CONTACT_STREET: keyof Contact = 'street';
4743
+ /**
4744
+ * Tags
4745
+ *
4746
+ * Tags assigned to this contact
4747
+ *
4748
+ *
4749
+ *
4750
+ * @remarks
4751
+ * This key constant provides type-safe access to the `tags` property of Contact objects.
4752
+ * Use this constant when you need to access properties dynamically or ensure type safety.
4753
+ *
4754
+ * @example
4755
+ * ```typescript
4756
+ * // Direct property access
4757
+ * const value = contact[KEY_CONTACT_TAGS];
4758
+ *
4759
+ * // Dynamic property access
4760
+ * const propertyName = KEY_CONTACT_TAGS;
4761
+ * const value = contact[propertyName];
4762
+ * ```
4763
+ *
4764
+ * @see {@link Contact} - The TypeScript type definition
4765
+ * @see {@link KEYS_CONTACT} - Array of all keys for this type
4766
+ */
4767
+ export const KEY_CONTACT_TAGS: keyof Contact = 'tags';
4743
4768
  /**
4744
4769
  * Title
4745
4770
  *
@@ -4803,6 +4828,7 @@ export const KEYS_CONTACT = [
4803
4828
  KEY_CONTACT_POSTAL_CODE,
4804
4829
  KEY_CONTACT_STATE,
4805
4830
  KEY_CONTACT_STREET,
4831
+ KEY_CONTACT_TAGS,
4806
4832
  KEY_CONTACT_TITLE,
4807
4833
  ] as const satisfies (keyof Contact)[];
4808
4834
 
@@ -451,6 +451,8 @@ export type POST_AvailabilityStream_Request_Body = POST_AvailabilityStream_Reque
451
451
  * Use this type to ensure type safety when making API requests to this endpoint.
452
452
  *
453
453
  * @path /v1/contacts
454
+ * @param tag_ids (query) - Filter by tag IDs. Can be specified multiple times.
455
+ * @param include (query) - Include additional data in the response. Can be specified multiple times.
454
456
  *
455
457
  * @see {@link GET_Contacts_Request_Query} - Query parameters type
456
458
  * @see {@link GET_Contacts_Request_Path} - Path parameters type
@@ -472,6 +474,8 @@ export type GET_Contacts_Request = {
472
474
  * Use this type to ensure type safety for query parameters.
473
475
  *
474
476
  * @path /v1/contacts
477
+ * @param tag_ids (query) - Filter by tag IDs. Can be specified multiple times.
478
+ * @param include (query) - Include additional data in the response. Can be specified multiple times.
475
479
  */
476
480
  export type GET_Contacts_Request_Query = GET_Contacts_Request['parameters']['query'];
477
481
 
@@ -774,9 +778,23 @@ export type DELETE_ContactsContactId_Request_Path = DELETE_ContactsContactId_Req
774
778
  */
775
779
  export type GET_ContactsContactId_Request = {
776
780
  parameters: {
781
+ query: operations['get_contact_v1_contacts__contact_id__get']['parameters']['query'];
777
782
  path: operations['get_contact_v1_contacts__contact_id__get']['parameters']['path'];
778
783
  };
779
784
  }
785
+ /**
786
+ * Query parameters for GET /v1/contacts/{contact_id}
787
+ *
788
+ * @remarks
789
+ * This type defines the query parameters for the GET /v1/contacts/{contact_id} endpoint.
790
+ * It provides type safety for all query parameters as defined in the OpenAPI specification.
791
+ *
792
+ * @example
793
+ * Use this type to ensure type safety for query parameters.
794
+ *
795
+ * @path /v1/contacts/{contact_id}
796
+ */
797
+ export type GET_ContactsContactId_Request_Query = GET_ContactsContactId_Request['parameters']['query'];
780
798
  /**
781
799
  * Path parameters for GET /v1/contacts/{contact_id}
782
800
  *
@@ -4618,7 +4636,7 @@ export type POST_Organizations_Request_Body = POST_Organizations_Request['reques
4618
4636
  */
4619
4637
  export type GET_OrganizationsAttributes_Request = {
4620
4638
  parameters: {
4621
- query: operations['get_attributes_v1_organizations_attributes_get']['parameters']['query'];
4639
+ query: operations['get_current_organization_attributes_v1_organizations_attributes_get']['parameters']['query'];
4622
4640
  };
4623
4641
  }
4624
4642
  /**
@@ -4657,24 +4675,8 @@ export type GET_OrganizationsAttributes_Request_Query = GET_OrganizationsAttribu
4657
4675
  * @see {@link PATCH_OrganizationsAttributes_Request_Body} - Request body type
4658
4676
  */
4659
4677
  export type PATCH_OrganizationsAttributes_Request = {
4660
- parameters: {
4661
- query: operations['update_attributes_v1_organizations_attributes_patch']['parameters']['query'];
4662
- };
4663
4678
  requestBody: OrganizationAttributeUpdateArray;
4664
4679
  }
4665
- /**
4666
- * Query parameters for PATCH /v1/organizations/attributes
4667
- *
4668
- * @remarks
4669
- * This type defines the query parameters for the PATCH /v1/organizations/attributes endpoint.
4670
- * It provides type safety for all query parameters as defined in the OpenAPI specification.
4671
- *
4672
- * @example
4673
- * Use this type to ensure type safety for query parameters.
4674
- *
4675
- * @path /v1/organizations/attributes
4676
- */
4677
- export type PATCH_OrganizationsAttributes_Request_Query = PATCH_OrganizationsAttributes_Request['parameters']['query'];
4678
4680
  /**
4679
4681
  * Request body for PATCH /v1/organizations/attributes
4680
4682
  *
@@ -5048,8 +5050,8 @@ export type PATCH_OrganizationsOrganizationId_Request_Body = PATCH_Organizations
5048
5050
  */
5049
5051
  export type GET_OrganizationsOrganizationIdAttributes_Request = {
5050
5052
  parameters: {
5051
- query: operations['get_attributes_v1_organizations__organization_id__attributes_get']['parameters']['query'];
5052
- path: operations['get_attributes_v1_organizations__organization_id__attributes_get']['parameters']['path'];
5053
+ query: operations['get_organization_attributes_v1_organizations__organization_id__attributes_get']['parameters']['query'];
5054
+ path: operations['get_organization_attributes_v1_organizations__organization_id__attributes_get']['parameters']['path'];
5053
5055
  };
5054
5056
  }
5055
5057
  /**
@@ -5102,7 +5104,7 @@ export type GET_OrganizationsOrganizationIdAttributes_Request_Path = GET_Organiz
5102
5104
  */
5103
5105
  export type PATCH_OrganizationsOrganizationIdAttributes_Request = {
5104
5106
  parameters: {
5105
- path: operations['update_attributes_v1_organizations__organization_id__attributes_patch']['parameters']['path'];
5107
+ path: operations['update_organization_attributes_v1_organizations__organization_id__attributes_patch']['parameters']['path'];
5106
5108
  };
5107
5109
  requestBody: OrganizationAttributeUpdateArray;
5108
5110
  }
@@ -574,6 +574,8 @@ export type POST_AvailabilityStream_Response_422 = HTTPValidationError
574
574
 
575
575
  *
576
576
  * @path /v1/contacts
577
+ * @param tag_ids (query) - Filter by tag IDs. Can be specified multiple times.
578
+ * @param include (query) - Include additional data in the response. Can be specified multiple times.
577
579
  *
578
580
  * @see {@link GET_Contacts_Response_200} - 200 response type
579
581
  * @see {@link GET_Contacts_Response_422} - 422 response type
@@ -593,6 +595,8 @@ export type GET_Contacts_Response = GET_Contacts_Response_200 | GET_Contacts_Res
593
595
 
594
596
  *
595
597
  * @path /v1/contacts
598
+ * @param tag_ids (query) - Filter by tag IDs. Can be specified multiple times.
599
+ * @param include (query) - Include additional data in the response. Can be specified multiple times.
596
600
  *
597
601
  * @see {@link GET_Contacts_Response} - The main response type definition
598
602
  * @see {@link Pagination_Contact} - The actual schema type definition
@@ -610,6 +614,8 @@ export type GET_Contacts_Response_200 = Pagination_Contact
610
614
 
611
615
  *
612
616
  * @path /v1/contacts
617
+ * @param tag_ids (query) - Filter by tag IDs. Can be specified multiple times.
618
+ * @param include (query) - Include additional data in the response. Can be specified multiple times.
613
619
  *
614
620
  * @see {@link GET_Contacts_Response} - The main response type definition
615
621
  * @see {@link HTTPValidationError} - The actual schema type definition
@@ -21,8 +21,22 @@
21
21
  * This file is auto-generated from the OpenAPI specification.
22
22
  * Do not edit manually.
23
23
  */
24
- import { ZoneIncludeField, DomainIncludeField, DomainDnssecData, DomainDnssecDataCreate, JobStatus, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, ReportType, ReportStatus, TagType, TldResponseShort, AttributeCondition, DomainContactType, ContactCreateBulkInstance, ContactAttributeLinkDetail, ContactAttributeDefinition, PostalAddressType, ContactConfigBase, CommandError, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsZoneCreateBulkInstance, DnsRecordPatchOp, DnsZonePatchRecordsBulkInstance, DnsRrsetPatchOp, DnsZonePatchRrsetsBulkInstance, DnsRrset, TagEnriched, DnsZoneUpdateBulkInstance, DomainAvailabilityCheck, ContactHandle, Nameserver, DomainCreateBulkInstance, BrowserStatsBucket, GeoStatsBucket, TimeSeriesBucket, DomainForwardPatchOp, PlatformStatsBucket, HttpRedirectRequest, HttpRedirectList, ReferrerStatsBucket, StatusCodeStatsBucket, UserAgentStatsBucket, VisitsByKeyBucket, DomainForward, DeletePolicyType, SyncOperationType, DomainContact, DomainHost, DomainSearchSuggestionWithPrice, DomainStatus, DomainTransferBulkInstance, DomainClientStatus, DomainUpdateBulkInstance, EmailForwardAliasCreate, EmailForwardLogEvent, EmailForwardAliasMetrics, EmailForwardAlias, EmailForward, PriceInfo, ValidationError, LaunchPhaseBase, LegalRequirementOperationType, LocalPresenceRequirementType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactAttributeSet, Contact, DnsZone, DomainForwardZone, Domain, EmailForwardLog, EmailForwardZone, EventResponse, Invoice, JobBatchMetadata, Job, ObjectLog, Organization, Parking, RequestHistory, Tag, UserPublic, ParkingCreateBulkInstance, ParkingDeleteBulkInstance, ParkingDisableBulkInstance, ParkingEnableBulkInstance, Period, Permission, PremiumAffectsType, PremiumPriceEntryRes, PremiumPricingAction, PublicReportRes, Relation, LegalRequirementBase, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
24
+ import { ContactIncludeField, ZoneIncludeField, DomainIncludeField, DomainDnssecData, DomainDnssecDataCreate, JobStatus, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, ReportType, ReportStatus, TagType, TldResponseShort, AttributeCondition, DomainContactType, ContactCreateBulkInstance, ContactAttributeLinkDetail, TagEnriched, ContactAttributeDefinition, PostalAddressType, ContactConfigBase, CommandError, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsZoneCreateBulkInstance, DnsRecordPatchOp, DnsZonePatchRecordsBulkInstance, DnsRrsetPatchOp, DnsZonePatchRrsetsBulkInstance, DnsRrset, DnsZoneUpdateBulkInstance, DomainAvailabilityCheck, ContactHandle, Nameserver, DomainCreateBulkInstance, BrowserStatsBucket, GeoStatsBucket, TimeSeriesBucket, DomainForwardPatchOp, PlatformStatsBucket, HttpRedirectRequest, HttpRedirectList, ReferrerStatsBucket, StatusCodeStatsBucket, UserAgentStatsBucket, VisitsByKeyBucket, DomainForward, DeletePolicyType, SyncOperationType, DomainContact, DomainHost, DomainSearchSuggestionWithPrice, DomainStatus, DomainTransferBulkInstance, DomainClientStatus, DomainUpdateBulkInstance, EmailForwardAliasCreate, EmailForwardLogEvent, EmailForwardAliasMetrics, EmailForwardAlias, EmailForward, PriceInfo, ValidationError, LaunchPhaseBase, LegalRequirementOperationType, LocalPresenceRequirementType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactAttributeSet, Contact, DnsZone, DomainForwardZone, Domain, EmailForwardLog, EmailForwardZone, EventResponse, Invoice, JobBatchMetadata, Job, ObjectLog, Organization, Parking, RequestHistory, Tag, UserPublic, ParkingCreateBulkInstance, ParkingDeleteBulkInstance, ParkingDisableBulkInstance, ParkingEnableBulkInstance, Period, Permission, PremiumAffectsType, PremiumPriceEntryRes, PremiumPricingAction, PublicReportRes, Relation, LegalRequirementBase, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
25
25
 
26
+ /**
27
+ * ContactIncludeField
28
+ *
29
+ * @remarks
30
+ * Array type for ContactIncludeField objects. Used when the API returns a collection of ContactIncludeField instances.
31
+ *
32
+ * @example
33
+ * ```typescript
34
+ * const items: ContactIncludeFieldArray = await api.getContactIncludeFields();
35
+ * ```
36
+ *
37
+ * @see {@link ContactIncludeField} - The individual ContactIncludeField type definition
38
+ */
39
+ export type ContactIncludeFieldArray = ContactIncludeField[];
26
40
  /**
27
41
  * ZoneIncludeField
28
42
  *
@@ -247,6 +261,20 @@ export type ContactCreateBulkInstanceArray = ContactCreateBulkInstance[];
247
261
  * @see {@link ContactAttributeLinkDetail} - The individual ContactAttributeLinkDetail type definition
248
262
  */
249
263
  export type ContactAttributeLinkDetailArray = ContactAttributeLinkDetail[];
264
+ /**
265
+ * TagEnrichedResponse
266
+ *
267
+ * @remarks
268
+ * Array type for TagEnrichedResponse objects. Used when the API returns a collection of TagEnrichedResponse instances.
269
+ *
270
+ * @example
271
+ * ```typescript
272
+ * const items: TagEnrichedArray = await api.getTagEnricheds();
273
+ * ```
274
+ *
275
+ * @see {@link TagEnriched} - The individual TagEnrichedResponse type definition
276
+ */
277
+ export type TagEnrichedArray = TagEnriched[];
250
278
  /**
251
279
  * ContactAttributeDefinition. Definition of a possible attribute for a TLD.
252
280
  *
@@ -443,20 +471,6 @@ export type DnsZonePatchRrsetsBulkInstanceArray = DnsZonePatchRrsetsBulkInstance
443
471
  * @see {@link DnsRrset} - The individual DnsRrsetResponse type definition
444
472
  */
445
473
  export type DnsRrsetArray = DnsRrset[];
446
- /**
447
- * TagEnrichedResponse
448
- *
449
- * @remarks
450
- * Array type for TagEnrichedResponse objects. Used when the API returns a collection of TagEnrichedResponse instances.
451
- *
452
- * @example
453
- * ```typescript
454
- * const items: TagEnrichedArray = await api.getTagEnricheds();
455
- * ```
456
- *
457
- * @see {@link TagEnriched} - The individual TagEnrichedResponse type definition
458
- */
459
- export type TagEnrichedArray = TagEnriched[];
460
474
  /**
461
475
  * DnsZoneUpdateBulkInstance
462
476
  *
@@ -602,6 +602,22 @@ export type ContactHandle = components['schemas']['ContactHandle'];
602
602
  * @see {@link components} - The OpenAPI components schema definition
603
603
  */
604
604
  export type ContactIdList = components['schemas']['ContactIdList'];
605
+ /**
606
+ * ContactIncludeField
607
+ *
608
+ * @remarks
609
+ * Type alias for the `ContactIncludeField` OpenAPI schema.
610
+ * This type represents contactincludefield data structures used in API requests and responses.
611
+ *
612
+ * @example
613
+ * ```typescript
614
+ * const response = await api.getContactIncludeField();
615
+ * const item: ContactIncludeField = response.results;
616
+ * ```
617
+ *
618
+ * @see {@link components} - The OpenAPI components schema definition
619
+ */
620
+ export type ContactIncludeField = components['schemas']['ContactIncludeField'];
605
621
  /**
606
622
  * ContactResponse
607
623
  *
package/src/openapi.yaml CHANGED
@@ -1072,6 +1072,11 @@ components:
1072
1072
  propertyNames:
1073
1073
  $ref: '#/components/schemas/DomainContactType'
1074
1074
  type: object
1075
+ ContactIncludeField:
1076
+ enum:
1077
+ - tags
1078
+ title: ContactIncludeField
1079
+ type: string
1075
1080
  ContactResponse:
1076
1081
  properties:
1077
1082
  attribute_sets:
@@ -1172,6 +1177,14 @@ components:
1172
1177
  minLength: 1
1173
1178
  title: Street
1174
1179
  type: string
1180
+ tags:
1181
+ anyOf:
1182
+ - items:
1183
+ $ref: '#/components/schemas/TagEnrichedResponse'
1184
+ type: array
1185
+ - type: 'null'
1186
+ description: Tags assigned to this contact
1187
+ title: Tags
1175
1188
  title:
1176
1189
  anyOf:
1177
1190
  - minLength: 1
@@ -10199,7 +10212,7 @@ info:
10199
10212
  \n\n"
10200
10213
  summary: OpusDNS - your gateway to a seamless domain management experience.
10201
10214
  title: OpusDNS API
10202
- version: 2026-04-27-182502
10215
+ version: 2026-04-28-063751
10203
10216
  x-logo:
10204
10217
  altText: OpusDNS API Reference
10205
10218
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -11050,6 +11063,29 @@ paths:
11050
11063
  schema:
11051
11064
  $ref: '#/components/schemas/SortOrder'
11052
11065
  default: desc
11066
+ - description: Filter by tag IDs. Can be specified multiple times.
11067
+ in: query
11068
+ name: tag_ids
11069
+ required: false
11070
+ schema:
11071
+ anyOf:
11072
+ - items:
11073
+ examples:
11074
+ - tag_01h45ytscbebyvny4gc8cr8ma2
11075
+ format: typeid
11076
+ pattern: ^tag_[0-7][0-9a-hjkmnpq-tv-z]{25}$
11077
+ type: string
11078
+ x-typeid-prefix: tag
11079
+ type: array
11080
+ - type: 'null'
11081
+ description: Filter by tag IDs. Can be specified multiple times.
11082
+ title: Tag Ids
11083
+ - in: query
11084
+ name: tag_mode
11085
+ required: false
11086
+ schema:
11087
+ $ref: '#/components/schemas/TagFilterMode'
11088
+ default: match_any
11053
11089
  - in: query
11054
11090
  name: first_name
11055
11091
  required: false
@@ -11108,6 +11144,20 @@ paths:
11108
11144
  type: string
11109
11145
  - type: 'null'
11110
11146
  title: Created Before
11147
+ - description: Include additional data in the response. Can be specified multiple
11148
+ times.
11149
+ in: query
11150
+ name: include
11151
+ required: false
11152
+ schema:
11153
+ anyOf:
11154
+ - items:
11155
+ $ref: '#/components/schemas/ContactIncludeField'
11156
+ type: array
11157
+ - type: 'null'
11158
+ description: Include additional data in the response. Can be specified multiple
11159
+ times.
11160
+ title: Include
11111
11161
  - in: query
11112
11162
  name: page
11113
11163
  required: false
@@ -11644,6 +11694,16 @@ paths:
11644
11694
  title: Contact Id
11645
11695
  type: string
11646
11696
  x-typeid-prefix: contact
11697
+ - in: query
11698
+ name: include
11699
+ required: false
11700
+ schema:
11701
+ anyOf:
11702
+ - items:
11703
+ $ref: '#/components/schemas/ContactIncludeField'
11704
+ type: array
11705
+ - type: 'null'
11706
+ title: Include
11647
11707
  responses:
11648
11708
  '200':
11649
11709
  content:
@@ -19712,21 +19772,8 @@ paths:
19712
19772
  /v1/organizations/attributes:
19713
19773
  get:
19714
19774
  description: Retrieves a list of organization attributes for the current organization
19715
- operationId: get_attributes_v1_organizations_attributes_get
19775
+ operationId: get_current_organization_attributes_v1_organizations_attributes_get
19716
19776
  parameters:
19717
- - in: query
19718
- name: organization_id
19719
- required: false
19720
- schema:
19721
- anyOf:
19722
- - examples:
19723
- - organization_01h45ytscbebyvny4gc8cr8ma2
19724
- format: typeid
19725
- pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
19726
- type: string
19727
- x-typeid-prefix: organization
19728
- - type: 'null'
19729
- title: Organization Id
19730
19777
  - description: Optional list of attribute keys to filter
19731
19778
  in: query
19732
19779
  name: keys
@@ -19746,7 +19793,8 @@ paths:
19746
19793
  schema:
19747
19794
  items:
19748
19795
  $ref: '#/components/schemas/OrganizationAttributeResponse'
19749
- title: Response Get Attributes V1 Organizations Attributes Get
19796
+ title: Response Get Current Organization Attributes V1 Organizations
19797
+ Attributes Get
19750
19798
  type: array
19751
19799
  description: Successful Response
19752
19800
  '401':
@@ -19787,21 +19835,7 @@ paths:
19787
19835
  - organization
19788
19836
  patch:
19789
19837
  description: Updates one or more organization attributes for the current organization
19790
- operationId: update_attributes_v1_organizations_attributes_patch
19791
- parameters:
19792
- - in: query
19793
- name: organization_id
19794
- required: false
19795
- schema:
19796
- anyOf:
19797
- - examples:
19798
- - organization_01h45ytscbebyvny4gc8cr8ma2
19799
- format: typeid
19800
- pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
19801
- type: string
19802
- x-typeid-prefix: organization
19803
- - type: 'null'
19804
- title: Organization Id
19838
+ operationId: update_current_organization_attributes_v1_organizations_attributes_patch
19805
19839
  requestBody:
19806
19840
  content:
19807
19841
  application/json:
@@ -19818,7 +19852,8 @@ paths:
19818
19852
  schema:
19819
19853
  items:
19820
19854
  $ref: '#/components/schemas/OrganizationAttributeResponse'
19821
- title: Response Update Attributes V1 Organizations Attributes Patch
19855
+ title: Response Update Current Organization Attributes V1 Organizations
19856
+ Attributes Patch
19822
19857
  type: array
19823
19858
  description: Successful Response
19824
19859
  '401':
@@ -20462,21 +20497,19 @@ paths:
20462
20497
  /v1/organizations/{organization_id}/attributes:
20463
20498
  get:
20464
20499
  description: Retrieves a list of organization attributes for the specified organization
20465
- operationId: get_attributes_v1_organizations__organization_id__attributes_get
20500
+ operationId: get_organization_attributes_v1_organizations__organization_id__attributes_get
20466
20501
  parameters:
20467
20502
  - in: path
20468
20503
  name: organization_id
20469
20504
  required: true
20470
20505
  schema:
20471
- anyOf:
20472
- - examples:
20473
- - organization_01h45ytscbebyvny4gc8cr8ma2
20474
- format: typeid
20475
- pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
20476
- type: string
20477
- x-typeid-prefix: organization
20478
- - type: 'null'
20506
+ examples:
20507
+ - organization_01h45ytscbebyvny4gc8cr8ma2
20508
+ format: typeid
20509
+ pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
20479
20510
  title: Organization Id
20511
+ type: string
20512
+ x-typeid-prefix: organization
20480
20513
  - description: Optional list of attribute keys to filter
20481
20514
  in: query
20482
20515
  name: keys
@@ -20496,8 +20529,8 @@ paths:
20496
20529
  schema:
20497
20530
  items:
20498
20531
  $ref: '#/components/schemas/OrganizationAttributeResponse'
20499
- title: Response Get Attributes V1 Organizations Organization Id Attributes
20500
- Get
20532
+ title: Response Get Organization Attributes V1 Organizations Organization
20533
+ Id Attributes Get
20501
20534
  type: array
20502
20535
  description: Successful Response
20503
20536
  '401':
@@ -20538,21 +20571,19 @@ paths:
20538
20571
  - organization
20539
20572
  patch:
20540
20573
  description: Updates one or more organization attributes for the specified organization
20541
- operationId: update_attributes_v1_organizations__organization_id__attributes_patch
20574
+ operationId: update_organization_attributes_v1_organizations__organization_id__attributes_patch
20542
20575
  parameters:
20543
20576
  - in: path
20544
20577
  name: organization_id
20545
20578
  required: true
20546
20579
  schema:
20547
- anyOf:
20548
- - examples:
20549
- - organization_01h45ytscbebyvny4gc8cr8ma2
20550
- format: typeid
20551
- pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
20552
- type: string
20553
- x-typeid-prefix: organization
20554
- - type: 'null'
20580
+ examples:
20581
+ - organization_01h45ytscbebyvny4gc8cr8ma2
20582
+ format: typeid
20583
+ pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
20555
20584
  title: Organization Id
20585
+ type: string
20586
+ x-typeid-prefix: organization
20556
20587
  requestBody:
20557
20588
  content:
20558
20589
  application/json:
@@ -20569,8 +20600,8 @@ paths:
20569
20600
  schema:
20570
20601
  items:
20571
20602
  $ref: '#/components/schemas/OrganizationAttributeResponse'
20572
- title: Response Update Attributes V1 Organizations Organization Id Attributes
20573
- Patch
20603
+ title: Response Update Organization Attributes V1 Organizations Organization
20604
+ Id Attributes Patch
20574
20605
  type: array
20575
20606
  description: Successful Response
20576
20607
  '401':
package/src/schema.d.ts CHANGED
@@ -1514,7 +1514,7 @@ export interface paths {
1514
1514
  * List organization attributes
1515
1515
  * @description Retrieves a list of organization attributes for the current organization
1516
1516
  */
1517
- get: operations["get_attributes_v1_organizations_attributes_get"];
1517
+ get: operations["get_current_organization_attributes_v1_organizations_attributes_get"];
1518
1518
  put?: never;
1519
1519
  post?: never;
1520
1520
  delete?: never;
@@ -1524,7 +1524,7 @@ export interface paths {
1524
1524
  * Update organization attributes
1525
1525
  * @description Updates one or more organization attributes for the current organization
1526
1526
  */
1527
- patch: operations["update_attributes_v1_organizations_attributes_patch"];
1527
+ patch: operations["update_current_organization_attributes_v1_organizations_attributes_patch"];
1528
1528
  trace?: never;
1529
1529
  };
1530
1530
  "/v1/organizations/ip-restrictions": {
@@ -1672,7 +1672,7 @@ export interface paths {
1672
1672
  * List organization attributes
1673
1673
  * @description Retrieves a list of organization attributes for the specified organization
1674
1674
  */
1675
- get: operations["get_attributes_v1_organizations__organization_id__attributes_get"];
1675
+ get: operations["get_organization_attributes_v1_organizations__organization_id__attributes_get"];
1676
1676
  put?: never;
1677
1677
  post?: never;
1678
1678
  delete?: never;
@@ -1682,7 +1682,7 @@ export interface paths {
1682
1682
  * Update organization attributes
1683
1683
  * @description Updates one or more organization attributes for the specified organization
1684
1684
  */
1685
- patch: operations["update_attributes_v1_organizations__organization_id__attributes_patch"];
1685
+ patch: operations["update_organization_attributes_v1_organizations__organization_id__attributes_patch"];
1686
1686
  trace?: never;
1687
1687
  };
1688
1688
  "/v1/organizations/{organization_id}/billing/invoices": {
@@ -2971,6 +2971,11 @@ export interface components {
2971
2971
  ContactIdList: {
2972
2972
  [key: string]: TypeId<"contact">;
2973
2973
  };
2974
+ /**
2975
+ * ContactIncludeField
2976
+ * @enum {string}
2977
+ */
2978
+ ContactIncludeField: "tags";
2974
2979
  /** ContactResponse */
2975
2980
  ContactResponse: {
2976
2981
  /**
@@ -3061,6 +3066,11 @@ export interface components {
3061
3066
  * @description The address of the contact
3062
3067
  */
3063
3068
  street: string;
3069
+ /**
3070
+ * Tags
3071
+ * @description Tags assigned to this contact
3072
+ */
3073
+ tags?: components["schemas"]["TagEnrichedResponse"][] | null;
3064
3074
  /**
3065
3075
  * Title
3066
3076
  * @description The title of the contact
@@ -9466,6 +9476,9 @@ export interface operations {
9466
9476
  query?: {
9467
9477
  sort_by?: components["schemas"]["ContactSortField"];
9468
9478
  sort_order?: components["schemas"]["SortOrder"];
9479
+ /** @description Filter by tag IDs. Can be specified multiple times. */
9480
+ tag_ids?: TypeId<"tag">[] | null;
9481
+ tag_mode?: components["schemas"]["TagFilterMode"];
9469
9482
  first_name?: string | null;
9470
9483
  last_name?: string | null;
9471
9484
  email?: string | null;
@@ -9473,6 +9486,8 @@ export interface operations {
9473
9486
  country?: string | null;
9474
9487
  created_after?: Date | null;
9475
9488
  created_before?: Date | null;
9489
+ /** @description Include additional data in the response. Can be specified multiple times. */
9490
+ include?: components["schemas"]["ContactIncludeField"][] | null;
9476
9491
  page?: number;
9477
9492
  page_size?: number;
9478
9493
  };
@@ -9952,7 +9967,9 @@ export interface operations {
9952
9967
  };
9953
9968
  get_contact_v1_contacts__contact_id__get: {
9954
9969
  parameters: {
9955
- query?: never;
9970
+ query?: {
9971
+ include?: components["schemas"]["ContactIncludeField"][] | null;
9972
+ };
9956
9973
  header?: never;
9957
9974
  path: {
9958
9975
  contact_id: TypeId<"contact">;
@@ -15555,10 +15572,9 @@ export interface operations {
15555
15572
  };
15556
15573
  };
15557
15574
  };
15558
- get_attributes_v1_organizations_attributes_get: {
15575
+ get_current_organization_attributes_v1_organizations_attributes_get: {
15559
15576
  parameters: {
15560
15577
  query?: {
15561
- organization_id?: TypeId<"organization"> | null;
15562
15578
  /** @description Optional list of attribute keys to filter */
15563
15579
  keys?: string[] | null;
15564
15580
  };
@@ -15620,11 +15636,9 @@ export interface operations {
15620
15636
  };
15621
15637
  };
15622
15638
  };
15623
- update_attributes_v1_organizations_attributes_patch: {
15639
+ update_current_organization_attributes_v1_organizations_attributes_patch: {
15624
15640
  parameters: {
15625
- query?: {
15626
- organization_id?: TypeId<"organization"> | null;
15627
- };
15641
+ query?: never;
15628
15642
  header?: never;
15629
15643
  path?: never;
15630
15644
  cookie?: never;
@@ -16323,7 +16337,7 @@ export interface operations {
16323
16337
  };
16324
16338
  };
16325
16339
  };
16326
- get_attributes_v1_organizations__organization_id__attributes_get: {
16340
+ get_organization_attributes_v1_organizations__organization_id__attributes_get: {
16327
16341
  parameters: {
16328
16342
  query?: {
16329
16343
  /** @description Optional list of attribute keys to filter */
@@ -16331,7 +16345,7 @@ export interface operations {
16331
16345
  };
16332
16346
  header?: never;
16333
16347
  path: {
16334
- organization_id: TypeId<"organization"> | null;
16348
+ organization_id: TypeId<"organization">;
16335
16349
  };
16336
16350
  cookie?: never;
16337
16351
  };
@@ -16389,12 +16403,12 @@ export interface operations {
16389
16403
  };
16390
16404
  };
16391
16405
  };
16392
- update_attributes_v1_organizations__organization_id__attributes_patch: {
16406
+ update_organization_attributes_v1_organizations__organization_id__attributes_patch: {
16393
16407
  parameters: {
16394
16408
  query?: never;
16395
16409
  header?: never;
16396
16410
  path: {
16397
- organization_id: TypeId<"organization"> | null;
16411
+ organization_id: TypeId<"organization">;
16398
16412
  };
16399
16413
  cookie?: never;
16400
16414
  };