@opusdns/api 0.308.0 → 0.309.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.308.0",
6
+ "version": "0.309.0",
7
7
  "description": "TypeScript types for the OpusDNS OpenAPI specification",
8
8
  "main": "./src/index.ts",
9
9
  "module": "./src/index.ts",
@@ -1691,6 +1691,45 @@ export type PUT_ContactsContactIdVerification_Request_Query = PUT_ContactsContac
1691
1691
  */
1692
1692
  export type PUT_ContactsContactIdVerification_Request_Path = PUT_ContactsContactIdVerification_Request['parameters']['path'];
1693
1693
 
1694
+ /**
1695
+ * Request type for GET ContactsContactIdVerifications endpoint
1696
+ *
1697
+ * Get contact verification status
1698
+ * Retrieve the current verification state for a contact from the contact-verification service.
1699
+ *
1700
+ * @remarks
1701
+ * This type defines the complete request structure for the GET ContactsContactIdVerifications endpoint.
1702
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
1703
+ * Use this type to ensure type safety when making API requests to this endpoint.
1704
+ *
1705
+ * @example
1706
+ * Use this type to ensure type safety when making API requests to this endpoint.
1707
+ *
1708
+ * @path /v1/contacts/{contact_id}/verifications
1709
+ *
1710
+ * @see {@link GET_ContactsContactIdVerifications_Request_Query} - Query parameters type
1711
+ * @see {@link GET_ContactsContactIdVerifications_Request_Path} - Path parameters type
1712
+ * @see {@link GET_ContactsContactIdVerifications_Request_Body} - Request body type
1713
+ */
1714
+ export type GET_ContactsContactIdVerifications_Request = {
1715
+ parameters: {
1716
+ path: operations['get_contact_verification_status_v1_contacts__contact_id__verifications_get']['parameters']['path'];
1717
+ };
1718
+ }
1719
+ /**
1720
+ * Path parameters for GET /v1/contacts/{contact_id}/verifications
1721
+ *
1722
+ * @remarks
1723
+ * This type defines the path parameters for the GET /v1/contacts/{contact_id}/verifications endpoint.
1724
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
1725
+ *
1726
+ * @example
1727
+ * Use this type to ensure type safety for path parameters.
1728
+ *
1729
+ * @path /v1/contacts/{contact_id}/verifications
1730
+ */
1731
+ export type GET_ContactsContactIdVerifications_Request_Path = GET_ContactsContactIdVerifications_Request['parameters']['path'];
1732
+
1694
1733
  /**
1695
1734
  * Request type for POST ContactsContactIdVerificationsAttest endpoint
1696
1735
  *
@@ -3257,6 +3257,116 @@ export type PUT_ContactsByContactIdVerification_Response_404 = Problem
3257
3257
  */
3258
3258
  export type PUT_ContactsByContactIdVerification_Response_422 = HTTPValidationError
3259
3259
 
3260
+ /**
3261
+ * Response types for GET ContactsByContactIdVerifications endpoint
3262
+ *
3263
+ * Get contact verification status
3264
+ * Retrieve the current verification state for a contact from the contact-verification service.
3265
+ *
3266
+ * @remarks
3267
+ * This type defines all possible response structures for the GET ContactsByContactIdVerifications endpoint.
3268
+ * Each response code maps to a specific response type as defined in the OpenAPI specification.
3269
+ * Use this type to ensure type safety when handling API responses from this endpoint.
3270
+ *
3271
+
3272
+ *
3273
+ * @path /v1/contacts/{contact_id}/verifications
3274
+ *
3275
+ * @see {@link GET_ContactsByContactIdVerifications_Response_200} - 200 response type
3276
+ * @see {@link GET_ContactsByContactIdVerifications_Response_401} - 401 response type
3277
+ * @see {@link GET_ContactsByContactIdVerifications_Response_404} - 404 response type
3278
+ * @see {@link GET_ContactsByContactIdVerifications_Response_422} - 422 response type
3279
+ * @see {@link GET_ContactsByContactIdVerifications_Response_502} - 502 response type
3280
+ *
3281
+
3282
+ */
3283
+ export type GET_ContactsByContactIdVerifications_Response = GET_ContactsByContactIdVerifications_Response_200 | GET_ContactsByContactIdVerifications_Response_401 | GET_ContactsByContactIdVerifications_Response_404 | GET_ContactsByContactIdVerifications_Response_422 | GET_ContactsByContactIdVerifications_Response_502;
3284
+
3285
+ /**
3286
+ * 200 response for GET ContactsByContactIdVerifications endpoint
3287
+ *
3288
+ * @remarks
3289
+ * This type defines the response structure for the 200 status code
3290
+ * of the GET ContactsByContactIdVerifications endpoint.
3291
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
3292
+ *
3293
+
3294
+ *
3295
+ * @path /v1/contacts/{contact_id}/verifications
3296
+ *
3297
+ * @see {@link GET_ContactsByContactIdVerifications_Response} - The main response type definition
3298
+ * @see {@link ContactAttestRes} - The actual schema type definition
3299
+ */
3300
+ export type GET_ContactsByContactIdVerifications_Response_200 = ContactAttestRes
3301
+
3302
+ /**
3303
+ * 401 response for GET ContactsByContactIdVerifications endpoint
3304
+ *
3305
+ * @remarks
3306
+ * This type defines the response structure for the 401 status code
3307
+ * of the GET ContactsByContactIdVerifications endpoint.
3308
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
3309
+ *
3310
+
3311
+ *
3312
+ * @path /v1/contacts/{contact_id}/verifications
3313
+ *
3314
+ * @see {@link GET_ContactsByContactIdVerifications_Response} - The main response type definition
3315
+ * @see {@link Problem} - The actual schema type definition
3316
+ */
3317
+ export type GET_ContactsByContactIdVerifications_Response_401 = Problem
3318
+
3319
+ /**
3320
+ * 404 response for GET ContactsByContactIdVerifications endpoint
3321
+ *
3322
+ * @remarks
3323
+ * This type defines the response structure for the 404 status code
3324
+ * of the GET ContactsByContactIdVerifications endpoint.
3325
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
3326
+ *
3327
+
3328
+ *
3329
+ * @path /v1/contacts/{contact_id}/verifications
3330
+ *
3331
+ * @see {@link GET_ContactsByContactIdVerifications_Response} - The main response type definition
3332
+ * @see {@link Problem} - The actual schema type definition
3333
+ */
3334
+ export type GET_ContactsByContactIdVerifications_Response_404 = Problem
3335
+
3336
+ /**
3337
+ * 422 response for GET ContactsByContactIdVerifications endpoint
3338
+ *
3339
+ * @remarks
3340
+ * This type defines the response structure for the 422 status code
3341
+ * of the GET ContactsByContactIdVerifications endpoint.
3342
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
3343
+ *
3344
+
3345
+ *
3346
+ * @path /v1/contacts/{contact_id}/verifications
3347
+ *
3348
+ * @see {@link GET_ContactsByContactIdVerifications_Response} - The main response type definition
3349
+ * @see {@link HTTPValidationError} - The actual schema type definition
3350
+ */
3351
+ export type GET_ContactsByContactIdVerifications_Response_422 = HTTPValidationError
3352
+
3353
+ /**
3354
+ * 502 response for GET ContactsByContactIdVerifications endpoint
3355
+ *
3356
+ * @remarks
3357
+ * This type defines the response structure for the 502 status code
3358
+ * of the GET ContactsByContactIdVerifications endpoint.
3359
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
3360
+ *
3361
+
3362
+ *
3363
+ * @path /v1/contacts/{contact_id}/verifications
3364
+ *
3365
+ * @see {@link GET_ContactsByContactIdVerifications_Response} - The main response type definition
3366
+ * @see {@link Problem} - The actual schema type definition
3367
+ */
3368
+ export type GET_ContactsByContactIdVerifications_Response_502 = Problem
3369
+
3260
3370
  /**
3261
3371
  * Response types for POST ContactsByContactIdVerificationsAttest endpoint
3262
3372
  *
@@ -3275,12 +3385,13 @@ export type PUT_ContactsByContactIdVerification_Response_422 = HTTPValidationErr
3275
3385
  * @see {@link POST_ContactsByContactIdVerificationsAttest_Response_200} - 200 response type
3276
3386
  * @see {@link POST_ContactsByContactIdVerificationsAttest_Response_400} - 400 response type
3277
3387
  * @see {@link POST_ContactsByContactIdVerificationsAttest_Response_401} - 401 response type
3388
+ * @see {@link POST_ContactsByContactIdVerificationsAttest_Response_404} - 404 response type
3278
3389
  * @see {@link POST_ContactsByContactIdVerificationsAttest_Response_422} - 422 response type
3279
3390
  * @see {@link POST_ContactsByContactIdVerificationsAttest_Response_502} - 502 response type
3280
3391
  *
3281
3392
 
3282
3393
  */
3283
- export type POST_ContactsByContactIdVerificationsAttest_Response = POST_ContactsByContactIdVerificationsAttest_Response_200 | POST_ContactsByContactIdVerificationsAttest_Response_400 | POST_ContactsByContactIdVerificationsAttest_Response_401 | POST_ContactsByContactIdVerificationsAttest_Response_422 | POST_ContactsByContactIdVerificationsAttest_Response_502;
3394
+ export type POST_ContactsByContactIdVerificationsAttest_Response = POST_ContactsByContactIdVerificationsAttest_Response_200 | POST_ContactsByContactIdVerificationsAttest_Response_400 | POST_ContactsByContactIdVerificationsAttest_Response_401 | POST_ContactsByContactIdVerificationsAttest_Response_404 | POST_ContactsByContactIdVerificationsAttest_Response_422 | POST_ContactsByContactIdVerificationsAttest_Response_502;
3284
3395
 
3285
3396
  /**
3286
3397
  * 200 response for POST ContactsByContactIdVerificationsAttest endpoint
@@ -3333,6 +3444,23 @@ export type POST_ContactsByContactIdVerificationsAttest_Response_400 = Problem
3333
3444
  */
3334
3445
  export type POST_ContactsByContactIdVerificationsAttest_Response_401 = Problem
3335
3446
 
3447
+ /**
3448
+ * 404 response for POST ContactsByContactIdVerificationsAttest endpoint
3449
+ *
3450
+ * @remarks
3451
+ * This type defines the response structure for the 404 status code
3452
+ * of the POST ContactsByContactIdVerificationsAttest endpoint.
3453
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
3454
+ *
3455
+
3456
+ *
3457
+ * @path /v1/contacts/{contact_id}/verifications/attest
3458
+ *
3459
+ * @see {@link POST_ContactsByContactIdVerificationsAttest_Response} - The main response type definition
3460
+ * @see {@link Problem} - The actual schema type definition
3461
+ */
3462
+ export type POST_ContactsByContactIdVerificationsAttest_Response_404 = Problem
3463
+
3336
3464
  /**
3337
3465
  * 422 response for POST ContactsByContactIdVerificationsAttest endpoint
3338
3466
  *
package/src/openapi.yaml CHANGED
@@ -11529,7 +11529,7 @@ info:
11529
11529
  \n\n"
11530
11530
  summary: OpusDNS - your gateway to a seamless domain management experience.
11531
11531
  title: OpusDNS API
11532
- version: 2026-05-19-074018
11532
+ version: 2026-05-19-074821
11533
11533
  x-logo:
11534
11534
  altText: OpusDNS API Reference
11535
11535
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -14605,6 +14605,79 @@ paths:
14605
14605
  summary: Complete contact verification by contact ID
14606
14606
  tags:
14607
14607
  - contact
14608
+ /v1/contacts/{contact_id}/verifications:
14609
+ get:
14610
+ description: Retrieve the current verification state for a contact from the
14611
+ contact-verification service.
14612
+ operationId: get_contact_verification_status_v1_contacts__contact_id__verifications_get
14613
+ parameters:
14614
+ - in: path
14615
+ name: contact_id
14616
+ required: true
14617
+ schema:
14618
+ examples:
14619
+ - contact_01h45ytscbebyvny4gc8cr8ma2
14620
+ format: typeid
14621
+ pattern: ^contact_[0-7][0-9a-hjkmnpq-tv-z]{25}$
14622
+ title: Contact Id
14623
+ type: string
14624
+ x-typeid-prefix: contact
14625
+ responses:
14626
+ '200':
14627
+ content:
14628
+ application/json:
14629
+ schema:
14630
+ $ref: '#/components/schemas/ContactAttestRes'
14631
+ description: Successful Response
14632
+ '401':
14633
+ content:
14634
+ application/problem+json:
14635
+ example:
14636
+ code: ERROR_AUTHENTICATION
14637
+ detail: Additional error context.
14638
+ status: 401
14639
+ title: Authentication Error
14640
+ type: authentication
14641
+ schema:
14642
+ $ref: '#/components/schemas/Problem'
14643
+ description: Unauthorized
14644
+ '404':
14645
+ content:
14646
+ application/problem+json:
14647
+ example:
14648
+ code: ERROR_CONTACT_VERIFICATION_UPSTREAM_NOT_FOUND
14649
+ contact_id: Additional error context.
14650
+ detail: Contact is not registered with the contact-verification service.
14651
+ status: 404
14652
+ title: Contact Not Registered with Verification Service
14653
+ type: contact-verification-upstream-not-found
14654
+ schema:
14655
+ $ref: '#/components/schemas/Problem'
14656
+ description: Not Found
14657
+ '422':
14658
+ content:
14659
+ application/problem+json:
14660
+ schema:
14661
+ $ref: '#/components/schemas/HTTPValidationError'
14662
+ description: Validation Error
14663
+ '502':
14664
+ content:
14665
+ application/problem+json:
14666
+ example:
14667
+ code: ERROR_CONTACT_VERIFICATION_UPSTREAM_ERROR
14668
+ detail: Additional error context.
14669
+ status: 502
14670
+ title: Contact Verification Service Error
14671
+ type: contact-verification-upstream
14672
+ schema:
14673
+ $ref: '#/components/schemas/Problem'
14674
+ description: Bad Gateway
14675
+ security:
14676
+ - OAuth2PasswordBearer: []
14677
+ - APIKeyHeader: []
14678
+ summary: Get contact verification status
14679
+ tags:
14680
+ - contact
14608
14681
  /v1/contacts/{contact_id}/verifications/attest:
14609
14682
  post:
14610
14683
  description: Submit one or more contact-verification attestations. Returns the
@@ -14662,6 +14735,19 @@ paths:
14662
14735
  schema:
14663
14736
  $ref: '#/components/schemas/Problem'
14664
14737
  description: Unauthorized
14738
+ '404':
14739
+ content:
14740
+ application/problem+json:
14741
+ example:
14742
+ code: ERROR_CONTACT_VERIFICATION_UPSTREAM_NOT_FOUND
14743
+ contact_id: Additional error context.
14744
+ detail: Contact is not registered with the contact-verification service.
14745
+ status: 404
14746
+ title: Contact Not Registered with Verification Service
14747
+ type: contact-verification-upstream-not-found
14748
+ schema:
14749
+ $ref: '#/components/schemas/Problem'
14750
+ description: Not Found
14665
14751
  '422':
14666
14752
  content:
14667
14753
  application/problem+json:
package/src/schema.d.ts CHANGED
@@ -471,6 +471,26 @@ export interface paths {
471
471
  patch?: never;
472
472
  trace?: never;
473
473
  };
474
+ "/v1/contacts/{contact_id}/verifications": {
475
+ parameters: {
476
+ query?: never;
477
+ header?: never;
478
+ path?: never;
479
+ cookie?: never;
480
+ };
481
+ /**
482
+ * Get contact verification status
483
+ * @description Retrieve the current verification state for a contact from the contact-verification service.
484
+ */
485
+ get: operations["get_contact_verification_status_v1_contacts__contact_id__verifications_get"];
486
+ put?: never;
487
+ post?: never;
488
+ delete?: never;
489
+ options?: never;
490
+ head?: never;
491
+ patch?: never;
492
+ trace?: never;
493
+ };
474
494
  "/v1/contacts/{contact_id}/verifications/attest": {
475
495
  parameters: {
476
496
  query?: never;
@@ -12650,6 +12670,86 @@ export interface operations {
12650
12670
  };
12651
12671
  };
12652
12672
  };
12673
+ get_contact_verification_status_v1_contacts__contact_id__verifications_get: {
12674
+ parameters: {
12675
+ query?: never;
12676
+ header?: never;
12677
+ path: {
12678
+ contact_id: TypeId<"contact">;
12679
+ };
12680
+ cookie?: never;
12681
+ };
12682
+ requestBody?: never;
12683
+ responses: {
12684
+ /** @description Successful Response */
12685
+ 200: {
12686
+ headers: {
12687
+ [name: string]: unknown;
12688
+ };
12689
+ content: {
12690
+ "application/json": components["schemas"]["ContactAttestRes"];
12691
+ };
12692
+ };
12693
+ /** @description Unauthorized */
12694
+ 401: {
12695
+ headers: {
12696
+ [name: string]: unknown;
12697
+ };
12698
+ content: {
12699
+ /** @example {
12700
+ * "code": "ERROR_AUTHENTICATION",
12701
+ * "detail": "Additional error context.",
12702
+ * "status": 401,
12703
+ * "title": "Authentication Error",
12704
+ * "type": "authentication"
12705
+ * } */
12706
+ "application/problem+json": components["schemas"]["Problem"];
12707
+ };
12708
+ };
12709
+ /** @description Not Found */
12710
+ 404: {
12711
+ headers: {
12712
+ [name: string]: unknown;
12713
+ };
12714
+ content: {
12715
+ /** @example {
12716
+ * "code": "ERROR_CONTACT_VERIFICATION_UPSTREAM_NOT_FOUND",
12717
+ * "contact_id": "Additional error context.",
12718
+ * "detail": "Contact is not registered with the contact-verification service.",
12719
+ * "status": 404,
12720
+ * "title": "Contact Not Registered with Verification Service",
12721
+ * "type": "contact-verification-upstream-not-found"
12722
+ * } */
12723
+ "application/problem+json": components["schemas"]["Problem"];
12724
+ };
12725
+ };
12726
+ /** @description Validation Error */
12727
+ 422: {
12728
+ headers: {
12729
+ [name: string]: unknown;
12730
+ };
12731
+ content: {
12732
+ "application/problem+json": components["schemas"]["HTTPValidationError"];
12733
+ };
12734
+ };
12735
+ /** @description Bad Gateway */
12736
+ 502: {
12737
+ headers: {
12738
+ [name: string]: unknown;
12739
+ };
12740
+ content: {
12741
+ /** @example {
12742
+ * "code": "ERROR_CONTACT_VERIFICATION_UPSTREAM_ERROR",
12743
+ * "detail": "Additional error context.",
12744
+ * "status": 502,
12745
+ * "title": "Contact Verification Service Error",
12746
+ * "type": "contact-verification-upstream"
12747
+ * } */
12748
+ "application/problem+json": components["schemas"]["Problem"];
12749
+ };
12750
+ };
12751
+ };
12752
+ };
12653
12753
  attest_contact_verification_v1_contacts__contact_id__verifications_attest_post: {
12654
12754
  parameters: {
12655
12755
  query?: never;
@@ -12707,6 +12807,23 @@ export interface operations {
12707
12807
  "application/problem+json": components["schemas"]["Problem"];
12708
12808
  };
12709
12809
  };
12810
+ /** @description Not Found */
12811
+ 404: {
12812
+ headers: {
12813
+ [name: string]: unknown;
12814
+ };
12815
+ content: {
12816
+ /** @example {
12817
+ * "code": "ERROR_CONTACT_VERIFICATION_UPSTREAM_NOT_FOUND",
12818
+ * "contact_id": "Additional error context.",
12819
+ * "detail": "Contact is not registered with the contact-verification service.",
12820
+ * "status": 404,
12821
+ * "title": "Contact Not Registered with Verification Service",
12822
+ * "type": "contact-verification-upstream-not-found"
12823
+ * } */
12824
+ "application/problem+json": components["schemas"]["Problem"];
12825
+ };
12826
+ };
12710
12827
  /** @description Validation Error */
12711
12828
  422: {
12712
12829
  headers: {