@opusdns/api 0.25.0 → 0.27.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
@@ -8,7 +8,7 @@
8
8
  "typescript": "^5.8.2"
9
9
  },
10
10
  "name": "@opusdns/api",
11
- "version": "0.25.0",
11
+ "version": "0.27.0",
12
12
  "description": "TypeScript types for the OpusDNS OpenAPI specification",
13
13
  "main": "./src/index.ts",
14
14
  "module": "./src/index.ts",
@@ -1554,6 +1554,7 @@ export const PERMISSION = {
1554
1554
  CREATE: "create",
1555
1555
  DELETE: "delete",
1556
1556
  ENTERPRISE: "enterprise",
1557
+ HAS_ACCEPTED_TOS: "has_accepted_tos",
1557
1558
  MANAGE_API_KEYS: "manage_api_keys",
1558
1559
  MANAGE_BILLING: "manage_billing",
1559
1560
  MANAGE_CMS_CONTENT: "manage_cms_content",
@@ -1609,6 +1610,7 @@ export const PERMISSION_VALUES = [
1609
1610
  'create',
1610
1611
  'delete',
1611
1612
  'enterprise',
1613
+ 'has_accepted_tos',
1612
1614
  'manage_api_keys',
1613
1615
  'manage_billing',
1614
1616
  'manage_cms_content',
@@ -14622,7 +14622,7 @@ export const KEY_SIGNUP_CREATE_ORGANIZATION = 'organization' as keyof SignupCrea
14622
14622
  /**
14623
14623
  * terms_of_service property
14624
14624
  *
14625
- * Optional terms of service acceptance.
14625
+ * Terms of service acceptance.
14626
14626
  *
14627
14627
  *
14628
14628
  *
@@ -14851,6 +14851,7 @@ export const KEYS_SPICE_DB_RELATIONSHIP_UPDATE = [
14851
14851
  /**
14852
14852
  * Accepted
14853
14853
  *
14854
+ * The organization accepts Terms of Service.
14854
14855
  *
14855
14856
  * @type {boolean}
14856
14857
  *
@@ -34,7 +34,7 @@ import { operations } from '../schema';
34
34
 
35
35
  import { DomainDnssecDataCreateArray, OrganizationAttributeUpdateArray } from './schemas-arrays.d';
36
36
 
37
- import { OrganizationCredentialExtra, SignupCreate, ContactCreate, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatchOps, DnsZoneRrsetsCreate, DomainCreate, DomainUpdate, DomainRenewRequest, DomainTransferIn, EmailForwardAlias, EmailForwardAliasUpdate, NotificationCreate, NotificationUpdate, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate, PlanUpdate, UserCreate, TermsOfServiceAccept, UserUpdate, SpiceDbRelationshipUpdate } from './schemas.d';
37
+ import { OrganizationCredentialExtra, SignupCreate, ContactCreate, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatchOps, DnsZoneRrsetsCreate, DomainCreate, DomainUpdate, DomainRenewRequest, DomainTransferIn, EmailForwardAlias, EmailForwardAliasUpdate, NotificationCreate, NotificationUpdate, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate, PlanUpdate, UserCreate, UserUpdate, SpiceDbRelationshipUpdate } from './schemas.d';
38
38
 
39
39
  /**
40
40
  * Request type for GET AuthClientCredentials endpoint
@@ -3347,42 +3347,6 @@ export type POST_Users_Request = {
3347
3347
  */
3348
3348
  export type POST_Users_Request_Body = POST_Users_Request['requestBody'];
3349
3349
 
3350
- /**
3351
- * Request type for POST UsersAcceptTos endpoint
3352
- *
3353
- * Tos Sign
3354
- *
3355
- * @remarks
3356
- * This type defines the complete request structure for the POST UsersAcceptTos endpoint.
3357
- * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
3358
- * Use this type to ensure type safety when making API requests to this endpoint.
3359
- *
3360
- * @example
3361
- * Use this type to ensure type safety when making API requests to this endpoint.
3362
- *
3363
- * @path /v1/users/accept-tos
3364
- *
3365
- * @see {@link POST_UsersAcceptTos_Request_Query} - Query parameters type
3366
- * @see {@link POST_UsersAcceptTos_Request_Path} - Path parameters type
3367
- * @see {@link POST_UsersAcceptTos_Request_Body} - Request body type
3368
- */
3369
- export type POST_UsersAcceptTos_Request = {
3370
- requestBody: TermsOfServiceAccept;
3371
- }
3372
- /**
3373
- * Request body for POST /v1/users/accept-tos
3374
- *
3375
- * @remarks
3376
- * This type defines the request body structure for the POST /v1/users/accept-tos endpoint.
3377
- * It provides type safety for the request body as defined in the OpenAPI specification.
3378
- *
3379
- * @example
3380
- * Use this type to ensure type safety for request body structure.
3381
- *
3382
- * @path /v1/users/accept-tos
3383
- */
3384
- export type POST_UsersAcceptTos_Request_Body = POST_UsersAcceptTos_Request['requestBody'];
3385
-
3386
3350
  /**
3387
3351
  * Request type for GET UsersMe endpoint
3388
3352
  *
@@ -4926,43 +4926,6 @@ export type POST_Users_Response_200 = User
4926
4926
  */
4927
4927
  export type POST_Users_Response_422 = HTTPValidationError
4928
4928
 
4929
- /**
4930
- * Response types for POST UsersAcceptTos endpoint
4931
- *
4932
- * Tos Sign
4933
- *
4934
- * @remarks
4935
- * This type defines all possible response structures for the POST UsersAcceptTos endpoint.
4936
- * Each response code maps to a specific response type as defined in the OpenAPI specification.
4937
- * Use this type to ensure type safety when handling API responses from this endpoint.
4938
- *
4939
-
4940
- *
4941
- * @path /v1/users/accept-tos
4942
- *
4943
- * @see {@link POST_UsersAcceptTos_Response_422} - 422 response type
4944
- *
4945
-
4946
- */
4947
- export type POST_UsersAcceptTos_Response = POST_UsersAcceptTos_Response_422;
4948
-
4949
- /**
4950
- * 422 response for POST UsersAcceptTos endpoint
4951
- *
4952
- * @remarks
4953
- * This type defines the response structure for the 422 status code
4954
- * of the POST UsersAcceptTos endpoint.
4955
- * It provides type safety for handling this specific response as defined in the OpenAPI specification.
4956
- *
4957
-
4958
- *
4959
- * @path /v1/users/accept-tos
4960
- *
4961
- * @see {@link POST_UsersAcceptTos_Response} - The main response type definition
4962
- * @see {@link HTTPValidationError} - The actual schema type definition
4963
- */
4964
- export type POST_UsersAcceptTos_Response_422 = HTTPValidationError
4965
-
4966
4929
  /**
4967
4930
  * Response types for DELETE UsersByUserId endpoint
4968
4931
  *
@@ -21,7 +21,7 @@
21
21
  * This file is auto-generated from the OpenAPI specification.
22
22
  * Do not edit manually.
23
23
  */
24
- import { DomainDnssecData, DomainDnssecDataCreate, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, TldResponseShort, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, Nameserver, DeletePolicyType, SyncOperationType, DomainContact, DomainStatus, DomainSearchSuggestion, DomainClientStatus, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, ContactRoleType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, ContactSchema, DnsZone, Domain, EmailForwardAlias, EventResponse, OrganizationCredential, Organization, UserNotificationSummary, Period, Permission, PremiumAffectsType, Relation, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
24
+ import { DomainDnssecData, DomainDnssecDataCreate, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, TldResponseShort, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, Nameserver, DeletePolicyType, SyncOperationType, DomainContact, DomainSearchSuggestion, DomainStatus, DomainClientStatus, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, ContactRoleType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, ContactSchema, DnsZone, Domain, EmailForwardAlias, EventResponse, OrganizationCredential, Organization, UserNotificationSummary, Period, Permission, PremiumAffectsType, Relation, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
25
25
 
26
26
  /**
27
27
  * DomainDnssecDataResponse
@@ -304,33 +304,33 @@ export type SyncOperationTypeArray = SyncOperationType[];
304
304
  */
305
305
  export type DomainContactArray = DomainContact[];
306
306
  /**
307
- * DomainStatus
307
+ * DomainSearchSuggestion
308
308
  *
309
309
  * @remarks
310
- * Array type for DomainStatus objects. Used when the API returns a collection of DomainStatus instances.
310
+ * Array type for DomainSearchSuggestion objects. Used when the API returns a collection of DomainSearchSuggestion instances.
311
311
  *
312
312
  * @example
313
313
  * ```typescript
314
- * const items: DomainStatusArray = await api.getDomainStatuss();
314
+ * const items: DomainSearchSuggestionArray = await api.getDomainSearchSuggestions();
315
315
  * ```
316
316
  *
317
- * @see {@link DomainStatus} - The individual DomainStatus type definition
317
+ * @see {@link DomainSearchSuggestion} - The individual DomainSearchSuggestion type definition
318
318
  */
319
- export type DomainStatusArray = DomainStatus[];
319
+ export type DomainSearchSuggestionArray = DomainSearchSuggestion[];
320
320
  /**
321
- * DomainSearchSuggestion
321
+ * DomainStatus
322
322
  *
323
323
  * @remarks
324
- * Array type for DomainSearchSuggestion objects. Used when the API returns a collection of DomainSearchSuggestion instances.
324
+ * Array type for DomainStatus objects. Used when the API returns a collection of DomainStatus instances.
325
325
  *
326
326
  * @example
327
327
  * ```typescript
328
- * const items: DomainSearchSuggestionArray = await api.getDomainSearchSuggestions();
328
+ * const items: DomainStatusArray = await api.getDomainStatuss();
329
329
  * ```
330
330
  *
331
- * @see {@link DomainSearchSuggestion} - The individual DomainSearchSuggestion type definition
331
+ * @see {@link DomainStatus} - The individual DomainStatus type definition
332
332
  */
333
- export type DomainSearchSuggestionArray = DomainSearchSuggestion[];
333
+ export type DomainStatusArray = DomainStatus[];
334
334
  /**
335
335
  * DomainClientStatus
336
336
  *
package/src/openapi.yaml CHANGED
@@ -1574,7 +1574,7 @@ components:
1574
1574
  registry_statuses:
1575
1575
  description: All the domain statuses
1576
1576
  items:
1577
- $ref: '#/components/schemas/DomainStatus'
1577
+ type: string
1578
1578
  title: Registry Statuses
1579
1579
  type: array
1580
1580
  renewal_mode:
@@ -2317,8 +2317,10 @@ components:
2317
2317
  ip_addresses:
2318
2318
  description: The ip addresses of the name server
2319
2319
  examples:
2320
- - 0.0.0.0
2321
- - 127.0.0.1
2320
+ - - 0.0.0.0
2321
+ - 127.0.0.1
2322
+ - - 2001:db8::1
2323
+ - 2001:db8::2
2322
2324
  items:
2323
2325
  format: ipvanyaddress
2324
2326
  type: string
@@ -3535,6 +3537,7 @@ components:
3535
3537
  - create
3536
3538
  - delete
3537
3539
  - enterprise
3540
+ - has_accepted_tos
3538
3541
  - manage_api_keys
3539
3542
  - manage_billing
3540
3543
  - manage_cms_content
@@ -3794,16 +3797,15 @@ components:
3794
3797
  $ref: '#/components/schemas/OrganizationCreate'
3795
3798
  description: Organization signup.
3796
3799
  terms_of_service:
3797
- anyOf:
3798
- - $ref: '#/components/schemas/TermsOfServiceAccept'
3799
- - type: 'null'
3800
- description: Optional terms of service acceptance.
3800
+ $ref: '#/components/schemas/TermsOfServiceAccept'
3801
+ description: Terms of service acceptance.
3801
3802
  user:
3802
3803
  $ref: '#/components/schemas/UserCreate'
3803
3804
  description: User signup to platform.
3804
3805
  required:
3805
3806
  - user
3806
3807
  - organization
3808
+ - terms_of_service
3807
3809
  title: SignupCreate
3808
3810
  type: object
3809
3811
  SldLength:
@@ -3863,6 +3865,7 @@ components:
3863
3865
  TermsOfServiceAccept:
3864
3866
  properties:
3865
3867
  accepted:
3868
+ description: The organization accepts Terms of Service.
3866
3869
  title: Accepted
3867
3870
  type: boolean
3868
3871
  required:
@@ -4784,7 +4787,7 @@ info:
4784
4787
  '
4785
4788
  summary: OpusDNS - your gateway to a seamless domain management experience.
4786
4789
  title: OpusDNS API
4787
- version: 2025-08-27-172550
4790
+ version: 2025-08-29-160817
4788
4791
  x-logo:
4789
4792
  altText: OpusDNS API Reference
4790
4793
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -8546,29 +8549,6 @@ paths:
8546
8549
  summary: Create User
8547
8550
  tags:
8548
8551
  - user
8549
- /v1/users/accept-tos:
8550
- post:
8551
- operationId: tos_sign_v1_users_accept_tos_post
8552
- requestBody:
8553
- content:
8554
- application/json:
8555
- schema:
8556
- $ref: '#/components/schemas/TermsOfServiceAccept'
8557
- required: true
8558
- responses:
8559
- '204':
8560
- description: Successful Response
8561
- '422':
8562
- content:
8563
- application/problem+json:
8564
- schema:
8565
- $ref: '#/components/schemas/HTTPValidationError'
8566
- description: Validation Error
8567
- security:
8568
- - OAuth2PasswordBearer: []
8569
- summary: Tos Sign
8570
- tags:
8571
- - user
8572
8552
  /v1/users/me:
8573
8553
  get:
8574
8554
  operationId: get_current_user_v1_users_me_get
package/src/schema.d.ts CHANGED
@@ -974,23 +974,6 @@ export interface paths {
974
974
  patch?: never;
975
975
  trace?: never;
976
976
  };
977
- "/v1/users/accept-tos": {
978
- parameters: {
979
- query?: never;
980
- header?: never;
981
- path?: never;
982
- cookie?: never;
983
- };
984
- get?: never;
985
- put?: never;
986
- /** Tos Sign */
987
- post: operations["tos_sign_v1_users_accept_tos_post"];
988
- delete?: never;
989
- options?: never;
990
- head?: never;
991
- patch?: never;
992
- trace?: never;
993
- };
994
977
  "/v1/users/me": {
995
978
  parameters: {
996
979
  query?: never;
@@ -2109,7 +2092,7 @@ export interface components {
2109
2092
  * Registry Statuses
2110
2093
  * @description All the domain statuses
2111
2094
  */
2112
- registry_statuses?: components["schemas"]["DomainStatus"][];
2095
+ registry_statuses?: string[];
2113
2096
  /** @description The renewal mode of the domain */
2114
2097
  renewal_mode?: components["schemas"]["RenewalMode"];
2115
2098
  /**
@@ -3423,7 +3406,7 @@ export interface components {
3423
3406
  * Permission
3424
3407
  * @enum {string}
3425
3408
  */
3426
- Permission: "acknowledge" | "bulk_create" | "bulk_delete" | "bulk_renew_expire" | "bulk_transfer_trade" | "bulk_update" | "create" | "delete" | "enterprise" | "manage_api_keys" | "manage_billing" | "manage_cms_content" | "manage_contacts" | "manage_dns_zones" | "manage_domains" | "manage_email_forwards" | "manage_opusdns_api_keys" | "manage_products" | "manage_reseller" | "manage_user_relations" | "manage_users" | "plan_manager" | "premium" | "premium_reseller" | "renew_expire" | "starter" | "transfer_trade" | "update" | "verify" | "view" | "view_audit_logs";
3409
+ Permission: "acknowledge" | "bulk_create" | "bulk_delete" | "bulk_renew_expire" | "bulk_transfer_trade" | "bulk_update" | "create" | "delete" | "enterprise" | "has_accepted_tos" | "manage_api_keys" | "manage_billing" | "manage_cms_content" | "manage_contacts" | "manage_dns_zones" | "manage_domains" | "manage_email_forwards" | "manage_opusdns_api_keys" | "manage_products" | "manage_reseller" | "manage_user_relations" | "manage_users" | "plan_manager" | "premium" | "premium_reseller" | "renew_expire" | "starter" | "transfer_trade" | "update" | "verify" | "view" | "view_audit_logs";
3427
3410
  /** PermissionSet */
3428
3411
  PermissionSet: {
3429
3412
  /** Permissions */
@@ -3575,8 +3558,8 @@ export interface components {
3575
3558
  SignupCreate: {
3576
3559
  /** @description Organization signup. */
3577
3560
  organization: components["schemas"]["OrganizationCreate"];
3578
- /** @description Optional terms of service acceptance. */
3579
- terms_of_service?: components["schemas"]["TermsOfServiceAccept"] | null;
3561
+ /** @description Terms of service acceptance. */
3562
+ terms_of_service: components["schemas"]["TermsOfServiceAccept"];
3580
3563
  /** @description User signup to platform. */
3581
3564
  user: components["schemas"]["UserCreate"];
3582
3565
  };
@@ -3617,7 +3600,10 @@ export interface components {
3617
3600
  TLDType: "gTLD" | "ccTLD";
3618
3601
  /** TermsOfServiceAccept */
3619
3602
  TermsOfServiceAccept: {
3620
- /** Accepted */
3603
+ /**
3604
+ * Accepted
3605
+ * @description The organization accepts Terms of Service.
3606
+ */
3621
3607
  accepted: boolean;
3622
3608
  };
3623
3609
  /** TldBase */
@@ -7654,37 +7640,6 @@ export interface operations {
7654
7640
  };
7655
7641
  };
7656
7642
  };
7657
- tos_sign_v1_users_accept_tos_post: {
7658
- parameters: {
7659
- query?: never;
7660
- header?: never;
7661
- path?: never;
7662
- cookie?: never;
7663
- };
7664
- requestBody: {
7665
- content: {
7666
- "application/json": components["schemas"]["TermsOfServiceAccept"];
7667
- };
7668
- };
7669
- responses: {
7670
- /** @description Successful Response */
7671
- 204: {
7672
- headers: {
7673
- [name: string]: unknown;
7674
- };
7675
- content?: never;
7676
- };
7677
- /** @description Validation Error */
7678
- 422: {
7679
- headers: {
7680
- [name: string]: unknown;
7681
- };
7682
- content: {
7683
- "application/problem+json": components["schemas"]["HTTPValidationError"];
7684
- };
7685
- };
7686
- };
7687
- };
7688
7643
  get_current_user_v1_users_me_get: {
7689
7644
  parameters: {
7690
7645
  query?: {