@opusdns/api 1.17.0 → 1.19.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.2.0"
4
4
  },
5
5
  "name": "@opusdns/api",
6
- "version": "1.17.0",
6
+ "version": "1.19.0",
7
7
  "description": "TypeScript types for the OpusDNS OpenAPI specification",
8
8
  "main": "./src/index.ts",
9
9
  "module": "./src/index.ts",
@@ -67,6 +67,7 @@ import type {
67
67
  MetricsGrouping,
68
68
  ObjectEventType,
69
69
  ObjectLogSortField,
70
+ OrganizationCredentialStatus,
70
71
  OrganizationSortField,
71
72
  OrganizationStatus,
72
73
  ParkingSortField,
@@ -581,6 +582,7 @@ export const DNSSEC_STATUS_VALUES = [
581
582
  export const DOMAIN_ATTRIBUTE_KEY = {
582
583
  AUTO_RENEW_PERIOD: "auto_renew_period",
583
584
  MUSIC_REGISTRANT_ATTESTATION: "music_registrant_attestation",
585
+ NIC_IT_COMPLIANCE_CONFIRMATION: "nic_it_compliance_confirmation",
584
586
  TRAVEL_INDUSTRY_ACKNOWLEDGEMENT: "travel_industry_acknowledgement",
585
587
  VERIFICATION_REQUIRED: "verification_required",
586
588
  } as const satisfies Record<string, DomainAttributeKey>;
@@ -588,6 +590,7 @@ export const DOMAIN_ATTRIBUTE_KEY = {
588
590
  export const DOMAIN_ATTRIBUTE_KEY_VALUES = [
589
591
  'auto_renew_period',
590
592
  'music_registrant_attestation',
593
+ 'nic_it_compliance_confirmation',
591
594
  'travel_industry_acknowledgement',
592
595
  'verification_required',
593
596
  ] as const satisfies ReadonlyArray<DomainAttributeKey>;
@@ -1224,6 +1227,18 @@ export const OBJECT_LOG_SORT_FIELD_VALUES = [
1224
1227
  'performed_by_id',
1225
1228
  ] as const satisfies ReadonlyArray<ObjectLogSortField>;
1226
1229
 
1230
+ export const ORGANIZATION_CREDENTIAL_STATUS = {
1231
+ ACTIVE: "active",
1232
+ EXPIRED: "expired",
1233
+ REVOKED: "revoked",
1234
+ } as const satisfies Record<string, OrganizationCredentialStatus>;
1235
+
1236
+ export const ORGANIZATION_CREDENTIAL_STATUS_VALUES = [
1237
+ 'active',
1238
+ 'expired',
1239
+ 'revoked',
1240
+ ] as const satisfies ReadonlyArray<OrganizationCredentialStatus>;
1241
+
1227
1242
  export const ORGANIZATION_SORT_FIELD = {
1228
1243
  CREATED_ON: "created_on",
1229
1244
  NAME: "name",
@@ -241,6 +241,7 @@ import type {
241
241
  OrganizationAttribute2,
242
242
  OrganizationAttributeUpdate,
243
243
  OrganizationCreate,
244
+ OrganizationCredential,
244
245
  OrganizationToken,
245
246
  OrganizationUpdate,
246
247
  OrganizationWithBillingData,
@@ -3463,6 +3464,30 @@ export const KEYS_ORGANIZATION_CREATE = [
3463
3464
  KEY_ORGANIZATION_CREATE_USERS,
3464
3465
  ] as const satisfies (keyof OrganizationCreate)[];
3465
3466
 
3467
+ export const KEY_ORGANIZATION_CREDENTIAL_API_KEY_DESCRIPTION = 'api_key_description' satisfies keyof OrganizationCredential;
3468
+ export const KEY_ORGANIZATION_CREDENTIAL_API_KEY_ID = 'api_key_id' satisfies keyof OrganizationCredential;
3469
+ export const KEY_ORGANIZATION_CREDENTIAL_API_KEY_NAME = 'api_key_name' satisfies keyof OrganizationCredential;
3470
+ export const KEY_ORGANIZATION_CREDENTIAL_CREATED_ON = 'created_on' satisfies keyof OrganizationCredential;
3471
+ export const KEY_ORGANIZATION_CREDENTIAL_DELETED_ON = 'deleted_on' satisfies keyof OrganizationCredential;
3472
+ export const KEY_ORGANIZATION_CREDENTIAL_EXPIRES_AT = 'expires_at' satisfies keyof OrganizationCredential;
3473
+ export const KEY_ORGANIZATION_CREDENTIAL_LAST_USED_ON = 'last_used_on' satisfies keyof OrganizationCredential;
3474
+ export const KEY_ORGANIZATION_CREDENTIAL_ORGANIZATION_ID = 'organization_id' satisfies keyof OrganizationCredential;
3475
+ export const KEY_ORGANIZATION_CREDENTIAL_ROLE = 'role' satisfies keyof OrganizationCredential;
3476
+ export const KEY_ORGANIZATION_CREDENTIAL_STATUS = 'status' satisfies keyof OrganizationCredential;
3477
+
3478
+ export const KEYS_ORGANIZATION_CREDENTIAL = [
3479
+ KEY_ORGANIZATION_CREDENTIAL_API_KEY_DESCRIPTION,
3480
+ KEY_ORGANIZATION_CREDENTIAL_API_KEY_ID,
3481
+ KEY_ORGANIZATION_CREDENTIAL_API_KEY_NAME,
3482
+ KEY_ORGANIZATION_CREDENTIAL_CREATED_ON,
3483
+ KEY_ORGANIZATION_CREDENTIAL_DELETED_ON,
3484
+ KEY_ORGANIZATION_CREDENTIAL_EXPIRES_AT,
3485
+ KEY_ORGANIZATION_CREDENTIAL_LAST_USED_ON,
3486
+ KEY_ORGANIZATION_CREDENTIAL_ORGANIZATION_ID,
3487
+ KEY_ORGANIZATION_CREDENTIAL_ROLE,
3488
+ KEY_ORGANIZATION_CREDENTIAL_STATUS,
3489
+ ] as const satisfies (keyof OrganizationCredential)[];
3490
+
3466
3491
  export const KEY_ORGANIZATION_TOKEN_ACCESS_TOKEN = 'access_token' satisfies keyof OrganizationToken;
3467
3492
  export const KEY_ORGANIZATION_TOKEN_EXPIRES_IN = 'expires_in' satisfies keyof OrganizationToken;
3468
3493
  export const KEY_ORGANIZATION_TOKEN_TOKEN_TYPE = 'token_type' satisfies keyof OrganizationToken;
@@ -166,6 +166,9 @@ export type GET_ArchiveRequestHistory_Request = {
166
166
  };
167
167
  export type GET_ArchiveRequestHistory_Request_Query = GET_ArchiveRequestHistory_Request['parameters']['query'];
168
168
 
169
+ export type GET_AuthClientCredentialsIntrospect_Request = {
170
+ };
171
+
169
172
  export type POST_AuthToken_Request = {
170
173
  requestBody: PublicAuthRequestForm;
171
174
  };
@@ -56,6 +56,7 @@ import type {
56
56
  ObjectTagChanges2,
57
57
  Organization,
58
58
  OrganizationAttribute2,
59
+ OrganizationCredential,
59
60
  OrganizationWithBillingData,
60
61
  Pagination_BillingTransaction,
61
62
  Pagination_Contact,
@@ -306,6 +307,12 @@ export type GET_ArchiveRequestHistory_Response = GET_ArchiveRequestHistory_Respo
306
307
  export type GET_ArchiveRequestHistory_Response_200 = Pagination_RequestHistory;
307
308
  export type GET_ArchiveRequestHistory_Response_422 = HTTPValidationError;
308
309
 
310
+ export type GET_AuthClientCredentialsIntrospect_Response = GET_AuthClientCredentialsIntrospect_Response_200 | GET_AuthClientCredentialsIntrospect_Response_401 | GET_AuthClientCredentialsIntrospect_Response_422;
311
+
312
+ export type GET_AuthClientCredentialsIntrospect_Response_200 = OrganizationCredential;
313
+ export type GET_AuthClientCredentialsIntrospect_Response_401 = Problem;
314
+ export type GET_AuthClientCredentialsIntrospect_Response_422 = HTTPValidationError;
315
+
309
316
  export type GET_Availability_Response = GET_Availability_Response_200 | GET_Availability_Response_401 | GET_Availability_Response_422;
310
317
 
311
318
  export type GET_Availability_Response_200 = DomainAvailabilityList;
@@ -314,6 +314,8 @@ export type OrganizationAttributeCreate = components['schemas']['OrganizationAtt
314
314
  export type OrganizationAttribute2 = components['schemas']['OrganizationAttributeResponse'];
315
315
  export type OrganizationAttributeUpdate = components['schemas']['OrganizationAttributeUpdate'];
316
316
  export type OrganizationCreate = components['schemas']['OrganizationCreate'];
317
+ export type OrganizationCredential = components['schemas']['OrganizationCredential'];
318
+ export type OrganizationCredentialStatus = components['schemas']['OrganizationCredentialStatus'];
317
319
  export type OrganizationSortField = components['schemas']['OrganizationSortField'];
318
320
  export type OrganizationStatus = components['schemas']['OrganizationStatus'];
319
321
  export type OrganizationToken = components['schemas']['OrganizationTokenResponse'];
package/src/openapi.yaml CHANGED
@@ -3182,6 +3182,7 @@ components:
3182
3182
  enum:
3183
3183
  - auto_renew_period
3184
3184
  - music_registrant_attestation
3185
+ - nic_it_compliance_confirmation
3185
3186
  - travel_industry_acknowledgement
3186
3187
  - verification_required
3187
3188
  title: DomainAttributeKey
@@ -8445,6 +8446,87 @@ components:
8445
8446
  - name
8446
8447
  title: OrganizationCreate
8447
8448
  type: object
8449
+ OrganizationCredential:
8450
+ properties:
8451
+ api_key_description:
8452
+ anyOf:
8453
+ - type: string
8454
+ - type: 'null'
8455
+ description: Description of the organization credential.
8456
+ title: Api Key Description
8457
+ api_key_id:
8458
+ description: Unique identifier of the organization credential.
8459
+ examples:
8460
+ - api_key_01h45ytscbebyvny4gc8cr8ma2
8461
+ format: typeid
8462
+ pattern: ^api_key_[0-7][0-9a-hjkmnpq-tv-z]{25}$
8463
+ title: Api Key Id
8464
+ type: string
8465
+ x-typeid-prefix: api_key
8466
+ api_key_name:
8467
+ anyOf:
8468
+ - type: string
8469
+ - type: 'null'
8470
+ description: Name of the organization credential. Only a-z, A-Z, 0-9, underscore,
8471
+ and hyphen are allowed.
8472
+ title: Api Key Name
8473
+ created_on:
8474
+ description: The date/time the entry was created on
8475
+ format: date-time
8476
+ title: Created On
8477
+ type: string
8478
+ deleted_on:
8479
+ anyOf:
8480
+ - format: date-time
8481
+ type: string
8482
+ - type: 'null'
8483
+ description: The date/time the entry was deleted on
8484
+ title: Deleted On
8485
+ expires_at:
8486
+ anyOf:
8487
+ - format: date-time
8488
+ type: string
8489
+ - type: 'null'
8490
+ description: The date and time the credential expiration.
8491
+ title: Expires At
8492
+ last_used_on:
8493
+ anyOf:
8494
+ - format: date-time
8495
+ type: string
8496
+ - type: 'null'
8497
+ description: The date/time the entry was deleted on
8498
+ title: Last Used On
8499
+ organization_id:
8500
+ default: None
8501
+ examples:
8502
+ - organization_01h45ytscbebyvny4gc8cr8ma2
8503
+ format: typeid
8504
+ pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
8505
+ title: Organization Id
8506
+ type: string
8507
+ x-typeid-prefix: organization
8508
+ role:
8509
+ anyOf:
8510
+ - $ref: '#/components/schemas/PublicRole'
8511
+ - $ref: '#/components/schemas/CustomRoleLabel'
8512
+ - type: 'null'
8513
+ title: Role
8514
+ status:
8515
+ $ref: '#/components/schemas/OrganizationCredentialStatus'
8516
+ description: The status of the organization credential.
8517
+ readOnly: true
8518
+ required:
8519
+ - api_key_id
8520
+ - status
8521
+ title: OrganizationCredential
8522
+ type: object
8523
+ OrganizationCredentialStatus:
8524
+ enum:
8525
+ - active
8526
+ - expired
8527
+ - revoked
8528
+ title: OrganizationCredentialStatus
8529
+ type: string
8448
8530
  OrganizationSortField:
8449
8531
  enum:
8450
8532
  - created_on
@@ -12261,7 +12343,7 @@ info:
12261
12343
  \n\n"
12262
12344
  summary: OpusDNS - your gateway to a seamless domain management experience.
12263
12345
  title: OpusDNS API
12264
- version: 2026-06-16-093305
12346
+ version: 2026-06-17-220249
12265
12347
  x-logo:
12266
12348
  altText: OpusDNS API Reference
12267
12349
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -14049,6 +14131,43 @@ paths:
14049
14131
  summary: Retrieve request history logs
14050
14132
  tags:
14051
14133
  - archive
14134
+ /v1/auth/client_credentials/introspect:
14135
+ get:
14136
+ description: Returns the stored record for the API key (or organization token)
14137
+ used to authenticate the request, including its organization. Requires API-key
14138
+ or organization-token authentication; user tokens are rejected.
14139
+ operationId: introspect_client_credential_v1_auth_client_credentials_introspect_get
14140
+ responses:
14141
+ '200':
14142
+ content:
14143
+ application/json:
14144
+ schema:
14145
+ $ref: '#/components/schemas/OrganizationCredential'
14146
+ description: Successful Response
14147
+ '401':
14148
+ content:
14149
+ application/problem+json:
14150
+ example:
14151
+ code: ERROR_AUTHENTICATION
14152
+ detail: Additional error context.
14153
+ status: 401
14154
+ title: Authentication Error
14155
+ type: authentication
14156
+ schema:
14157
+ $ref: '#/components/schemas/Problem'
14158
+ description: Unauthorized
14159
+ '422':
14160
+ content:
14161
+ application/problem+json:
14162
+ schema:
14163
+ $ref: '#/components/schemas/HTTPValidationError'
14164
+ description: Validation Error
14165
+ security:
14166
+ - OAuth2PasswordBearer: []
14167
+ - APIKeyHeader: []
14168
+ summary: Introspect the current API key
14169
+ tags:
14170
+ - authentication
14052
14171
  /v1/auth/token:
14053
14172
  post:
14054
14173
  operationId: issue_organization_token_v1_auth_token_post
package/src/schema.d.ts CHANGED
@@ -255,6 +255,26 @@ export interface paths {
255
255
  patch?: never;
256
256
  trace?: never;
257
257
  };
258
+ "/v1/auth/client_credentials/introspect": {
259
+ parameters: {
260
+ query?: never;
261
+ header?: never;
262
+ path?: never;
263
+ cookie?: never;
264
+ };
265
+ /**
266
+ * Introspect the current API key
267
+ * @description Returns the stored record for the API key (or organization token) used to authenticate the request, including its organization. Requires API-key or organization-token authentication; user tokens are rejected.
268
+ */
269
+ get: operations["introspect_client_credential_v1_auth_client_credentials_introspect_get"];
270
+ put?: never;
271
+ post?: never;
272
+ delete?: never;
273
+ options?: never;
274
+ head?: never;
275
+ patch?: never;
276
+ trace?: never;
277
+ };
258
278
  "/v1/auth/token": {
259
279
  parameters: {
260
280
  query?: never;
@@ -4691,7 +4711,7 @@ export interface components {
4691
4711
  * DomainAttributeKey
4692
4712
  * @enum {string}
4693
4713
  */
4694
- DomainAttributeKey: "auto_renew_period" | "music_registrant_attestation" | "travel_industry_acknowledgement" | "verification_required";
4714
+ DomainAttributeKey: "auto_renew_period" | "music_registrant_attestation" | "nic_it_compliance_confirmation" | "travel_industry_acknowledgement" | "verification_required";
4695
4715
  /** DomainAvailability */
4696
4716
  DomainAvailability: {
4697
4717
  /** Domain */
@@ -8202,6 +8222,63 @@ export interface components {
8202
8222
  */
8203
8223
  users?: components["schemas"]["UserCreate"][];
8204
8224
  };
8225
+ /** OrganizationCredential */
8226
+ OrganizationCredential: {
8227
+ /**
8228
+ * Api Key Description
8229
+ * @description Description of the organization credential.
8230
+ */
8231
+ api_key_description?: string | null;
8232
+ /**
8233
+ * Api Key Id
8234
+ * Format: typeid
8235
+ * @description Unique identifier of the organization credential.
8236
+ * @example api_key_01h45ytscbebyvny4gc8cr8ma2
8237
+ */
8238
+ api_key_id: TypeId<"api_key">;
8239
+ /**
8240
+ * Api Key Name
8241
+ * @description Name of the organization credential. Only a-z, A-Z, 0-9, underscore, and hyphen are allowed.
8242
+ */
8243
+ api_key_name?: string | null;
8244
+ /**
8245
+ * Created On
8246
+ * Format: date-time
8247
+ * @description The date/time the entry was created on
8248
+ */
8249
+ created_on?: Date;
8250
+ /**
8251
+ * Deleted On
8252
+ * @description The date/time the entry was deleted on
8253
+ */
8254
+ deleted_on?: Date | null;
8255
+ /**
8256
+ * Expires At
8257
+ * @description The date and time the credential expiration.
8258
+ */
8259
+ expires_at?: Date | null;
8260
+ /**
8261
+ * Last Used On
8262
+ * @description The date/time the entry was deleted on
8263
+ */
8264
+ last_used_on?: Date | null;
8265
+ /**
8266
+ * Organization Id
8267
+ * Format: typeid
8268
+ * @default None
8269
+ * @example organization_01h45ytscbebyvny4gc8cr8ma2
8270
+ */
8271
+ organization_id: TypeId<"organization">;
8272
+ /** Role */
8273
+ role?: components["schemas"]["PublicRole"] | components["schemas"]["CustomRoleLabel"] | null;
8274
+ /** @description The status of the organization credential. */
8275
+ readonly status: components["schemas"]["OrganizationCredentialStatus"];
8276
+ };
8277
+ /**
8278
+ * OrganizationCredentialStatus
8279
+ * @enum {string}
8280
+ */
8281
+ OrganizationCredentialStatus: "active" | "expired" | "revoked";
8205
8282
  /**
8206
8283
  * OrganizationSortField
8207
8284
  * @enum {string}
@@ -12151,6 +12228,51 @@ export interface operations {
12151
12228
  };
12152
12229
  };
12153
12230
  };
12231
+ introspect_client_credential_v1_auth_client_credentials_introspect_get: {
12232
+ parameters: {
12233
+ query?: never;
12234
+ header?: never;
12235
+ path?: never;
12236
+ cookie?: never;
12237
+ };
12238
+ requestBody?: never;
12239
+ responses: {
12240
+ /** @description Successful Response */
12241
+ 200: {
12242
+ headers: {
12243
+ [name: string]: unknown;
12244
+ };
12245
+ content: {
12246
+ "application/json": components["schemas"]["OrganizationCredential"];
12247
+ };
12248
+ };
12249
+ /** @description Unauthorized */
12250
+ 401: {
12251
+ headers: {
12252
+ [name: string]: unknown;
12253
+ };
12254
+ content: {
12255
+ /** @example {
12256
+ * "code": "ERROR_AUTHENTICATION",
12257
+ * "detail": "Additional error context.",
12258
+ * "status": 401,
12259
+ * "title": "Authentication Error",
12260
+ * "type": "authentication"
12261
+ * } */
12262
+ "application/problem+json": components["schemas"]["Problem"];
12263
+ };
12264
+ };
12265
+ /** @description Validation Error */
12266
+ 422: {
12267
+ headers: {
12268
+ [name: string]: unknown;
12269
+ };
12270
+ content: {
12271
+ "application/problem+json": components["schemas"]["HTTPValidationError"];
12272
+ };
12273
+ };
12274
+ };
12275
+ };
12154
12276
  issue_organization_token_v1_auth_token_post: {
12155
12277
  parameters: {
12156
12278
  query?: never;